Skip to content

docs(tutorials): add end-to-end playbook examples#69

Merged
sbaerlocher merged 2 commits into
mainfrom
docs/more-playbook-examples
Jun 26, 2026
Merged

docs(tutorials): add end-to-end playbook examples#69
sbaerlocher merged 2 commits into
mainfrom
docs/more-playbook-examples

Conversation

@sbaerlocher

Copy link
Copy Markdown
Member

Summary

  • Add three worked end-to-end playbook examples to the tutorials guide: k3s with Fleet and monitoring, multi-host firewall, and secret management.
  • Gives readers complete, copy-ready playbooks instead of only basic snippets.

Test plan

  • CI green (Sphinx build, lint)
  • Examples render correctly in the built docs

Comment thread rst/guide/tutorials/examples.rst

@claude claude Bot 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.

Thanks for expanding the worked examples — Examples 10 and 11 look good. One blocking issue in Example 9: the Alloy play uses hosts: k3s_all, but that example's inventory.ini never defines a k3s_all group (only k3s_server and k3s_agents), so a reader copying it runs the monitoring play against zero hosts. Add a [k3s_all:children] group as Example 2 does (suggestion left inline). Also flagged non-blocking: the k3s_agents worker is declared but never joined to the cluster.

@claude claude Bot 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.

All raised issues have been addressed.

Add three worked examples to the tutorials guide (k3s with Fleet and
monitoring, multi-host firewall, secret management) so readers have
complete, copy-ready playbooks beyond the basic snippets.

Signed-off-by: Simon Bärlocher <s.baerlocher@sbaerlocher.ch>
Add the missing k3s_all group so the Alloy play targets real hosts
instead of zero, and add an agent-join play so the worker actually
joins the cluster — addresses review findings.

Signed-off-by: Simon Bärlocher <s.baerlocher@sbaerlocher.ch>
@sbaerlocher sbaerlocher force-pushed the docs/more-playbook-examples branch from 910cd3b to 320c7d4 Compare June 26, 2026 17:43
@sbaerlocher sbaerlocher enabled auto-merge (squash) June 26, 2026 17:43
@sbaerlocher sbaerlocher merged commit 3350e17 into main Jun 26, 2026
6 checks passed
@sbaerlocher sbaerlocher deleted the docs/more-playbook-examples branch June 26, 2026 17:44
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.

1 participant