personal_infra/ansible/roles/caddy_site
counterweight 954b683c71
ansible: delete the duplicated vars files, move globals to group_vars/all
Three files existed only as second copies of things group_vars/all already
auto-loads, and 34 playbooks named them in vars_files: - which outranks
group_vars, so the copies won. The day someone edited one and not the other,
those plays would silently keep the stale value. infra_vars.yml was already
drifting: group_vars/all/main.yml had grown age_backup_recipient and
backup_pull_public_key that it lacked.

  infra_vars.yml          - a strict subset of group_vars/all/main.yml
  infra_secrets.yml       - decrypts byte-identical to group_vars/all/vault.yml
  infra_secrets.yml.example - documented Uptime Kuma credentials as the reason
                              the file exists, which stopped being true

Deleted, along with 62 vars_files entries across 34 playbooks (12 of which
named ../../group_vars/all/main.yml directly - same defect, a vars_files entry
duplicating an auto-loaded file at higher precedence than the file itself).

Checked before touching anything: infra_secrets.yml was listed LAST in 10 plays,
after services_config.yml, so removal would flip precedence if the two shared a
key. They share none, and neither does services_config.yml with
group_vars/all/main.yml, so the removal is provably inert.

services_config.yml was the last one standing. It held four unrelated things:

  caddy_sites_dir            - an identical copy of roles/caddy_site/defaults/.
                               Deleted; the role default is now the only one.
  *.tailscale_hostname (x3)  - a THIRD copy of each box's identity, which
                               inventory.ini already holds as ansible_host.
                               Deleted. Edge plays now read
                               hostvars['<host>'].ansible_host - verified an
                               edge play resolves that with nothing loaded and
                               the other host in no play. Three copies of one
                               name is how bitcoin_rpc_host ended up labelled
                               "knots_box" while pointing at fulcrum-box.
  subdomains, ntfy topic,    - genuinely global: their readers span managed,
  headscale namespace          monitoring, vpn_control and edge, so no single
                               group covers them. Moved to group_vars/all/main.yml
                               where they auto-load. The ntfy_topic and
                               headscale_namespace indirection through
                               service_settings collapses to the global name.
  the four cross-host ports  - the only entries with a real justification.
                               Left in place; they move in the next commit.

Also dead, all Uptime Kuma residue or duplication:
  phoenixd_monitor_name, forgejo_runner healthcheck_timeout_seconds/retries,
  fulcrum_tailscale_hostname, and bitcoin_knots_version - the last being a
  v-prefixed copy of bitcoin_knots_version_short that nothing read, two
  hand-maintained copies of one version string.

Corrected a false comment: services_config.yml claimed the uptime_kuma subdomain
"no longer resolves to anything". It resolves to 164.92.239.72 and answers HTTP
302, and 11 playbooks still template it. Same wrong premise as PLAN_3.

Verification: all 37 playbooks' --list-tasks output is byte-identical before and
after. A probe resolving all 22 values services_config.yml used to supply returns
21 identical and one intended deletion (caddy_sites_dir, now role-only - confirmed
the role still resolves it: "Ensure Caddy sites-enabled directory exists" comes
back ok against the real path). memos check-diff identical before and after.
Syntax passes on every playbook.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-13 20:58:46 +02:00
..
defaults ansible: delete the duplicated vars files, move globals to group_vars/all 2026-09-13 20:58:46 +02:00
handlers ntfy, datum-gateway, headscale: use the caddy_site role 2026-09-11 23:37:38 +02:00
tasks caddy: add the caddy_site role 2026-09-11 23:10:43 +02:00
templates caddy: add the caddy_site role 2026-09-11 23:10:43 +02:00
README.md caddy: close out Plan 4 2026-09-11 23:53:09 +02:00

caddy_site

Writes one Caddy site file into {{ caddy_sites_dir }}, makes sure the main Caddyfile imports that directory, validates the result, and reloads Caddy once.

Replaces the four-task block that was copy-pasted into 10 playbooks.

Runs on any host in the [caddy] group — edge (vipy), monitoring (watchtower) and vpn_control (spacey).

