Skip to content

examples: show how cluster_config gets its connection details - #381

Open
ddemlow wants to merge 1 commit into
mainfrom
docs/example-environment
Open

ddemlow wants to merge 1 commit into
mainfrom
docs/example-environment

Conversation

@ddemlow

@ddemlow ddemlow commented Sep 29, 2026

Copy link
Copy Markdown
Member

Partial fix for #380 (the examples part only; role READMEs and action_groups remain open there).

  • examples/cluster_config.yml: add a commented play-level environment: block with SC_HOST / SC_USERNAME / SC_PASSWORD, and explain that the role takes no cluster_instance and that environment must be at play level (on an include_role task it does not reach the role's tasks). Left commented so the existing "export in your shell" workflow from examples/README.md keeps working unchanged.
  • examples/iso_info.yml: the commented SC_* entries were list items (# - SC_HOST: ...) under a mapping; uncommented as written they are invalid YAML. Now plain mapping keys.

Comment-only changes. Verified locally that both files parse as-is and with the environment lines uncommented, and that the old iso_info form fails to parse when uncommented. ansible-playbook --syntax-check passes on cluster_config.yml.

CI is currently offline, so no green checks expected.

🤖 Generated with Claude Code

examples/cluster_config.yml had no environment section, so a reader
had no hint that the role takes no cluster_instance and relies on
SC_HOST / SC_USERNAME / SC_PASSWORD. Add a commented play-level block
and say why it belongs at play level (environment on include_role does
not reach the role's tasks).

examples/iso_info.yml wrote its commented SC_* entries as list items
under a mapping; uncommented as written that is invalid YAML.

Refs #380

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

This branch has not been deployed

No deployments
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