ansible-cop-review

Ansible CoP Review Skill

Review Ansible code against all Red Hat Communities of Practice (CoP) automation good practices, providing detailed feedback and actionable recommendations.

Review Scope

This skill reviews Ansible automation against the complete Red Hat CoP framework:

1. Structure & Organization - Project layout, directory structure, naming
2. Role Design - Variable naming, idempotency, platform support
3. Playbook Design - Type-Function pattern, simplicity, tagging
4. Code Quality - YAML formatting, ansible-lint compliance, documentation
5. Testing - Molecule tests, idempotence validation, CI/CD integration
6. Security - Credential handling, privilege escalation, validation

Review Process

1. Identify What to Review

Determine the scope:

• Single role - Review role structure and implementation
• Playbook - Review playbook design and role usage
• Collection - Review collection organization and content
• Complete project - Review entire automation project

2. Read the Code

Use appropriate tools to read all relevant files:

# List project structure
find . -type f -name "*.yml" -o -name "*.yaml"

# Read playbooks
cat playbooks/*.yml

# Read role files
cat roles/*/tasks/main.yml
cat roles/*/defaults/main.yml
cat roles/*/meta/main.yml

3. Apply CoP Standards

Check against all Red Hat CoP criteria (detailed below).

4. Generate Review Report

Provide structured feedback:

• Summary - Overall assessment
• Critical Issues - Must fix (breaks standards)
• Warnings - Should fix (best practices)
• Recommendations - Nice to have (improvements)
• Strengths - What's done well

Red Hat CoP Standards Checklist

Structure & Organization

Project Structure

Standard:

project/
├── ansible.cfg
├── inventory/
│   ├── production/
│   │   ├── hosts
│   │   └── group_vars/
│   └── staging/
├── playbooks/
│   ├── types/              # Type playbooks
│   │   ├── web_server.yml
│   │   └── database.yml
│   └── landscapes/         # Landscape playbooks
│       └── ecommerce.yml
├── roles/                  # Local roles
└── collections/
    └── requirements.yml