# Copyright (C) 2021 Red Hat, Inc., Pavel Moravec # 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 re import match from shlex import quote from sos.report.plugins import Plugin, IndependentPlugin, PluginOpt class PulpCore(Plugin, IndependentPlugin): short_desc = 'Pulp-3 aka pulpcore' plugin_name = "pulpcore" commands = ("pulpcore-manager",) files = ("/etc/pulp/settings.py",) containers = ("pulp-api", "pulp-content", "pulp-worker-.*") option_list = [ PluginOpt('task-days', default=7, desc='days of task history') ] dbhost = "localhost" dbport = 5432 dbname = "pulpcore" dbuser = "pulp" dbpasswd = "" staticroot = "/var/lib/pulp/assets" uploaddir = "/var/lib/pulp/tmp" env = {"PGPASSWORD": dbpasswd} settings_file = "/etc/pulp/settings.py" def parse_settings_config(self): """ Parse pulp settings """ databases_scope = False def separate_value(line, sep=':'): # an auxiliary method to parse values from lines like: # 'HOST': 'localhost', val = line.split(sep)[1].lstrip().rstrip(',') if (val.startswith('"') and val.endswith('"')) or \ (val.startswith('\'') and val.endswith('\'')): val = val[1:-1] return val try: with open(self.settings_file, 'r', encoding='UTF-8') as file: # split the lines to "one option per line" format for line in file.read() \ .replace(',', ',\n').replace('{', '{\n') \ .replace('}', '\n}').splitlines(): # skip empty lines and lines with comments if not line or line[0] == '#': continue if line.startswith("DATABASES"): databases_scope = True continue # example HOST line to parse: # 'HOST': 'localhost', pattern = r"\s*['|\"]%s['|\"]\s*:\s*\S+" if databases_scope and match(pattern % 'HOST', line): self.dbhost = separate_value(line) if databases_scope and match(pattern % 'PORT', line): self.dbport = separate_value(line) if databases_scope and match(pattern % 'NAME', line): self.dbname = separate_value(line) if databases_scope and match(pattern % 'USER', line): self.dbuser = separate_value(line) if databases_scope and match(pattern % 'PASSWORD', line): self.dbpasswd = separate_value(line) # if line contains closing '}' database_scope end if databases_scope and '}' in line: databases_scope = False if line.startswith("STATIC_ROOT = "): self.staticroot = separate_value(line, sep='=') if line.startswith("CHUNKED_UPLOAD_DIR = "): self.uploaddir = separate_value(line, sep='=') except IOError: # fallback when the cfg file is not accessible pass def parse_pod_config(self): # get PULP_DATABASES__default__* env variables from a json list def _env_to_dict(env_list): return dict( item.split('=', 1) for item in env_list if isinstance(item, str) and item.startswith("PULP_DATABASES__default__") and '=' in item ) pod_inspect = self.exec_cmd( f"podman inspect {self.pulp_container} " "--format='{{json .Config.Env}}'" ) if pod_inspect['status'] == 0: env_list = json.loads(pod_inspect['output']) env = _env_to_dict(env_list) self.dbname = env.get('PULP_DATABASES__default__NAME', '') self.dbhost = env.get('PULP_DATABASES__default__HOST', '') self.dbuser = env.get('PULP_DATABASES__default__USER', '') self.dbport = env.get('PULP_DATABASES__default__PORT', '') pod_secret = self.exec_cmd( "podman secret inspect --showsecret " "--format '{{.SecretData}}' pulp-db-password") self.dbpasswd = pod_secret['output'].strip() def setup(self): self.runas = None self.rhui_container = self.pulp_container = self.psql_container = None rhui_podman_ps = self.exec_cmd("podman ps --filter name=rhui5-rhua", runas="rhui") # check for RHUI deployments if rhui_podman_ps['status'] == 0: lines = rhui_podman_ps['output'].splitlines() if len(lines) > 1: # we know there is a container of given name self.runas = 'rhui' self.rhui_container = 'rhui5-rhua' self.settings_file = '/var/lib/rhui/config/pulp/settings.py' else: # check for foremanctl deployments pattern = "|".join(f"(?:{p})" for p in self.containers) pulp_containers = self.get_all_containers_by_regex(pattern, get_all=True) if pulp_containers: self.pulp_container = pulp_containers[0][1] self.psql_container = 'postgresql' for cont in self.containers: # convert python RE to systemd style self.add_journal(units=[ f"{cont.replace('-.*', '@*')}.service"]) # get psql config - different for foremanctl / pulp-* container if self.pulp_container: self.parse_pod_config() else: self.parse_settings_config() # set the password to os.environ when calling psql commands to prevent # printing it in sos logs # we can't set os.environ directly now: other plugins can overwrite it self.env = {"PGPASSWORD": self.dbpasswd} self.add_copy_spec([ "/etc/pulp/settings.py", "/etc/pki/pulp/*" ], runas=self.runas, container=self.rhui_container) # skip collecting certificate keys self.add_forbidden_path("/etc/pki/pulp/**/*.key") self.add_cmd_output("curl -ks https://localhost/pulp/api/v3/status/", suggest_filename="pulp_status", runas=self.runas, container=self.rhui_container) dynaconf_env = {"LC_ALL": "en_US.UTF-8", "PULP_SETTINGS": "/etc/pulp/settings.py", "DJANGO_SETTINGS_MODULE": "pulpcore.app.settings"} self.add_cmd_output("dynaconf list", env=dynaconf_env, runas=self.runas, container=self.rhui_container or self.pulp_container, suggest_filename='dynaconf_list') for _dir in [self.staticroot, self.uploaddir]: self.add_dir_listing(_dir, runas=self.runas, container=self.rhui_container or self.pulp_container) task_days = self.get_option('task-days') for table in ['core_task', 'core_taskgroup', 'core_groupprogressreport', 'core_progressreport']: _query = ("COPY (SELECT STRING_AGG(column_name, ', ') FROM " f"information_schema.columns WHERE table_name='{table}'" "AND table_schema = 'public' AND column_name NOT IN" " ('args', 'kwargs', 'enc_args', 'enc_kwargs'))" " TO STDOUT;") col_out = self.exec_cmd(self.build_query_cmd(_query, csv=False), env=self.env, runas=self.runas, container=self.rhui_container or self.psql_container) columns = col_out['output'] if col_out['status'] == 0 else '*' _query = (f"select {columns} from {table} where pulp_last_updated" f"> NOW() - interval '{task_days} days' order by" " pulp_last_updated") _cmd = self.build_query_cmd(_query, csv=True) self.add_cmd_output(_cmd, env=self.env, suggest_filename=table, runas=self.runas, container=self.rhui_container or self.psql_container) # collect tables sizes, ordered _cmd = self.build_query_cmd( "SELECT table_name, pg_size_pretty(total_bytes) AS total, " "pg_size_pretty(index_bytes) AS INDEX , " "pg_size_pretty(toast_bytes) AS toast, pg_size_pretty(table_bytes)" " AS TABLE FROM ( SELECT *, " "total_bytes-index_bytes-COALESCE(toast_bytes,0) AS table_bytes " "FROM (SELECT c.oid,nspname AS table_schema, relname AS " "TABLE_NAME, c.reltuples AS row_estimate, " "pg_total_relation_size(c.oid) AS total_bytes, " "pg_indexes_size(c.oid) AS index_bytes, " "pg_total_relation_size(reltoastrelid) AS toast_bytes " "FROM pg_class c LEFT JOIN pg_namespace n ON " "n.oid = c.relnamespace WHERE relkind = 'r') a) a order by " "total_bytes DESC", csv=False ) self.add_cmd_output(_cmd, suggest_filename='pulpcore_db_tables_sizes', env=self.env, runas=self.runas, container=self.rhui_container or self.psql_container) def build_query_cmd(self, query, csv=False): """ Builds the command needed to invoke the pgsql query as the postgres user. The query requires significant quoting work to satisfy both the shell and postgres parsing requirements. Note that this will generate a large amount of quoting in sos logs referencing the command being run """ if csv: query = f"COPY ({query}) TO STDOUT " \ "WITH (FORMAT 'csv', DELIMITER ';', HEADER)" _dbcmd = "psql --no-password -h %s -p %s -U %s -d %s -c %s" return _dbcmd % (self.dbhost, self.dbport, self.dbuser, self.dbname, quote(query)) def postproc(self): # obfuscate from /etc/pulp/settings.py and "dynaconf list": # SECRET_KEY = "eKfeDkTnvss7p5WFqYdGPWxXfHnsbDBx" # 'PASSWORD': 'tGrag2DmtLqKLTWTQ6U68f6MAhbqZVQj', # AUTH_LDAP_BIND_PASSWORD = 'ouch-a-secret' # and also one-liners like # 'SECRET_KEY': 'dontreadit', "PASSWORD": "c0nf1d3nt1al", reg = r"((SECRET_KEY|AUTH_LDAP_BIND_PASSWORD|password|PASSWORD)" \ r"(\"|'|:|=|\s)+)([^\s'\"]+)" repl = r"\1********" self.do_path_regex_sub("/etc/pulp/settings.py", reg, repl) self.do_cmd_output_sub("dynaconf list", reg, repl) # vim: set et ts=4 sw=4 :