Ansible Roles and Project Structure

# CHAPTER 7

Ansible Roles and Project Structure #

1. Introduction #

2. Learning Objectives #

• Define the purpose and structural layout of an Ansible Role.

• Use the ansible-galaxy CLI to generate a Role skeleton.

• Refactor a monolithic playbook into modular Roles.

• Execute Roles within a main Playbook using the roles: directive.

• Understand the hierarchical separation of tasks/, vars/, and handlers/.

3. Beginner-Friendly Explanation #

• The Monolithic Playbook: One master mechanic runs around with a 500-page manual, building the engine, painting the car, and sewing the leather seats all by themselves. It's chaotic and slow.

• Ansible Roles: You break the factory into Stations. Station 1 (The Engine Role) only knows how to build engines. Station 2 (The Paint Role) only knows how to paint.

If you want to build a truck instead of a car, you don't rewrite the 500-page manual. You just tell the factory: "Use the Engine Role, but skip the Leather Seats Role." Roles make your automation plug-and-play.

4. The Architecture of a Role #

The Standard Directory Structure:

my-ansible-project/
├── site.yml               (The main playbook that calls the roles)
├── inventory.ini
└── roles/
    └── web_server/        (The Role Name)
        ├── tasks/
        │   └── main.yml   (The actual list of tasks)
        ├── vars/
        │   └── main.yml   (Variables specific to this role)
        ├── templates/     (Configuration files to be copied)
        └── handlers/
            └── main.yml   (Service restarts)

How to create a Role automatically: You don't have to create these folders manually. Open your terminal, navigate to your roles/ directory, and run:

ansible-galaxy init web_server

Ansible will instantly generate the perfect, standardized folder skeleton.

5. Refactoring to a Role #

In roles/webserver/tasks/main.yml: *(Notice we do NOT write hosts: or tasks: here. We just list the raw tasks!)*

---
- name: Install Nginx
  apt:
    name: nginx
    state: present

- name: Ensure Nginx is running
  service:
    name: nginx
    state: started

In our main playbook (site.yml): We delete all the old tasks and replace them with a roles: block.

---
- name: Configure All Web Infrastructure
  hosts: webservers
  become: yes

  # Ansible automatically looks in the 'roles/' folder for a folder named 'web_server'
  roles:
    - web_server 
    # - database_server (We could add another role here!)

*When you run ansible-playbook site.yml, Ansible seamlessly merges the tasks from the Role into the execution.*

6. Mini Project: Create Reusable Web Server Role #

Step-by-Step Architecture Concept: Assume we have created a generic nginx_web role. We can pass different variables to it from our main playbook!

In site.yml:

---
# Play 1: The Corporate Website
- hosts: corporate_servers
  become: yes
  roles:
    - role: nginx_web
      vars:
        port: 80
        website_name: "Corporate Portal"

# Play 2: The Internal Admin Dashboard
- hosts: internal_servers
  become: yes
  roles:
    - role: nginx_web
      vars:
        port: 8080
        website_name: "Secret Admin Dashboard"

*We used the exact same automation logic (the nginxweb role) but dynamically injected different ports and names. True reusability!*

• Role Path Errors: If Ansible throws ERROR! the role 'webserver' was not found, verify your folder structure. Ansible looks for roles in a folder named exactly roles/ in the same directory as your main playbook. If you store roles elsewhere, you must define the roles_path in your ansible.cfg file.

11. Exercises #

1. 1. What is the CLI command used to generate a standardized Ansible Role directory skeleton?

1. 2. Explain why you do not include the hosts: or become: directives inside a Role's tasks/main.yml file.

12. FAQs #

13. Interview Questions #

• Q: Detail the enterprise architecture of an Ansible Project. How does abstracting logic into Roles fulfill the DRY (Don't Repeat Yourself) principle, and what is the standard directory structure of a Role?

• Q: Explain the operational workflow of incorporating a third-party module from Ansible Galaxy into a production CI/CD deployment pipeline. What are the security considerations?

14. Summary #

15. Next Chapter Recommendation #