3
ܓi> @ s> d dl Z d dlmZ d dlmZ d dlmZ G dd dZdS ) N)Lock)
ClusterOption)boldc @ s e Zd ZdZg Zd;Zg Zi Zi ZdZ dZ
dZ dd Z e
dd Ze
d d
Ze
d d Zd
d Zdd Zdd Zdd Zdd Zdd Zdd Zdd Zd d Zd d Zd!d" Zd#d$ Z do s z'Cluster.display_help..F)newlinez Uses the following sos preset: c s s" | ]\}}d | d| V qdS )z-- Nr )r kvr r r r! { s z Sets the following sos options: z Enables the following plugins: c s s | ]
}|V qd S )Nr )r Zplugr r r r! s c s s | ]\}}| d | V qdS )=Nr )r r$ r% r r r r! s z#Sets the following plugin options: zAvailable cluster optionsz/These options may be toggled or changed using 'z-c z.$option=$value'
r# z<4z Option Namez<20ZDefaultz<30 DescriptionzTrue/Onz False/Offr )r display_self_help set_titler __doc__add_text__mro__packagesjoin
sos_preset sos_optionsitems sos_pluginssos_plugin_options option_listZ add_sectionr r
isinstancebool)r sectionZ_optsr
ZoptsecoptvalZ_lnr r r display_help] s^
$zCluster.display_helpc C s |j d |jd |jd ddlm} dd l}|j|j| d}|jd |jdd d
d d d
dd xD|D ]<}td|d }|jdd |d |d jd
dd qtW d S )Nz*SoS Collect Cluster Profiles Detailed Helpz
Cluster profiles are used to represent different clustering technologies or platforms. Profiles define how cluster nodes are discovered, and optionally filtered, for default executions of collector.zCluster profiles are enabled similarly to SoS report plugins; usually by package, command, or configuration file presence. Clusters may also define default transports for SoS collect.r ) SoSCollectorclustersz6The following cluster profiles are locally available:
r# z>8Namez<40r) z<30F)r" zcollect.clusters.r ) r, r. Z
sos.collectorr> inspectZ
_load_modulesZ getmoduler r )r r: r> rA r? clusterZ_secr r r r+ s&
zCluster.display_self_helpc C sF x@| j D ]6}t|d |d j|d | j|d d}| jj| qW dS )zALoads the options defined by a cluster and sets the default valuer r r* )r Zopt_typevaluerB descriptionN)r7 r r r
r r )r r; optionr r r r s
zCluster._get_optionsc C s d| j d d| S )N[r z] )r
)r msgr r r _fmt_msg s zCluster._fmt_msgc C s | j j| j| dS )zUsed to print info messagesN)r inforH )r rG r r r log_info s zCluster.log_infoc C s | j j| dS )z Used to print error messagesN)r error)r rG r r r log_error s zCluster.log_errorc C s | j j| j| dS )z Used to print debug messagesN)r debugrH )r rG r r r log_debug s zCluster.log_debugc C s | j j| j| dS )z Used to print warning messagesN)r ZwarningrH )r rG r r r log_warn s zCluster.log_warnc C sR x,| j jD ] }|j|kr
|j| jkr
|jS q
W x | jD ]}|j|kr6|jS q6W dS )a
This is used to by clusters to check if a cluster option was
supplied to sos collect
:param option: The name of the option to fetch
:type option: ``str``
:returns: The value of the requested option if it exists, or ``False``
F)r
Zcluster_optionsr rB r
rC r )r rE r; r r r
get_option s
zCluster.get_optionc C s
|| _ dS )a Some clusters generate and/or deploy well-known and consistent
SSH keys across environments. If this is the case, the cluster profile
may call this command so that subsequent node connections will use that
key rather than prompting the user for one or a password.
Note this will only function if collector is being run locally on the
primary node.
N)r )r keyr r r add_default_ssh_key s zCluster.add_default_ssh_keyc C s dS )a
If there is a need to set specific options on ONLY the non-primary
nodes in a collection, override this method in the cluster profile
and do that here.
:param node: The non-primary node
:type node: ``SoSNode``
Nr )r noder r r set_node_options s zCluster.set_node_optionsc C s dS )a` The default connection type used by sos collect is to leverage the
local system's SSH installation using ControlPersist, however certain
cluster types may want to use something else.
Override this in a specific cluster profile to set the ``transport``
option according to what type of transport should be used.
Zcontrol_persistr )r r r r set_transport_type s zCluster.set_transport_typec C s dS )a If there is a need to set specific options in the sos command being
run on the cluster's primary nodes, override this method in the cluster
profile and do that here.
:param node: The primary node
:type node: ``SoSNode``
Nr )r rS r r r set_primary_options s zCluster.set_primary_optionsc C s |j | jj kS )a In the event there are multiple primaries, or if the collect command
is being run from a system that is technically capable of enumerating
nodes but the cluster profiles needs to specify primary-specific
options for other nodes, override this method in the cluster profile
:param node: The node for the cluster to check
:type node: ``SoSNode``
)Zaddressr )r rS r r r check_node_is_primary s z Cluster.check_node_is_primary autoc C s4 | j j||||d}|d r0|d jdd|d< |S )a( Used to retrieve command output from a (primary) node in a cluster
:param cmd: The command to run
:type cmd: ``str``
:param need_root: Does the command require root privileges
:type need_root: ``bool``
:param timeout: Amount of time to allow cmd to run in seconds
:type timeout: ``int``
:param use_shell: Does the command required execution within a shell?
:type use_shell: ``auto`` or ``bool``
:returns: The output and status of `cmd`
:rtype: ``dict``
) need_root use_shelltimeoutoutputz Password:r )r Z run_commandreplace)r cmdrZ r\ r[ resr r r exec_primary_cmd& s
zCluster.exec_primary_cmdc C s dS )z
This MAY be used by a cluster to do prep work in case there are
extra commands to be run even if a node list is given by the user, and
thus get_nodes() would not be called
Nr )r r r r setup? s z
Cluster.setupc C s$ x | j D ]}| jj|rdS qW dS )a
This may be overridden by clusters
This is called by sos collect on each cluster type that exists, and
is meant to return True when the cluster type matches a criteria
that indicates that is the cluster type is in use.
Only the first cluster type to determine a match is run
:returns: ``True`` if the cluster profile should be used, or ``False``
:rtype: ``bool``
TF)r0 r Z is_installed)r Zpkgr r r
check_enabledF s
zCluster.check_enabledc C s dS )z
This may be overridden by clusters
Perform any necessary cleanup steps required by the cluster profile.
This helps ensure that sos does make lasting changes to the environment
in which we are running
Nr )r r r r cleanupX s zCluster.cleanupc C s t dS )aB
This MUST be overridden by a cluster profile subclassing this class
A cluster should use this method to return a list or string that
contains all the nodes that a report should be collected from
:returns: A list of node FQDNs or IP addresses
:rtype: ``list`` or ``None``
N)NotImplementedError)r r r r get_nodesa s
zCluster.get_nodesc C s> y| j S tk
r8 } z| jd| g S d }~X nX d S )NzFailed to get node list: )format_node_list ExceptionrN )r er r r
_get_nodesm s
zCluster._get_nodesc C s | j |}|jjd| |S )aE
Used by ``SosNode()`` to retrieve the appropriate label from the
cluster as set by ``set_node_label()`` in the cluster profile.
:param node: The name of the node to get a label for
:type node: ``str``
:returns: The label to use for the node's report
:rtype: ``str``
label)set_node_labelZmanifestZ add_field)r rS rk r r r get_node_labelt s
zCluster.get_node_labelc C s dS )zThis may be overridden by clusters profiles subclassing this class
If there is a distinction between primaries and nodes, or types of
nodes, then this can be used to label the sos report archives as needed
r r )r rS r r r rl s zCluster.set_node_labelc C s y | j }W n2 tk
r> } ztd| |W Y dd}~X nX t|trZdd |D }n(t|trtdd |D }ntd| tt|}x |D ]}|jdr|j| qW |S )z
Format the returned list of nodes from a cluster into a known
format. This being a list that contains no duplicates
:returns: A list of nodes, without extraneous entries from cmd output
:rtype: ``list``
z#Cluster failed to enumerate nodes: Nc S s g | ]}|r|j qS r )strip)r nr r r
s z,Cluster.format_node_list..c S s g | ]}|j d j qS ),)splitrn )r ro r r r rp s z'Cluster returned unexpected node list: -_()rF ]/\)rs rt ru rv rF rw rx ry )rf rh r8 liststrset
startswithremove)r Znodeserrr rS r r r rg s
zCluster.format_node_listc C st g }yV| j }|rXt|ts"|g}x4|D ],}|j }|j| d|kr(|j|d q(W W n tk
rn Y nX |S )a)
Ensures that any files returned by a cluster's run_extra_cmd()
method are properly typed as a list for iterative collection. If any
of the files are an additional sos report (e.g. the ovirt db dump) then
the md5 sum file is automatically added to the list
Z sosreportz.md5)Z
run_extra_cmdr8 rz rn r AttributeError)r filesr` Z
extra_filer r r _run_extra_cmd s
zCluster._run_extra_cmd)r )FrX rY )'r
__module__ __qualname__r- r7 r0 r5 r3 r6 r2 r Zstrict_node_listr classmethodr r= r+ r rH rJ rL rN rO rP rR rT rU rV rW ra rb rc rd rf rj rm rl rg r r r r r r sH % F "
r )r Z threadingr Z sos.optionsr Z
sos.utilitiesr r r r r r s