LLI Wiki — My Digital Knowledge Base

Variables Ansible : register, include_vars et ancres

Définir, capturer et importer des variables Ansible, et réutiliser des blocs YAML avec ancres et alias.

Les variables Ansible permettent de paramétrer les playbooks, les rôles et les inventaires. Cette page présente la définition d'une variable, la capture d'une sortie avec register, l'import d'un fichier de variables et l'usage des ancres YAML.

Définir une variable dans un playbook

- name: Example Simple Variable
  hosts: all
  become: yes
  vars:
    username: bob
  tasks:
  - name: Add the user {{ username }}
    ansible.builtin.user:
      name: "{{ username }}"
      state: present

Capturer une sortie avec register

Une variable enregistrée avec register est liée à l'hôte qui a exécuté la tâche. Elle est lue depuis un autre hôte via hostvars.

- hosts: localhost
  tasks:
  - command: /bin/echo "this is a test"
    register: foo

- hosts: anotherhost
  tasks:
  - debug: var=foo
    when: foo is defined
  - debug: var=hostvars['localhost']['foo']
    when: hostvars['localhost']['foo'] is defined

Sur anotherhost, foo n'est pas défini : la première tâche est ignorée, la seconde lit la valeur de localhost.

Importer un fichier de variables

Fichier var_name.yaml :

name1: test1

Playbook :

---
- name: writing something
  hosts: all
  tasks:
  - include_vars: var_name.yaml
  - debug: msg="My name is {{ name1 }}"

Ancres et alias YAML

Une ancre (&) définit un bloc réutilisable, un alias (*) le référence et la clé << fusionne un bloc dans un autre.

- name: Example Anchors and Aliases
  hosts: all
  become: yes
  vars:
    user_groups: &user_groups
     - devs
     - support
    user_1:
        user_info: &user_info
            name: bob
            groups: *user_groups
            state: present
            create_home: yes
    user_2:
        user_info:
            <<: *user_info
            name: christina
    user_3:
        user_info:
            <<: *user_info
            name: jessica
            groups: support
  tasks:
  - name: Add several groups
    ansible.builtin.group:
      name: "{{ item }}"
      state: present
    loop: "{{ user_groups }}"
  - name: Add several users
    ansible.builtin.user:
      <<: *user_info
      name: "{{ item.user_info.name }}"
      groups: "{{ item.user_info.groups }}"
    loop:
      - "{{ user_1 }}"
      - "{{ user_2 }}"
      - "{{ user_3 }}"

Remarques

Mastodon LLIMastodon SocialFosstodon