Tools/Ansible/Gestion des Boucles - Historique des versions

Admin : /* Itération sur un dictionnaire */

2020-05-26T07:57:00Z

Itération sur un dictionnaire

Admin : /* Listes imbriquées */

2020-05-26T07:47:49Z

Listes imbriquées

Admin : /* Liste de listes */

2020-05-26T07:22:00Z

Liste de listes

Admin : /* Boucles et plug-in de recherche */

2020-05-26T07:12:30Z

Boucles et plug-in de recherche

Admin : Page créée avec « {{MediaWiki}} {{FOND_BLEU|Ansible - '''Mise en oeuvre de boucles avancées'''}} =Boucles et plug-in de recherche= L'utilisation de boucles pour itérer sur des tâches p… »

2020-05-26T07:04:17Z

Page créée avec « {{MediaWiki}} {{FOND_BLEU|Ansible - '''Mise en oeuvre de boucles avancées'''}} =Boucles et plug-in de recherche= L'utilisation de boucles pour itérer sur des tâches p… »

Nouvelle page

{{MediaWiki}}
{{FOND_BLEU|Ansible - '''Mise en oeuvre de boucles avancées'''}}

=Boucles et plug-in de recherche=

L'utilisation de boucles pour itérer sur des tâches peut vous aider à simplifier vos playbooks Ansible. Le mot-clé loop effectue une boucle sur une liste d'éléments à plat. Lorsqu'il est utilisé en association avec des plug-ins de recherche, vous pouvez créer des données plus complexes dans vos listes pour vos boucles.

Le mot-clé {{CODE|loop}} a été introduit dans Ansible 2.5. Avant cela, l'itération de la tâche a été mise en oeuvre à l'aide de mots-clés contenant en premier with_, suivis du nom d'un plug-in de recherche.

L'équivalent de loop dans cette syntaxe est {{CODE|with_list}} et est conçu pour l'itération sur une liste plate simple.

Pour les listes simples, {{CODE|loop}} est la meilleure syntaxe à utiliser.

À titre d'exemple, les trois syntaxes suivantes présentent les mêmes résultats. La première est celle qui est préférée :

<syntaxhighlight lang="yaml">
- name: using loop
debug:
msg: "{{ item }}"
loop: "{{ mylist }}"
- name: using with_list
debug:
msg: "{{ item }}"
with_list: "{{ mylist }}"
- name: using lookup plugin
debug:
msg: "{{ item }}"
loop: "{{ lookup('list', mylist) }}"
</syntaxhighlight>

Vous pouvez refactoriser une tâche d'itération de type {{CODE|with_*}} pour utiliser le mot-clé {{CODE|loop}}, en utilisant une combinaison appropriée de plug-ins de recherche et de filtres pour correspondre à la fonctionnalité.
L'utilisation du mot-clé {{CODE|loop}} à la place de boucles de type {{CODE|with_*}} présente les avantages suivants :

* Il n'est pas nécessaire de mémoriser ou de trouver un mot-clé de type {{CODE|with_*}} pour votre scénario d'itération. À la place, utilisez des plug-ins et des filtres pour adapter une tâche de mot-clé {{CODE|loop}} à votre cas d'utilisation.
* Concentrez-vous sur l'apprentissage des plug-ins et des filtres disponibles dans Ansible, dont la capacité d'application est plus étendue que la simple itération.

* Vous disposez d'un accès en ligne de commande à la documentation du plug-in de recherche, à l'aide de la commande {{CODE|ansible-doc -t lookup}}. Cela vous permet de découvrir les plug-ins de recherche et de concevoir des scénarios d'itération personnalisés à l'aide de ces derniers.

