File manager

File manager - Edit - /home/newsbmcs.com/public_html/static/img/logo/clusters.tar

Back
ceph.py��0000644��00000004542�15027746175�0006060 0��ustar�00��# Copyright (C) 2022 Red Hat Inc., Jake Hunsaker <jhunsake@redhat.com> # This file is part of the sos project: https://github.com/sosreport/sos # # This copyrighted material is made available to anyone wishing to use, # modify, copy, or redistribute it subject to the terms and conditions of # version 2 of the GNU General Public License. # # See the LICENSE file in the source distribution for further information. import json from sos.collector.clusters import Cluster class ceph(Cluster): """ This cluster profile is for Ceph Storage clusters, and is primarily built around Red Hat Ceph Storage 5. Nodes are enumerated via `cephadm`; if your Ceph deployment uses cephadm but is not RHCS 5, this profile may work as intended, but it is not currently guaranteed to do so. If you are using such an environment and this profile does not work for you, please file a bug report detailing what is failing. By default, all nodes in the cluster will be returned for collection. This may not be desirable, so users are encouraged to use the `labels` option to specify a colon-delimited set of ceph node labels to restrict the list of nodes to. For example, using `-c ceph.labels=osd:mgr` will return only nodes labeled with either `osd` or `mgr`. """ cluster_name = 'Ceph Storage Cluster' sos_plugins = [ 'ceph_common', ] sos_options = {'log-size': 50} packages = ('cephadm',) option_list = [ ('labels', '', 'Colon delimited list of labels to select nodes with') ] def get_nodes(self): self.nodes = [] ceph_out = self.exec_primary_cmd( 'cephadm shell -- ceph orch host ls --format json', need_root=True ) if not ceph_out['status'] == 0: self.log_error( f"Could not enumerate nodes via cephadm: {ceph_out['output']}" ) return self.nodes nodes = json.loads(ceph_out['output'].splitlines()[-1]) _labels = [lab for lab in self.get_option('labels').split(':') if lab] for node in nodes: if _labels and not any(_l in node['labels'] for _l in _labels): self.log_debug(f"{node} filtered from list due to labels") continue self.nodes.append(node['hostname']) return self.nodes # vim: set et ts=4 sw=4 : ��pacemaker.py��0000644��00000007476�15027746175�0007102 0��ustar�00��# Copyright Red Hat 2020, Jake Hunsaker <jhunsake@redhat.com> # This file is part of the sos project: https://github.com/sosreport/sos # # This copyrighted material is made available to anyone wishing to use, # modify, copy, or redistribute it subject to the terms and conditions of # version 2 of the GNU General Public License. # # See the LICENSE file in the source distribution for further information. import re from xml.etree import ElementTree from sos.collector.clusters import Cluster from sos.utilities import sos_parse_version class pacemaker(Cluster): cluster_name = 'Pacemaker High Availability Cluster Manager' sos_plugins = ['pacemaker'] packages = ('pacemaker',) strict_node_list = True option_list = [ ('online', True, 'Collect nodes listed as online'), ('offline', True, 'Collect nodes listed as offline'), ('only-corosync', False, 'Only use corosync.conf to enumerate nodes') ] def get_nodes(self): self.nodes = [] # try crm_mon first try: if not self.get_option('only-corosync'): try: self.get_nodes_from_crm() except Exception as err: self.log_warn("Falling back to sourcing corosync.conf. " f"Could not parse crm_mon output: {err}") if not self.nodes: # fallback to corosync.conf, in case the node we're inspecting # is offline from the cluster self.get_nodes_from_corosync() except Exception as err: self.log_error(f"Could not determine nodes from cluster: {err}") _shorts = [n for n in self.nodes if '.' not in n] if _shorts: self.log_warn( f"WARNING: Node addresses '{','.join(_shorts)}' may not " "resolve locally if you are not running on a node in the " "cluster. Try using option '-c pacemaker.only-corosync' if " "these connections fail." ) return self.nodes def get_nodes_from_crm(self): """ Try to parse crm_mon output for node list and status. """ xmlopt = '--output-as=xml' # older pacemaker had a different option for xml output _ver = self.exec_primary_cmd('crm_mon --version') if _ver['status'] == 0: cver = _ver['output'].split()[1].split('-')[0] if sos_parse_version(cver) <= sos_parse_version('2.0.3'): xmlopt = '--as-xml' else: return _out = self.exec_primary_cmd( f"crm_mon --one-shot --inactive {xmlopt}", need_root=True ) if _out['status'] == 0: self.parse_crm_xml(_out['output']) def parse_crm_xml(self, xmlstring): """ Parse the xml output string provided by crm_mon """ _xml = ElementTree.fromstring(xmlstring) nodes = _xml.find('nodes') for node in nodes: _node = node.attrib if self.get_option('online') and _node['online'] == 'true': self.nodes.append(_node['name']) elif self.get_option('offline') and _node['online'] == 'false': self.nodes.append(_node['name']) def get_nodes_from_corosync(self): """ As a fallback measure, read corosync.conf to get the node list. Note that this prevents us from separating online nodes from offline nodes. """ self.log_warn("WARNING: unable to distinguish online nodes from " "offline nodes when sourcing from corosync.conf") cc = self.primary.read_file('/etc/corosync/corosync.conf') nodes = re.findall(r'((\sring0_addr:)(.))', cc) for node in nodes: self.nodes.append(node[-1].strip()) # vim: set et ts=4 sw=4 : ��juju.py��0000644��00000020635�15027746175�0006117 0��ustar�00��# Copyright (c) 2023 Canonical Ltd., Chi Wai Chan <chiwai.chan@canonical.com> # This file is part of the sos project: https://github.com/sosreport/sos # # This copyrighted material is made available to anyone wishing to use, # modify, copy, or redistribute it subject to the terms and conditions of # version 2 of the GNU General Public License. # # See the LICENSE file in the source distribution for further information. import logging import json import re from sos.collector.clusters import Cluster from sos.utilities import sos_parse_version from sos.utilities import sos_get_command_output def _parse_option_string(strings=None): """Parse comma separated string.""" if not strings: return [] return [string.strip() for string in strings.split(",")] def _get_index(model_name): """Helper function to get Index. The reason why we need Index defined in function is because currently the collector.__init__ will load all the classes in this module and also Index. This will cause bug because it think Index is Cluster type. Also We don't want to provide a customized filter to remove Index class. """ class Index: """Index structure to help parse juju status output. Attributes apps, units and machines are dict which key is the app/unit/machine name and the value is list of targets which format are {model_name}:{machine_id}. """ def __init__(self, model_name): self.model_name: str = model_name self.apps = {} self.units = {} self.machines = {} self.ui_log = logging.getLogger("sos") def add_principals(self, juju_status): """Adds principal units to index.""" for app, app_info in juju_status["applications"].items(): nodes = [] units = app_info.get("units", {}) for unit, unit_info in units.items(): machine = unit_info["machine"] node = f"{self.model_name}:{machine}" self.units[unit] = [node] self.machines[machine] = [node] nodes.append(node) self.apps[app] = nodes def add_subordinates(self, juju_status): """Add subordinates to index. Since subordinates does not have units they need to be manually added. """ for app, app_info in juju_status["applications"].items(): subordinate_to = app_info.get("subordinate-to", []) for parent in subordinate_to: # If parent is missing if not self.apps.get(parent): self.ui_log.warning( f"Principal charm {parent} is missing" ) continue self.apps[app].extend(self.apps[parent]) # If parent's units is missing if "units" not in juju_status["applications"][parent]: self.ui_log.warning( f"Principal charm {parent} is missing units" ) continue units = juju_status["applications"][parent]["units"] for _, unit_info in units.items(): node = f"{self.model_name}:{unit_info['machine']}" for sub_key, _ in unit_info.get( "subordinates", {} ).items(): if sub_key.startswith(app + "/"): self.units[sub_key] = [node] def add_machines(self, juju_status): """Add machines to index. If model does not have any applications it needs to be manually added. """ for machine in juju_status["machines"].keys(): node = f"{self.model_name}:{machine}" self.machines[machine] = [node] return Index(model_name) class juju(Cluster): """ The juju cluster profile is intended to be used on juju managed clouds. It"s assumed that `juju` is installed on the machine where `sos` is called, and that the juju user has superuser privilege to the current controller. By default, the sos reports will be collected from all the applications in the current model. If necessary, you can filter the nodes by models / applications / units / machines with cluster options. Example: sos collect --cluster-type juju -c "juju.models=sos" -c "juju.apps=a,b,c" """ cmd = "juju" cluster_name = "Juju Managed Clouds" option_list = [ ("apps", "", "Filter node list by apps (comma separated regex)."), ("units", "", "Filter node list by units (comma separated string)."), ("models", "", "Filter node list by models (comma separated string)."), ( "machines", "", "Filter node list by machines (comma separated string).", ), ] def _cleanup_juju_output(self, output): """Remove leading characters before {.""" return re.sub(r"(^[^{])(.)", "\\2", output, 0, re.MULTILINE) def _get_model_info(self, model_name): """Parse juju status output and return target dict. Here are couple helper functions to parse the juju principals units, subordinate units and machines. """ juju_status = self._execute_juju_status(model_name) index = _get_index(model_name=model_name) index.add_principals(juju_status) index.add_subordinates(juju_status) index.add_machines(juju_status) return index def _get_juju_version(self): """Grab the version of juju""" res = sos_get_command_output("juju version") return res['output'] def _execute_juju_status(self, model_name): model_option = f"-m {model_name}" if model_name else "" format_option = "--format json" juju_version = self._get_juju_version() if sos_parse_version(juju_version) > sos_parse_version("3"): format_option += " --no-color" status_cmd = f"{self.cmd} status {model_option} {format_option}" res = self.exec_primary_cmd(status_cmd) if not res["status"] == 0: raise Exception(f"'{status_cmd}' returned error: {res['status']}") juju_json_output = self._cleanup_juju_output((res["output"])) juju_status = None juju_status = json.loads(juju_json_output) return juju_status def _filter_by_pattern(self, key, patterns, model_info): """Filter with regex match.""" nodes = set() for pattern in patterns: for param, value in getattr(model_info, key).items(): if re.match(pattern, param): nodes.update(value or []) return nodes def _filter_by_fixed(self, key, patterns, model_info): """Filter with fixed match.""" nodes = set() for pattern in patterns: for param, value in getattr(model_info, key).items(): if pattern == param: nodes.update(value or []) return nodes def set_transport_type(self): """Dynamically change transport to 'juju'.""" return "juju" def get_nodes(self): """Get the machine numbers from `juju status`.""" models = _parse_option_string(self.get_option("models")) apps = _parse_option_string(self.get_option("apps")) units = _parse_option_string(self.get_option("units")) machines = _parse_option_string(self.get_option("machines")) filters = {"apps": apps, "units": units, "machines": machines} # Return empty nodes if no model and filter provided. if not any(filters.values()) and not models: return [] if not models: models = [""] # use current model by default nodes = set() for model in models: model_info = self._get_model_info(model) for key, resource in filters.items(): # Filter node by different policies if key == "apps": _nodes = self._filter_by_pattern(key, resource, model_info) else: _nodes = self._filter_by_fixed(key, resource, model_info) nodes.update(_nodes) return list(nodes) # vim: set et ts=4 sw=4 : ��ovirt.py��0000644��00000017764�15027746175�0006316 0��ustar�00��# Copyright Red Hat 2020, Jake Hunsaker <jhunsake@redhat.com> # This file is part of the sos project: https://github.com/sosreport/sos # # This copyrighted material is made available to anyone wishing to use, # modify, copy, or redistribute it subject to the terms and conditions of # version 2 of the GNU General Public License. # # See the LICENSE file in the source distribution for further information. import fnmatch from shlex import quote from sos.collector.clusters import Cluster ENGINE_KEY = '/etc/pki/ovirt-engine/keys/engine_id_rsa' class ovirt(Cluster): """ This cluster profile is for the oVirt/RHV project which provides for a virtualization cluster built ontop of KVM. Nodes enumerated will be hypervisors within the envrionment, not virtual machines running on those hypervisors. By default, ALL hypervisors within the environment are returned. This may be influenced by the 'cluster' and 'datacenter' cluster options, which will limit enumeration to hypervisors within the specific cluster and/or datacenter. The spm-only cluster option may also be used to only collect from hypervisors currently holding the SPM role. Optionally, to only collect an archive from manager and the postgresql database, use the no-hypervisors cluster option. By default, a second archive from the manager will be collected that is just the postgresql plugin configured in such a way that a dump of the manager's database that can be explored and restored to other systems will be collected. The ovirt profile focuses on the upstream, community ovirt project. The rhv profile is for Red Hat customers running RHV (formerly RHEV). The rhhi_virt profile is for Red Hat customers running RHV in a hyper-converged setup and enables gluster collections. """ cluster_name = 'Community oVirt' packages = ('ovirt-engine',) db_exec = '/usr/share/ovirt-engine/dbscripts/engine-psql.sh -c' option_list = [ ('no-database', False, 'Do not collect a database dump'), ('cluster', '', 'Only collect from hosts in this cluster'), ('datacenter', '', 'Only collect from hosts in this datacenter'), ('no-hypervisors', False, 'Do not collect from hypervisors'), ('spm-only', False, 'Only collect from SPM host(s)') ] def _run_db_query(self, query): ''' Wrapper for running DB queries on the manager. Any scrubbing of the query should be done _before_ passing the query to this method. ''' cmd = f"{self.db_exec} {quote(query)}" return self.exec_primary_cmd(cmd, need_root=True) def _sql_scrub(self, val): ''' Manually sanitize SQL queries since we can't leave this up to the driver since we do not have an actual DB connection ''' if not val: return '%' invalid_chars = ['\x00', '\\', '\n', '\r', '\032', '"', '\''] if any(x in invalid_chars for x in val): self.log_warn(f"WARNING: Cluster option \'{val}\' contains invalid" " characters. Using '%%' instead.") return '%' return val def _check_for_engine_keys(self): ''' Checks for the presence of the VDSM ssh keys the manager uses for communication with hypervisors. This only runs if we're locally on the RHV-M, and* if no ssh-keys are called out on the command line, and no --password option is given. ''' if self.primary.local: if not any([self.opts.ssh_key, self.opts.password, self.opts.password_per_node]): if self.primary.file_exists(ENGINE_KEY): self.add_default_ssh_key(ENGINE_KEY) self.log_debug("Found engine SSH key. User command line" " does not specify a key or password, using" " engine key.") def setup(self): self.pg_pass = False if not self.get_option('no-database'): self.conf = self.parse_db_conf() self.format_db_cmd() self._check_for_engine_keys() def format_db_cmd(self): cluster = self._sql_scrub(self.get_option('cluster')) datacenter = self._sql_scrub(self.get_option('datacenter')) self.dbquery = ("SELECT host_name from vds where cluster_id in " "(select cluster_id FROM cluster WHERE name like " f"'{cluster}' and storage_pool_id in (SELECT id FROM " f"storage_pool WHERE name like '{datacenter}'))") if self.get_option('spm-only'): # spm_status is an integer with the following meanings # 0 - Normal (not SPM) # 1 - Contending (SPM election in progress, but is not SPM) # 2 - SPM self.dbquery += ' AND spm_status = 2' self.log_debug(f'Query command for ovirt DB set to: {self.dbquery}') def get_nodes(self): if self.get_option('no-hypervisors'): return [] res = self._run_db_query(self.dbquery) if res['status'] == 0: nodes = res['output'].splitlines()[2:-1] return [n.split('(')[0].strip() for n in nodes] raise Exception(f'database query failed, return code: {res["status"]}') def run_extra_cmd(self): if not self.get_option('no-database') and self.conf: return self.collect_database() return False def parse_db_conf(self): conf = {} engconf = '/etc/ovirt-engine/engine.conf.d/10-setup-database.conf' res = self.exec_primary_cmd(f'cat {engconf}', need_root=True) if res['status'] == 0: config = res['output'].splitlines() for line in config: try: k = str(line.split('=')[0]) v = str(line.split('=')[1].replace('"', '')) conf[k] = v except IndexError: # not a valid line to parse config values from, ignore pass return conf return False def collect_database(self): plugin = 'postgresql' sos_opt = ( f"-k {plugin}.dbname={self.conf['ENGINE_DB_DATABASE']} " f"-k {plugin}.dbhost={self.conf['ENGINE_DB_HOST']} " f"-k {plugin}.dbport={self.conf['ENGINE_DB_PORT']} " f"-k {plugin}.dbuser={self.conf['ENGINE_DB_USER']}" ) cmd = ( f"PGPASSWORD={self.conf['ENGINE_DB_PASSWORD']} /usr/sbin/sos " f"report --name=postgresql --batch -o postgresql {sos_opt}" ) db_sos = self.exec_primary_cmd(cmd, need_root=True) for line in db_sos['output'].splitlines(): if fnmatch.fnmatch(line, 'sosreport-tar'): _pg_dump = line.strip() self.primary.manifest.add_field('postgresql_dump', _pg_dump.split('/')[-1]) return _pg_dump self.log_error('Failed to gather database dump') return False class rhv(ovirt): cluster_name = 'Red Hat Virtualization' packages = ('rhevm', 'rhvm') sos_preset = 'rhv' def set_node_label(self, node): if node.address == self.primary.address: return 'manager' if node.is_installed('ovirt-node-ng-nodectl'): return 'rhvh' return 'rhelh' class rhhi_virt(rhv): cluster_name = 'Red Hat Hyperconverged Infrastructure - Virtualization' sos_plugins = ('gluster',) sos_plugin_options = {'gluster.dump': 'on'} sos_preset = 'rhv' def check_enabled(self): return (self.primary.is_installed('rhvm') and self._check_for_rhhiv()) def _check_for_rhhiv(self): ret = self._run_db_query('SELECT count(server_id) FROM gluster_server') if ret['status'] == 0: # if there are any entries in this table, RHHI-V is in use return ret['output'].splitlines()[2].strip() != '0' return False # vim: set et ts=4 sw=4 : ��__pycache__/ocp.cpython-310.pyc��0000644��00000027321�15027746175�0012261 0��ustar�00��o ��-�_g.@��@��s@��d�dl�Z�d�dlmZ�d�dlmZ�d�dlmZ�G�dd��de�ZdS�)��N)�quote)�Cluster)� is_executablec��s��e�Zd�ZdZdZdZdZdZdZdZ dZ g�d�Zed d ��Z dd��Zd d��Z��fdd�Zdd��Zdd��Zdd��Zdd��Zdd��Zdd��Zdd��Zdd ��Zd!d"��Zd#d$��Zd%d&��Z��ZS�)'�ocpa�� This profile is for use with OpenShift Container Platform (v4) clusters instead of the kubernetes profile. This profile will favor using the `oc` transport type, which means it will leverage a locally installed `oc` binary. This is also how node enumeration is done. To instead use SSH to connect to the nodes, use the '--transport=control_persist' option. Thus, a functional `oc` binary for the user executing sos collect is required. Functional meaning that the user can run `oc` commands with clusterAdmin privileges. If this requires the use of a secondary configuration file, specify that path with the 'kubeconfig' cluster option. This config file will also be used on a single master node to perform API collections if the `with-api` option is enabled (default disabled). If no `kubeconfig` option is given, but `with-api` is enabled, the cluster profile will attempt to use a well-known default kubeconfig file if it is available on the host. Alternatively, provide a clusterAdmin access token either via the 'token' cluster option or, preferably, the SOSOCPTOKEN environment variable. By default, this profile will enumerate only master nodes within the cluster, and this may be changed by overriding the 'role' cluster option. To collect from all nodes in the cluster regardless of role, use the form -c ocp.role=''. Filtering nodes by a label applied to that node is also possible via the label cluster option, though be aware that this is _combined_ with the role option mentioned above. To avoid redundant collections of OCP API information (e.g. 'oc get' commands), this profile will attempt to enable the API collections on only a single master node. If the none of the master nodes have a functional 'oc' binary available, and* the --no-local option is used, that means that no API data will be collected. zOpenShift Container Platform v4)zopenshift-hyperkubezopenshift-clientsFNzsos-collect-tmp��))�labelr��z3Colon delimited list of labels to select nodes with)�role�masterzColon delimited list of roles to filter on)� kubeconfigr��zPath to the kubeconfig file)�tokenr��z1Service account token to use for oc authorization)�with-apiFz'Collect OCP API data from a master node)�api-urlr��z.Alternate API URL of an external control-planec��C��s��\|�j�sZd\|�_�\|�jj��r?\|�jjd\|�jjjd�}\|d�dkr0tj�\|�jjj\|d�� d��\|�_�n\|��d��\|��d \|d��\|�� d �rQ\|��j�d\|�� d ��7��_�\|��d\|�j��\|�j�S�) N�oczwhich oc)�chroot�statusr��output�/zHUnable to to determine PATH for 'oc' command, node enumeration may fail.zLocating 'oc' failed: r ��z --kubeconfig zoc base command set to )�_oc_cmd�primary�host�in_container�run_command�sysroot�os�path�join�strip�lstrip�log_warn� log_debug� get_option)�self�_oc_path��r#��</usr/lib/python3/dist-packages/sos/collector/clusters/ocp.py�oc_cmdL��s.�� z ocp.oc_cmdc��C��s��\|�j��d\|��S�)zcFormat the oc command to optionall include the kubeconfig file if one is specified � )r%��)r!��cmdr#��r#��r$�� fmt_oc_cmdf��s��zocp.fmt_oc_cmdc�� C��s0��\|��\|��d\|�j��d\|��d��}\|d�dkS�)zXAttempt to login to the API using the oc command using a provided token z.login --insecure-skip-tls-verify=True --token=r&��r ��r��r��)�exec_primary_cmdr(��r��r ��)r!��_resr#��r#��r$��_attempt_oc_loginl��s��zocp._attempt_oc_loginc��sP��t��rdS�\|��d�pt�dd��\|�_\|�jr\|��\|��d�}\|��\|�d�dkS�)NTr��SOSOCPTOKEN�whoamir��r��) �super� check_enabledr ��r��getenvr��r+��r(��r)��)r!��_who�� __class__r#��r$��r/��w��s�� zocp.check_enabledc��C��s��\|��dksdS�\|��\|��d��}\|d�dk\|�_\|�js#\|��d��td��\|��d\|�j��d ��\|��\|��d \|�j��}\|d�dkrE\|��dS�\|��d\|d ��td��)zpCreate the project that we will be executing in for any nodes' collection via a container image r��Nzauth can-i '' ''r��r��zWCheck for cluster-admin privileges returned false, cannot create project in OCP clusterzLInsufficient permissions to create temporary collection project. Aborting...z Creating new temporary project '�'znew-project TzFailed to create project: r��z?Failed to create temporary project for collection. Aborting...) �set_transport_typer)��r(��oc_cluster_adminr�� Exception�log_info�project�_label_sos_project)r!��out�retr#��r#��r$��setup��s �� z ocp.setupc�� C��sT��ddg}\|D�]!}\|��\|��d\|�j��d\|��d��}\|d�dks'td\|d ��qd S�)z�Add pertinent labels to the temporary project we've created so that our privileged containers can properly run. z4security.openshift.io/scc.podSecurityLabelSync=falsez-pod-security.kubernetes.io/enforce=privilegedzlabel namespace r&��z --overwriter��r��z!Error applying namespace labels: r��N)r)��r(��r9��r7��)r!��labelsr��r<��r#��r#��r$��r:��s��zocp._label_sos_projectc�� C��s��\|�j�rgz=\|�j\|��d\|�j��dd�}\|d�dks"\|��d\|d��\|��\|��d\|�j��d ��}\|d�dks?\|��d \|d��W�n�ty[�}�z\|��d\|��d��W�Y�d }~nd }~ww�\|��\|��d��d \|�_�dS�)z8Remove the project we created to execute within zdelete project ��)�timeoutr��r��z"Error deleting temporary project: r��zwait namespace/z --for=delete --timeout=30sz3Error waiting for temporary project to be deleted: zAFailed attempting to remove temporary project 'sos-collect-tmp': z. Please manually remove the temporary project.Nzproject defaultT)r9��r)��r(�� log_errorr7��)r!��r<��errr#��r#��r$��cleanup��sB��zocp.cleanupc�� C��s��i�}d\|d�v�rL\|��d��}i�}dD�]}z\|�\|��\|\|<�W�q�ty)��Y�qw�\|D�]}\|��}i�\|\|d�<�\|��D�]\}} \|\| �\|\|d��\|<�q<q,\|S�)a��From the output of get_nodes(), construct an easier-to-reference dict of nodes that will be used in determining labels, primary status, etc... :param nodelist: The split output of `oc get nodes` :type nodelist: ``list`` :returns: A dict of nodes with `get nodes` columns as keys :rtype: ``dict`` �NAMEr��)r��roles�versionzos-image)�pop�split�index�upperr7��items) r!��nodelist�nodes�statline�idx�state�node�_node�column�valuer#��r#��r$��_build_dict��s"��zocp._build_dictc��C��sT��\|�j�jdkr \|�j�jS�td\|�jjjd�rdS�\|��d��\|�j�d��\|�j�j s(t d��dS�)N�autor��)r��z]Local installation of 'oc' not found or is not correctly configured. Will use ControlPersist.z=Preferred transport 'oc' not available, will fallback to SSH.z?Press ENTER to continue connecting with SSH, or Ctrl+C toabort.�control_persist)�opts� transportr��r��r��r��r8��ui_log�warning�batch�input)r!��r#��r#��r$��r5��s�� zocp.set_transport_typec�� C��s��g�}i�\|�_�d}\|��d�r d�\|��d��d��}\|dt\|��7�}\|��\|��\|��}\|d�dkrt\|��d�d kr:\|��d ��t\|��d��d��}\|�� \|d�� \|�_�\|�j��D�]\}}\|rl\|D�]}\|\|d�v�rj\|�\|��nq[qS\|�\|��qS\|S�d } d\|d�v�r~d} t \| ��)Nzget nodes -o wider��,�:z -l r��r��r��r ��z�NOTE: By default, only master nodes are listed. To collect from all/more nodes, override the role option with '-c ocp.role=role1:role2'r��rE��z'oc' command failedzMissing or incompleteza'oc' failed due to missing kubeconfig on primary node. Specify one via '-c ocp.kubeconfig=<path>')� node_dictr ��r��rH��r��r)��r(��r��listrU�� splitlinesrK��appendr7��) r!��rM��r'��r>��resrE�� node_namerQ��r��msgr#��r#��r$�� get_nodes��s4�� z ocp.get_nodesc��C��s:��\|j�\|�jvrdS�dD�]}\|\|�j\|j��d�v�r\|��S�q dS�)Nr��)r ��workerrE��addressr`��)r!��rQ��r��r#��r#��r$��set_node_label��s��zocp.set_node_labelc��C��s$��\|j�\|�jvrdS�d\|�j\|j��d�v�S�)NFr ��rE��ri��r!��rQ��r#��r#��r$��check_node_is_primary%��s��zocp.check_node_is_primaryc��C��sH��\|��d�rd}\|rdnd}nd}\|rdnd}\|j�d\|��d\|��dS�) a��In earlier versions of sos, the openshift plugin option that is used to toggle the API collections was called `no-oc` rather than `with-api`. This older plugin option had the inverse logic of the current `with-api` option. Use this to toggle the correct plugin option given the node's sos version. Note that the use of version 4.2 here is tied to the RHEL release (the only usecase for this cluster profile) rather than the upstream version given the backports for that downstream. :param node: The node being inspected for API collections :type node: ``SoSNode`` :param use_api: Should this node enable API collections? :type use_api: ``bool`` z4.2-16r��on�offzno-ocz openshift.�=N)�check_sos_version�plugoptsrc��)r!��rQ��use_api�_opt�_valr#��r#��r$��_toggle_api_opt��s�� zocp._toggle_api_optc��C��sX��\|j��d��\|��d�s\|��\|d��d�S�\|�jr\|��\|d��d�S�d}\|��d�}\|r0\|�d�s0d\|�}\|p3\|}d}\|jjrGd }\|jd dd�rG\|d 7�}\|j \|��d�\|jjdd�}\|d�dkrd\|��\|d��d\|�_n.\|�j rw\|�j \|jd<�\|��\|d��d\|�_n\|�\|�r�\|\|kr�\|j�d\|��\|��\|d��d\|�_\|�jr�d\|j ��d�}\|�j�\|��\|�j�\|��d�S�d�S�)N� openshiftr��Fzl/host/etc/kubernetes/static-pod-resources/kube-apiserver-certs/secrets/node-kubeconfigs/localhost.kubeconfigr ��z/hostz/host/r��z/host/bin/ocz/root/.kube/configT)� need_rootz% --kubeconfig /host/root/.kube/configz whoami)� use_containerrx��r��r��r,��zopenshift.kubeconfig=z%API collections will be performed on z< Note: API collections may extend runtime by 10s of minutes )�enable_pluginsrc��r ��rv��api_collect_enabled� startswithr�� containerized�file_existsr��r��sos_env_varsrr��rj��soslog�inforZ��)r!��rQ��master_kube� _optconfig�_kubeconfigr��can_ocrf��r#��r#��r$��set_primary_optionsC��sP�� zocp.set_primary_optionsc��C��s��\|��\|d��d�S�)NF)rv��rl��r#��r#��r$��set_node_options��s��zocp.set_node_options)�__name__� __module__�__qualname__�__doc__�cluster_name�packagesr{��r��r9��r6��r��option_list�propertyr%��r(��r+��r/��r=��r:��rC��rU��r5��rg��rk��rm��rv��r��r�� __classcell__r#��r#��r2��r$��r��s4��' #=r��)r��shlexr��sos.collector.clustersr�� sos.utilitiesr��r��r#��r#��r#��r$��<module>��s �� __pycache__/satellite.cpython-310.pyc��0000644��00000003316�15027746175�0013464 0��ustar�00��o ��-�_gb��@��s,��d�dl�mZ�d�dlmZ�G�dd��de�ZdS�)��quote)�Clusterc��@��s0��e�Zd�ZdZdZdZdd��Zdd��Zdd ��Zd S�)� satellitea3�� This profile is specifically for Red Hat Satellite 6, and not earlier releases of Satellite. While note technically a 'cluster' in the traditional sense, Satellite does provide for 'capsule' nodes which is what this profile aims to enumerate beyond the 'primary' Satellite system. zRed Hat Satellite 6)r��zsatellite-installerc��C��s��d}d}\|t�\|t�\|��S�)Nzsu postgres -c %szpsql foreman -c %sr��)�self�query�_cmd�_dbcmd��r ��B/usr/lib/python3/dist-packages/sos/collector/clusters/satellite.py� _psql_cmd��s��zsatellite._psql_cmdc��C��sB��\|��d�}\|�j\|dd�}\|d�dkrdd��\|d��D��}\|S�g�S�) Nz/copy (select name from smart_proxies) to stdoutT)� need_root�statusr��c��S��s��g�\|�] }d�\|vr\|��qS�)zcould not change directory)�strip)�.0�nr ��r ��r�� <listcomp>%��s ��z'satellite.get_nodes.<locals>.<listcomp>�output)r��exec_primary_cmd� splitlines)r��cmd�res�nodesr ��r ��r�� get_nodes!��s�� zsatellite.get_nodesc��C��s��\|j�\|�jj�kr dS�dS�)Nr��capsule)�address�primary)r��noder ��r ��r��set_node_label,��s��zsatellite.set_node_labelN) �__name__� __module__�__qualname__�__doc__�cluster_name�packagesr��r��r��r ��r ��r ��r��r��s�� r��N)�shlexr��sos.collector.clustersr��r��r ��r ��r ��r��<module>��s�� __pycache__/__init__.cpython-310.pyc��0000644��00000035760�15027746175�0013245 0��ustar�00��o ��-�_g�>��@��s>��d�dl�Z�d�dlmZ�d�dlmZ�d�dlmZ�G�dd��d�ZdS�)��N)�Lock)� ClusterOption)�boldc��@��s��e�Zd�ZdZg�ZdZg�Zi�Zi�ZdZ dZ dZdd��Ze dd ��Ze d d��Ze dd ��Zdd��Zdd��Zdd��Zdd��Zdd��Zdd��Zdd��Zdd��Zdd��Zd d!��Zd"d#��Zd$d%��Z & 'd<d(d)�Zdd+��Zd,d-��Zd.d/��Z d0d1��Z!d2d3��Z"d4d5��Z#d6d7��Z$d8d9��Z%d:d;��Z&dS�)=�ClusteraZ��This is the class that cluster profiles should subclass in order to add support for different clustering technologies and environments to sos collect. A profile should at minimum define a package that indicates the node is configured for the type of cluster the profile is intended to serve and then additionally be able to return a list of enumerated nodes via the ``get_nodes()`` method :param commons: The commons dict containing system information. The same as what is handed to ``Plugin()`` :type commons: ``dict`` :cvar option_list: Options supported by the profile, and set by the --cluster-option cmdline arg :vartype option_list: ``list`` of ``tuples`` :cvar packages: What package(s) should this profile enable on :vartype packages: ``tuple`` :cvar sos_plugins: Which plugins to forcibly enable for node reports :vartype sos_plugins: ``list`` :cvar sos_options: Options to pass to report on every node :vartype sos_options: ``dict`` :cvar sos_plugin_options: Plugin options to forcibly set for nodes :vartype sos_plugin_options: ``dict`` :cvar sos_preset: A SoSReport preset to forcibly enable on nodes :vartype sos_preset: ``str`` :cvar cluster_name: The name of the cluster type :vartype cluster_name: ``str`` )��r��NFc��C��s��d�\|�_�d�\|�_\|d�\|�_\|d�\|�_\|�jjg\|�_\|�jjD�]}\|jdkr(\|�j�\|j��qd�\|�_ t ��\|�_t� d�\|�_t� d�\|�_g�\|�_\|��d�S�)N�tmpdir�cmdlineoptsr��sos�sos_ui)�primary�cluster_ssh_keyr��opts� __class__�__name__�cluster_type� __bases__�append� node_listr��lock�logging� getLogger�soslog�ui_log�options�_get_options)�self�commons�cls��r��A/usr/lib/python3/dist-packages/sos/collector/clusters/__init__.py�__init__E��s�� zCluster.__init__c��C��s��\|�j�r\|�j�S�\|�j��S�)z0Returns the cluster's name as a string. )�cluster_namer��lower)r��r��r��r��nameU��s�� zCluster.namec��C��s"��\|�t�u�r\|��\|��d�S�\|�\|�j��d��\|�jr$\|�jt�jur$\|�\|�j��n\|�jd�jr;\|�jd�t�ur;\|�\|�jd�j��n\|�d��\|�jrV\|jdd�dd��\|�jD��dd ��\|�j rd\|jd \|�j ��dd ��\|�j r\|d�dd��\|�j ��D��}\|�d\|��\|�jr�\|jd d�dd��\|�jD��dd ��\|�j r�\|�j }d�dd��\|��D��}\|jd\|��dd ��\|�j�r \|�d�}\|�dtd\|�j��d��d��\|jtddd�dd�dd�dd�d��dd ��\|�jD�]-}\|d�}t\|t�r�\|r�d}nd}dd�\|d �d�\|d�\|d!�d��}\|j\|dd ��q�d�S�d�S�)"Nz Cluster Profile Detailed Help��z/ Detailed help not available for this profile z#Enabled by the following packages: z, c��s��\|�]}\|V��qd�S��Nr��)�.0�pr��r��r�� <genexpr>p��z'Cluster.display_help.<locals>.<genexpr>F��newlinezUses the following sos preset: c��s��s$��\|�] \}}d�\|��d\|��V��qdS�)z--� Nr��r'��k�vr��r��r��r)��{��s��"�z Sets the following sos options: zEnables the following plugins: c��s��r%��r&��r��)r'��plugr��r��r��r)��r��c��s��s"��\|�]\}}\|��d�\|��V��qdS�)�=Nr��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<4zOption Namez<20�Default�<30�DescriptionzTrue/Onz False/Offr��)r��display_self_help� set_titler!��__doc__�add_text�__mro__�packages�join� sos_preset�sos_options�items�sos_plugins�sos_plugin_options�option_list�add_sectionr��r�� isinstance�bool)r��section�_optsr ��optsec�opt�val�_lnr��r��r��display_help]��s�� $�zCluster.display_helpc��C��s��\|��d��\|�d��\|�d��ddlm}�dd�l}\|�\|�\|��d�}\|�d��\|jdd �d d�dd ��dd��\|D�]}td\|d��}\|jdd �\|d�\|d�jd ��dd��q9d�S�)NzSoS 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.z�Cluster 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��)�SoSCollector�clustersz6The following cluster profiles are locally available: r-��z>8�Namez<40r7��r6��Fr+��zcollect.clusters.r$��) r:��r<�� sos.collectorrP��inspect� _load_modules� getmoduler��r!��)r��rI��rP��rT��rQ��cluster�_secr��r��r��r9��s4�� zCluster.display_self_helpc��C��sB��\|�j�D�]}t\|d�\|d�j\|d�\|�j\|d�d�}\|�j�\|��qdS�)zALoads the options defined by a cluster and sets the default valuer��r$��r8��)r#��opt_type�valuerW��descriptionN)rE��r��r��r��r��r��)r��rL��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��\|�j��\|��\|��dS�)zUsed to print info messagesN)r��infor`��r^��r��r��r��log_info��zCluster.log_infoc��C��s��\|�j��\|��dS�)zUsed to print error messagesN)r��errorr^��r��r��r�� log_error��s��zCluster.log_errorc��C��ra��)zUsed to print debug messagesN)r��debugr`��r^��r��r��r�� log_debug��rd��zCluster.log_debugc��C��ra��)zUsed to print warning messagesN)r��warningr`��r^��r��r��r��log_warn��rd��zCluster.log_warnc��C��sR��\|�j�jD�]}\|j\|kr\|j\|�jv�r\|j��S�q\|�jD�]}\|j\|kr&\|j��S�qdS�)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 ��cluster_optionsr#��rW��r��rZ��r��)r��r\��rL��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��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��zCluster.set_node_optionsc��C��ro��)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. �control_persistr��r��r��r��r��set_transport_type��s��zCluster.set_transport_typec��C��ro��)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��rp��r��r��r��set_primary_options��rs��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`` )�addressr��rp��r��r��r��check_node_is_primary��s�� zCluster.check_node_is_primary��autoc��C��s4��\|�j�j\|\|\|\|d�}\|d�r\|d��dd�\|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_shell�timeout�outputz Password:r��)r��run_command�replace)r��cmdr\|��r~��r}��resr��r��r��exec_primary_cmd&��s�� zCluster.exec_primary_cmdc��C��ro��)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��ru��r��r��r��setup?��rs��z Cluster.setupc��C��s"��\|�j�D�]}\|�j�\|�r�dS�qdS�)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)r>��r��is_installed)r��pkgr��r��r�� check_enabledF��s �� zCluster.check_enabledc��C��ro��)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��ru��r��r��r��cleanupX��rs��zCluster.cleanupc��C��s��t��)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`` )�NotImplementedErrorru��r��r��r�� get_nodesa��s�� zCluster.get_nodesc�� C��sD��z\|��W�S��ty!�}�z\|��d\|��g�W��Y�d�}~S�d�}~ww�)NzFailed to get node list: )�format_node_list� Exceptionrh��)r��er��r��r�� _get_nodesm��s�� zCluster._get_nodesc��C��s��\|��\|�}\|j�d\|��\|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_label�manifest� add_field)r��rq��r��r��r��r��get_node_labelt��s�� zCluster.get_node_labelc��C��ro��)z�This 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��rp��r��r��r��r��s��zCluster.set_node_labelc�� C��s��z\|��}W�n�ty�}�ztd\|��\|�d}~ww�t\|t�r(dd��\|D��}nt\|t�r5dd��\|D��}ntd\|��tt\|��}\|D�]}\|�d�rP\|�\|��qD\|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\|��qS�r��)�strip�r'��nr��r��r�� <listcomp>��s��z,Cluster.format_node_list.<locals>.<listcomp>c��S��s��g�\|�] }\|��d��qS�)�,)�splitr��r��r��r��r��r��s��z'Cluster returned unexpected node list: )�-�_�(�)r]��]�/�\)r��r��rG��list�str�set� startswith�remove)r��nodes�errr��rq��r��r��r��r��s&�� zCluster.format_node_listc��C��st��g�}z-\|��}\|rt\|t�s\|g}\|D�]}\|��}\|�\|��d\|v�r)\|�\|d��qW�\|S�W�\|S��ty9��Y�\|S�w�)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 � sosreportz.md5)� run_extra_cmdrG��r��r��r��AttributeError)r��filesr�� extra_filer��r��r��_run_extra_cmd��s(�� zCluster._run_extra_cmd)Frz��r{��)'r�� __module__�__qualname__r;��rE��r>��rC��rA��rD��r@��r!��strict_node_listr ��classmethodr#��rO��r9��r��r`��rc��rf��rh��rj��rl��rn��rr��rv��rw��ry��r��r��r��r��r��r��r��r��r��r��r��r��r��r��r��sR��& E ! � r��)r�� threadingr��sos.optionsr�� sos.utilitiesr��r��r��r��r��r��<module>��s �� __pycache__/openstack.cpython-310.pyc��0000644��00000005066�15027746175�0013471 0��ustar�00��o ��-�_g��@��s,��d�dl�Z�d�dlmZ�dZG�dd��de�ZdS�)��N)�Clusterz9/var/lib/mistral/overcloud/tripleo-ansible-inventory.yamlc��@��s,��e�Zd�ZdZdZg�d�Zdd��Zdd��ZdS�) �rhospa�� This cluster profile is for use with Red Hat OpenStack Platform environments. Different types of nodes may be enumerated by toggling the various profile options such as Controllers and Compute nodes. By default, only Controller nodes are enumerated. Node enumeration is done by inspecting the ansible inventory file used for deployment of the environment. This is canonically located at /var/lib/mistral/overcloud/tripleo-ansible-inventory.yaml. Similarly, the presence of this file on the primary node is what triggers the automatic enablement of this profile. Special consideration should be taken for where `sos collect` is being run from, in that the hostnames of the enumerated nodes must be resolveable from that system - not just from the primary node from which those nodes are discovered. If this is not possible, consider enabling the `use-ip` cluster option to instead have this profile source the IP addresses of the nodes in question. zRed Hat OpenStack Platform))�use-ipFz0use IP addresses instead of hostnames to connect)� controllerTz%collect reports from controller nodes)�computeFz"collect reports from compute nodesc��C��s��\|�j�jtdd�S�)NT)� need_root)�primary�file_exists� INVENTORY)�self��r��B/usr/lib/python3/dist-packages/sos/collector/clusters/openstack.py� check_enabled0��s��zrhosp.check_enabledc�� C��s��g�}\|��d�r dnd}zt�\|�j�t��}W�n�ty/�}�z \|��d\|��td�\|�d�}~ww�z'dD�]!}\|��\|��rT\|\|�d�� D�]}\|� \|\|�d�\|�\|��qDq3W�\|S��tyu�}�z\|��d\|��d \|��W�Y�d�}~\|S�d�}~ww�) Nr��external_ip�ctlplane_hostnamezError parsing yaml: z'Could not parse yaml for node addresses)� Controller�Compute�hostszError getting z host addresses: )� get_option�yaml� safe_loadr�� read_filer �� Exception�log_info�lower�keys�append� log_error)r��_nodes�_addr_field�_inv�err�_t�hostr��r��r �� get_nodes3��s0�� zrhosp.get_nodesN)�__name__� __module__�__qualname__�__doc__�cluster_name�option_listr��r$��r��r��r��r ��r��s��r��)r��sos.collector.clustersr��r ��r��r��r��r��r ��<module>��s�� __pycache__/kubernetes.cpython-310.pyc��0000644��00000003257�15027746175�0013651 0��ustar�00��o ��-�_g@��@��s,��d�dl�mZ�d�dlmZ�G�dd��de�ZdS�)��)�quote)�Clusterc��@��s:��e�Zd�ZdZdZdZd�gZddiZdZddgZ d d ��Z dS�)� kubernetesz� The kuberentes cluster profile is intended to be used on kubernetes clusters built from the upstream/source kubernetes (k8s) project. It is not intended for use with other projects or platforms that are built ontop of kubernetes. zCommunity Kubernetes)zkubernetes-masterzkubernetes.all�on�kubectl)�label��z-Filter node list to those with matching label)�roler��z,Filter node list to those with matching rolec��C��s��\|��j�d7��_�\|��d�r\|��j�dt\|��d��d�7��_�\|��\|�j��}\|d�dkrag�}dd��\|��d ��d �D��}\|d��dd��D�]}\|��}\|sQ\|�\|d��qA\|d �\|v�r^\|�\|d��qA\|S�td��)Nz get nodesr��z -l � �statusr��c��S��s��g�\|�]}\|r\|�qS��r��)�.0�xr��r��C/usr/lib/python3/dist-packages/sos/collector/clusters/kubernetes.py� <listcomp>)��s��z(kubernetes.get_nodes.<locals>.<listcomp>r ��,�output��z-Node enumeration did not return usable output)�cmd� get_optionr��exec_primary_cmd�split� splitlines�append� Exception)�self�res�nodes�roles�nodeln�noder��r��r�� get_nodes"��s �� zkubernetes.get_nodesN)�__name__� __module__�__qualname__�__doc__�cluster_name�packages�sos_plugins�sos_plugin_optionsr��option_listr"��r��r��r��r��r��s��r��N)�shlexr��sos.collector.clustersr��r��r��r��r��r��<module>��s�� __pycache__/ceph.cpython-310.pyc��0000644��00000004503�15027746175�0012414 0��ustar�00��o ��-�_gb ��@��s(��d�dl�Z�d�dlmZ�G�dd��de�ZdS�)��N)�Clusterc��@��s4��e�Zd�ZdZdZdgZddiZdZdgZdd ��Z d S�)�cepha!�� This cluster profile is for Ceph Storage clusters, and is primarily built around Red Hat Ceph Storage 5. Nodes are enumerated via `cephadm`; if your Ceph deployment uses cephadm but is not RHCS 5, this profile may work as intended, but it is not currently guaranteed to do so. If you are using such an environment and this profile does not work for you, please file a bug report detailing what is failing. By default, all nodes in the cluster will be returned for collection. This may not be desirable, so users are encouraged to use the `labels` option to specify a colon-delimited set of ceph node labels to restrict the list of nodes to. For example, using `-c ceph.labels=osd:mgr` will return only nodes labeled with either `osd` or `mgr`. zCeph Storage Cluster�ceph_commonzlog-size�2��)�cephadm)�labels��z3Colon delimited list of labels to select nodes withc��s��g�\|�_�\|�jddd�}\|d�dks\|��d\|d��\|�j�S�t�\|d��d��}d d ��\|��d��d�D��}\|D�] ��\|rOt��fd d�\|D��sO\|�� d��q7\|�j�� d��q7\|�j�S�)Nz0cephadm shell -- ceph orch host ls --format jsonT)� need_root�statusr��z'Could not enumerate nodes via cephadm: �output��c��S��s��g�\|�]}\|r\|�qS��r ��)�.0�labr ��r ��=/usr/lib/python3/dist-packages/sos/collector/clusters/ceph.py� <listcomp>:��s��z"ceph.get_nodes.<locals>.<listcomp>r��:c��3��s��\|�] }\|��d��v�V��qdS�)r��Nr ��)r��_l��noder ��r�� <genexpr><��s��z!ceph.get_nodes.<locals>.<genexpr>z! filtered from list due to labels�hostname)�nodes�exec_primary_cmd� log_error�json�loads� splitlines� get_option�split�any� log_debug�append)�self�ceph_outr��_labelsr ��r��r�� get_nodes,��s$��zceph.get_nodesN) �__name__� __module__�__qualname__�__doc__�cluster_name�sos_plugins�sos_options�packages�option_listr&��r ��r ��r ��r��r��s��r��)r��sos.collector.clustersr��r��r ��r ��r ��r��<module>��s�� __pycache__/pacemaker.cpython-310.pyc��0000644��00000006347�15027746175�0013435 0��ustar�00��o ��-�_g>��@��s@��d�dl�Z�d�dlmZ�d�dlmZ�d�dlmZ�G�dd��de�ZdS�)��N)�ElementTree)�Cluster)�sos_parse_versionc��@��sF��e�Zd�ZdZd�gZdZdZg�d�Zdd��Zdd��Z d d ��Z dd��Zd S�)� pacemakerz+Pacemaker High Availability Cluster Manager)r��T))�onlineTzCollect nodes listed as online)�offlineTzCollect nodes listed as offline)� only-corosyncFz)Only use corosync.conf to enumerate nodesc�� C��s��g�\|�_�z/\|��d�sz\|��W�n�ty)�}�z\|��d\|��W�Y�d�}~nd�}~ww�\|�j�s1\|��W�n�tyL�}�z\|��d\|��W�Y�d�}~nd�}~ww�dd��\|�j�D��}\|rc\|��dd�\|��d��\|�j�S�) Nr��zHFalling back to sourcing corosync.conf. Could not parse crm_mon output: z(Could not determine nodes from cluster: c��S��s��g�\|�]}d�\|vr\|�qS�)�.��)�.0�nr ��r ��B/usr/lib/python3/dist-packages/sos/collector/clusters/pacemaker.py� <listcomp>/��s��z'pacemaker.get_nodes.<locals>.<listcomp>zWARNING: Node addresses '�,z�' may not resolve locally if you are not running on a node in the cluster. Try using option '-c pacemaker.only-corosync' if these connections fail.)�nodes� get_option�get_nodes_from_crm� Exception�log_warn�get_nodes_from_corosync� log_error�join)�self�err�_shortsr ��r ��r �� get_nodes��s0�� zpacemaker.get_nodesc��C��s��d}\|��d�}\|d�dkr%\|d��d��d�d�}t\|�td�kr$d }nd S�\|�j�d\|��dd �}\|d�dkr@\|��\|d��d S�d S�)zG Try to parse crm_mon output for node list and status. z--output-as=xmlzcrm_mon --version�statusr��output��-z2.0.3z--as-xmlNzcrm_mon --one-shot --inactive T)� need_root)�exec_primary_cmd�splitr�� parse_crm_xml)r��xmlopt�_ver�cver�_outr ��r ��r ��r��9��s�� zpacemaker.get_nodes_from_crmc��C��sv��t��\|�}\|�d�}\|D�],}\|j}\|��d�r%\|d�dkr%\|�j�\|d��q\|��d�r8\|d�dkr8\|�j�\|d��qdS�)zA Parse the xml output string provided by crm_mon r��r��true�namer��falseN)r�� fromstring�find�attribr��r��append)r�� xmlstring�_xmlr��node�_noder ��r ��r ��r#��M��s�� zpacemaker.parse_crm_xmlc��C��sD��\|��d��\|�j�d�}t�d\|�}\|D�]}\|�j�\|d��qdS�)z� As a fallback measure, read corosync.conf to get the node list. Note that this prevents us from separating online nodes from offline nodes. z_WARNING: unable to distinguish online nodes from offline nodes when sourcing from corosync.confz/etc/corosync/corosync.confz((\sring0_addr:)(.))��N)r��primary� read_file�re�findallr��r.��strip)r��ccr��r1��r ��r ��r ��r��Z��s�� z!pacemaker.get_nodes_from_corosyncN)�__name__� __module__�__qualname__�cluster_name�sos_plugins�packages�strict_node_list�option_listr��r��r#��r��r ��r ��r ��r ��r��s�� r��)r6�� xml.etreer��sos.collector.clustersr�� sos.utilitiesr��r��r ��r ��r ��r ��<module>��s �� __pycache__/ovirt.cpython-310.pyc��0000644��00000017134�15027746175�0012644 0��ustar�00��o ��-�_g��@��sX��d�dl�Z�d�dlmZ�d�dlmZ�dZG�dd��de�ZG�dd��de�ZG�d d ��d e�ZdS�)��N)�quote)�Clusterz(/etc/pki/ovirt-engine/keys/engine_id_rsac��@��sl��e�Zd�ZdZdZdZdZg�d�Zdd��Zdd ��Z d d��Z dd ��Zdd��Zdd��Z dd��Zdd��Zdd��ZdS�)�ovirta�� This cluster profile is for the oVirt/RHV project which provides for a virtualization cluster built ontop of KVM. Nodes enumerated will be hypervisors within the envrionment, not virtual machines running on those hypervisors. By default, ALL hypervisors within the environment are returned. This may be influenced by the 'cluster' and 'datacenter' cluster options, which will limit enumeration to hypervisors within the specific cluster and/or datacenter. The spm-only cluster option may also be used to only collect from hypervisors currently holding the SPM role. Optionally, to only collect an archive from manager and the postgresql database, use the no-hypervisors cluster option. By default, a second archive from the manager will be collected that is just the postgresql plugin configured in such a way that a dump of the manager's database that can be explored and restored to other systems will be collected. The ovirt profile focuses on the upstream, community ovirt project. The rhv profile is for Red Hat customers running RHV (formerly RHEV). The rhhi_virt profile is for Red Hat customers running RHV in a hyper-converged setup and enables gluster collections. zCommunity oVirt)zovirt-enginez3/usr/share/ovirt-engine/dbscripts/engine-psql.sh -c))�no-databaseFzDo not collect a database dump)�cluster��z'Only collect from hosts in this cluster)� datacenterr��zOnly collect from hosts in this datacenter)�no-hypervisorsFzDo not collect from hypervisors)�spm-onlyFzOnly collect from SPM host(s)c��C��s"��\|�j��dt\|��}\|�j\|dd�S�)z� Wrapper for running DB queries on the manager. Any scrubbing of the query should be done _before_ passing the query to this method. � T�� need_root)�db_execr��exec_primary_cmd)�self�query�cmd��r��>/usr/lib/python3/dist-packages/sos/collector/clusters/ovirt.py� _run_db_query<��s��zovirt._run_db_queryc��s@��\|sdS�g�d��t��fdd�\|D��r\|��d\|��d��dS�\|S�)z� Manually sanitize SQL queries since we can't leave this up to the driver since we do not have an actual DB connection �%)��\� � ��"�'c��3��s��\|�]}\|��v�V��qd�S�)Nr��)�.0�x�� invalid_charsr��r�� <genexpr>M��s��z#ovirt._sql_scrub.<locals>.<genexpr>zWARNING: Cluster option 'z2' contains invalid characters. Using '%%' instead.)�any�log_warn)r��valr��r ��r�� _sql_scrubD��s��zovirt._sql_scrubc��C��sR��\|�j�jr#t\|�jj\|�jj\|�jjg�s%\|�j��t�r'\|�� t��\|�� d��dS�dS�dS�dS�)a�� Checks for the presence of the VDSM ssh keys the manager uses for communication with hypervisors. This only runs if we're locally on the RHV-M, and* if no ssh-keys are called out on the command line, and no --password option is given. z]Found engine SSH key. User command line does not specify a key or password, using engine key.N)�primary�localr#��opts�ssh_key�password�password_per_node�file_exists� ENGINE_KEY�add_default_ssh_key� log_debug�r��r��r��r��_check_for_engine_keysT��s�� zovirt._check_for_engine_keysc��C��s.��d\|�_�\|��d�s \|��\|�_\|��\|��d�S�)NFr��)�pg_pass� get_option� parse_db_conf�conf� format_db_cmdr2��r1��r��r��r��setupe��s �� zovirt.setupc��C��sb��\|��\|��d��}\|��\|��d��}d\|��d\|��d�\|�_\|��d�r&\|��jd7��_\|��d\|�j��d�S�) Nr��r��z_SELECT host_name from vds where cluster_id in (select cluster_id FROM cluster WHERE name like 'zG' and storage_pool_id in (SELECT id FROM storage_pool WHERE name like 'z'))r ��z AND spm_status = 2z#Query command for ovirt DB set to: )r&��r4��dbqueryr0��)r��r��r��r��r��r��r7��l��s�� zovirt.format_db_cmdc��C��sZ��\|��d�rg�S�\|��\|�j�}\|d�dkr$\|d��dd��}dd��\|D��S�td \|d��) Nr ��statusr��output��c��S��s��g�\|�]}\|��d��d��qS�)�(r��)�split�strip)r��nr��r��r�� <listcomp>��s��z#ovirt.get_nodes.<locals>.<listcomp>z$database query failed, return code: )r4��r��r9�� splitlines� Exception)r��res�nodesr��r��r�� get_nodes{��s�� zovirt.get_nodesc��C��s��\|��d�s\|�jr\|��S�dS�)Nr��F)r4��r6��collect_databaser1��r��r��r�� run_extra_cmd��s��zovirt.run_extra_cmdc�� C��s��i�}d}\|�j�d\|��dd�}\|d�dkrF\|d��}\|D�]'}zt\|�d�d��}t\|�d�d ��d d��}\|\|\|<�W�q�tyC��Y�qw�\|S�dS�) Nz6/etc/ovirt-engine/engine.conf.d/10-setup-database.confzcat Tr��r:��r��r;��=��r��r��F)r��rC��strr?��replace� IndexError)r��r6��engconfrE��config�line�k�vr��r��r��r5��s��zovirt.parse_db_confc��C��s��d}d\|��d\|�j�d��d\|��d\|�j�d��d\|��d\|�j�d ��d\|��d \|�j�d��}d\|�j�d ��d\|��}\|�j\|dd�}\|d��D�]}t�\|d�r]\|��}\|�jj�d\|�d�d��\|��S�q@\|�� d��dS�)N� postgresqlz-k z.dbname=�ENGINE_DB_DATABASEz -k z.dbhost=�ENGINE_DB_HOSTz.dbport=�ENGINE_DB_PORTz.dbuser=�ENGINE_DB_USERzPGPASSWORD=�ENGINE_DB_PASSWORDz> /usr/sbin/sos report --name=postgresql --batch -o postgresql Tr��r;��zsosreport-tar�postgresql_dump�/r=��zFailed to gather database dumpF) r6��r��rC��fnmatchr@��r'��manifest� add_fieldr?�� log_error)r��plugin�sos_optr��db_sosrQ��_pg_dumpr��r��r��rH��s<�� zovirt.collect_databaseN)�__name__� __module__�__qualname__�__doc__�cluster_name�packagesr��option_listr��r&��r2��r8��r7��rG��rI��r5��rH��r��r��r��r��r��s�� r��c��@��s ��e�Zd�ZdZdZd�Zdd��ZdS�)�rhvzRed Hat Virtualization)�rhevm�rhvmc��C��s$��\|j�\|�jj�kr dS�\|�d�rdS�dS�)N�managerzovirt-node-ng-nodectl�rhvh�rhelh)�addressr'��is_installed)r��noder��r��r��set_node_label��s �� zrhv.set_node_labelN)rd��re��rf��rh��ri�� sos_presetrt��r��r��r��r��rk��s ��rk��c��@��s0��e�Zd�ZdZdZddiZdZdd��Zdd ��Zd S�)� rhhi_virtz6Red Hat Hyperconverged Infrastructure - Virtualization)�glusterzgluster.dump�onrk��c��C��s��\|�j��d�o \|��S�)Nrm��)r'��rr��_check_for_rhhivr1��r��r��r�� check_enabled��s��zrhhi_virt.check_enabledc��C��s2��\|��d�}\|d�dkr\|d��d��dkS�dS�)Nz+SELECT count(server_id) FROM gluster_serverr:��r��r;��r<��0F)r��rC��r@��)r��retr��r��r��ry��s�� zrhhi_virt._check_for_rhhivN) rd��re��rf��rh��sos_plugins�sos_plugin_optionsru��rz��ry��r��r��r��r��rv��s��rv��) r\��shlexr��sos.collector.clustersr��r.��r��rk��rv��r��r��r��r��<module>��s�� __pycache__/jbon.cpython-310.pyc��0000644��00000002020�15027746175�0012415 0��ustar�00��o ��-�_g��@��s ��d�dl�mZ�G�dd��de�ZdS�)��)�Clusterc��@��s(��e�Zd�ZdZdZdZdd��Zdd��ZdS�)�jbonaY�� Used when --cluster-type=none (or jbon) to avoid cluster checks, and just use the provided --nodes list. Using this profile will skip any and all operations that a cluster profile normally performs, and will not set any plugins, plugin options, or presets for the sos report generated on the nodes provided by --nodes. z"Just a Bunch Of Nodes (no cluster)Nc��C��s��g�S�)N��selfr��r��=/usr/lib/python3/dist-packages/sos/collector/clusters/jbon.py� get_nodes��s��zjbon.get_nodesc��C��s��dS�)NFr��r��r��r��r�� check_enabled��s��zjbon.check_enabled)�__name__� __module__�__qualname__�__doc__�cluster_name�packagesr��r ��r��r��r��r��r��s�� r��N)�sos.collector.clustersr��r��r��r��r��r��<module>��s�� __pycache__/saltstack.cpython-310.pyc��0000644��00000005241�15027746175�0013466 0��ustar�00��o ��-�_gp��@��s4��d�dl�Z�d�dlmZ�d�dlmZ�G�dd��de�ZdS�)��N)�quote)�Clusterc��@��sl��e�Zd�ZdZdZdZdgZdZg�d�ZdZ dZ d ed efdd�Z d ed efdd�Zd efdd�Zdd��ZdS�)� saltstackzh The saltstack cluster profile is intended to be used on saltstack clusters (Salt Project). � Saltstack)zsalt-master� saltmasterT))�compound��z+Filter node list to those matching compound)�globr��z/Filter node list to those matching glob pattern)�grainr��z-Filter node list to those with matching grain)�minion_id_unresolvableFz\Returns the FQDN grain of each minion in the node list when the minion ID is not a hostname.)� nodegroupr��z,Filter node list to those matching nodegroup)�pillarr��z.Filter node list to those with matching pillar)�subnetr��z#Filter node list to those in subnetFz#salt-run --out=pprint manage.status�output�returnc��C��s6��g�}t��\|�dd��}\|��D�] \}}\|�\|��q\|S�)N�'�")�json�loads�replace�items�extend)�selfr��nodes�salt_json_output�_�value��r��B/usr/lib/python3/dist-packages/sos/collector/clusters/saltstack.py�_parse_manage_status(��s ��zsaltstack._parse_manage_status� manage_statusc��C��sn��g�}\|��D�].\}}\|dkr\|��d\|��d��\|�\|��q\|D�]}d\|��d�}\|�\|��\|�d��qq\|S�)N�downzNode(s) z are status down.zsalt --out=newline_values_only z grains.get fqdnr��)r��log_warnr��append�exec_primary_cmd�strip)r��r �� hostnames�status�minions�minion�node_cmdr��r��r��_get_hostnames_from_grain/��s�� z#saltstack._get_hostnames_from_grainc��C��sX��\|��\|�j�}\|d�dkrtd��\|��d�r%t�\|d��dd��}\|��\|�S�\|��\|d��S�)Nr'��r��z-Node enumeration did not return usable outputr��r��r��r��) r$��r�� Exception� get_optionr��r��r��r+��r��)r��resr'��r��r��r�� _get_nodes@��s�� zsaltstack._get_nodesc��C��s^��\|�j�D�]'}\|d�dkr\|��\|d��}\|r\|��jdt\|��d\|d��7��_�\|��S�q\|��S�)Nr��r��z tgt=z tgt_type=)�option_listr-��r��r��r/��)r��option�optr��r��r�� get_nodesI��s�� "��zsaltstack.get_nodesN)�__name__� __module__�__qualname__�__doc__�cluster_name�packages�sos_plugins�strict_node_listr0��targetedr��str�listr��dictr+��r/��r3��r��r��r��r��r��s�� r��)r��shlexr��sos.collector.clustersr��r��r��r��r��r��<module>��s�� __pycache__/juju.cpython-310.pyc��0000644��00000016116�15027746175�0012455 0��ustar�00��o ��-�_g�!��@��sb��d�dl�Z�d�dlZd�dlZd�dlmZ�d�dlmZ�d�dlmZ�ddd�Zdd��Z G�d d ��d e�Z dS�)��N)�Cluster)�sos_parse_version��sos_get_command_outputc��C��s��\|�sg�S�dd��\|��d�D��S�)zParse comma separated string.c��S��s��g�\|�]}\|��qS��)�strip)�.0�stringr��r��=/usr/lib/python3/dist-packages/sos/collector/clusters/juju.py� <listcomp>��s��z(_parse_option_string.<locals>.<listcomp>�,)�split)�stringsr��r��r ��_parse_option_string��s��r��c��C��s��G�dd��d�}\|\|��S�)aR��Helper function to get Index. The reason why we need Index defined in function is because currently the collector.__init__ will load all the classes in this module and also Index. This will cause bug because it think Index is Cluster type. Also We don't want to provide a customized filter to remove Index class. c��@��s0��e�Zd�ZdZdd��Zdd��Zdd��Zdd ��Zd S�)z_get_index.<locals>.Indexz�Index structure to help parse juju status output. Attributes apps, units and machines are dict which key is the app/unit/machine name and the value is list of targets which format are {model_name}:{machine_id}. c��S��s(��\|\|�_�i�\|�_i�\|�_i�\|�_t�d�\|�_d�S�)N�sos)� model_name�apps�units�machines�logging� getLogger�ui_log)�selfr��r��r��r ��__init__.��s ��z"_get_index.<locals>.Index.__init__c�� S��s��\|d��D�]7\}}g�}\|�di��}\|��D�]!\}}\|d�}\|�j��d\|��} \| g\|�j\|<�\| g\|�j\|<�\|�\| ��q\|\|�j\|<�qdS�)zAdds principal units to index.�applicationsr��machine�:N)�items�getr��r��r��appendr��) r��juju_status�app�app_info�nodesr��unit� unit_infor��noder��r��r ��add_principals5��s��z(_get_index.<locals>.Index.add_principalsc��S��s��\|d��D�]s\}}\|�dg��}\|D�]f}\|�j�\|�s%\|�j�d\|��d��q\|�j\|��\|�j\|��d\|d�\|�vrC\|�j�d\|��d��q\|d�\|�d�}\|��D�](\}}\|�j��d\|d��} \|�d i��D�]\} }\| �\|d ��rv\| g\|�j\| <�qeqOqqdS�)z�Add subordinates to index. Since subordinates does not have units they need to be manually added. r��zsubordinate-tozPrincipal charm z is missingr��z is missing unitsr��r��subordinates�/N) r��r��r��r��warning�extendr�� startswithr��)r��r ��r!��r"��subordinate_to�parentr��_r%��r&��sub_keyr��r��r ��add_subordinatesC��s:�� z_get_index.<locals>.Index.add_subordinatesc��S��s2��\|d��D�]}\|�j��d\|��}\|g\|�j\|<�qdS�)z�Add machines to index. If model does not have any applications it needs to be manually added. r��r��N)�keysr��r��)r��r ��r��r&��r��r��r ��add_machinesd��s��z&_get_index.<locals>.Index.add_machinesN)�__name__� __module__�__qualname__�__doc__r��r'��r1��r3��r��r��r��r ��Index%��s��!r8��r��)r��r8��r��r��r �� _get_index��s�� Ir9��c��@��s`��e�Zd�ZdZd�ZdZg�d�Zdd��Zdd��Zdd ��Z d d��Z dd ��Zdd��Zdd��Z dd��ZdS�)�jujua!�� The juju cluster profile is intended to be used on juju managed clouds. It"s assumed that `juju` is installed on the machine where `sos` is called, and that the juju user has superuser privilege to the current controller. By default, the sos reports will be collected from all the applications in the current model. If necessary, you can filter the nodes by models / applications / units / machines with cluster options. Example: sos collect --cluster-type juju -c "juju.models=sos" -c "juju.apps=a,b,c" zJuju Managed Clouds))r��z1Filter node list by apps (comma separated regex).)r��r;��z3Filter node list by units (comma separated string).)�modelsr;��z4Filter node list by models (comma separated string).)r��r;��z6Filter node list by machines (comma separated string).c��C��s��t��dd\|dt�j�S�)z#Remove leading characters before {.z(^[^{])(.)z\2r��)�re�sub� MULTILINE)r��outputr��r��r ��_cleanup_juju_output��s��zjuju._cleanup_juju_outputc��C��s6��\|��\|�}t\|d�}\|�\|��\|�\|��\|�\|��\|S�)z�Parse juju status output and return target dict. Here are couple helper functions to parse the juju principals units, subordinate units and machines. )r��)�_execute_juju_statusr9��r'��r1��r3��)r��r��r ��indexr��r��r ��_get_model_info��s�� zjuju._get_model_infoc��C��s��t�d�}\|d�S�)zGrab the version of jujuzjuju versionr@��r��)r��resr��r��r ��_get_juju_version��s��zjuju._get_juju_versionc�� C��s��\|rd\|��nd}d}\|��}t\|�td�kr\|d7�}\|�j��d\|��d\|��}\|��\|�}\|d�d ks=td \|��d\|d��\|��\|d��}d�}t�\|�}\|S�) Nz-m r;��z --format json�3z --no-colorz status � �statusr��'z' returned error: r@��)rF��r��cmd�exec_primary_cmd� ExceptionrA��json�loads) r��r��model_option� format_option�juju_version� status_cmdrE��juju_json_outputr ��r��r��r ��rB��s�� zjuju._execute_juju_statusc��C��sF��t��}\|D�]}t\|\|��D�]\}}t�\|\|�r\|�\|pg��qq\|S�)zFilter with regex match.)�set�getattrr��r=��match�update�r��key�patterns� model_infor#��pattern�param�valuer��r��r ��_filter_by_pattern��s��zjuju._filter_by_patternc��C��sB��t��}\|D�]}t\|\|��D�]\}}\|\|kr\|�\|pg��qq\|S�)zFilter with fixed match.)rU��rV��r��rX��rY��r��r��r ��_filter_by_fixed��s��zjuju._filter_by_fixedc��C��s��dS�)z'Dynamically change transport to 'juju'.r:��r��)r��r��r��r ��set_transport_type��s��zjuju.set_transport_typec��C��s��t�\|��d��}t�\|��d��}t�\|��d��}t�\|��d��}\|\|\|d�}t\|��s,\|s,g�S�\|s1dg}t��}\|D�](}\|��\|�}\|��D�]\} } \| dkrQ\|��\| \| \|�}n\|��\| \| \|�}\|� \|��qAq6t \|�S�)z+Get the machine numbers from `juju status`.r<��r��r��r��)r��r��r��r;��)r�� get_option�any�valuesrU��rD��r��r`��ra��rX��list)r��r<��r��r��r��filtersr#��modelr\��rZ��resource�_nodesr��r��r �� get_nodes��s&�� zjuju.get_nodesN)r4��r5��r6��r7��rK��cluster_name�option_listrA��rD��rF��rB��r`��ra��rb��rk��r��r��r��r ��r:��q��s�� r:��)N)r��rN��r=��sos.collector.clustersr�� sos.utilitiesr��r��r��r9��r:��r��r��r��r ��<module>��s�� V��jbon.py��0000644��00000002223�15027746175�0006063 0��ustar�00��# Copyright Red Hat 2020, Jake Hunsaker <jhunsake@redhat.com> # This file is part of the sos project: https://github.com/sosreport/sos # # This copyrighted material is made available to anyone wishing to use, # modify, copy, or redistribute it subject to the terms and conditions of # version 2 of the GNU General Public License. # # See the LICENSE file in the source distribution for further information. from sos.collector.clusters import Cluster class jbon(Cluster): """ Used when --cluster-type=none (or jbon) to avoid cluster checks, and just use the provided --nodes list. Using this profile will skip any and all operations that a cluster profile normally performs, and will not set any plugins, plugin options, or presets for the sos report generated on the nodes provided by --nodes. """ cluster_name = 'Just a Bunch Of Nodes (no cluster)' packages = None def get_nodes(self): return [] def check_enabled(self): # This should never be called, but as insurance explicitly never # allow this to be enabled via the determine_cluster() path return False # vim: set et ts=4 sw=4 : ��saltstack.py��0000644��00000006160�15027746175�0007130 0��ustar�00��# Copyright Red Hat 2022, Trevor Benson <trevor.benson@gmail.com> # This file is part of the sos project: https://github.com/sosreport/sos # # This copyrighted material is made available to anyone wishing to use, # modify, copy, or redistribute it subject to the terms and conditions of # version 2 of the GNU General Public License. # # See the LICENSE file in the source distribution for further information. import json from shlex import quote from sos.collector.clusters import Cluster class saltstack(Cluster): """ The saltstack cluster profile is intended to be used on saltstack clusters (Salt Project). """ cluster_name = "Saltstack" packages = ("salt-master",) sos_plugins = ["saltmaster"] strict_node_list = True option_list = [ ("compound", "", "Filter node list to those matching compound"), ("glob", "", "Filter node list to those matching glob pattern"), ("grain", "", "Filter node list to those with matching grain"), ("minion_id_unresolvable", False, "Returns the FQDN grain of each" " minion in the node list when the minion ID is not a hostname."), ("nodegroup", "", "Filter node list to those matching nodegroup"), ("pillar", "", "Filter node list to those with matching pillar"), ("subnet", "", "Filter node list to those in subnet"), ] targeted = False node_cmd = "salt-run --out=pprint manage.status" def _parse_manage_status(self, output: str) -> list: nodes = [] salt_json_output = json.loads(output.replace("'", '"')) for _, value in salt_json_output.items(): nodes.extend(value) return nodes def _get_hostnames_from_grain(self, manage_status: dict) -> list: hostnames = [] for status, minions in manage_status.items(): if status == "down": self.log_warn(f"Node(s) {minions} are status down.") hostnames.extend(minions) else: for minion in minions: node_cmd = ( f"salt --out=newline_values_only {minion} " f"grains.get fqdn" ) hostnames.append( self.exec_primary_cmd(node_cmd)["output"].strip() ) return hostnames def _get_nodes(self) -> list: res = self.exec_primary_cmd(self.node_cmd) if res["status"] != 0: raise Exception("Node enumeration did not return usable output") if self.get_option("minion_id_unresolvable"): status = json.loads(res["output"].replace("'", '"')) return self._get_hostnames_from_grain(status) return self._parse_manage_status(res["output"]) def get_nodes(self): # Default to all online nodes for option in self.option_list: if option[0] != "minion_id_unresolvable": opt = self.get_option(option[0]) if opt: self.node_cmd += f" tgt={quote(opt)} tgt_type={option[0]}" break return self._get_nodes() # vim: set et ts=4 sw=4 : ��satellite.py��0000644��00000003142�15027746175�0007122 0��ustar�00��# Copyright Red Hat 2020, Jake Hunsaker <jhunsake@redhat.com> # This file is part of the sos project: https://github.com/sosreport/sos # # This copyrighted material is made available to anyone wishing to use, # modify, copy, or redistribute it subject to the terms and conditions of # version 2 of the GNU General Public License. # # See the LICENSE file in the source distribution for further information. from shlex import quote from sos.collector.clusters import Cluster class satellite(Cluster): """ This profile is specifically for Red Hat Satellite 6, and not earlier releases of Satellite. While note technically a 'cluster' in the traditional sense, Satellite does provide for 'capsule' nodes which is what this profile aims to enumerate beyond the 'primary' Satellite system. """ cluster_name = 'Red Hat Satellite 6' packages = ('satellite', 'satellite-installer') def _psql_cmd(self, query): _cmd = "su postgres -c %s" _dbcmd = "psql foreman -c %s" return _cmd % quote(_dbcmd % quote(query)) def get_nodes(self): cmd = self._psql_cmd('copy (select name from smart_proxies) to stdout') res = self.exec_primary_cmd(cmd, need_root=True) if res['status'] == 0: nodes = [ n.strip() for n in res['output'].splitlines() if 'could not change directory' not in n ] return nodes return [] def set_node_label(self, node): if node.address == self.primary.address: return 'satellite' return 'capsule' # vim: set et ts=4 sw=4 : ��ocp.py��0000644��00000040056�15027746175�0005722 0��ustar�00��# Copyright Red Hat 2021, Jake Hunsaker <jhunsake@redhat.com> # This file is part of the sos project: https://github.com/sosreport/sos # # This copyrighted material is made available to anyone wishing to use, # modify, copy, or redistribute it subject to the terms and conditions of # version 2 of the GNU General Public License. # # See the LICENSE file in the source distribution for further information. import os from shlex import quote from sos.collector.clusters import Cluster from sos.utilities import is_executable class ocp(Cluster): """ This profile is for use with OpenShift Container Platform (v4) clusters instead of the kubernetes profile. This profile will favor using the `oc` transport type, which means it will leverage a locally installed `oc` binary. This is also how node enumeration is done. To instead use SSH to connect to the nodes, use the '--transport=control_persist' option. Thus, a functional `oc` binary for the user executing sos collect is required. Functional meaning that the user can run `oc` commands with clusterAdmin privileges. If this requires the use of a secondary configuration file, specify that path with the 'kubeconfig' cluster option. This config file will also be used on a single master node to perform API collections if the `with-api` option is enabled (default disabled). If no `kubeconfig` option is given, but `with-api` is enabled, the cluster profile will attempt to use a well-known default kubeconfig file if it is available on the host. Alternatively, provide a clusterAdmin access token either via the 'token' cluster option or, preferably, the SOSOCPTOKEN environment variable. By default, this profile will enumerate only master nodes within the cluster, and this may be changed by overriding the 'role' cluster option. To collect from all nodes in the cluster regardless of role, use the form -c ocp.role=''. Filtering nodes by a label applied to that node is also possible via the label cluster option, though be aware that this is _combined_ with the role option mentioned above. To avoid redundant collections of OCP API information (e.g. 'oc get' commands), this profile will attempt to enable the API collections on only a single master node. If the none of the master nodes have a functional 'oc' binary available, and* the --no-local option is used, that means that no API data will be collected. """ cluster_name = 'OpenShift Container Platform v4' packages = ('openshift-hyperkube', 'openshift-clients') api_collect_enabled = False token = None project = 'sos-collect-tmp' oc_cluster_admin = None _oc_cmd = '' option_list = [ ('label', '', 'Colon delimited list of labels to select nodes with'), ('role', 'master', 'Colon delimited list of roles to filter on'), ('kubeconfig', '', 'Path to the kubeconfig file'), ('token', '', 'Service account token to use for oc authorization'), ('with-api', False, 'Collect OCP API data from a master node'), ('api-url', '', 'Alternate API URL of an external control-plane'), ] @property def oc_cmd(self): if not self._oc_cmd: self._oc_cmd = 'oc' if self.primary.host.in_container(): _oc_path = self.primary.run_command( 'which oc', chroot=self.primary.host.sysroot ) if _oc_path['status'] == 0: self._oc_cmd = os.path.join( self.primary.host.sysroot, _oc_path['output'].strip().lstrip('/') ) else: self.log_warn( "Unable to to determine PATH for 'oc' command, " "node enumeration may fail." ) self.log_debug( f"Locating 'oc' failed: {_oc_path['output']}") if self.get_option('kubeconfig'): self._oc_cmd += " --kubeconfig " \ f"{self.get_option('kubeconfig')}" self.log_debug(f"oc base command set to {self._oc_cmd}") return self._oc_cmd def fmt_oc_cmd(self, cmd): """Format the oc command to optionall include the kubeconfig file if one is specified """ return f"{self.oc_cmd} {cmd}" def _attempt_oc_login(self): """Attempt to login to the API using the oc command using a provided token """ _res = self.exec_primary_cmd( self.fmt_oc_cmd("login --insecure-skip-tls-verify=True " f"--token={self.token} " f"{self.get_option('api-url')}") ) return _res['status'] == 0 def check_enabled(self): if super().check_enabled(): return True self.token = self.get_option('token') or os.getenv('SOSOCPTOKEN', None) if self.token: self._attempt_oc_login() _who = self.fmt_oc_cmd('whoami') return self.exec_primary_cmd(_who)['status'] == 0 def setup(self): """Create the project that we will be executing in for any nodes' collection via a container image """ if not self.set_transport_type() == 'oc': return None out = self.exec_primary_cmd(self.fmt_oc_cmd("auth can-i '' ''")) self.oc_cluster_admin = out['status'] == 0 if not self.oc_cluster_admin: self.log_debug("Check for cluster-admin privileges returned false," " cannot create project in OCP cluster") raise Exception("Insufficient permissions to create temporary " "collection project.\nAborting...") self.log_info(f"Creating new temporary project '{self.project}'") ret = self.exec_primary_cmd( self.fmt_oc_cmd(f"new-project {self.project}") ) if ret['status'] == 0: self._label_sos_project() return True self.log_debug(f"Failed to create project: {ret['output']}") raise Exception("Failed to create temporary project for collection. " "\nAborting...") def _label_sos_project(self): """Add pertinent labels to the temporary project we've created so that our privileged containers can properly run. """ labels = [ "security.openshift.io/scc.podSecurityLabelSync=false", "pod-security.kubernetes.io/enforce=privileged" ] for label in labels: ret = self.exec_primary_cmd( self.fmt_oc_cmd( f"label namespace {self.project} {label} --overwrite" ) ) if not ret['status'] == 0: raise Exception( f"Error applying namespace labels: {ret['output']}" ) def cleanup(self): """Remove the project we created to execute within """ if self.project: try: ret = self.exec_primary_cmd( self.fmt_oc_cmd(f"delete project {self.project}"), timeout=30 ) if not ret['status'] == 0: self.log_error( f"Error deleting temporary project: {ret['output']}" ) ret = self.exec_primary_cmd( self.fmt_oc_cmd( f"wait namespace/{self.project} --for=delete " f"--timeout=30s" ) ) if not ret['status'] == 0: self.log_error( f"Error waiting for temporary project to be deleted: " f"{ret['output']}" ) except Exception as err: self.log_error( f"Failed attempting to remove temporary project " f"'sos-collect-tmp': {err}\n" f"Please manually remove the temporary project." ) # don't leave the config on a non-existing project self.exec_primary_cmd(self.fmt_oc_cmd("project default")) self.project = None return True def _build_dict(self, nodelist): """From the output of get_nodes(), construct an easier-to-reference dict of nodes that will be used in determining labels, primary status, etc... :param nodelist: The split output of `oc get nodes` :type nodelist: ``list`` :returns: A dict of nodes with `get nodes` columns as keys :rtype: ``dict`` """ nodes = {} if 'NAME' in nodelist[0]: # get the index of the fields statline = nodelist.pop(0).split() idx = {} for state in ['status', 'roles', 'version', 'os-image']: try: idx[state] = statline.index(state.upper()) except Exception: # label is not available, which is not fatal for our dict # construction here pass for node in nodelist: _node = node.split() nodes[_node[0]] = {} for column, value in idx.items(): nodes[_node[0]][column] = _node[value] return nodes def set_transport_type(self): if self.opts.transport != 'auto': return self.opts.transport if is_executable('oc', sysroot=self.primary.host.sysroot): return 'oc' self.log_info("Local installation of 'oc' not found or is not " "correctly configured. Will use ControlPersist.") self.ui_log.warning( "Preferred transport 'oc' not available, will fallback to SSH." ) if not self.opts.batch: input("Press ENTER to continue connecting with SSH, or Ctrl+C to" "abort.") return 'control_persist' def get_nodes(self): nodes = [] self.node_dict = {} cmd = 'get nodes -o wide' if self.get_option('label'): labels = ','.join(self.get_option('label').split(':')) cmd += f" -l {quote(labels)}" res = self.exec_primary_cmd(self.fmt_oc_cmd(cmd)) if res['status'] == 0: if self.get_option('role') == 'master': self.log_warn("NOTE: By default, only master nodes are listed." "\nTo collect from all/more nodes, override the " "role option with '-c ocp.role=role1:role2'") roles = list(self.get_option('role').split(':')) self.node_dict = self._build_dict(res['output'].splitlines()) for node_name, node in self.node_dict.items(): if roles: for role in roles: if role in node['roles']: nodes.append(node_name) break else: nodes.append(node_name) else: msg = "'oc' command failed" if 'Missing or incomplete' in res['output']: msg = ("'oc' failed due to missing kubeconfig on primary node." " Specify one via '-c ocp.kubeconfig=<path>'") raise Exception(msg) return nodes def set_node_label(self, node): if node.address not in self.node_dict: return '' for label in ['master', 'worker']: if label in self.node_dict[node.address]['roles']: return label return '' def check_node_is_primary(self, node): if node.address not in self.node_dict: return False return 'master' in self.node_dict[node.address]['roles'] def _toggle_api_opt(self, node, use_api): """In earlier versions of sos, the openshift plugin option that is used to toggle the API collections was called `no-oc` rather than `with-api`. This older plugin option had the inverse logic of the current `with-api` option. Use this to toggle the correct plugin option given the node's sos version. Note that the use of version 4.2 here is tied to the RHEL release (the only usecase for this cluster profile) rather than the upstream version given the backports for that downstream. :param node: The node being inspected for API collections :type node: ``SoSNode`` :param use_api: Should this node enable API collections? :type use_api: ``bool`` """ if node.check_sos_version('4.2-16'): _opt = 'with-api' _val = 'on' if use_api else 'off' else: _opt = 'no-oc' _val = 'off' if use_api else 'on' node.plugopts.append(f"openshift.{_opt}={_val}") def set_primary_options(self, node): node.enable_plugins.append('openshift') if not self.get_option('with-api'): self._toggle_api_opt(node, False) return if self.api_collect_enabled: # a primary has already been enabled for API collection, disable # it among others self._toggle_api_opt(node, False) else: # running in a container, so reference the /host mount point master_kube = ( '/host/etc/kubernetes/static-pod-resources/' 'kube-apiserver-certs/secrets/node-kubeconfigs/' 'localhost.kubeconfig' ) _optconfig = self.get_option('kubeconfig') if _optconfig and not _optconfig.startswith('/host'): _optconfig = '/host/' + _optconfig _kubeconfig = _optconfig or master_kube _oc_cmd = 'oc' if node.host.containerized: _oc_cmd = '/host/bin/oc' # when run from a container, the oc command does not inherit # the default config, so if it's present then pass it here to # detect a funcitonal oc command. This is sidestepped in sos # report by being able to chroot the `oc` execution which we # cannot do remotely if node.file_exists('/root/.kube/config', need_root=True): _oc_cmd += ' --kubeconfig /host/root/.kube/config' can_oc = node.run_command(f"{_oc_cmd} whoami", use_container=node.host.containerized, # container is available only to root # and if rhel, need to run sos as root # anyways which will run oc as root need_root=True) if can_oc['status'] == 0: # the primary node can already access the API self._toggle_api_opt(node, True) self.api_collect_enabled = True elif self.token: node.sos_env_vars['SOSOCPTOKEN'] = self.token self._toggle_api_opt(node, True) self.api_collect_enabled = True elif node.file_exists(_kubeconfig): # if the file exists, then the openshift sos plugin will use it # if the with-api option is turned on if _kubeconfig != master_kube: node.plugopts.append( f"openshift.kubeconfig={_kubeconfig}" ) self._toggle_api_opt(node, True) self.api_collect_enabled = True if self.api_collect_enabled: msg = (f"API collections will be performed on {node.address}\n" "Note: API collections may extend runtime by 10s of " "minutes\n") self.soslog.info(msg) self.ui_log.info(msg) def set_node_options(self, node): # don't attempt OC API collections on non-primary nodes self._toggle_api_opt(node, False) # vim: set et ts=4 sw=4 : ��openstack.py��0000644��00000005427�15027746175�0007133 0��ustar�00��# Copyright Red Hat 2022, Jake Hunsaker <jhunsake@redhat.com> # This file is part of the sos project: https://github.com/sosreport/sos # # This copyrighted material is made available to anyone wishing to use, # modify, copy, or redistribute it subject to the terms and conditions of # version 2 of the GNU General Public License. # # See the LICENSE file in the source distribution for further information. import yaml from sos.collector.clusters import Cluster INVENTORY = "/var/lib/mistral/overcloud/tripleo-ansible-inventory.yaml" class rhosp(Cluster): """ This cluster profile is for use with Red Hat OpenStack Platform environments. Different types of nodes may be enumerated by toggling the various profile options such as Controllers and Compute nodes. By default, only Controller nodes are enumerated. Node enumeration is done by inspecting the ansible inventory file used for deployment of the environment. This is canonically located at /var/lib/mistral/overcloud/tripleo-ansible-inventory.yaml. Similarly, the presence of this file on the primary node is what triggers the automatic enablement of this profile. Special consideration should be taken for where `sos collect` is being run from, in that the hostnames of the enumerated nodes must be resolveable from that system - not just from the primary node from which those nodes are discovered. If this is not possible, consider enabling the `use-ip` cluster option to instead have this profile source the IP addresses of the nodes in question. """ cluster_name = 'Red Hat OpenStack Platform' option_list = [ ('use-ip', False, 'use IP addresses instead of hostnames to connect'), ('controller', True, 'collect reports from controller nodes'), ('compute', False, 'collect reports from compute nodes') ] def check_enabled(self): return self.primary.file_exists(INVENTORY, need_root=True) def get_nodes(self): _nodes = [] _addr_field = ('external_ip' if self.get_option('use-ip') else 'ctlplane_hostname') try: _inv = yaml.safe_load(self.primary.read_file(INVENTORY)) except Exception as err: self.log_info(f"Error parsing yaml: {err}") raise Exception("Could not parse yaml for node addresses") from err try: for _t in ['Controller', 'Compute']: # fields are titled in the yaml, but our opts are lowercase if self.get_option(_t.lower()): for host in _inv[_t]['hosts'].keys(): _nodes.append(_inv[_t]['hosts'][host][_addr_field]) except Exception as err: self.log_error(f"Error getting {_t} host addresses: {err}") return _nodes ��__init__.py��0000644��00000037310�15027746175�0006677 0��ustar�00��# Copyright Red Hat 2020, Jake Hunsaker <jhunsake@redhat.com> # This file is part of the sos project: https://github.com/sosreport/sos # # This copyrighted material is made available to anyone wishing to use, # modify, copy, or redistribute it subject to the terms and conditions of # version 2 of the GNU General Public License. # # See the LICENSE file in the source distribution for further information. import logging from threading import Lock from sos.options import ClusterOption from sos.utilities import bold class Cluster(): """This is the class that cluster profiles should subclass in order to add support for different clustering technologies and environments to sos collect. A profile should at minimum define a package that indicates the node is configured for the type of cluster the profile is intended to serve and then additionally be able to return a list of enumerated nodes via the ``get_nodes()`` method :param commons: The commons dict containing system information. The same as what is handed to ``Plugin()`` :type commons: ``dict`` :cvar option_list: Options supported by the profile, and set by the --cluster-option cmdline arg :vartype option_list: ``list`` of ``tuples`` :cvar packages: What package(s) should this profile enable on :vartype packages: ``tuple`` :cvar sos_plugins: Which plugins to forcibly enable for node reports :vartype sos_plugins: ``list`` :cvar sos_options: Options to pass to report on every node :vartype sos_options: ``dict`` :cvar sos_plugin_options: Plugin options to forcibly set for nodes :vartype sos_plugin_options: ``dict`` :cvar sos_preset: A SoSReport preset to forcibly enable on nodes :vartype sos_preset: ``str`` :cvar cluster_name: The name of the cluster type :vartype cluster_name: ``str`` """ option_list = [] packages = ('',) sos_plugins = [] sos_options = {} sos_plugin_options = {} sos_preset = '' cluster_name = None # set this to True if the local host running collect should not be # forcibly added to the node list. This can be helpful in situations where # the host's fqdn and the name the cluster uses are different strict_node_list = False def __init__(self, commons): self.primary = None self.cluster_ssh_key = None self.tmpdir = commons['tmpdir'] self.opts = commons['cmdlineopts'] self.cluster_type = [self.__class__.__name__] for cls in self.__class__.__bases__: if cls.__name__ != 'Cluster': self.cluster_type.append(cls.__name__) self.node_list = None self.lock = Lock() self.soslog = logging.getLogger('sos') self.ui_log = logging.getLogger('sos_ui') self.options = [] self._get_options() @classmethod def name(cls): """Returns the cluster's name as a string. """ if cls.cluster_name: return cls.cluster_name return cls.__name__.lower() @classmethod def display_help(cls, section): # pylint: disable=too-many-branches if cls is Cluster: cls.display_self_help(section) return section.set_title(f"{cls.cluster_name} Cluster Profile Detailed Help") if cls.__doc__ and cls.__doc__ is not Cluster.__doc__: section.add_text(cls.__doc__) # [1] here is the actual cluster profile elif cls.__mro__[1].__doc__ and cls.__mro__[1] is not Cluster: section.add_text(cls.__mro__[1].__doc__) else: section.add_text( "\n\tDetailed help not available for this profile\n" ) if cls.packages: section.add_text( "Enabled by the following packages: " f"{', '.join(p for p in cls.packages)}", newline=False ) if cls.sos_preset: section.add_text( f"Uses the following sos preset: {cls.sos_preset}", newline=False ) if cls.sos_options: _opts = ', '.join(f'--{k} {v}' for k, v in cls.sos_options.items()) section.add_text(f"Sets the following sos options: {_opts}") if cls.sos_plugins: section.add_text( "Enables the following plugins: " f"{', '.join(plug for plug in cls.sos_plugins)}", newline=False ) if cls.sos_plugin_options: _opts = cls.sos_plugin_options opts = ', '.join(f"{k}={v}" for k, v in _opts.items()) section.add_text( f"Sets the following plugin options: {opts}", newline=False ) if cls.option_list: optsec = section.add_section("Available cluster options") optsec.add_text( "These options may be toggled or changed using " f"'{bold(f'-c {cls.__name__}.$option=$value')}'" ) optsec.add_text( bold( f"\n{' ':<4}{'Option Name':<20}{'Default':<30}" f"{'Description':<20}\n"), newline=False ) for opt in cls.option_list: val = opt[1] if isinstance(val, bool): if val: val = 'True/On' else: val = 'False/Off' _ln = f"{' ':<4}{opt[0]:<20}{val:<30}{opt[2]:<20}" optsec.add_text(_ln, newline=False) @classmethod def display_self_help(cls, section): section.set_title('SoS Collect Cluster Profiles Detailed Help') section.add_text( '\nCluster 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.' ) section.add_text( 'Cluster 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.' ) from sos.collector import SoSCollector import inspect clusters = SoSCollector._load_modules(inspect.getmodule(cls), 'clusters') section.add_text( 'The following cluster profiles are locally available:\n' ) section.add_text( f"{' ':>8}{'Name':<40}{'Description':<30}", newline=False ) for cluster in clusters: _sec = bold(f"collect.clusters.{cluster[0]}") section.add_text( f"{' ':>8}{_sec:<40}{cluster[1].cluster_name:<30}", newline=False ) def _get_options(self): """Loads the options defined by a cluster and sets the default value""" for opt in self.option_list: option = ClusterOption(name=opt[0], opt_type=opt[1].__class__, value=opt[1], cluster=self.cluster_type, description=opt[2]) self.options.append(option) def _fmt_msg(self, msg): return f'[{self.cluster_type[0]}] {msg}' def log_info(self, msg): """Used to print info messages""" self.soslog.info(self._fmt_msg(msg)) def log_error(self, msg): """Used to print error messages""" self.soslog.error(msg) def log_debug(self, msg): """Used to print debug messages""" self.soslog.debug(self._fmt_msg(msg)) def log_warn(self, msg): """Used to print warning messages""" self.soslog.warning(self._fmt_msg(msg)) def get_option(self, option): """ 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`` """ # check CLI before defaults for opt in self.opts.cluster_options: if opt.name == option and opt.cluster in self.cluster_type: return opt.value # provide defaults otherwise for opt in self.options: if opt.name == option: return opt.value return False def add_default_ssh_key(self, key): """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. """ self.cluster_ssh_key = key def set_node_options(self, node): """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`` """ def set_transport_type(self): """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. """ return 'control_persist' def set_primary_options(self, node): """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`` """ def check_node_is_primary(self, node): """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`` """ return node.address == self.primary.address def exec_primary_cmd(self, cmd, need_root=False, timeout=180, use_shell='auto'): """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`` """ res = self.primary.run_command(cmd, need_root=need_root, use_shell=use_shell, timeout=timeout) if res['output']: res['output'] = res['output'].replace('Password:', '') return res def setup(self): """ 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 """ def check_enabled(self): """ 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`` """ for pkg in self.packages: if self.primary.is_installed(pkg): return True return False def cleanup(self): """ 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 """ def get_nodes(self): """ 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`` """ raise NotImplementedError def _get_nodes(self): try: return self.format_node_list() except Exception as e: self.log_debug(f'Failed to get node list: {e}') return [] def get_node_label(self, node): """ 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 = self.set_node_label(node) node.manifest.add_field('label', label) return label def set_node_label(self, node): # pylint: disable=unused-argument """This 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 """ return '' def format_node_list(self): """ 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`` """ try: nodes = self.get_nodes() except Exception as err: raise Exception(f"Cluster failed to enumerate nodes: {err}") \ from err if isinstance(nodes, list): node_list = [n.strip() for n in nodes if n] elif isinstance(nodes, str): node_list = [n.split(',').strip() for n in nodes] else: raise Exception(f"Cluster returned unexpected node list: {nodes}") node_list = list(set(node_list)) for node in node_list: if node.startswith(('-', '_', '(', ')', '[', ']', '/', '\\')): node_list.remove(node) return node_list def _run_extra_cmd(self): """ 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 """ files = [] try: res = self.run_extra_cmd() if res: if not isinstance(res, list): res = [res] for extra_file in res: extra_file = extra_file.strip() files.append(extra_file) if 'sosreport' in extra_file: files.append(extra_file + '.md5') except AttributeError: # run_extra_cmd() not defined for cluster profile pass return files ��kubernetes.py��0000644��00000003500�15027746175�0007301 0��ustar�00��# Copyright Red Hat 2020, Jake Hunsaker <jhunsake@redhat.com> # This file is part of the sos project: https://github.com/sosreport/sos # # This copyrighted material is made available to anyone wishing to use, # modify, copy, or redistribute it subject to the terms and conditions of # version 2 of the GNU General Public License. # # See the LICENSE file in the source distribution for further information. from shlex import quote from sos.collector.clusters import Cluster class kubernetes(Cluster): """ The kuberentes cluster profile is intended to be used on kubernetes clusters built from the upstream/source kubernetes (k8s) project. It is not intended for use with other projects or platforms that are built ontop of kubernetes. """ cluster_name = 'Community Kubernetes' packages = ('kubernetes-master',) sos_plugins = ['kubernetes'] sos_plugin_options = {'kubernetes.all': 'on'} cmd = 'kubectl' option_list = [ ('label', '', 'Filter node list to those with matching label'), ('role', '', 'Filter node list to those with matching role') ] def get_nodes(self): self.cmd += ' get nodes' if self.get_option('label'): self.cmd += f' -l {quote(self.get_option("label"))} ' res = self.exec_primary_cmd(self.cmd) if res['status'] == 0: nodes = [] roles = [x for x in self.get_option('role').split(',') if x] for nodeln in res['output'].splitlines()[1:]: node = nodeln.split() if not roles: nodes.append(node[0]) else: if node[2] in roles: nodes.append(node[0]) return nodes raise Exception('Node enumeration did not return usable output') # vim: set et ts=4 sw=4 : ��

| ver. 1.4 | Github | . | PHP 8.2.28 | Generation time: 0.03 | proxy | phpinfo | Settings