Cut the comment bloat from the Podman playbooks
Comment blocks now stay within three lines and explain only the non-obvious. Long histories, include examples, and commented-out code are gone. No task, key, or value changed; the only data change is comment text inside the generated unit files.
This commit is contained in:
1 parent
2aab1aec1e
commit
476a6d7cd0
85 files changed
+372
-2433
No files matched your search
@@ -1,13 +1,6 @@
|
||||
---
|
||||
# Postgres is its own playbook (postgres/playbook.yml) and a rootless Quadlet
|
||||
# unit there. This handler runs as the connection user, so `systemctl --user`
|
||||
# works without setting XDG_RUNTIME_DIR.
|
||||
#
|
||||
# Required by postgres/roles/attach, which notifies it whenever this app's
|
||||
# drop-in changes: a new drop-in changes the generated unit, so Postgres must be
|
||||
# recreated to join the network — Quadlet has no live equivalent of
|
||||
# `podman network connect`. That is a few seconds of downtime for every attached
|
||||
# app, not just this one. See postgres/readme.md, "The trade-off".
|
||||
# A new drop-in changes the generated unit, so Postgres must be recreated to join the network.
|
||||
# That restarts every attached app, not just this one.
|
||||
- name: Restart Postgres
|
||||
ansible.builtin.systemd_service:
|
||||
name: "{{ postgres_unit }}"
|
||||
|
||||
@@ -1,32 +1,11 @@
|
||||
---
|
||||
# Attach this app's network to the shared Postgres unit.
|
||||
#
|
||||
# Postgres knows nothing about its clients, exactly like Caddy: a service joins
|
||||
# by dropping 50-hiwikijs.conf and the shared 10-network-aliases.conf next to
|
||||
# postgres.container. The canonical way to do that is the shared include below —
|
||||
# it writes the same bytes every service writes, asserts that hiwikijs.network
|
||||
# already exists, and notifies the "Restart Postgres" handler defined in this
|
||||
# role.
|
||||
#
|
||||
# This runs in the roles phase, which is after the register include in
|
||||
# playbook.yml's pre_tasks has created hiwikijs.network.
|
||||
|
||||
# Runs in the roles phase, after the register include in pre_tasks created the network.
|
||||
- name: Attach Wiki.js to Postgres
|
||||
ansible.builtin.include_tasks: "{{ playbook_dir }}/../postgres/roles/attach/tasks/main.yaml"
|
||||
|
||||
# On a first attach both drop-ins are new, so Postgres has to be recreated to
|
||||
# join hiwikijs_net — and the shared 10-network-aliases.conf is what creates the
|
||||
# `db` alias DB_HOST asks for. That restart is a *handler*, which by default runs
|
||||
# at the end of the play, after the wikijs role has already started the app. The
|
||||
# app would then come up before `db` resolves, fail its own HTTP probe, and fail
|
||||
# the play on a machine where nothing is actually wrong.
|
||||
#
|
||||
# Flushing applies the new drop-in before the app starts. On later runs the
|
||||
# drop-ins are unchanged, nothing is pending, and this is a no-op.
|
||||
#
|
||||
# Note that flush_handlers flushes *everything* pending, which includes the
|
||||
# "Restart Caddy" that the register include notified in pre_tasks — and that is
|
||||
# the right thing here: the Caddy drop-in is new too, and Caddy has to be
|
||||
# recreated to join the network before it can proxy to hiwikijs.
|
||||
# The restart is a handler, so it would run after the wikijs role starts the app.
|
||||
# Flushing applies the new drop-in before the app starts; later runs are a no-op.
|
||||
# Flush also applies Caddy's pending restart, which is right: Caddy must join the network to proxy.
|
||||
- name: Apply the Postgres network change before starting Wiki.js
|
||||
ansible.builtin.meta: flush_handlers
|
||||
Reference in new issue
Block a user