mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-11 13:17:07 +00:00
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>
91 lines
2.8 KiB
YAML
91 lines
2.8 KiB
YAML
---
|
|
- name: Wait for Discourse API
|
|
wait_for:
|
|
host: "{{ lookup('domain','web-app-discourse') }}"
|
|
port: 80
|
|
delay: 5
|
|
timeout: 600
|
|
|
|
- name: Add /var/www/discourse to Git safe.directory
|
|
command: >
|
|
container exec {{ lookup('applications', 'web-app-discourse').services.discourse.name }} \
|
|
git config --global --add safe.directory /var/www/discourse
|
|
args:
|
|
chdir: "{{ lookup('container', application_id, 'directories.instance') }}"
|
|
changed_when: false
|
|
|
|
- name: Revoke old WP Discourse API keys via Rails
|
|
command: >
|
|
container exec {{ lookup('applications', 'web-app-discourse').services.discourse.name }} bash -lc "\
|
|
cd /var/www/discourse && \
|
|
script/rails runner \"\
|
|
ApiKey.where(\
|
|
user_id: User.find_by_username('system').id,\
|
|
description: 'WP Discourse Integration',\
|
|
revoked_at: nil\
|
|
).update_all(revoked_at: Time.current)\
|
|
\""
|
|
args:
|
|
chdir: "{{ lookup('container', application_id, 'directories.instance') }}"
|
|
changed_when: false
|
|
failed_when: false
|
|
|
|
- name: Generate new WP Discourse API key via Rake task
|
|
command: >
|
|
container exec {{ lookup('applications', 'web-app-discourse').services.discourse.name }} bash -lc "\
|
|
cd /var/www/discourse && \
|
|
bin/rake api_key:create_master['WP Discourse Integration']\
|
|
"
|
|
args:
|
|
chdir: "{{ lookup('container', application_id, 'directories.instance') }}"
|
|
register: discourse_generated_api_key
|
|
|
|
- name: Store the new WP Discourse API key in a fact
|
|
set_fact:
|
|
vault_discourse_api_key: "{{ discourse_generated_api_key.stdout | trim }}"
|
|
|
|
- name: "Load WP Discourse settings"
|
|
include_vars:
|
|
file: "{{ role_path }}/vars/discourse.yml"
|
|
|
|
- name: "Install WP Discourse plugin"
|
|
command: >
|
|
{{ BIN_COMPOSE }} exec -u www-data -T application
|
|
wp plugin install wp-discourse --activate
|
|
--path={{ WORDPRESS_DOCKER_HTML_PATH }}
|
|
args:
|
|
chdir: "{{ lookup('container', application_id, 'directories.instance') }}"
|
|
|
|
- name: "Configure WP Discourse settings"
|
|
loop: "{{ discourse_settings | map(attribute='name') | unique | list }}"
|
|
loop_control:
|
|
label: "{{ item }}"
|
|
vars:
|
|
option_name: "{{ item }}"
|
|
|
|
option_items: >-
|
|
{{ discourse_settings
|
|
| selectattr('name', 'equalto', option_name)
|
|
| list
|
|
}}
|
|
|
|
option_kv: >-
|
|
{{ dict(
|
|
option_items | map(attribute='key')
|
|
| zip(option_items | map(attribute='value'))
|
|
) }}
|
|
|
|
option_json_b64: "{{ option_kv | to_json | b64encode }}"
|
|
|
|
command: >
|
|
{{ BIN_COMPOSE }} exec -u www-data -T application bash -lc
|
|
"wp eval \"update_option(
|
|
'{{ option_name }}',
|
|
json_decode(
|
|
base64_decode('{{ option_json_b64 }}'),
|
|
true
|
|
)
|
|
);\" --path={{ WORDPRESS_DOCKER_HTML_PATH }}"
|
|
args:
|
|
chdir: "{{ lookup('container', application_id, 'directories.instance') }}"
|