{{IMPORTANT|
contenu=Le message d'Ansible en amont a évolué depuis Ansible 2.5. Il est recommandé d'utiliser le mot-clé {{CODE|loop}} au lieu des boucles {{CODE|with_*}}, mais il existe des cas d'utilisation où l'ancienne syntaxe peut être plus adaptée. Conformément à la documentation, la syntaxe {{CODE|with_*}} n'est pas obsolète et doit être encore valide dans un avenir proche. La syntaxe de {{CODE|loop}} peut continuer à évoluer dans les versions à venir d'Ansible.

Voici quelques astuces clés, basées sur les conseils en amont d'Ansible 2.8 :

* Le mot-clé loop requiert une liste et n'accepte pas de chaîne. Si cela vous pose problème, souvenez-vous de la différence entre {{CODE|lookup}} et {{CODE|query}}.
* Toute utilisation de {{CODE|with_*}} qui est décrite dans « Migration de with_X vers loop » [https://docs.ansible.com/ansible/latest/user_guide/playbooks_loops.html#migrating-to-loop] peut être convertie en toute sécurité.
Ces derniers utilisent principalement des filtres.
* Si vous avez besoin d'utiliser un plug-in de recherche pour convertir une construction {{CODE|with_*}} afin d'utiliser {{CODE|loop}}, il peut être plus clair de continuer à utiliser la syntaxe {{CODE|with_*}}.
}}

@@ Ligne 188 : / Ligne 188 : @@
      state: present
    loop: "{{ users | dict2items }}"
 </syntaxhighlight>

← Version précédente		Version du 26 mai 2020 à 07:47
Ligne 149 :		Ligne 149 :

	Le filtre {{CODE\|subelements}} crée une liste à partir des données de la variable users. Chaque élément de la liste est lui-même une liste à deux éléments. Le premier élément contient une référence à chaque utilisateur. Le second élément contient une référence à une entrée unique à partir de la liste {{CODE\|authorized}} pour cet utilisateur.		Le filtre {{CODE\|subelements}} crée une liste à partir des données de la variable users. Chaque élément de la liste est lui-même une liste à deux éléments. Le premier élément contient une référence à chaque utilisateur. Le second élément contient une référence à une entrée unique à partir de la liste {{CODE\|authorized}} pour cet utilisateur.
		+
		+	== Itération sur un dictionnaire ==
		+	Vous rencontrez souvent des données organisées sous la forme d'un ensemble de paires clé/valeur, généralement dénommées dans la communauté Ansible en tant que dictionnaire, au lieu d'être structurée en tant que liste. À titre d'exemple, considérez la définition suivante d'une variable {{CODE\|users}} définie ci-dessous :
		+
		+
		+	<syntaxhighlight lang="yaml">
		+	users:
		+	demo1:
		+	name: Demo User 1
		+	mail: demo1@example.com
		+	demo2:
		+	name: Demo User 2
		+	mail: demo2@example.com
		+	...output omitted...
		+	demo200:
		+	name: Demo User 200
		+	mail: demo200@example.com
		+	</syntaxhighlight>
		+
		+	Avant Ansible 2.5, vous devez utiliser le mot-clé {{CODE\|with_dict}} pour itérer au sein des paires clé/valeur de ce dictionnaire. Pour chaque itération, la variable {{CODE\|item}} dispose de deux attributs : {{CODE\|key}} et {{CODE\|value}}. L'attribut {{CODE\|key}} contient la valeur de l'une des clés de dictionnaire, tandis que l'attribut value contient les données associées à la clé du dictionnaire :
		+
		+	<syntaxhighlight lang="yaml">
		+	- name: Iterate over Users
		+	user:
		+	name: "{{ item.key }}"
		+	comment: "{{ item.value.name }}"
		+	state: present
		+	with_dict: "{{ users }}"
		+	</syntaxhighlight>
		+
		+	Vous pouvez également utiliser le filtre {{CODE\|dict2items}} pour transformer un dictionnaire en une liste, ce qui est probablement plus facile à comprendre. Les éléments de cette liste sont structurés de la même façon que les éléments générés par le mot-clé {{CODE\|with_dict}} :
		+
		+	<syntaxhighlight lang="yaml">
		+	- name: Iterate over Users
		+	user:
		+	name: "{{ item.key }}"
		+	comment: "{{ item.value.name }}"
		+	state: present
		+	loop: "{{ users \| dict2items }}"
		+	</syntaxhighlight>

← Version précédente		Version du 26 mai 2020 à 07:22
Ligne 95 :		Ligne 95 :
	d'une liste de listes.		d'une liste de listes.
	}}		}}
		+
		+
		+	== Listes imbriquées ==
		+	Les données des fichiers de variables, des faits Ansible et des services externes sont souvent une composition de structures de données plus simples, telles que des listes et des dictionnaires.
		+
		+	Considérez la variable {{CODE\|users}} définie ci-dessous :
		+
		+
		+	<syntaxhighlight lang="yaml">
		+	users:
		+	- name: paul
		+	password: "{{ paul_pass }}"
		+	authorized:
		+	- keys/paul_key1.pub
		+	- keys/paul_key2.pub
		+	mysql:
		+	hosts:
		+	- "%"
		+	- "127.0.0.1"
		+	- "::1"
		+	- "localhost"
		+	groups:
		+	- wheel
		+	- name: john
		+	password: "{{ john_pass }}"
		+	authorized:
		+	- keys/john_key.pub
		+	mysql:
		+	password: other-mysql-password
		+	hosts:
		+	- "utility"
		+	groups:
		+	- wheel
		+	- devops
		+	</syntaxhighlight>
		+
		+
		+	La variable users est une liste. Chaque entrée de la liste est un dictionnaire avec les clés : {{CODE\|name}},
		+	{{CODE\|password}}, {{CODE\|authorized}}, {{CODE\|mysql}} et {{CODE\|groups}}. Les clés {{CODE\|name}} et {{CODE\|password}} définissent des chaînes simples, tandis que les clés {{CODE\|authorized}} et {{CODE\|groups}} définissent des listes. La clé {{CODE\|mysql}} fait référence à un autre dictionnaire qui contient des métadonnées liées à MySQL pour chaque utilisateur.
		+
		+	Tout comme le filtre {{CODE\|flatten}}, le filtre {{CODE\|subelements}} crée une liste unique à partir d'une liste contenant des listes imbriquées. Le filtre traite une liste de dictionnaires, et chaque dictionnaire contient une clé qui fait référence à une liste. Pour utiliser le filtre {{CODE\|subelements}}, vous devez indiquer le nom d'une clé sur chaque dictionnaire correspondant à une liste.
		+
		+	Pour illustrer cette opération, reprenons la définition de la variable {{CODE\|users}} précédente. Le filtre {{CODE\|subelements}} active l'itération par le biais de tous les utilisateurs et de leurs fichiers de clés
		+	autorisés définis dans la variable :
		+
		+	<syntaxhighlight lang="yaml">
		+	- name: Set authorized ssh key
		+	authorized_key:
		+	user: "{{ item.0.name }}"
		+	key: "{{ lookup('file', item.1) }}"
		+	loop: "{{ users \| subelements('authorized') }}"
		+	</syntaxhighlight>
		+
		+	Le filtre {{CODE\|subelements}} crée une liste à partir des données de la variable users. Chaque élément de la liste est lui-même une liste à deux éléments. Le premier élément contient une référence à chaque utilisateur. Le second élément contient une référence à une entrée unique à partir de la liste {{CODE\|authorized}} pour cet utilisateur.

@@ Ligne 47 : / Ligne 47 : @@
 Ces derniers utilisent principalement des filtres.
 * Si vous avez besoin d'utiliser un plug-in de recherche pour convertir une construction {{CODE|with_*}} afin d'utiliser {{CODE|loop}}, il peut être plus clair de continuer à utiliser la syntaxe {{CODE|with_*}}.
 }}