0x1949 Team - FAZEMRX - MANAGER
Edit File: __init__.cpython-310.pyc
o i��d�� � @ s� d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dlZd dl Z d dl m Z d dl m Z d dl m Z d dlmZ d dlmZ d dlmZ d dlmZ d d lmZ d d lmZmZ d d lm Z d d l m Z d d l m Z dZ!G dd� de �Z"dS )� N)�datetime)�ThreadPoolExecutor)�getpass)�Path)�quote)�fill)� SoSCleaner)�SosNode)� ClusterOption� str_to_bool)� SoSComponent)�bold)� __version__z/etc/sos/groups.dc s� e Zd ZdZdZi dd�dd�dd�dd�dd�d d �d d�d g �d d�dd �dg �dg �dg �dd�dd�dd�dd�i dd�dd�d d �d g �d d�d d�d!d�d"d�d#d �d$d�d%d&�d'd�d(d�d)g �d*d�d+d�d,d��i d-d�d.d�d/g �d0d�d1d�d2g �d3d�d4d�d5d�d6d�d7d�d8d�d9d�d:d�d;g �d<g �d=g ��dd>d?d@d dg dddddd dd dA��Z� fdBdC�ZdDdE� ZedFdG� �Z edHdI� �Z edJdK� �Z dLdM� Z edNdO� �Z edPdQ� �Zd�dRdS�ZdTdU� ZdVdW� ZdXdY� ZdZd[� Zd\d]� Zd^d_� Zd`da� Zdbdc� Zddde� Zdfdg� Zdhdi� Zdjdk� Zdldm� Z dndo� Z dpdq� Z drds� Z dtdu� Z dvdw� Z!dxdy� Z"dzd{� Z#d|d}� Z$d~d� Z%d�d�� Z&d�d�� Z'd�d�� Z(d�d�� Z)d�d�� Z*d�d�� Z+d�d�� Z,d�d�� Z-d�d�� Z.d�d�� Z/� Z0S )�� SoSCollectora� sos collect, or SoS Collector, is the formerly standalone sos-collector project, brought into sos natively in 4.0 and later. It is meant to collect sos reports from an arbitrary number of remote nodes, as well as the localhost, at the same time. These nodes may be either user defined, defined by some clustering software, or both. For cluster defined lists of nodes, cluster profiles exist that not only define how these node lists are generated but may also influence the sos report command run on nodes depending upon their role within the cluster. Nodes are connected to via a 'transport' which defaults to the use of OpenSSH's Control Persist feature. Other transport types are available, and may be specifically linked to use with a certain cluster profile (or, at minimum, a node within a certain cluster type even if that profile is not used). sos collect may be run from either a node within the cluster that is capable of enumerating/discovering the other cluster nodes, or may be run from a user's workstation and instructed to first connect to such a node via the --primary option. If run in the latter manner, users will likely want to use the --no-local option, as by default sos collect will also collect an sos report locally. Users should expect this command to result in a tarball containing one or more sos report archives on the system that sos collect was executed on. z8Collect an sos report from multiple nodes simultaneously�all_logsF� alloptions�allow_system_changes� become_root�case_id�chroot�auto�clean�cluster_options� cluster_typeN�container_runtime�domains�disable_parsers�enable_plugins� encrypt_key� � encrypt_pass�group�image�force_pull_imageT�jobs� � journal_sizer �keywords� keyword_file�keep_binary_files�label� list_options�log_size� low_priority�map_file� /etc/sos/cleaner/default_mapping�primary� namespaces�nodes� no_env_vars�no_local� nopasswd_sudo� no_pkg_check� no_update� only_plugins�password�password_per_node�plugopts�plugin_timeout� cmd_timeout�preset� registry_user�registry_password�registry_authfile� save_group�since� skip_commands� skip_files� skip_plugins� �rootiX )�ssh_key�ssh_port�ssh_user�timeout� transport�verify� usernames�upload� upload_url�upload_directory� upload_user� upload_pass� upload_method�upload_no_ssl_verify�upload_protocolc s| t t| ��|||� t�d� g | _g | _d | _d| _d | _ d | _ | j j � d� | j j j| _| j�dd� | j�d� t| jdd� t�� | _zttd d � t�t�� d �D ���| _W n tym | � d � d g| _Y nw | � � | � � | _ | jj s�z)| �!� | �"� | �#d d�$dd� t%j&D �� � | �#d| j �'� � | �(� W d S t)y� | �*dd� Y d S ty� � w d S )N�? r �collectr �none� node_list�sudo_pwr c S s g | ]}|d d �qS )r% r � ��.0�ir] r] �8/usr/lib/python3/dist-packages/sos/collector/__init__.py� <listcomp>� s �z)SoSCollector.__init__.<locals>.<listcomp>zkCould not get a list of IP addresses from this hostnamne. This may indicate a DNS issue in your environmentz 127.0.0.1z Executing %s� c s � � | ]}|V qd S �Nr] )r_ �sr] r] ra � <genexpr>� � � z(SoSCollector.__init__.<locals>.<genexpr>zFound cluster profiles: %s�Exiting on user cancel� )+�superr �__init__�os�umask� client_listr[ r0 � retrieved�clusterr �manifest� components� add_sectionrY � collect_md� add_field�add_list�setattr�opts�socket� gethostname�hostname�list�set� getaddrinfo�ip_addrs� Exception� log_error�_parse_options� load_clusters�clustersr+ �parse_node_strings�parse_cluster_options� log_debug�join�sys�argv�keys�verify_cluster_options�KeyboardInterrupt�exit)�self�parser� parsed_args� cmdline_args�� __class__r] ra rl � sR � � � � ��zSoSCollector.__init__c C sD ddl }|jj}i }| �|d�}|D ] }|d | j�||d < q|S )zmLoads all cluster types supported by the local installation for future comparison and/or use r Nr� � )�sos.collector.clusters� collectorr� � _load_modules�commons)r� �sos�package�supported_clustersr� rq r] r] ra r� � s zSoSCollector.load_clustersc C s2 g }|j D ]}tj�|�r|�| �||�� q|S )z'Helper to import cluster and host types)�__path__rm �path�isdir�extend�_find_modules_in_path)�clsr� �submod�modulesr� r] r] ra r� � s �zSoSCollector._load_modulesc C sj g }t j�|�r3tt �|��D ]#}|�d�sqd|v r qt j�|�\}}d||f }|�| �|�� q|S )aX Given a path and a module name, find everything that can be imported and then import it path - the filesystem path of the package modulename - the name of the module in the package E.G. a path of 'clusters', and a modulename of 'ovirt' equates to importing sos.collector.clusters.ovirt z.py�__zsos.collector.%s.%s) rm r� �exists�sorted�listdir�endswith�splitextr� �_import_modules)r� r� � modulenamer� �pyfile�fname�ext�modnamer] r] ra r� � s z"SoSCollector._find_modules_in_pathc C sT |� d�d }t|t� t� |g�}t�|tj�}|D ] }|d dv r'|�|� q|S )z/Import and return all found classes in a module�.� r )�SosHost�Cluster)�split� __import__�globals�locals�inspect� getmembers�isclass�remove)r� r� �mod_short_name�moduler� �modr] r] ra r� � s �z SoSCollector._import_modulesc C s� | j jsdS g }t| j jt�s| j jg| j _| j jD ]\}dd� t|�D �}|�t|�� d}d}|D ]2}z&|}|||� }t�t� |�� d|v rOd|vrOW q2|�|� d�� |}W q2 tj yd Y q2w |t|�krv|�||d d� � q|| j _dS ) ar Parses the given --nodes option(s) to properly format the regex list that we use. We cannot blindly split on ',' chars since it is a valid regex character, so we need to scan along the given strings and check at each comma if we should use the preceeding string by itself or not, based on if there is a valid regex at that index. Nc S s g | ] \}}|d kr|�qS )�,r] )r_ r` �mr] r] ra rb � z3SoSCollector.parse_node_strings.<locals>.<listcomp>r �[�]r� r� ) ry r2 � isinstancer} � enumerate�append�len�re�compile�escape�lstrip�error)r� r2 �node�idxs�start�pos�idx�regr] r] ra r� � s4 � � z SoSCollector.parse_node_stringsc C s� |� dd�}|jddddd� |jddd d� |jd dd d d � |jddg d�dd� |jdddd� |jddddd� |jdtd d d � |jd d d!dd"d#d$� |jd%d td&d'� |jd(dd d)d � |jd*d+dd,d� |jd-d.dg d/d � |jd0d d1d� |jd2dd d3d � |jd4td d5d � |jd6td d7d � |jd8d d9d� |jd:g dd;d<d=� |jd>g dd?d@d=� |jdAddBd� |� dCdD�}|jdEdFddGdHd$� |jdIdJdK� |jdLdMdK� |jdNdOdPdQdRdS� |jdTd dUd� |jdVddWd� |jdXdYdK� |jdZd[d\d]td^d_� |jd`d dad� |jdbd dcd� |jddd ded� |jdfdgdhdK� |jdidjdktdld'� |jdmdnddod� |jdpdqdK� |jdrdsdtduddvdw� |jdxddyd� |jdzdQd{d� |jd|dd}d� |jd~ddd� |jd�d�td�d�� |jd�dd d�d � |jd�dd d�d � |jd�dd d�d�� |jd�d�dK� |jd�td d�d�� |jd�dtd�d'� |jd�dd d�d � |jd�d d�d� |jd�d d�d� |jd�d d�d� |jd�d d�d� |jd�dg d��d�d� |jd�d dd�d�� |jd�dg d��d�d� |� d�d��}|jd�d�d�d�d dd�d�� |jd�d dd�d�d=� |jd�d�g dd�d�� |jd�dg d�d�d�� |jd�dg d�d�d�� |jd�d d�d�d�� |jd�dd d�d�d�� |jd�d�d�d�dw� |jd�d�g dd�d�� d S )�NzReport Passthru Optionsz0These options control how report is run on nodesz-az --alloptions� store_truez Enable all sos report options)�action�helpz --all-logsz Collect logs regardless of sizez--allow-system-changesFz;Allow sosreport to run commands that may alter system state)r� �defaultr� z--chrootr )r �always�neverz#chroot executed commands to SYSROOT)r� �choicesr� z--container-runtimer zLDefault container runtime to use for collections. 'auto' for policy control.)r� r� z-ez--enable-pluginsr� z%Enable specific plugins for sosreportz--journal-sizer z!Limit the size of journals in MiB)�typer� r� z-kz--plugin-optionz --plugoptsr; z&Plugin option as plugname.option=value)r� �destr� z --log-sizez7Limit the size of individual logs (not journals) in MiB)r� r� r� z--low-priorityzRun reports as low priorityz-nz--skip-pluginszSkip these pluginsz-oz--only-pluginszRun these plugins onlyz --namespaceszDlimit number of namespaces to collect output for - 0 means unlimitedz --no-env-varsz%Do not collect env vars in sosreportsz--plugin-timeoutz#Set the global plugin timeout valuez --cmd-timeoutz$Set the global command timeout valuez--sincezbEscapes archived files older than date. This will also affect --all-logs. Format: YYYYMMDD[HHMMSS]z--skip-commandsrD z do not execute these commands)r� r� r� r� z --skip-filesrE zdo not collect these filesz--verifyz*perform pkg verification during collectionzCollector Optionsz.These options control how collect runs locallyz-bz--becomer z Become root on the remote nodesz --case-idzSpecify case number)r� z--cluster-typez!Specify a type of cluster profilez-cz--cluster-optionr r� zVSpecify a cluster options used by a profile and takes the form of cluster.option=value)r� r� r� z--groupz Use a predefined group JSON filez --save-groupz%Save a resulting node list to a groupz--imagez;Specify the container image to use for containerized hosts.z--force-pull-imagez--pullT)TFzDForce pull the container image even if it already exists on the host)r� r� r� r� z--registry-userzBUsername to authenticate to the registry with for pulling an imagez--registry-passwordzBPassword to authenticate to the registry with for pulling an imagez--registry-authfilezJUse this authfile to provide registry authentication when pulling an imagez-iz --ssh-keyzSpecify an ssh keyz-jz--jobsr% z%Number of concurrent nodes to collectz-lz--list-optionsz#List options available for profilesz--labelz Assign a label to the archivesz --primaryz --managerz --controllerr0 z.Specify a primary node for cluster enumeration)r� r� r� z--nopasswd-sudoz Use passwordless sudo on nodesz--nodeszDProvide a comma delimited list of nodes, or a regex to match againstz--no-pkg-checkz^Do not run package checks. Use this with --cluster-type if there are rpm or apt issues on nodez --no-localz&Do not collect a report from localhostz-pz --ssh-portz Specify SSH port for all nodes)r� r� z --passwordz"Prompt for user password for nodesz--password-per-nodez!Prompt for password for each nodez--presetzSpecify a sos preset to use)r� �requiredr� z --ssh-userz!Specify an SSH user. Default rootz --timeoutz#Timeout for sosreport on each node.)r� r� r� z --transportz"Remote connection transport to usez--uploadz+Upload archive to a policy-default locationz --upload-urlz&Upload the archive to specified serverz--upload-directoryz$Specify upload directory for archivez --upload-userz Username to authenticate withz --upload-passz Password to authenticate withz--upload-method)r �put�postz HTTP method to use for uploadingz--upload-no-ssl-verifyz'Disable SSL verification for upload url)r� r� r� z--upload-protocol)r �https�ftp�sftpz$Manually specify the upload protocolzCleaner/Masking Optionsz7These options control how data obfuscation is performedz--cleanz --cleanerz--maskr z Obfuscate sensitive information)r� r� r� r� z--keep-binary-filesr) zGKeep unprocessable binary files in the archive instead of removing themz --domainsr z$Additional domain names to obfuscatez--disable-parsersr zCDisable specific parsers, so that those elements are not obfuscated)r� r� r� r� z --keywordsr' z List of keywords to obfuscatez--keyword-filer( z&Provide a file a keywords to obfuscate)r� r� r� z --no-updater7 z%Do not update the default cleaner mapz --map-filer. r/ z;Provide a previously generated mapping file for obfuscationz --usernamesrO z List of usernames to obfuscate)�add_argument_group� add_argument�intr �str)r� r� �sos_grp� collect_grp� cleaner_grpr] r] ra �add_parser_options s� � ����� � � � �� � ��� � �� � ��� ���������� � �� ����� ��� �� � ���������� �� �� ���� �z SoSCollector.add_parser_optionsc C s\ |� d� |�| j� ddddd�}|�d� |D ]}|jd�d t|�|| �d d � qd S ) NzSoS Collect Detailed Helpz Information on cluster profilesz Specific profile informationz'Information on how connections are madez Specific transport information)zcollect.clusterszcollect.clusters.$clusterzcollect.transportsz collect.transports.$transportz8The following help sections may be of further interest: z{:>8}{:<40}{:<30}rc F)�newline)� set_title�add_text�__doc__�formatr )r� �section� hsections�hsecr] r] ra � display_help� s ����zSoSCollector.display_helpc C sn | j r| j �� |r| �|� z| �� W n ty Y nw |dkr'| �� |s0t�|� dS t�|� dS )a� Used to terminate and ensure all cleanup is done, setting the exit code as specified if required. :param msg: Log the provided message as an error :type msg: ``str`` :param error: The exit code to use when terminating :type error: ``int`` :param force: Use os.exit() to break out of nested threads if needed :type force: ``bool`` rj N) rq �cleanupr� �close_all_connectionsr� r� r� rm �_exit)r� �msgr� �forcer] r] ra r� � s �zSoSCollector.exitc C s@ | j | j jdkr dnd| jtt| j j�t| j��| jd�| _dS )zxFrom commandline options, defaults, etc... build a set of commons to hand to other collector mechanisms rH TF)� cmdlineopts� need_sudo�tmpdir�hostlen�policyN) ry rK r� �maxr� r0 r| r� r� �r� r] r] ra r� s �zSoSCollector._parse_optionsc C s� g }t | jjt�s| jjg| j_| jjrR| jjD ]9}|�d�d }|�d�d �d�d }z |�d�d �� d }W n tyE d}Y nw |�t|||j|�� q|| j_d S )Nr� r r� �=�True) r� ry r r} r� � IndexErrorr� r r� )r� ry �optionrq �name�valuer] r] ra r� s �� z"SoSCollector.parse_cluster_optionsc C s� | j jrB| j jD ])}d}| jD ]!}| j| jD ]}|j|jkr/|j|kr/d}| �||�|_ nqqq|sD| �d|j|jf d� dS dS dS )z+Verify that requested cluster options existFTz&Unknown cluster option provided: %s.%sr� N) ry r r� �optionsr rq �_validate_optionr r� )r� �opt�match�clustr r] r] ra r� 2 s& �� ��� z#SoSCollector.verify_cluster_optionsc C sx |j tks |j |j ksd}| �||j|j |j f d� |jS |j�� }|dvr4d}| �||j d� dS |dv r:dS dS ) aC Checks to make sure that the option given on the CLI is valid. Valid in this sense means that the type of value given matches what a cluster profile expects (str for str, bool for bool, etc). For bool options, this will also convert the string equivalent to an actual boolean value z.Invalid option type for %s. Expected %s got %sr� )�true�on�yes�false�off�nozUInvalid value for %s. Accepted values are: 'true', 'false', 'on', 'off', 'yes', 'no'.)r r r TFN)�opt_type�boolr� r r �lower)r� r� �clir� �valr] r] ra r A s z SoSCollector._validate_optionc C � | j �|� dS )z.Log info messages to both console and log fileN)�soslog�info�r� r� r] r] ra �log_infoZ � zSoSCollector.log_infoc C r )z.Log warn messages to both console and log fileN)r �warningr r] r] ra �log_warn^ r zSoSCollector.log_warnc C r )z/Log error messages to both console and log fileN)r r� r r] r] ra r� b r zSoSCollector.log_errorc C s, t �� d d }d||f }| j�|� dS )z.Log debug message to both console and log filer� � z[sos_collector:%s] %sN)r� �stackr �debug)r� r� �callerr] r] ra r� f s zSoSCollector.log_debugc sH t j�d� t j�d� t| j�D ]}t j�d�|| j| j�� qi � | jD ]/}| j| jD ]&}|j� � � vr>|� |j< q/|j D ]}|� |j j vrT� |j j � |� qAq/q't j�d� t j�d�dddd d �� t� � fd d �d �D ]'}� | }d�d� dd� t|j �D ��|j|j jt|j�|j�}t j�|� qtt j�d� dS )z&Display options for available clustersz; The following clusters are supported by this installation z@Use the short name with --cluster-type or cluster options (-c) z {:<15} {:30} z/ The following cluster options are available: z {:25} {:15} {:<10} {:10} {:<} r� z Option Name�Type�Default� Descriptionc s � | j S re )rq )�x��_optsr] ra �<lambda>� s z+SoSCollector.list_options.<locals>.<lambda>��keyz" {:25} {:15} {:<10} {:<10} {:<10} z, c s rd re r] )r_ �cr] r] ra rg � rh z,SoSCollector.list_options.<locals>.<genexpr>zh Options take the form of cluster.name=value E.G. "ovirt.no-database=True" or "pacemaker.offline=False" N)r� �stdout�writer� r� r� � cluster_namer r r� rq r� r� r �__name__r� r � description)r� rq �_clusterr r �_opt�optlnr] r' ra r+ l sJ � ��� ��zSoSCollector.list_optionsc C s t �| j� dS )z7Removes the temp directory and all collected sosreportsN)�shutil�rmtreer� r r] r] ra �delete_tmp_dir� r zSoSCollector.delete_tmp_dirc C s� d}| j jr|d| j j 7 }| j jr|d| j j 7 }t�t�� d�}ztjt_W n t y1 Y nw d� dd� t d�D ��}d|||f S ) z(Generates a name for the tarball archivez sos-collectorz-%sz%Y-%m-%dr c s s � | ] }t �tj�V qd S re )�random�choice�string� lowercase)r_ r& r] r] ra rg � s � z1SoSCollector._get_archive_name.<locals>.<genexpr>� z%s-%s-%s) ry r* r r �strftime�nowr: �ascii_lowercaser; � NameErrorr� �range)r� �nstr�dt�randr] r] ra �_get_archive_name� s �z SoSCollector._get_archive_namec C s& | � � | _d}| jd | j d | S )zuReturns the path, including filename, of the tarball we build that contains the collected sosreports �gz�/z.tar.)rE �arc_namer� )r� �comprr] r] ra �_get_archive_path� s z SoSCollector._get_archive_pathc C s0 d}d}|� � D ] }|t||dd� d }q|S )N�P r F)�replace_whitespace� )� splitlinesr )r� r� �width�_fmt�liner] r] ra �_fmt_msg� s zSoSCollector._fmt_msgc C s" | j j}|tj�t�� d| �tj�t|�g}d}|D ] }tj�|�r'|} nq|du r2t d| ��| � d| � t |d��I}t � |�}dD ]}|| r`| � d||| f � t| j ||| � qF|d r| � d |d � | j j�|d � W d � dS W d � dS 1 s�w Y dS ) a� Attempts to load the host group specified on the command line. Host groups are defined via JSON files, typically saved under /etc/sos/groups.d/, although users can specify a full filepath on the commandline to point to one existing anywhere on the system Host groups define a list of nodes and/or regexes and optionally the primary and cluster-type options. z.config/sos/groups.d/%sNzno group definition for %szLoading host group %s�r)r0 r z*Setting option '%s' to '%s' per host groupr2 zAdding %s to node list)ry r! rm r� r� r �home�COLLECTOR_CONFIG_DIRr� �OSErrorr� �open�json�loadrx r2 r� )r� �grp�pathsr� r� �hf�_groupr+ r] r] ra �_load_group_config� s: � � ���"�z SoSCollector._load_group_configc C s� | j j| j j| jjd dd� | jD �d�}t�� dkr,tj� t � � d�}tj |dd� nt }tj� ||d �}t|d ��}t�||� W d � n1 sMw Y t�|d � |S ) a Saves the results of this run of sos-collector to a host group file on the system so it can be used later on. The host group will save the options primary, cluster_type, and nodes as determined by sos-collector prior to execution of sosreports. r c S s g | ]}|�qS r] r] �r_ �nr] r] ra rb � s z1SoSCollector.write_host_group.<locals>.<listcomp>)r r0 r r2 z.config/sos/groups.dT)�exist_okr �wNi� )ry rB r0 rq r r[ rm �getuidr� r� r rT �makedirsrU rW rX �dump�chmod)r� �cfg� group_pathr� r\ r] r] ra �write_host_group� s � � z SoSCollector.write_host_groupc C s� | j �| j� | jjs | jjs | �d� d}| j�| � |�� zV| jjs,| jjrB| jj rB| jj sB| �d� d| jj }t |d�| j_| jd rt| jjst| jj st| jjsj| jjsj| �d� d| jj }t |d�| j_n | jjst| jj| j_W n ty� | �d d � Y nw | jjr�| jj d ks�| jj r�d }| �|d � | �d� d| jj }t |d�| j_d| jd< n | �d� d| j_| jjr�z| �� W n ty� } zd| jj|f }| �|d � W Y d }~nd }~ww z| j �� W n ty� | �dd � Y nw | jj �r | �� d| j_nozNd}d }d}| jj�sOt� � dk�rO| jj�sO| jj �sCd}t |�}|dk�rB| j�|� d}d| j_d }n | j�|� d}d| j_t d| j||d�| _ W n t�yz } z| �d| � | �d d � W Y d }~nd }~ww | j � d | j j � | j �!d � | j j"�!| j j � | j �#t$| j j"| j j �� | jj%�r�| jj%d k�r�| j&d | _'n | j&| jj% | _'| jj%| _%| j | j'_ n| �(� | j'd u �r�| jj"�s�d!}| �|d � n| j'd u �r�| jj"�r�| �d"� | j&d | _'d | _%| j � d#| j%� | j'�r4| j'| j _'| jj)d$k�r| j'�*� | j_)| j'�+� | j'j,�r4| jj-�s4| �d%| j'j, � | j'j,| j_-| �.� | jj/�ro| jj/}z| �0� }| �d&||f � W d S t�yn } z| �1d'||f � W Y d }~d S d }~ww d S )(Nz)password not specified, assuming SSH keyszisos-collector ASSUMES that SSH keys are installed on all nodes unless the --password option is provided. z&password specified, not using SSH keysz&Provide the SSH password for user %s: )�promptr� z3non-root user specified, will request sudo passwordzQA non-root user has been provided. Provide sudo password for %s on remote nodes: z Exiting on user cancel rj rH zkCannot become root without obtaining root password. Do not use --batch if you need to become root remotely.r� z,non-root user asking to become root remotelyz<User %s will attempt to become root. Provide root password: FzSOption to become root but ssh user is root. Ignoring request to change user on nodez%Could not load specified group %s: %s�Exiting on user cancel Tz�Local sos report generation forcibly skipped due to lack of root privileges. Either use --nopasswd-sudo, run as root, or do not use --batch so that you will be prompted for a password r z8Enter local sudo password to generate local sos report: r � localhost)� local_sudo� load_factsz*Unable to determine local installation: %szsUnable to determine local installation. Use the --no-local option if localhost should not be included. Aborting... r0 r2 rZ �jbonzFCluster type could not be determined and no nodes provided Aborting...zCluster type could not be determined, but --nodes is provided. Attempting to continue using JBON cluster type and the node listr r z"Updating SSH key to %s per clusterzWrote group '%s' to %szCould not save group %s: %s)2r� � set_commonsr� ry r9 r: r� �ui_logr rR r0 �batchrK r r5 r\ r� r� r � root_passwordr r! r^ r� �pre_work�connect_to_primaryr4 rm rc r ru rv �addressrt r2 �set_node_manifest�getattrr r� rq �determine_clusterrM �set_transport_type�setup�cluster_ssh_keyrI � get_nodesrB ri r� )r� r� �err� can_run_localrm �skip_local_msg�gnamer� r] r] ra �prep� s � �� �� � � � � ��� � �� � ����� � � ���zSoSCollector.prepc C s. | j �d� | js| jjs| �dd� | j �d� | jjr>| jjdur>| jjr+| jj s>| j j s>| j �d| j d | jjf � t | j�D ]}| j �d| j d |f � qC| j �d� | jjs�z td� | j �d� W dS tyz | �d d � Y dS ty� } z| �t|�d� W Y d}~dS d}~ww dS ) zuPrints a list of nodes to collect from, if available. If no nodes are discovered or provided, abort. r zGNo nodes were detected, or nodes do not have sos installed. Aborting...r� z1The following is a list of nodes to collect from:Nz %-*sr� zC Press ENTER to continue with these nodes, or press CTRL-C to quit ri rj )rq r r[ r0 � connectedr� r| �localry r4 rq �strict_node_listr� r� rr �inputr� r� �repr)r� r� �er] r] ra � display_nodes� s6 � �� ���zSoSCollector.display_nodesc C s d}i }| j jrt| j j�|d< | j jrd|d< | j jr d|d< | j jr(d|d< | j jr6tt| j j��|d< | j jrBt| j j�|d< | j j rNt| j j �|d < | j j d kr\t| j j �|d < |� � D ]\}}|d |� d |� d �7 }q`|� � }| � d|� �� d| jd< || jd< | j�d|� dS )z9Configures the sosreport command that is run on the nodeszsosreport --batch zcase-idr r zall-logsrN zlog-size�sysrootr r zcompression-typez--rc zInitial sos cmd set to �sos_cmd� sos_options�initial_sos_cmdN)ry r r r r rN r, r� r� r �compression_type�items�rstripr� r� ru rv )r� r� r� �k�vr] r] ra �configure_sos_cmd� s2 z SoSCollector.configure_sos_cmdc C sn zt | jj| j�| _| j�d| jj � W dS ty6 } z| �d| � | �dd� W Y d}~dS d}~ww )zgIf run with --primary, we will run cluster checks again that instead of the localhost. z,Connected to %s, determining cluster type...z%Failed to connect to primary node: %sz.Could not connect to primary node. Aborting...r� N) r ry r0 r� rq r r� r� r� )r� r� r] r] ra ru � s ���z SoSCollector.connect_to_primaryc C s� t | j�� �}| j�� D ]`}|�|� | j|_|�� rl|jj}| �d| � |D ])}t |j|j�rQ|jj}| �d| � | j|_|�� rQ| �d||f � |} nq(|| _ |� � | _ | j | j d< | j�d| j � dS q dS )a@ This sets the cluster type and loads that cluster's cluster. If no cluster type is matched and no list of nodes is provided by the user, then we abort. If a list of nodes is given, this is not run, however the cluster can still be run if the user sets a --cluster-type manually z6Installation matches %s, checking for layered profilesz/Layered profile %s found. Checking installationziInstallation matches both layered profile %s and base profile %s, setting cluster type to layered profilerq zCluster type set to %sN)r} r� �valuesr� r0 � check_enabledr� r0 r� � issubclassrq r r r� rq r )r� �checksrq �cname� remaining�rnamer] r] ra ry � s@ ���� ���z SoSCollector.determine_clusterc C s& | j r| j�� }| �d| � |S g S )z>Collects the list of nodes from the determined cluster clusterz Node list: %s)r rq � _get_nodesr� )r� r2 r] r] ra �get_nodes_from_cluster s z#SoSCollector.get_nodes_from_clusterc C s� | j | jv r| jjr| j�| j � | jjs&| jD ] }|| jv r%| j�|� q| jdurG| jjsG| jD ]}|| jj ks@|| jjkrF| j�|� q2t t dd� | jD ���| _| � d| j � | j � d| j� dS )zSReduce duplicate entries of the localhost and/or primary node if applicableNc s s � | ]}|r|V qd S re r] r_ r] r] ra rg � � z0SoSCollector.reduce_node_list.<locals>.<genexpr>zNode list reduced to %sr[ )r| r[ ry r4 r� rq r� r� r0 r} r~ r� ru rw )r� r` r` r] r] ra �reduce_node_list s � �z SoSCollector.reduce_node_listc C sr | j jD ]2}zt�|�}t�||�rW dS W q tjy6 } zd}| �||||f � W Y d}~qd}~ww dS )z�Compares a discovered node name to a provided list of nodes from the user. If there is not a match, the node is removed from the listTz0Error comparing %s to provided node regex %s: %sNF)ry r2 �fnmatch� translater� r r� r� )r� r� �regexr~ r� r] r] ra �compare_node_to_regex s � ��z"SoSCollector.compare_node_to_regexc s� | j s| jsd}| �|d� z | �� }| jjr(|D ] � | �� �r&| j�� � qn|| _W n: t yf } z.| � d| � | � d� | jj| _| jD ]� t � fdd�dD ��r[| j� � � qHW Y d}~nd}~ww | jjr�| jjD ] � t � fd d�d D ��r}qo� | jvr�| � d � � | j�� � qo| j s�| j �d �d }| jD ]� |� �d �d kr�| j� � � q�| jjs�| j�| j � | �� ztt| jtd��}t|| jd �| jd< W dS ttfy� Y dS w )z3 Sets the list of nodes to collect sosreports from zaCould not determine a cluster type and no list of nodes or primary node was provided. Aborting...r� zError parsing node list: %sz#Setting node list to --nodes optionc 3 � � | ]}|� v V qd S re r] r^ �r� r] ra rg = r� z)SoSCollector.get_nodes.<locals>.<genexpr>)�*�\�?�(�)rG Nc 3 r� re r] r^ r� r] ra rg C r� z*\?()/[]z Force adding %s to node listr� r r* r� )r0 rq r� r� ry r2 r� r[ r� r� r� �anyr� r| r� r� r� r� r� r� � TypeError� ValueError)r� r� r2 r� �host� _node_maxr] r� ra r} ( s^ ��� � ��� � � �zSoSCollector.get_nodesc C s� z:t |d | j|d d�}|�| j� |jr4| j�|� | jj� |d � |� t | jj|d �� W dS |� � W dS t yD Y dS w )z�Try to connect to the node, and if we can add to the client list to run sosreport on Positional arguments node - a tuple specifying (address, password). If no password, set to None r r� )r9 N)r r� � set_clusterrq r� ro r� ru r2 rt rw rx � disconnectr� )r� r� �clientr] r] ra �_connect_to_nodeX s � �z SoSCollector._connect_to_nodec C s� d}| j �dt � | �|| j �}| j �|� d}| jjsTz t|� | j �d� W dS ty; | � dd� Y dS t yS } z | � |d� W Y d}~dS d}~ww dS ) zmPrint the intro message and prompts for a case ID if one is not provided on the command line ah This utility is used to collect sos reports from multiple nodes simultaneously. Remote connections are made and/or maintained to those nodes via well-known transport protocols such as SSH. An archive of sos report tarballs collected from the nodes will be generated in %s and may be provided to an appropriate support representative. The generated archive may contain data considered sensitive and its content should be reviewed by the originating organization before being passed to any third party. No configuration changes will be made to the system running this utility or remote systems that it connects to. z sos-collector (version %s) z, Press ENTER to continue, or CTRL-C to quit r ri rj r� N) rq r r rR r� ry rr r� r� r� r� )r� � disclaimer� intro_msgrj r� r] r] ra �intron s ���zSoSCollector.introc C s~ | j jr | �� | �� | �� | �� | �� | �� | �� | _| j | jd� | j � � | _ | j � dd� | �� | �� d S )N)r �sos_logsi� )ry r+ r� r� r� r� r� rE � archive_name� setup_archive�archive�get_archive_path� archive_pathrd rY r r] r] ra �execute� s zSoSCollector.executec s t | jj| jjg�� | jjr!� �t | j��s| jjs!| j � | j� | j � d� � fdd�| jD �}| j jrUg }|D ]}d| j j|d f }t|�}|� |d |f� q9|}z�t| j j�}|j| j|dd� |jdd � | j jr}| j d jd kr}| j �d� t| j �| _| jdkr�| �d d� n| jdkr�| j d jd kr�| �d d� | j � d | j| j jf � t| j j�}|j| j| j dd� |jdd � t| j j�}|j| j | j dd� |jdd � W n/ t y� | jdddd� Y n t �y } zd| }| j|ddd� W Y d}~nd}~ww t | jd��r'| j � d� | j� � } | �r'| j�!| � d}| �"|| j#| jf � | �$� | j#dk�rC| �%� } nd}| �|d� | j j&�r�| j'�(� �r�z| j'�)| � | j � d� W dS t �y� } z| j �*d| � W Y d}~dS d}~ww dS dS )zX For each node, start a collection thread and then tar all collected sosreports z Connecting to nodes...c s g | ] }|� vr|d f�qS re r] r_ ��filtersr] ra rb � r� z(SoSCollector.collect.<locals>.<listcomp>z%Please enter the password for %s@%s: r r� )� chunksizeT)�waitrl z No nodes connected. Aborting...z�Collection would only gather from localhost due to failure to either enumerate or connect to cluster nodes. Assuming single collection from localhost is not desired. Aborting...z[ Beginning collection of sosreports from %s nodes, collecting a maximum of %s concurrently rk rj )r� z Could not connect to nodes: %sN� run_extra_cmdz/Collecting additional data from primary node...z* Successfully captured %s of %s sosreportsz3No sosreports were collected, nothing to archive...z Uploaded archive successfullyzUpload attempt failed: %s)+r~ r0 rv r| r� � intersectionr[ rq r� ro r� rq r ry r: rK r r r$ �mapr� �shutdownr4 �popr� � report_numr� �_finalize_sos_cmd�_collectr� r� �hasattr�_run_extra_cmd�collect_extra_cmdr rp r� �create_cluster_archiverP r� �get_upload_url�upload_archiver� ) r� r2 �_nodesr� r� �node_pwd�pool�npoolr~ �filesrH r] r� ra rY � s� �� � � � �� ���zSoSCollector.collectc C sJ z|� � W dS ty$ } z| �d|j|f � W Y d}~dS d}~ww )z�Calls finalize_sos_cmd() on each node so that we have the final command before we thread out the actual execution of sos z)Could not finalize sos command for %s: %sN)�finalize_sos_cmdr� r� rv �r� r� r~ r] r] ra r� � s ���z SoSCollector._finalize_sos_cmdc C sv z |j s |�� n| jjs|�� |jr | jd7 _W dS W dS ty: } z| �d| � W Y d}~dS d}~ww )zRuns sosreport on each noder� zError running sosreport: %sN)r� � sosreportry r4 rp r� r� r� r] r] ra r� s � ��zSoSCollector._collectc C s. | j D ]}|jr| �d|j � |�� qdS )z Close all sessions for nodeszClosing connection to %sN)ro r� r� rv r� )r� r� r] r] ra r� s ��z"SoSCollector.close_all_connectionsc C s d}g }| j D ] }|jD ]}|�|� q qd}| jjr_| j| j| j| j| jd�}z | j � d� t d|d�}|� | j� |� � \}}d}W n ty^ } z| j �d| � W Y d}~nd}~ww �z| �d� |D ]@}|�d �d } |rx|�| �} tj�| j|�} | jj| | d � |r�|�|�} | r�tj�d |�d �d �} | d 7 } | j�| | � qh| jj| jtj�dd�d � | jj| jtj�dd�d � | jdur�| j� | jj � |�rtj�| j| jj �} |j tj�| dd�dd� |j tj�| dd�dd� |j tj�| dd�dd� | j� | jj �} tj�| jtj�!| ��}|�r&|�|�"dd��}t�#| |� |�rK|�tj�| jd| j$ ��}t�#||� | j � d| � | j%� d| � | j � d� | j � d| � |W S t�y� } zd|| j&f }| �'|d � W Y d}~dS d}~ww ) zeCalls for creation of tar archive then cleans up the temporary files created by sos-collectorNF)r� r� �sys_tmpr rr r T)�in_place� hook_commonsz&ERROR: unable to obfuscate reports: %sz!Creating archive of sosreports...rG ���)r� � checksumsz.sha256r� zsos.logzui.log)� short_name� sos_reportsz manifest.jsonz.tarz-obfuscated.tarz%s_private_mapz4A mapping of obfuscated elements is available at %szArchive created as %szP The following archive has been created. Please provide it to your support team.z %s zNCould not finalize archive: %s Data may still be available uncompressed at %sr� )(ro � file_listr� ry r r� r� r� rr rq r r �set_target_pathr� r� r� r r� �obfuscate_stringrm r� r� r� �add_file�get_new_checksum� add_string� sos_log_file�sos_ui_log_file�add_final_manifest_datar� �_name�obfuscate_file�finalize�basename�replace�renamer� r r� r� )r� r. � arc_pathsr� r� �do_cleanr� �cleanerr~ r� r �checksum�_dirrH � final_name�map_namer� r] r] ra r� s� �� � ��� � � � ���� � �� � ���z#SoSCollector.create_cluster_archive)Nr F)1r0 � __module__� __qualname__r� �desc� arg_defaultsrl r� � classmethodr� r� r� r� r� r� r� r� r� r� r r r r� r� r+ r7 rE rJ rR r^ ri r� r� r� ru ry r� r� r� r} r� r� r� rY r� r� r� r� � __classcell__r] r] r� ra r & sT �������� � � � � ��������������� � � � � �!�"�#�$�%�&�'�(�)�*�+�,�-�.�/�0�1�2�3�4� E4 ! G ,& & 0!X r )#r� r� rX rm r8 r� r: rz r5 r� r �concurrent.futuresr r �pathlibr �pipesr �textwrapr � sos.cleanerr �sos.collector.sosnoder � sos.optionsr r � sos.componentr � sos.utilitiesr r� r rU r r] r] r] ra �<module> s0