Usage

- ansible.builtin.include_role:
    name: caddy_site
  vars:
    caddy_site_name: forgejo                     # -> forgejo.conf
    caddy_site_domain: "{{ forgejo_domain }}"
    caddy_site_upstream: "localhost:{{ forgejo_port }}"

Use include_role, not a roles: block, so the call stays in task order next to the tasks it depends on. Variables passed this way are scoped to the include and do not leak into later calls — so every call must pass everything it needs; nothing carries over.

Shapes

Pick exactly one of caddy_site_upstream, caddy_site_root, caddy_site_body.

Want Set
reverse_proxy host:port caddy_site_upstream
static root * + file_server caddy_site_root
anything else caddy_site_body (raw, indented 4 for you)

caddy_site_upstream accepts two modifiers, which add a block to the reverse_proxy:

  • caddy_site_headers_up: {"X-Forwarded-Host": "..."}
  • caddy_site_resolvers: "100.100.100.100" — Tailscale MagicDNS

and caddy_site_basic_auth wraps the site in a basic_auth block.

caddy_site_basic_auth is a LIST, not a dict

caddy_site_basic_auth:
  - user: "{{ datum_dashboard_username }}"
    hash: "{{ datum_dashboard_password_hash }}"

Ansible does not template dictionary keys. With { "{{ user }}": "hash" } the value is rendered and the key is not, so the literal string {{ datum_dashboard_username }} lands in the config file. Found while building this role; the assert refuses a mapping so it cannot happen again.

Secrets and --diff

Rendered site files can carry credentials — datum-gateway.conf holds a bcrypt hash — and --diff prints rendered content. The template task therefore sets diff: "{{ caddy_site_reveal | bool }}", default false, so --diff runs are safe everywhere. Pass -e caddy_site_reveal=true to see what moved on a site you know is not secret.

Validation

validate: "caddy validate --adapter caddyfile --config %s" runs against the rendered temp file before it is moved into place. Verified on vipy that a single site fragment validates cleanly (rc=0, Valid configuration) and that a malformed one is rejected (rc=1, with the syntax error and line number). A failed validate leaves the live file untouched, so a broken config can no longer reach a running Caddy.

What it cannot catch is a conflict with the global /etc/caddy/Caddyfile.

The reload is a handler

Reload caddy fires once, at the end of the play, however many sites notified it. The code this replaced ran command: systemctl reload caddy immediately, mid-play. If a later task in the same play needs the new config to be live, flush first:

- ansible.builtin.meta: flush_handlers

Known intentional difference

The resolvers block is commented # Use Tailscale MagicDNS to resolve the upstream hostname in every case. datum-gateway previously said # Resolve via Tailscale MagicDNS. Migrating it therefore rewrites one comment line, which Caddy ignores. Every other site renders byte-identical to what its playbook produced.

Sites on the hosts that this role does NOT manage

Four vhosts exist in /etc/caddy/sites-enabled/ that no playbook writes. They were made by hand. The role only ever writes the one file it is told to, so it leaves them alone — but nothing in the repo records them, and that is why they are listed here. Checked 2026-09-11:

File Host Serves State
uptime-kuma.conf watchtower localhost:3001 HTTP 302 — still live, see below
arbretstaging.conf vipy arbret-staging-box:80 via MagicDNS HTTP 200
bitcoininfra.conf vipy static file_server from /var/www/bitcoin-services-home HTTP 200
scriberr.conf vipy scriberr-box:8080 via MagicDNS HTTP 502 — upstream down

uptime-kuma.conf must not be deleted as dead config. Uptime Kuma was "decommissioned" in the repo — its playbooks archived and its credentials pulled from the vault — but the container is still running on watchtower (louislam/uptime-kuma:latest, created 2026-02-07, restart=unless-stopped) and is still reachable at its public subdomain. Only the Ansible code was retired; the service was not. See archive/uptime_kuma/.

scriberr returning 502 is the one that looks like genuine rot: it proxies to a scriberr-box that is not answering, and scriberr-box is not in the inventory.