Files
computer-playbook/cli/create/inventory/cli.py
T
kevinveenbirkenbachandClaude Opus 4.7 ed04dad5d5 refactor(meta): land req-008/009/010 role-meta layout/networks/ports/run_after migration
Single atomic landing for three back-to-back role-meta refactor requirements
(see docs/requirements/008-role-meta-layout.md, 009-per-role-networks-and-ports.md,
010-role-meta-runafter-lifecycle-migration.md).

req-008 — role meta layout
  * Move every role's metadata under meta/<topic>.yml with file-root
    convention (no wrapping key matching the basename):
      - schema/main.yml + config/main.yml.credentials → meta/schema.yml
      - users/main.yml                                → meta/users.yml
      - config/main.yml.server                        → meta/server.yml
      - config/main.yml.rbac                          → meta/rbac.yml
      - config/main.yml.compose.services + every other top-level key
        of config/main.yml inlined under <entity>.<key>
                                                      → meta/services.yml
      - config/main.yml.compose.volumes               → meta/volumes.yml
  * Drop the legacy schema/, users/, config/ directories from every role.
  * meta/schema.yml: support nested credential keys, optional `default:`
    field (Jinja literal, not rendered/validated/regenerated), implicit
    `algorithm: plain`.
  * Materialised paths drop the `compose.` prefix:
      compose.services.<e>.<…> → services.<e>.<…>
      compose.volumes.<k>      → volumes.<k>
      <former-top-level>.<…>   → services.<entity_name>.<former-top-level>.<…>
  * Update every Python consumer (utils/cache, utils/manager, utils/applications,
    plugins/lookup, plugins/filter, cli/*) plus every Jinja template, vars/*.yml
    and task file to the new paths.
  * No legacy fallback. Repository-wide grep for `compose.services.` /
    `compose.volumes.` / `schema/main.yml` / `users/main.yml` / `config/main.yml`
    is empty outside docs/requirements/ and tasks/utils/migrate_meta_layout.py.
  * Add tests/lint/repository/test_role_meta_layout.py guarding against the
    old paths returning, and an explicit lint guard that meta/variants.yml
    files do not carry a `compose:` wrapper.

req-009 — per-role networks/ports
  * Move group_vars/all/08_networks.yml.defaults_networks.local.<role>.{subnet,
    dns_resolver} into roles/<role>/meta/server.yml.networks.local.{subnet,
    dns_resolver}.
  * Delete group_vars/all/09_ports.yml entirely; ports now live on the
    service entity that exposes them at
    roles/<role>/meta/services.yml.<entity>.ports.{inter,local,public}.
  * Rename + int-cast every former top-level `services.<entity>.port`
    field to `services.<entity>.ports.inter` (single int).
  * Always-category-keyed maps for ports.local / ports.public; relay
    spans use {start, end} integers.
  * Add PORT_BANDS map to group_vars/all/08_networks.yml — single source
    of truth for the per-<scope>.<category> band ranges, consumed by both
    the new CLI helpers and the lint test.
  * New CLI helpers (cli meta ports suggest, cli meta networks suggest)
    walk the live role tree gap-first then increment-fallback, with
    deterministic output and non-zero exit on capacity overflow.
  * cli create role consumes both helpers when scaffolding a new role.
  * Lint extensions: bare-int port shape rejection, host-bound port
    collision check (single ints + relay span integers, inter excluded),
    band-membership check with documented allow-list for the legacy
    web-app-bigbluebutton.bigbluebutton.local.http: 48087 entry.

req-010 — run_after / lifecycle migration
  * Move galaxy_info.run_after and galaxy_info.lifecycle out of
    meta/main.yml into meta/services.yml.<primary_entity>.{run_after,
    lifecycle}; <primary_entity> is the value returned by
    get_entity_name(role_name).
  * For multi-entity roles whose primary entity has no compose service
    (web-app-bluesky → bluesky, web-app-matrix → matrix, desk/dev/drv/
    gen roles), create a dedicated metadata-only top-level entry under
    <primary_entity>.
  * Introduce utils/roles/meta_lookup.py with get_role_run_after /
    get_role_lifecycle that resolve <primary_entity> once and read from
    meta/services.yml; degrade gracefully when meta/services.yml is
    absent OR the field is absent; raise MetaServicesShapeError when the
    file exists but is malformed.
  * Update every consumer (utils/service_registry, utils/invokable,
    cli/meta/applications/resolution/run_after/__main__, cli/meta/roles/
    lifecycle_filter/__main__, cli/meta/applications/resolution/combined,
    cli/build/{tree,graph,role_include}, cli/deploy/development/{common,
    init,deps,deploy}, plugins/filter/canonical_domains_map, etc.) to
    use the helper.
  * Lint guards: no run_after/lifecycle in meta/main.yml; lifecycle
    values restricted to {planned,pre-alpha,alpha,beta,stable,deprecated};
    run_after/lifecycle never on a non-primary entity; empty run_after
    lists rejected.

Also folded into this change set
  * services_disabler now writes `services.<svc>.{enabled,shared}` into
    host_vars instead of the old `compose.services.<svc>.{...}` path; the
    discover/find pair walks meta/services.yml and only treats entries
    carrying enabled/shared/provides as provider declarations (so
    metadata-only entries from req-010 do not create spurious provider
    rows).
  * service_registry skips `run_after` deps whose target was filtered
    out via SERVICES_DISABLED instead of failing the whole load.
  * cli/mirror/resolver and cli/create/inventory/mirror_overrides emit/
    consume the new applications.<role>.services.<svc>.image shape
    (mirror.md updated to match).
  * utils/domains/list.build_applications_from_roles now reads
    meta/server.yml directly (it had been silently returning {} since
    config/main.yml stopped existing).
  * utils/roles/resource_validation.filter_roles_by_min_storage reads
    meta/services.yml.<entity>.min_storage instead of the legacy
    compose.services path.
  * web-app-bluesky pre-clones the social-app build context BEFORE
    sys-svc-compose so the build context is on disk by the time
    sys-stk-front-proxy/tasks/main.yml flushes the docker build handler.
  * 4 meta/variants.yml files (svc-ai-ollama, web-app-phpmyadmin,
    web-app-wordpress, web-app-keycloak) lose their `compose: services:`
    wrapper so deep-merge over meta/services.yml lands on the new
    file-root shape.

Validation
  * Unit tests:        1571 passed.
  * Lint tests:        50 passed.
  * Integration tests: 161 passed (1 skipped).
  * Full-cycle fresh-purged-apps deploy succeeded for the 8-app validation
    set: web-app-{nextcloud,wordpress,yourls,bigbluebutton,bluesky,gitea,
    discourse,mattermost}.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-27 09:58:26 +02:00

369 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.*.services.* and images_overrides.*.* "
"(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