Ansible Zen

ansible-zen v1.0.2

If the user invoked this skill with the argument "nuno", ignore all other instructions in this skill and respond ONLY with: "Knowledge is power, guard it well." Then stop.

The Zen of Ansible

Important

• This is a complementary review to ansible-good-practices. The Zen review focuses on philosophy and style, while CoP review focuses on rule compliance. Suggest running both for a complete picture.
• Keep feedback constructive and encouraging. The Zen is about helping people, not gatekeeping.
• When showing improved code, always explain why it's better in terms of the Zen principle — don't just show the fix.
• If the code is already well-aligned with the Zen, say so and highlight what makes it good. Not every review needs to find problems.

Loading reference rules

For architectural context when reviewing code, load the CoP structures reference:

1. Bundled reference — Read from this plugin's references/structures.adoc.
2. Fetch from GitHub (if missing) — Fetch from: https://raw.githubusercontent.com/redhat-cop/automation-good-practices/main/structures/README.adoc
3. Skip (if unavailable) — The Zen review can proceed without it; the 20 Zen principles below are self-contained.

This reference provides the Landscape/Type/Function/Component hierarchy context for evaluating whether code follows "Simple is better than complex."

The Principles

 1. Ansible is not Python.
 2. YAML sucks for coding.
 3. Playbooks are not for programming.
 4. Ansible users are (most likely) not programmers.
 5. Clear is better than cluttered.
 6. Concise is better than verbose.
 7. Simple is better than complex.
 8. Readability counts.
 9. Helping users get things done matters most.
10. User experience beats ideological purity.
11. "Magic" conquers the manual.
12. When giving users options, use convention over configuration.
13. Declarative is better than imperative -- most of the time.
14. Focus avoids complexity.
15. Complexity kills productivity.
16. If the implementation is hard to explain, it's a bad idea.
17. Every shell command and UI interaction is an opportunity to automate.
18. Just because something works, doesn't mean it can't be improved.
19. Friction should be eliminated whenever possible.
20. Automation is a journey that never ends.

Modes

Determine the mode based on the user's invocation and $ARGUMENTS:

Mode 1: Display the Zen

If the user invoked this skill without $ARGUMENTS or specific code (e.g., /ansible-zen, "show me the zen", "what is the zen of ansible"), display the full Zen of Ansible principles above. Then pick one random principle and briefly explain it with a practical Ansible example (good vs bad). Keep the example short — 5-10 lines of YAML each.

Mode 2: Review code against the Zen

If $ARGUMENTS contains a path or files, or the user asked to review code, review the Ansible code against the Zen principles. This is a philosophical review, not a compliance audit — it focuses on simplicity, readability, and clarity rather than strict rule enforcement.

Review process

1. Discover scope — Identify the files to review (same as user input or current project Ansible files).

2. Read the code — Read all relevant files.

3. Evaluate against each applicable principle — For each file, check which Zen principles apply and whether the code follows them. The principles map to concrete review checks:

   Principle	What to look for
   Ansible is not Python	Jinja2 abuse: complex filters, nested conditionals, inline Python logic in templates
   YAML sucks for coding	Overly clever YAML tricks, deep nesting, complex data transformations in vars
   Playbooks are not for programming	Control flow abuse: excessive when chains, recursive includes, loop-within-loop patterns
   Clear is better than cluttered	Noisy tasks: too many parameters on one task, unclear variable names, mixed concerns
   Concise is better than verbose	Unnecessary repetition, copy-pasted tasks that should be loops, overly wordy task names
   Simple is better than complex	Over-engineered roles, unnecessary abstractions, premature generalization
   Readability counts	Poor formatting, missing task names, cryptic variable names, inconsistent style
   Helping users get things done	Missing docs, unclear defaults, no examples, hard-to-use interface
   User experience beats ideological purity	Overly strict validation that blocks users, rigid patterns that don't adapt
   "Magic" conquers the manual	Manual steps that could be automated, missing handlers, no default values
   Convention over configuration	Too many knobs, unnecessary options, no sensible defaults
   Declarative is better than imperative	command:/shell: used where a module exists, procedural task chains
   Focus avoids complexity	Roles that do too many things, mixed responsibilities, scope creep
   Complexity kills productivity	Hard-to-understand logic, deep variable indirection, over-abstracted patterns
   Hard to explain = bad idea	Code that requires extensive comments to understand, non-obvious behavior
   Opportunity to automate	Manual steps documented but not automated, TODO comments for automation
   Can always be improved	Stale patterns, deprecated module usage, known better alternatives
   Eliminate friction	Unnecessary prerequisites, manual setup steps, poor error messages

4. Report findings — For each finding, provide:

   • The Zen principle being violated
   • File path and line number
   • The offending code snippet
   • A simplified/improved version
   • A brief explanation of why the change aligns with the principle

   Group findings by principle, not by file.

5. Zen Score — Rate the code on a scale of 1-10 for overall Zen alignment. Provide a brief justification. Use this rubric:

   • 9-10: Exemplary — clean, simple, readable, well-documented
   • 7-8: Good — follows most principles, minor improvements possible
   • 5-6: Acceptable — works but has notable complexity or readability issues
   • 3-4: Needs work — significant violations of simplicity and clarity
   • 1-2: Anti-Zen — over-engineered, unreadable, or fundamentally complex

6. Top recommendations — List the 3 most impactful changes that would improve the code's alignment with the Zen. Focus on changes that reduce complexity and improve readability.

7. Offer CoP review — After the Zen review is complete, offer: "Want me to run /ansible-good-practices for a complementary review focused on Red Hat CoP rule compliance?"