Resources attached to the Road To DevOps tutorial https://blog.noobtoroot.xyz/road-to-devops/

10 KiB

Raw Blame History Unescape Escape

Roles Ansible

Les Roles permettent d'organiser les instructions Ansible de manière à favoriser leur ré-utilisabilité.

Qu'est-ce qu'un Role ?

Un Role Ansible défini une action précise telle que :
- Installer et configurer un serveur Apache
- Installer et configurer un serveur Mariadb
Un Role Ansible peut être appelé dans un ou plusieurs Playbook.

Avantages des Roles

Organisation
- Découpage en plusieurs dossiers et fichiers
- Facilite la compréhension et la maintenance du code.
Ré-utilisabilité
- Les Roles peuvent facilement être ré-utilisés au sein de plusieurs Playbooks.
Partage
- Les Roles peuvent être partagés sous la forme de catalogues.

Organisation d'un Role

roles/
├── my-role
│   ├── README.md
│   ├── defaults             <= Variables par défaut du Role
│   │   └── main.yaml
│   ├── files                <= Fichiers pouvant être déployés par le Role
│   │   └── my-file.yaml
│   ├── handlers             <= Handlers à exécuter
│   │   └── main.yaml
│   ├── meta                 <= Métadonnées sur le Role
│   │   └── main.yaml
│   ├── tasks                <= Tâches à exécuter
│   │   └── main.yaml
│   └── templates            <= Templates de fichiers
│   │   └── my-template.j2
│   └── vars                 <= Autres variables pour le Role
│       └── main.yaml

Un Role doit inclure au minimum un des dossiers suivants
defaults, files, handlers, tasks, templates, vars.
Si un dossier est déclaré, il doit contenir au minimum un fichier nommé main.yaml.

Utiliser un Role

La méthode classique est la suivante :

playbook.yaml

- hosts: my-group-of-servers
  roles:
     - my-role-1
     - my-role-2

Ordre d'exécution des tâches

L'ordre d'exécution des tâches
dans un Playbook est le suivant :

Tâches définies dans pre_tasks
Handlers déclenchés jusque là
Tâches définies dans roles
Tâches définies dans le playbook (tasks)
Handlers déclenchés jusque là
Tâches définies dans post_tasks
Handlers déclenchés jusque là

pre_tasks, post_tasks

tasks
Tâches définies dans la section tasks. Elles sont lancées après les Rôles et avant les tâches définies dans post_tasks.
pre_tasks
Tâches lancées avant les Rôles.
post_tasks
Tâches lancées après les tâches de la section tasks
(et donc après les Rôles).

Exemple

Définition de pre_tasks, roles, tasks et post_tasks.

- hosts: ansible-1
  pre_tasks:
    - name: Pre tasks
      debug:
        msg: 'I am executed before the Roles.'
  roles:
    - my-role
  tasks:
    - name : Tasks
      debug:
        msg: 'I am executed right after the Roles and just before the Post Tasks.'
  post_tasks:
    - name: Post tasks
      debug:
        msg: 'I am executed after the main Tasks.'

L'ordre de déclaration n'a pas d'importance.

Ordre réel d'exécution

$ ansible-playbook -v -i inventories/formation/hosts my-playbook.yaml

PLAY [ansible-1] *******************************************************

TASK [Pre tasks] ***************************************************************
ok: [ansible-1] => {
    "msg": "I am executed before the Roles."
}

TASK [my-role : Role] **********************************************************
ok: [ansible-1] => {
    "msg": "I am running after Pre Tasks and before Tasks."
}

TASK [Tasks] *******************************************************************
ok: [ansible-1] => {
    "msg": "I am executed right after the Roles and just before the Post Tasks."
}

TASK [Post tasks] **************************************************************
ok: [ansible-1] => {
    "msg": "I am executed after the main Tasks."
}
...

Exemple de découpage en Roles

playbook.yaml

- hosts: web
  roles:
    - apache
    - wordpress

Le Playbook exécute les Roles apache et wordpress.

Tâches du Role apache

roles/install-apache/tasks/install.yaml

- name: Installation of Apache Package
  yum:
    name: httpd
    state: present
    update_cache: yes

- name: Ensure Apache is running (and enable it at boot)
  service:
    name: httpd
    state: started
    enabled: yes

Tâches du Role apache (suite)

roles/configure-apache/tasks/configure.yaml

- name: Modify permission of directory {{ app_directory }}
  file:
    dest: '{{ app_directory }}'
    mode: 0755
    owner: '{{ app_user }}'
    group: '{{ app_group }}'
    recurse: yes

- name: Modify Apache configuration
  lineinfile:
    dest: /etc/httpd/conf/httpd.conf
    regexp: '^Listen '
    line: 'Listen {{ apache_listen_port }}'
  notify: Reload Apache

Variables du Role apache

roles/configure-apache/vars/main.yaml

apache_listen_port: 8081
app_directory: /var/www/html
app_user: apache
app_group: apache

Handlers du Role apache

roles/configure-apache/handlers/main.yaml

- name: Reload Apache
  service:
    name: httpd
    state: reloaded

Exécution du playbook

$ ansible-playbook -i ./hosts playbook.yaml

PLAY [web] *********************************************************************

TASK [setup] *******************************************************************
ok: [web1.formation.sii.fr]
ok: [web2.formation.sii.fr]

TASK [apache : Installation of Apache Package] *********************************
ok: [web2.formation.sii.fr]
ok: [web1.formation.sii.fr]

TASK [apache : Ensure Apache is running (and enable it at boot)] ***************
ok: [web1.formation.sii.fr]
ok: [web2.formation.sii.fr]

TASK [apache : Modify permission of directory /var/www/html] *******************
ok: [web1.formation.sii.fr]
ok: [web2.formation.sii.fr]

TASK [apache : Modify Apache configuration] ************************************
changed: [web1.formation.sii.fr]
changed: [web2.formation.sii.fr]

RUNNING HANDLER [apache : Reload Apache] ***************************************
changed: [web1.formation.sii.fr]
changed: [web2.formation.sii.fr]

PLAY RECAP *********************************************************************
web1.formation.sii.fr    : ok=6    changed=2    unreachable=0    failed=0
web2.formation.sii.fr    : ok=6    changed=2    unreachable=0    failed=0

Les Roles sont exécutés séquentiellement.

Importer des fichiers de tâches

Dans un Role le fichier tasks/main.yaml peut appeler d'autres fichiers contenant des tâches avec import_tasks ou include_tasks.
Exemple :

roles/my-role/tasks/main.yaml

tasks:
- import_tasks: install.yaml
- import_tasks: configure.yaml
# ou
- include_tasks: install.yaml
- include_tasks: configure.yaml

Gérer un import par type d'OS

L'import de tâches permet notamment de gérer les différences d'implémentations entre systèmes.
Exemple :