Ansible — Créer un rôle personnalisé

Comprendre le rôle « factory » create_role

Plutôt que de créer chaque rôle à la main, on construit un rôle spécial qui en génère d'autres. L'objectif : standardiser la création de rôles avec vos propres conventions (dossiers optionnels, README pré-rempli…) et rester maître du résultat.

Le rôle générateur tient dans deux fichiers :

roles/create_role/
├── defaults/main.yml    ← quels dossiers créer + où créer le rôle
└── tasks/main.yml       ← la logique de création (dossiers + fichiers)

On crée le squelette de ce rôle générateur :

mkdir -p roles/create_role/{tasks,defaults}

Variables par défaut (defaults/main.yml)

Fichier roles/create_role/defaults/main.yml — il définit le nom du futur rôle, l'emplacement de création et quels dossiers générer. Les booléens permettent d'activer ou désactiver chaque dossier selon les besoins.

---
new_role_name: ""
roles_path: "/etc/ansible/roles"

role_create_defaults: true
role_create_handlers: true
role_create_tasks: true
role_create_templates: true

Tâches du rôle factory (tasks/main.yml)

Fichier roles/create_role/tasks/main.yml. Pour chaque dossier : si la variable correspondante est true, on crée le dossier puis un fichier main.yml vide dedans. Le README est généré pré-rempli.

---
- name: Create defaults folder
  ansible.builtin.file:
    path: "{{ roles_path }}/{{ new_role_name }}/defaults"
    state: directory
  when: role_create_defaults

- name: Create handlers folder
  ansible.builtin.file:
    path: "{{ roles_path }}/{{ new_role_name }}/handlers"
    state: directory
  when: role_create_handlers

- name: Create tasks folder
  ansible.builtin.file:
    path: "{{ roles_path }}/{{ new_role_name }}/tasks"
    state: directory
  when: role_create_tasks

- name: Create templates folder
  ansible.builtin.file:
    path: "{{ roles_path }}/{{ new_role_name }}/templates"
    state: directory
  when: role_create_templates

- name: Create main.yml in defaults
  ansible.builtin.copy:
    dest: "{{ roles_path }}/{{ new_role_name }}/defaults/main.yml"
    content: |
      ---
  when: role_create_defaults

- name: Create main.yml in handlers
  ansible.builtin.copy:
    dest: "{{ roles_path }}/{{ new_role_name }}/handlers/main.yml"
    content: |
      ---
  when: role_create_handlers

- name: Create main.yml in tasks
  ansible.builtin.copy:
    dest: "{{ roles_path }}/{{ new_role_name }}/tasks/main.yml"
    content: |
      ---
  when: role_create_tasks

- name: Create README
  ansible.builtin.copy:
    dest: "{{ roles_path }}/{{ new_role_name }}/README.md"
    content: |
      # Role: {{ new_role_name }}

      ## Role Description

      ## Role Vars

Décryptage :

• when: — la tâche n'est exécutée que si la condition est vraie.
• ansible.builtin.file avec state: directory — crée (ou s'assure que existe) un dossier.
• ansible.builtin.copy avec content: — crée un fichier avec le contenu indiqué à la volée (sans template séparé).

Écrire le playbook d'appel

Fichier playbooks/new_role.yml — il invoque le rôle factory en lui donnant le nom du rôle à créer :

---
- name: Create new Role structure
  hosts: localhost
  roles:
    - create_role
  vars:
    new_role_name: "test01"
    role_create_defaults: true
    role_create_handlers: true
    role_create_tasks: true
    role_create_templates: true

Point important : hosts: localhost — le rôle tourne sur votre propre machine de contrôle, pas sur un serveur distant. Logique : on crée des fichiers en local.

Générer un nouveau rôle

# Le nom est défini dans le playbook
ansible-playbook playbooks/new_role.yml

# Ou surcharger le nom à la volée avec -e ("extra vars")
ansible-playbook playbooks/new_role.yml -e "new_role_name=backup"

Résultat — l'arborescence générée dans roles/ :

roles/test01/
├── README.md
├── defaults/main.yml
├── handlers/main.yml
├── tasks/main.yml
└── templates/

Le README.md est déjà pré-rempli avec le nom du rôle :

# Role: test01

## Role Description

## Role Vars

Utiliser votre nouveau rôle

Le rôle est créé et prêt à être rempli :

1. Éditez roles/test01/tasks/main.yml et ajoutez vos tâches.
2. Définissez les variables par défaut dans defaults/main.yml.
3. Complétez le README.md (utile pour vous dans 6 mois !).
4. Invoquez le rôle depuis un playbook :

   ---
   - name: Déployer test01
     hosts: all
     become: true
     roles:
       - test01