File: //lib/python3/dist-packages/sos/policies/distros/__pycache__/redhat.cpython-38.pyc
U
i��d�_ � @ sF d dl Z d dlZd dlZd dlZd dlmZ d dlmZmZm Z m
Z
m Z m Z m
Z
mZmZmZ d dlmZmZ d dlmZ d dlmZ d dlmZ zd dlZdZ W n e k
r� d Z Y nX d
Z d Z d Z G d
d� de�Z!dZ"dZ#dZ$G dd� de!�Z%G dd� de%�Z&G dd� de%�Z'G dd� de%�Z(G dd� de'�Z)G d d � d e!�Z*dS ) � N)� RedHatPlugin)
� RHEL_PRESETS�ATOMIC_PRESETS�RHV�RHEL�CB�RHOSP�RHOCP�RH_CFME� RH_SATELLITE�ATOMIC)� LinuxPolicy�ENV_HOST_SYSROOT)�RpmPackageManager)�bold)�_sosTFz/etc/os-releasezRed Hat Enterprise LinuxZAtomicc s� e Zd ZdZdZddgZdZdZdZdZ dZ
dZ d Z d
Z
d Zd� fd
d� Zeddd��Ze� fdd��Zdd� Zdd� Zdd� Z� ZS ) � RedHatPolicy�Red Hat)zDistribution Websitezhttps://www.redhat.com/)zCommercial Supportzhttps://access.redhat.com/z/var/tmpFz/opt/rhZfriendlyN�podman�sosz /usr/sbinTc s� t t| �j||||d� d| _t| j|d�| _| jtg7 _| jj | _
| j
sdt j �
d� t �d� | �| j
�| _| jr�d| _nd| _| jtjd 7 _| jtjd 7 _| js�| �� | �� d S )
N��sysroot�init�
probe_runtime� remote_execF)�chrootr z'Could not obtain installed package list� z /usr/sbin:/usr/bin:/root/binz'/sbin:/bin:/usr/sbin:/usr/bin:/root/binz/usr/local/binz/usr/local/sbin)�superr �__init__�usrmover r �package_managerZvalid_subclassesr Zpackages�pkgs�sys�stderr�write�exit�
check_usrmove�PATH�os�pathsepr Z
set_exec_pathZ load_presets��selfr r r r �� __class__� �=/usr/lib/python3/dist-packages/sos/policies/distros/redhat.pyr 5 s, ��
zRedHatPolicy.__init__� c C s dS )a� This method checks to see if we are running on Red Hat. It must be
overriden by concrete subclasses to return True when running on a
Fedora, RHEL or other Red Hat distribution or False otherwise.
If `remote` is provided, it should be the contents of a remote host's
os-release, or comparable, file to be used in place of the locally
available one.
Fr. ��cls�remoter. r. r/ �checkT s
zRedHatPolicy.checkc sl | t k r tt | ��|� d S |�d� ttttd�}|D ].}td| �}|jd� d||| j
�dd� q8d S )Nz�This policy is a building block for all other Red Hat family distributions. You are likely looking for one of the distributions listed below.
)ZcentosZrhelZ redhatcoreosZfedoraz policies.%sz{:>8}{:<35}{:<30}� F)�newline) r r �display_distro_helpZadd_text� CentOsPolicy�
RHELPolicy�RedHatCoreOSPolicy� FedoraPolicyr �format�distro)r2 ZsectionZsubsZsubcZsublnr, r. r/ r7 ` s" �� �z RedHatPolicy.display_distro_helpc C sD d|kr t j�d�o t j�d�S |d d }|d dkr<dS dS d S )
aq Test whether the running system implements UsrMove.
If the 'filesystem' package is present, it will check that the
version is greater than 3. If the package is not present the
'/bin' and '/sbin' paths are checked and UsrMove is assumed
if both are symbolic links.
:param pkgs: a packages dictionary
Z
filesystemz/binz/sbin�versionr �3TFN)r( �path�islink)r+ r! Zfilesys_versionr. r. r/ r& y s
zRedHatPolicy.check_usrmovec C s6 g }dd� }| j r.|D ]}|�||�� q|S |S dS )a2 Mangle paths for post-UsrMove systems.
If the system implements UsrMove, all files will be in
'/usr/[s]bin'. This method substitutes all the /[s]bin
references in the 'files' list with '/usr/[s]bin'.
:param files: the list of package managed files
c S s: ddg}| |kr*| t j�d| dd � �fS t�dd| �fS )Nz/bin/rpmz
/bin/mailxz/usrr z (^)(/s?bin)z\1/usr\2)r( r@ �join�re�sub)r@ Z
skip_pathsr. r. r/ �transform_path� s z8RedHatPolicy.mangle_package_path.<locals>.transform_pathN)r �extend)r+ �files�pathsrE �fr. r. r/ �mangle_package_path� s z RedHatPolicy.mangle_package_pathc C s |s
| j S |S �N)�_tmp_dir)r+ Z opt_tmp_dirr. r. r/ � get_tmp_dir� s zRedHatPolicy.get_tmp_dir)NNTN)r0 )�__name__�
__module__� __qualname__r= �vendor� vendor_urlsrL Z
_in_containerZdefault_scl_prefixZ name_pattern�
upload_url� upload_userZdefault_container_runtimeZ sos_pkg_nameZ sos_bin_pathr � classmethodr4 r7 r& rJ rM �
__classcell__r. r. r, r/ r $ s0 � � r a[
Any information provided to %(vendor)s will be treated in accordance with the published support policies at:
%(vendor_urls)s
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 changes will be made to system configuration.
z https://api.access.redhat.comz sftp://sftp.access.redhat.comc s� e Zd ZdZeZdZede d �Z e
Z dZ d � fdd � Z
ed d d ��Z� fd
d�Zdd� Zdd� Zdd� Zdd� Z� fdd�Z� fdd�Zdd � Zd d � Z� ZS )!r9 at
The RHEL policy is used specifically for Red Hat Enterprise Linux, of
any release, and not forks or derivative distributions. For example, this
policy will be loaded for any RHEL 8 installation, but will not be loaded
for CentOS Stream 8 or Red Hat CoreOS, for which there are separate
policies.
Plugins activated by installed packages will only be activated if those
packages are installed via RPM (dnf/yum inclusive). Packages installed by
other means are not considered by this policy.
By default, --upload will be directed to using the SFTP location provided
by Red Hat for technical support cases. Users who provide login credentials
for their Red Hat Customer Portal account will have their archives uploaded
to a user-specific directory.
If users provide those credentials as well as a case number, --upload will
instead attempt to directly upload archives to the referenced case, thus
streamlining the process of providing data to technical support engineers.
If either or both of the credentials or case number are omitted or are
incorrect, then a temporary anonymous user will be used for upload to the
SFTP server, and users will need to provide that information to their
technical support engineer. This information will be printed at the end of
the upload process for any sos report execution.
r a This command will collect diagnostic and configuration information from this %(distro)s system and installed applications.
An archive containing the collected information will be generated in %(tmpdir)s and may be provided to a %(vendor)s support representative.
�%(vendor_text)s
�postNTc s& t t| �j||||d� | �t� d S �Nr )r r9 r �register_presetsr r* r, r. r/ r � s
�zRHELPolicy.__init__r0 c C s� |r| j |kS tj�t�s dS ttd��N}|D ]B}|�d�r.|�d�\}}|�d�}|�| j �r. W 5 Q R � dS q.W 5 Q R X dS )a� Test to see if the running host is a RHEL installation.
Checks for the presence of the "Red Hat Enterprise Linux"
release string at the beginning of the NAME field in the
`/etc/os-release` file and returns ``True`` if it is
found, and ``False`` otherwise.
:returns: ``True`` if the host is running RHEL or ``False``
otherwise.
F�r�NAME�=z"'T) r= r( r@ �exists�
OS_RELEASE�open�
startswith�split�strip)r2 r3 rI �line�name�valuer. r. r/ r4 � s
zRHELPolicy.checkc sp | j d jrd S | j d jr.tt| ��� d S | �� sl| jrLtt d��| _n t
| _| j � d� tt d��| _d S )N� cmdlineoptszVEnter your Red Hat Customer Portal username for uploading [empty for anonymous SFTP]: z&No case id provided, uploading to SFTPzYEnter your Red Hat Customer Portal username for uploading to SFTP [empty for anonymous]: )
�commonsrT rS r r9 �prompt_for_upload_user�get_upload_user�case_id�input�_� RH_SFTP_HOST�ui_log�info�r+ r, r. r/ ri s �
�z!RHELPolicy.prompt_for_upload_userc C sN | j r | j S | jd j r$| jd j S | jd jdkr8tS d}t|| j S d S )Nrg Zsftpz /support/v1/cases/%s/attachments)rS rh Zupload_protocolrn � RH_API_HOSTrk )r+ Z rh_case_apir. r. r/ �get_upload_url s zRHELPolicy.get_upload_urlc C s | � � �t�rddd�S i S )NZfalsezno-cache)Z isPrivatez
cache-control)rs ra rr rq r. r. r/ �_get_upload_headers& s
z RHELPolicy._get_upload_headersc C s* | � � �t�rdS | � � �t�r$dS | jS )NzRed Hat Customer PortalzRed Hat Secure FTP)rs ra rr rn rS rq r. r. r/ �get_upload_url_string+ s
z RHELPolicy.get_upload_url_stringc C s> | j �d�d }| jr$d| j|f }| jr:tj�| j|�}|S )z�The RH SFTP server will only automatically connect file uploads to
cases if the filename _starts_ with the case number
�/���z%s_%s)Zupload_archive_namerb rk Zupload_directoryr( r@ rB )r+ �fnamer. r. r/ �_get_sftp_upload_name2 s z RHELPolicy._get_sftp_upload_namec sf t �d�d | �� kr$tt| ��� S ts0td��d}d}td }| � � r�| �
� r�| � � }t j
||dd�}|jdkr�| � � }t�|j�d }n*| j�d
|j� d |�� � �� | j�d � |�s:d
di}t j
|t�|�dd�}|jdk�r t�|j�}|d }|d }| j�td|� d��� n | j�d|j� d |�� � �� |�rZ|�rZtt| �j||d�S td��dS )z�Override the base upload_sftp to allow for setting an on-demand
generated anonymous login for the RH SFTP server if a username and
password are not given
z//r zPpython3-requests is not installed and is required for obtaining SFTP auth token.Nz/support/v2/sftp/token�
)�auth�timeout�� �tokenz$DEBUG: auth attempt failed (status: z): zUUnable to retrieve Red Hat auth token using provided credentials. Will try anonymous.Z isAnonymousT)�datar| ZusernamezUser z^ used for anonymous upload. Please inform your support engineer so they may retrieve the data.z)DEBUG: anonymous request failed (status: )�userZpasswordz1Could not retrieve valid or anonymous credentials)rn rb rs r r9 � upload_sftp�REQUESTS_LOADED� Exceptionrr rj �get_upload_passwordZget_upload_https_auth�requestsrX Z status_code�json�loads�textro �debug�error�dumpsrp rm ) r+ Z_tokenZ_userZurlr{ ZretZadataZanonZrespr, r. r/ r� = sJ
�� �� �zRHELPolicy.upload_sftpc s� z<| j r*| j �t�r*| �� r$| �� s*t| _ tt| ��|�}W nT t k
r� d}| j �t�s`� n,| j
� t dt� ��� t| _ tt| ��|�}Y nX |S )zOverride the base upload_archive to provide for automatic failover
from RHCP failures to the public RH dropbox
Fz1Upload to Red Hat Customer Portal failed. Trying )
rS ra rr rj r� rn r r9 �upload_archiver� ro r� rm )r+ �archiveZuploadedr, r. r/ r� t s$ �� �zRHELPolicy.upload_archivec C sF z,| j �d�}| j|d d }t|d �W S tk
r@ Y nX dS )Nzredhat-release*r r> F)r �all_pkgs_by_name_regexr! �intr� )r+ ZrrZpkgnamer. r. r/ � dist_version� s zRHELPolicy.dist_versionc C s� dD ]$}| j �d| d�r| �t� S q| �d�d k rB| �t�S | �d�d k rZ| �t�S | �d�d k rr| �t�S | �d�d k s�| �d�d k r�| �t�S | �t �S ) N)ZrescueZ emergencyz %s.targetFzsatellite-commonz
rhosp-releaseZcfmez ovirt-engineZvdsm)
Z init_systemZ
is_running� find_presetr � pkg_by_namer r r
r r )r+ �targetr. r. r/ � probe_preset� s
�
zRHELPolicy.probe_preset)NNTN)r0 )rN rO rP �__doc__�RHEL_RELEASE_STRr= rQ rm �disclaimer_text�msgrn Z _upload_urlZ_upload_methodr rU r4 ri rs rt ru ry r� r� r� r� rV r. r. r, r/ r9 � s0 �� � 7 r9 c @ s e Zd ZdZdZdgZdS )r8 �CentOS��Community Websitezhttps://www.centos.org/N�rN rO rP r= rQ rR r. r. r. r/ r8 � s r8 c sn e Zd ZdZede d �ZdZdZdZ dZ
dZ d� fd
d � Z e
dd
d��Zdd� Zddd�Zdd� Z� ZS )�RedHatAtomicPolicyzRed Hat Atomic Host��This command will collect diagnostic and configuration information from this %(distro)s system.
An archive containing the collected information will be generated in %(tmpdir)s and may be provided to a %(vendor)s support representative.
rW TZdockerz.registry.access.redhat.com/rhel7/support-tools�/host�
rpm -q sosNc s& t t| �j||||d� | �t� d S rY )r r� r rZ r r* r, r. r/ r � s
�zRedHatAtomicPolicy.__init__r0 c C s� |r| j |kS d}ttjkr |S tjt t }tj�|�s>dS z(t|d��� � � D ]}|t
|kO }qRW n t k
rz Y nX |S )NFr[ ) r= r r( �environr_ r@ r^ r` �read�
splitlines�ATOMIC_RELEASE_STR�IOError)r2 r3 Zatomic� host_releaserd r. r. r/ r4 � s
zRedHatAtomicPolicy.checkc C s | � d�r| �t�S | �t�S )Nzatomic-openshift)r� r� r r rq r. r. r/ r� � s
z RedHatAtomicPolicy.probe_presetFc C s6 d}|p | j }|rdnd}|j| j| j|||p0dd�S �Na {runtime} run -di --name {name} --privileged --ipc=host --net=host --pid=host -e HOST=/host -e NAME={name} -e IMAGE={image} {pull} -v /run:/run -v /var/log:/var/log -v /etc/machine-id:/etc/machine-id -v /etc/localtime:/etc/localtime -v /:/host {auth} {image}z
--pull=alwaysr0 )Zruntimere �imageZpullr{ ��container_imager< �container_runtime�sos_container_name�r+ r� r{ Z
force_pullZ_cmdZ_imageZ_pullr. r. r/ �create_sos_container� s
�z'RedHatAtomicPolicy.create_sos_containerc C s dS )Nz#docker rm --force sos-collector-tmpr. rq r. r. r/ �set_cleanup_cmd� s z"RedHatAtomicPolicy.set_cleanup_cmd)NNTN)r0 )NNF)rN rO rP r= rm r� r� Z containerzedr� r� �sos_path_strip�container_version_commandr rU r4 r� r� r� rV r. r. r, r/ r� � s& �� �
r� c sv e Zd ZdZdZede d �ZdZdZ dZ
dZ d Z d
Z
d� fd d
� Zeddd��Zdd� Zddd�Zdd� Z� ZS )r: aB
Red Hat CoreOS is a containerized host built upon Red Hat Enterprise Linux
and as such this policy is built on top of the RHEL policy. For users, this
should be entirely transparent as any behavior exhibited or influenced on
RHEL systems by that policy will be seen on RHCOS systems as well.
The one change is that this policy ensures that sos collect will deploy a
container on RHCOS systems in order to facilitate sos report collection,
as RHCOS discourages non-default package installation via rpm-ostree which
is used to maintain atomicity for RHCOS nodes. The default container image
used by this policy is the support-tools image maintained by Red Hat on
registry.redhat.io.
Note that this policy is only loaded when sos is directly run on an RHCOS
node - if sos collect uses the `oc` transport (the default transport that
will be attempted by the ocp cluster profile), then the policy loaded
inside the launched pod will be RHEL. Again, this is expected and will not
impact how sos report collections are performed.
zRed Hat CoreOSr� rW Tr z®istry.redhat.io/rhel8/support-toolsr� r� z /var/lib/kubelet/config.jsonNc s t t| �j||||d� d S rY )r r: r r* r, r. r/ r s �zRedHatCoreOSPolicy.__init__r0 c C sn |r d|kS d}t tjkr |S tjt t }z(t|d��� �� D ]}|d|kO }q@W n tk
rh Y nX |S )NZCoreOSFr[ z Red Hat Enterprise Linux CoreOS)r r( r� r_ r` r� r� r� )r2 r3 Zcoreosr� rd r. r. r/ r4 s
zRedHatCoreOSPolicy.checkc C s
| � t�S rK )r� r rq r. r. r/ r� 0 s z RedHatCoreOSPolicy.probe_presetFc C s6 d}|p | j }|rdnd}|j| j| j|||p0dd�S r� r� r� r. r. r/ r� 5 s
�z'RedHatCoreOSPolicy.create_sos_containerc C s
d| j S )Nzpodman rm --force %s)r� rq r. r. r/ r� C s z"RedHatCoreOSPolicy.set_cleanup_cmd)NNTN)r0 )NNF)rN rO rP r� r= rm r� r� Z
containerizedr� r� r� r� Zcontainer_authfiler rU r4 r� r� r� rV r. r. r, r/ r: � s* �� �
r: c @ s e Zd ZdZdZdgZdS )�CentOsAtomicPolicyzCentOS Atomic Hostr� r� Nr� r. r. r. r/ r� G s r� c sH e Zd ZdZdZdZddgZd� fdd � Zedd d ��Z d
d� Z
� Z S )r; aj
The policy for Fedora based systems, regardless of spin/edition. This
policy is based on the parent Red Hat policy, and thus will only check for
RPM packages when considering packaged-based plugin enablement. Packages
installed by other sources are not considered.
There is no default --upload location for this policy. If users need to
upload an sos report archive from a Fedora system, they will need to
provide the location via --upload-url, and optionally login credentials
for that location via --upload-user and --upload-pass (or the appropriate
environment variables).
ZFedorazthe Fedora Project)r� zhttps://fedoraproject.org/)zCommunity Forumsz%https://discussion.fedoraproject.org/NTc s t t| �j||||d� d S rY )r r; r r* r, r. r/ r b s �zFedoraPolicy.__init__r0 c C s |r| j |kS tj�d�S )zXThis method checks to see if we are running on Fedora. It returns
True or False.z/etc/fedora-release)r= r( r@ �isfiler1 r. r. r/ r4 h s
zFedoraPolicy.checkc C s$ | � d�p| �d�d }t|d �S )Nzfedora-releasezfedora-release-.*rw r> )r� r� r� )r+ �pkgr. r. r/ �fedora_versionr s
�zFedoraPolicy.fedora_version)NNTN)r0 ) rN rO rP r� r= rQ rR r rU r4 r� rV r. r. r, r/ r; M s
� � r; )+r� r( r" rC Zsos.report.pluginsr Zsos.presets.redhatr r r r r r r r
r r Zsos.policies.distrosr
r Z!sos.policies.package_managers.rpmr Z
sos.utilitiesr r r rm r� r� � ImportErrorr_ r� r� r r� rr rn r9 r8 r� r: r� r; r. r. r. r/ �<module> s: 0
qCT