Files
computer-playbook/cli/create/inventory/cli.py
T
kevinveenbirkenbachandClaude Sonnet 4.6 9d863f1ef4 feat(inventory): add SERVICES_DISABLED env var support and environment test flow
- Add services_disabler.py: parse SERVICES_DISABLED, disable services in host_vars,
  remove provider roles from inventory
- Wire apply_services_disabled_from_env into cli/create/inventory/cli.py after deploy
- Add unit tests for all services_disabler functions
- Update hardware.md and variables.md with SERVICES_DISABLED documentation
- Update environment.sh: deploy dashboard with SERVICES_DISABLED=matomo first,
  assert dashboard reachable + matomo not reachable, then deploy matomo and assert
  reachable; extract assert_http_status / assert_http_status_not helpers

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-29 15:00:24 +02:00

368 lines
12 KiB
Python

from __future__ import annotations
import argparse
import os
from pathlib import Path
from typing import Any, Dict, List, Optional
import sys
from .project import detect_project_root, build_env_with_project_root
from .yaml_io import load_yaml, dump_yaml
from .inventory_generator import generate_dynamic_inventory
from .filters import parse_roles_list, filter_dynamic_inventory
from .host_vars import (
ensure_host_vars_file,
ensure_become_password,
apply_vars_overrides,
apply_vars_overrides_from_file,
)
from .mirror_overrides import apply_mirror_overrides
from .services_disabler import apply_services_disabled_from_env
from .credentials_generator import generate_credentials_for_roles
from .passwords import generate_random_password
def _fatal(msg: str) -> None:
raise SystemExit(f"[FATAL] {msg}")
def _resolve_inventory_file(
inventory_dir: Path, inventory_file_arg: Optional[str]
) -> Path:
if inventory_file_arg:
return Path(inventory_file_arg).resolve()
return (inventory_dir / "devices.yml").resolve()
def _resolve_roles_dir(project_root: Path, roles_dir_arg: Optional[str]) -> Path:
return (
Path(roles_dir_arg) if roles_dir_arg else (project_root / "roles")
).resolve()
def _resolve_categories_file(
roles_dir: Path, categories_file_arg: Optional[str]
) -> Path:
return (
Path(categories_file_arg)
if categories_file_arg
else (roles_dir / "categories.yml")
).resolve()
def _resolve_mirrors_file(
project_root: Path, mirror_arg: Optional[str]
) -> Optional[Path]:
"""
--mirror can be used in two ways:
- --mirror -> uses <repo-root>/mirrors.yml
- --mirror /path/file -> uses the given path
If mirror_arg is None, mirroring is disabled.
"""
if mirror_arg is None:
return None
# argparse uses const="mirrors.yml" when flag is present without value
candidate = Path(mirror_arg)
if not candidate.is_absolute():
candidate = (project_root / candidate).resolve()
return candidate.resolve()
def main(argv: Optional[List[str]] = None) -> int:
parser = argparse.ArgumentParser(
description=(
"Create or update a full inventory for a host and generate credentials "
"for all selected applications."
)
)
parser.add_argument(
"inventory_dir", help="Inventory directory (e.g. inventories/galaxyserver)."
)
parser.add_argument(
"--host",
default="localhost",
help="Hostname to use in the inventory (default: localhost).",
)
parser.add_argument(
"--primary-domain",
default=None,
help="Primary domain for this host (optional).",
)
parser.add_argument(
"--ssl-disabled",
action="store_true",
help="Disable SSL for this host (sets TLS_ENABLED: false).",
)
parser.add_argument(
"--become-password", default=None, help="Optional become password (vaulted)."
)
parser.add_argument(
"--vars",
required=False,
help=(
"Optional JSON object string with additional values for host_vars/<host>.yml. "
"Merged and overwrites existing values."
),
)
parser.add_argument(
"--ip4", default="127.0.0.1", help="IPv4 address for networks.internet.ip4."
)
parser.add_argument(
"--ip6", default="::1", help="IPv6 address for networks.internet.ip6."
)
parser.add_argument(
"--inventory-file",
default=None,
help="Inventory YAML file path (default: <inventory-dir>/devices.yml).",
)
parser.add_argument(
"--roles",
nargs="+",
help="Legacy include list (used only if neither --include nor --exclude is set).",
)
parser.add_argument(
"--include",
nargs="+",
help="Only include these application_ids (mutually exclusive with --exclude).",
)
parser.add_argument(
"--exclude",
nargs="+",
help="Exclude these application_ids (mutually exclusive with --include).",
)
parser.add_argument(
"--vault-password-file",
default=None,
help="Vault password file path. Default: <inventory-dir>/.password",
)
parser.add_argument(
"--roles-dir", default=None, help="Path to roles/ (default: <repo-root>/roles)."
)
parser.add_argument(
"--categories-file",
default=None,
help="Path to roles/categories.yml (default: <roles-dir>/categories.yml).",
)
parser.add_argument(
"--workers",
type=int,
default=4,
help="Worker threads for credentials generation (default: 4).",
)
parser.add_argument(
"--vars-file",
default=None,
help=(
"Optional YAML file with additional values for host_vars/<host>.yml. "
"Merged and overwrites existing values."
),
)
# New: mirroring support
parser.add_argument(
"--mirror",
nargs="?",
const="mirrors.yml",
default=None,
help=(
"Apply docker image mirror overrides to host_vars applications.*.compose.services.* "
"(image/version). If used without value, defaults to <repo-root>/mirrors.yml. "
"If a value is provided, it is treated as a path to the mirrors YAML/JSON file."
),
)
args = parser.parse_args(argv)
include_filter = parse_roles_list(args.include)
exclude_filter = parse_roles_list(args.exclude)
legacy_roles_filter = parse_roles_list(args.roles)
if include_filter and exclude_filter:
_fatal(
"Options --include and --exclude are mutually exclusive. Use only one of them."
)
project_root = detect_project_root(Path(__file__).resolve())
env = build_env_with_project_root(project_root)
roles_dir = _resolve_roles_dir(project_root, args.roles_dir)
categories_file = _resolve_categories_file(roles_dir, args.categories_file)
mirrors_file = _resolve_mirrors_file(project_root, args.mirror)
inventory_dir = Path(args.inventory_dir).resolve()
inventory_dir.mkdir(parents=True, exist_ok=True)
inventory_file = _resolve_inventory_file(inventory_dir, args.inventory_file)
host_vars_file = (inventory_dir / "host_vars" / f"{args.host}.yml").resolve()
# Vault password file
if args.vault_password_file:
vault_password_file = Path(args.vault_password_file).resolve()
else:
vault_password_file = (inventory_dir / ".password").resolve()
if not vault_password_file.exists():
print(
f"[INFO] No --vault-password-file provided. Creating {vault_password_file} ..."
)
vault_password_file.parent.mkdir(parents=True, exist_ok=True)
password = generate_random_password()
fd = os.open(
str(vault_password_file), os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o600
)
with os.fdopen(fd, "w", encoding="utf-8") as f:
f.write(password + "\n")
try:
vault_password_file.chmod(0o600)
except PermissionError:
print(
f"[WARN] Could not set permissions to 0o600 on {vault_password_file}.",
file=sys.stderr,
)
else:
print(f"[INFO] Using existing vault password file: {vault_password_file}")
tmp_inventory = (inventory_dir / "_inventory_full_tmp.yml").resolve()
print(
"[INFO] Generating dynamic inventory via python -m cli.build.inventory.full ..."
)
dyn_inv = generate_dynamic_inventory(
host=args.host,
roles_dir=roles_dir,
categories_file=categories_file,
tmp_inventory=tmp_inventory,
project_root=project_root,
env=env,
)
dyn_inv = filter_dynamic_inventory(
dyn_inv,
include_filter=include_filter,
exclude_filter=exclude_filter,
legacy_roles_filter=legacy_roles_filter,
)
dyn_children = (dyn_inv.get("all", {}) or {}).get("children", {}) or {}
application_ids = sorted(dyn_children.keys())
# Merge inventory file
if inventory_file.exists():
print(f"[INFO] Merging into existing inventory: {inventory_file}")
base_inv = load_yaml(inventory_file)
else:
print(f"[INFO] Creating new inventory file: {inventory_file}")
base_inv = {}
merged_inv = _merge_inventories(base_inv, dyn_inv, host=args.host)
dump_yaml(inventory_file, merged_inv)
# Host vars
print(f"[INFO] Ensuring host_vars for host '{args.host}' at {host_vars_file}")
ensure_host_vars_file(
host_vars_file=host_vars_file,
host=args.host,
primary_domain=args.primary_domain,
ssl_disabled=args.ssl_disabled,
ip4=args.ip4,
ip6=args.ip6,
)
print(f"[INFO] Ensuring ansible_become_password for host '{args.host}'")
ensure_become_password(
host_vars_file=host_vars_file,
vault_password_file=vault_password_file,
become_password=args.become_password,
)
# Credentials
if application_ids:
print(
f"[INFO] Generating credentials for {len(application_ids)} applications..."
)
generate_credentials_for_roles(
application_ids=application_ids,
roles_dir=roles_dir,
host_vars_file=host_vars_file,
vault_password_file=vault_password_file,
project_root=project_root,
env=env,
workers=args.workers,
)
else:
print(
"[WARN] No application_ids found after filtering. Skipping credentials generation."
)
if args.vars_file:
print(
f"[INFO] Applying YAML overrides to host_vars for host '{args.host}' via --vars-file"
)
apply_vars_overrides_from_file(
host_vars_file=host_vars_file, vars_file=Path(args.vars_file).resolve()
)
if args.vars:
print(
f"[INFO] Applying JSON overrides to host_vars for host '{args.host}' via --vars"
)
apply_vars_overrides(host_vars_file=host_vars_file, json_str=args.vars)
# Mirror overrides should win (requested behavior: "überschreiben")
if mirrors_file is not None:
print(f"[INFO] Applying mirror overrides from: {mirrors_file}")
apply_mirror_overrides(host_vars_file=host_vars_file, mirrors_file=mirrors_file)
# Disable services listed in SERVICES_DISABLED env var (space- or comma-separated).
# Also removes the provider roles from the inventory.
apply_services_disabled_from_env(
host_vars_file=host_vars_file,
inventory_file=inventory_file,
roles_dir=roles_dir,
)
print(
"[INFO] Done. Inventory and host_vars updated without deleting existing values."
)
return 0
def _merge_inventories(
base: Dict[str, Any], new: Dict[str, Any], host: str
) -> Dict[str, Any]:
"""
Merge `new` inventory into `base` inventory without deleting existing groups/hosts/vars.
For each group in `new`:
- ensure the group exists in `base`
- ensure `hosts` exists
- ensure the given `host` is present in that group's `hosts`
"""
base_all = base.setdefault("all", {})
base_children = base_all.setdefault("children", {})
new_all = new.get("all", {})
new_children = (
(new_all.get("children", {}) or {}) if isinstance(new_all, dict) else {}
)
for group_name, group_data in new_children.items():
base_group = base_children.setdefault(group_name, {})
base_hosts = base_group.setdefault("hosts", {})
new_hosts = (group_data or {}).get("hosts", {}) or {}
host_vars: Dict[str, Any] = {}
if isinstance(new_hosts, dict) and host in new_hosts:
hv = new_hosts.get(host) or {}
if isinstance(hv, dict):
host_vars = hv
if host not in base_hosts:
base_hosts[host] = host_vars or {}
return base