Uyuni Health Check Tool Disconnected Solution

health-check/.gitignore

@@ -0,0 +1,12 @@
+build
+dist
+.eggs
+*.egg-info
+logcli-linux-amd64
+promtail-linux-amd64
+__pycache__
+**/config/exporter/config.yaml
+**/config/promtail/config.yaml
+**/config/grafana/dashboards/supportconfig_with_logs.json
+
+.vscode/

health-check/README.md

@@ -0,0 +1,41 @@
+### uyuni-health-check
+
+A tool providing dashboard, metrics and logs from an Uyuni server supportconfig to visualise its health status.
+
+## Requirements
+
+* `python3`
+* `podman`
+
+## Building and installing
+
+Install the tool locally into a virtual environment:
+
+```
+python3 -m venv venv
+. venv/bin/activate
+pip install .
+```
+
+## Getting started
+
+This tool builds and deploys the necessary containers to scrape some metrics and logs from an Uyuni server supportconfig directory.
+Execute the `run` phase of the tool as such:
+
+```
+uyuni-health-check -s ~/path/to/supportconfig run --logs --from_datetime=2024-01-01T00:00:00Z --to_datetime=2024-06-01T20:00:00Z
+```
+
+This will create and start the following containers locally:
+
+- uyuni-health-exporter (port `9000`)
+- grafana (port `3000`)
+- loki (port `9100`)
+- promtail (port `9081`)
+
+After you start the containers, visit `localhost:3000` and select the `Supportconfig with Logs` dashboard.
+If necessary, the default username/password for Grafana is `admin:admin`.
+
+## Security notes
+After running this tool, and until containers are destroyed, the Grafana Dashboards (and other metrics) are exposing metrics and logs messages that may contain sensitive data and information to any non-root user in the system or to anyone that have access to this host in the network.
+

health-check/pyproject.toml

@@ -0,0 +1,44 @@
+# SPDX-FileCopyrightText: 2023 SUSE LLC
+#
+# SPDX-License-Identifier: Apache-2.0
+
+[project]
+name = "uyuni-health-check"
+description = "Show Uyuni server health metrics and logs"
+readme = "README.md"
+requires-python = ">=3.6"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "Click",
+    "rich",
+    "requests",
+    "Jinja2",
+    "PyYAML",
+    "tomli",
+]
+maintainers = [
+    {name = "Pablo Suárez Hernández", email = "[email protected]"},
+]
+dynamic = ["version"]
+
+[project.urls]
+homepage = "https://github.com/uyuni-project/uyuni"
+tracker =  "https://github.com/uyuni-project/uyuni/issues"
+
+[project.scripts]
+uyuni-health-check = "uyuni_health_check.main:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[build-system]
+requires = [
+    "setuptools>=42",
+    "setuptools_scm[toml]",
+    "wheel",
+]
+build-backend = "setuptools.build_meta"
+

health-check/src/uyuni_health_check/config.py

@@ -0,0 +1,72 @@
+import functools
+import os
+from typing import Any, Dict
+import tomli
+from pathlib import Path
+import json
+import jinja2
+
+BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+CONFIG_DIR = os.path.join(BASE_DIR, "config")
+TEMPLATES_DIR = os.path.join(CONFIG_DIR, "templates")
+CONTAINERS_DIR = os.path.join(BASE_DIR, "containers")
+CONFIG_TOML_PATH = os.environ.get("HEALTH_CHECK_TOML", os.path.join(BASE_DIR, "config.toml"))
+
+@functools.lru_cache
+def _init_jinja_env() -> jinja2.Environment:
+    return jinja2.Environment(loader=jinja2.FileSystemLoader(TEMPLATES_DIR))
+
+@functools.lru_cache
+def parse_config() -> Dict:
+    if not os.path.exists(CONFIG_TOML_PATH):
+        raise ValueError(f"Config file does not exist: {CONFIG_TOML_PATH}")
+
+    with open(CONFIG_TOML_PATH, "rb") as f:
+        conf = tomli.load(f)
+    return conf
+
+def get_json_template_filepath(json_relative_path: str) -> str:
+    return os.path.join(TEMPLATES_DIR, json_relative_path)
+
+def load_jinja_template(template: str) -> jinja2.Template:
+    return _init_jinja_env().get_template(template)
+
+def load_dockerfile_dir(dockerfile_dir: str) -> str:
+    return os.path.join(CONTAINERS_DIR, dockerfile_dir)
+
+def get_config_dir_path(component: str) -> str:
+    return os.path.join(CONFIG_DIR, component)
+
+def load_prop(property: str) -> Any:
+    res = parse_config().copy()
+    for prop_part in property.split('.'):
+        try:
+            res = res[prop_part]
+        except Exception as e:
+            raise ValueError(
+                f"Invalid config lookup ({property}); trying to get {prop_part} from {res}"
+            ) from e
+    return res
+
+def write_config(component: str, config_file_path: str, content: str, is_json=False):
+    basedir = Path(get_config_dir_path(component))
+    if not basedir.exists():
+        basedir.mkdir(parents=True)
+    file_path = os.path.join(basedir, config_file_path)
+    with open(file_path, "w") as file:
+        if is_json:
+            json.dump(content, file, indent=4)
+        else:
+            file.write(content)
+
+def get_config_file_path(component):
+    return os.path.join(get_config_dir_path(component), "config.yaml")
+
+def get_sources_dir(component):
+    return os.path.join(BASE_DIR, component)
+
+def get_grafana_config_dir():
+    return os.path.join(CONFIG_DIR, "grafana")
+
+def get_prometheus_config_dir():
+    return os.path.join(CONFIG_DIR, "prometheus")

health-check/src/uyuni_health_check/config.toml

@@ -0,0 +1,11 @@
+[podman]
+network_name = "health-check-network"
+
+[loki]
+loki_container_name = "uyuni_health_check_loki"
+loki_port = 3100
+jobs = ["cobbler", "postgresql", "rhn", "apache"]
+
+[logcli]
+logcli_container_name = "uyuni_health_check_logcli"
+logcli_image_name = "logcli"