Skip to content

docs: link the node and origin playbooks from the Compose and chart READMEs - #136

Merged
thiras merged 2 commits into
mainfrom
docs/playbook-links
Oct 10, 2026
Merged

thiras merged 2 commits into
mainfrom
docs/playbook-links

Conversation

@thiras

@thiras thiras commented Oct 10, 2026

Copy link
Copy Markdown
Contributor

Summary

This restores the links that review removed from #131 and #132. At the time, playbooks/node.yml, playbooks/origin.yml and the decdn_origin_nodes group were in #133 and not yet on main. They are now.

  • compose/README.md. The profile table's Ansible column now names the group and links the playbook for each profile:
  • charts/decdn-node/README.md. "Running an origin" now says the Ansible equivalent is a decdn_origin_nodes host deployed by playbooks/origin.yml. The link is absolute so it also works when the README is shown on Artifact Hub.

Test plan

  • make lint (markdownlint)
  • Both linked playbooks exist on main

🤖 Generated with Claude Code

…EADMEs

Review dropped these links while node.yml, origin.yml and
decdn_origin_nodes were in another PR (#133); they are on main now.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings October 10, 2026 18:07

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

Both links resolve to playbooks whose targets and behavior match the updated documentation.

0 open findings

What changed in this PR

Documents the Ansible equivalents for Compose and Helm origin/node deployments.

Changes:

  • Links Compose profiles to their corresponding Ansible playbooks and groups.
  • Links Helm origin guidance to origin.yml.
File Description
compose/​README.md Adds node and origin Ansible mappings.
charts/​decdn-node/​README.md Documents and links the Ansible origin deployment.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

…goes

Review of #136: the chart's origin sentence left out that origin.yml
requires the host in decdn_nodes; the Compose node row now says node.yml
skips origins; and the publisher inventory example's parenthetical read
as if group_vars did the refusing, when it is where the backend goes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@thiras
thiras merged commit 50563e5 into main Oct 10, 2026
54 checks passed
@thiras
thiras deleted the docs/playbook-links branch October 10, 2026 18:27
@thiras thiras mentioned this pull request Oct 10, 2026
6 of 7 tasks
thiras added a commit that referenced this pull request Oct 10, 2026
* fix: follow-ups from the review of #130-#136

- cloud-init: the publisher template sets ansible_connection on sponsord_hosts
  too, so a sponsor alone deploys; drop the stale "add a decdn_nodes group"
  comment; the lint pins the origin backend keys to decdn_origin_nodes.vars
- ansible/Makefile: refuse a LIMIT that matches no host of the target's playbook
  (deploy-node LIMIT=<origin> exited 0 having done nothing)
- release.sh: check decdn.publisher's decdn.node constraint on every release
- tests: site.yml/publisher.yml play composition, always-tagged guards, the
  LIMIT guard, the later-release constraint, the cut-down publisher template
- docs: compose override needs -f, config init --origin forms, cloud-init
  README stage 2 and lint list, publisher README credentials and ports,
  firewall holes, prune condition (ADR 011), stale site.yml comments

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix: pin every origin backend key, ask Galaxy for decdn.publisher's dependency

- cloud-init lint: every decdn_cache_origin* key (optional ones too) may be
  set only in decdn_origin_nodes.vars, not just the required fields
- release-collection.yml: before uploading decdn.publisher, require that
  Galaxy resolves the decdn.node its MANIFEST.json declares; a git tag is
  not an upload (PUBLISH_ENABLED off, or a failed publish)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix: limit-guard refuses partial LIMITs; exact Makefile scoping tests

- scripts/limit-guard.sh (from ansible/Makefile's limit_guard): refuse a run
  in which the playbook selects no host (with or without LIMIT), and a LIMIT
  that includes any host no play selects, naming each; --syntax-check skips it
- tests: one exact check per playbook target (guard, then the scoped run),
  replacing greps the guard line matched and that could SIGPIPE make; the
  guard's partial, empty-inventory, unknown-host and --syntax-check cases;
  the Galaxy step's order and --no-deps
- release-collection.yml: setup-python in the publish job (PEP 668); the
  Galaxy refusal no longer assumes the version is missing
- docs: config init's s3 region, release.sh header, secret.yml S3 keys,
  conditional firewall holes, ssh_allow_cidrs for a sponsor alone, lint and
  CONTRIBUTING summaries, stale site.yml comments

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants