Justine le 22 juin 2022 à 10:05

2022-06-22T10:05:17Z

← Version précédente		Version du 22 juin 2022 à 10:05
Ligne 1 :		Ligne 1 :
			[[Category:Ansible]]

	https://docs.ansible.com/ansible/latest/user_guide/playbooks_filters.html		https://docs.ansible.com/ansible/latest/user_guide/playbooks_filters.html
	[https://jinja.palletsprojects.com/en/2.10.x/templates/#builtin-filters Liste des filtres de Jinja2]		[https://jinja.palletsprojects.com/en/2.10.x/templates/#builtin-filters Liste des filtres de Jinja2]

Justine : Page créée avec « https://docs.ansible.com/ansible/latest/user_guide/playbooks_filters.html [https://jinja.palletsprojects.com/en/2.10.x/templates/#builtin-filters Liste des filtres de Jinj... »

2019-11-23T13:07:39Z

Page créée avec « https://docs.ansible.com/ansible/latest/user_guide/playbooks_filters.html [https://jinja.palletsprojects.com/en/2.10.x/templates/#builtin-filters Liste des filtres de Jinj... »

Nouvelle page

https://docs.ansible.com/ansible/latest/user_guide/playbooks_filters.html
[https://jinja.palletsprojects.com/en/2.10.x/templates/#builtin-filters Liste des filtres de Jinja2]

= Que sont les filtres =

Les filtres d'Ansible viennent de Jinja2, et servent à transformer des données dans une expression de template.

Il faut garder à l'esprit que la transformation des filtres se produit sur le contrôleur, et non pas sur l'hôte en lui-même. En plus des filtres fournis par Jinja2, Ansible fournit des filtres qui lui sont spécifiques et permet de créer ses propres filtres.

On va ici en voir quelques uns. L'intégralité est disponible dans les liens donnés au dessus, parce qu'il y'en a beaucoup.

== Formater des données ==

Il est possible de formater des données depuis / vers du yaml ou du JSON.

<syntaxhighlight lang='yaml'>
# Formattage simple
{{ some_variable | to_json }}
{{ some_variable | to_yaml }}

#Human readable
{{ some_variable | to_nice_json }}
{{ some_variable | to_nice_yaml }}

#On peut définir l'indentation
{{ some_variable | to_nice_json(indent=2) }}
{{ some_variable | to_nice_yaml(indent=8) }}

</syntaxhighlight>

Ces filtres utilisent une lib qui a une limite de 80 caractères par ligne. On peut changer ça pour éviter d'avoir des linebreak au milieu d'une ligne:

<syntaxhighlight lang='yaml'>
{{ some_variable | to_yaml(indent=8, width=1337) }}
{{ some_variable | to_nice_yaml(indent=8, width=1337) }}
</syntaxhighlight>

Enfin, on peut lire depuis un format ou l'autre :

<syntaxhighlight lang='yaml'>
{{ some_variable | from_json }}
{{ some_variable | from_yaml }}

tasks:
- shell: cat /some/path/to/file.json
register: result

- set_fact:
myvar: "{{ result.stdout | from_json }}"

</syntaxhighlight>

From_yaml_all permet de générer une variable à partir de yaml multi-documents.

<syntaxhighlight lang='yaml'>
tasks:
- shell: cat /some/path/to/multidoc-file.yaml
register: result
- debug:
msg: '{{ item }}'
loop: '{{ result.stdout | from_yaml_all | list }}'

</syntaxhighlight>

== Gestion de définition de variables ==

On peut forcer une variable à être définie:

<syntaxhighlight lang='yaml'>
{{ variable | mandatory }}
</syntaxhighlight>

Mais on peut aussi fournir une valeur par défaut:

<syntaxhighlight lang='yaml'>
{{ some_variable | default(5) }}

#On peut vouloir utiliser une valeur par défaut si la variable est False ou
#une chaîne de caractères vide. Il faut alors mettre le deuxième paramètre à True:

{{ lookup('env', 'MY_USER') | default('admin', true) }}
</syntaxhighlight>

== Filtres de listes ==

<syntaxhighlight lang='yaml'>
#Récupérer la valeur minimale d'une liste de nombres
{{ list1 | min }}

#Valeur maximale:
{{ [3, 4, 2] | max }}

#Aplatir une liste
{{ [3, [4, 2] ] | flatten }}

#Aplatir seulement le premier niveau
{{ [3, [4, [2]] ] | flatten(levels=1) }}

##Les filtres suivants renvoient un seul ensemble à partir de plusieurs, ou de listes

#Ensemble à partir d'une liste
{{ list1 | unique }}

#Union de 2 listes
{{ list1 | union(list2) }}

#Intersection de 2 listes (A inter B)
{{ list1 | intersect(list2) }}

#Différence de deux listes (Items qui sont dans A mais pas dans B)
{{ list1 | difference(list2) }}

#Différence symétrique (Items exclusifs à A ou B)
{{ list1 | symmetric_difference(list2) }}

#Concaténer une liste en un string
{{ list | join(" ") }}

</syntaxhighlight>

== Filtres de dictionnaires ==
=== item2dict ===

<syntaxhighlight lang='yaml'>
#Transformer un dictionnaire en une liste, utilisable avec loop
{{ dict | dict2items }}

#Ce qui transforme ça :
tags:
Application: payment
Environment: dev

#... en ça:
- key: Application
value: payment
- key: Environment
value: dev

#On peut gérer les valeurs des clefs et des valeurs dans l'objet transformé:
{{ files | dict2items(key_name='file', value_name='path') }}

#Ce qui transforme ça:
files:
users: /etc/passwd
groups: /etc/group

#...en ça:
- file: users
path: /etc/passwd
- file: groups
path: /etc/group

</syntaxhighlight>

=== dict2item ===

<syntaxhighlight lang='yaml'>
#Même chose dans l'autre sens : on transforme une liste de dicts,
#avec 2 clefs, en un dictionnaire
{{ tags | items2dict }}

#Ce qui transforme ça:
tags:
- key: Application
value: payment
- key: Environment
value: dev

#...en ça:
Application: payment
Environment: dev

#On peut toujours changer les valeurs des clefs et des valeurs
{{ tags | items2dict(key_name='key', value_name='value') }}

</syntaxhighlight>

=== zip ===

zip permet de combiner les valeurs de plusieurs listes.

<syntaxhighlight lang='yaml'>
- name: give me list combo of two lists
debug:
msg: "{{ [1,2,3,4,5] | zip(['a','b','c','d','e','f']) | list }}"

- name: give me shortest combo of two lists
debug:
msg: "{{ [1,2,3] | zip(['a','b','c','d','e','f']) | list }}"

#Ces filtres peuvent être utilisés pour construire des dictionnaires:
{{ dict(keys_list | zip(values_list)) }}

#Ce qui change ça:
keys_list:
- one
- two
values_list:
- apple
- orange

#... en ça:
one: apple
two: orange
</syntaxhighlight>

=== subelements ===
Similaire au lookup subelements, je n'ai pas compris ?

<syntaxhighlight lang='yaml'>
{{ users | subelements('groups', skip_missing=True) }}

#Change ça:
users:
- name: alice
authorized:
- /tmp/alice/onekey.pub
- /tmp/alice/twokey.pub
groups:
- wheel
- docker
- name: bob
authorized:
- /tmp/bob/id_rsa.pub
groups:
- docker

#... en ça:
-
- name: alice
groups:
- wheel
- docker
authorized:
- /tmp/alice/onekey.pub
- /tmp/alice/twokey.pub
- wheel
-
- name: alice
groups:
- wheel
- docker
authorized:
- /tmp/alice/onekey.pub
- /tmp/alice/twokey.pub
- docker
-
- name: bob
authorized:
- /tmp/bob/id_rsa.pub
groups:
- docker
- docker

#Exemple d'application
- name: Set authorized ssh key, extracting just that data from 'users'
authorized_key:
user: "{{ item.0.name }}"
key: "{{ lookup('file', item.1) }}"
loop: "{{ users | subelements('authorized') }}"

</syntaxhighlight>

== Filtres de commentaires ==

De nombreux filtres permettent de produire des commentaires, hautement personnalisés :

<syntaxhighlight lang='yaml'>
{{ "Plain style (default)" | comment }}

#Donne:

#
# Plain style (default)
#

#Plusieurs langages sont dispos:
{{ "C style" | comment('c') }}
{{ "C block style" | comment('cblock') }}
{{ "Erlang style" | comment('erlang') }}
{{ "XML style" | comment('xml') }}

#On peut choisir le caractère:
{{ "My Special Case" | comment(decoration="! ") }}

#Donne:
!
! My Special Case
!

#On peut aussi complètement customiser les commentaires
{{ "Custom style" | comment('plain', prefix='#######\n#', postfix='#\n#######\n ###\n #') }}

#Donne:

#######
#
# Custom style
#
#######
###
#
</syntaxhighlight>

== Urlsplit ==

Permet d'extraire des éléments d'une URL.

<syntaxhighlight lang='yaml'>
{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('hostname') }}
# => 'www.acme.com'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('netloc') }}
# => 'user:password@www.acme.com:9000'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('username') }}
# => 'user'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('password') }}
# => 'password'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('path') }}
# => '/dir/index.html'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('port') }}
# => '9000'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('scheme') }}
# => 'http'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('query') }}
# => 'query=term'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit('fragment') }}
# => 'fragment'

{{ "http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment" | urlsplit }}
# =>
# {
# "fragment": "fragment",
# "hostname": "www.acme.com",
# "netloc": "user:password@www.acme.com:9000",
# "password": "password",
# "path": "/dir/index.html",
# "port": 9000,
# "query": "query=term",
# "scheme": "http",
# "username": "user"
# }
</syntaxhighlight>

== Regex ==

On peut faire des regex directments dans les variables :

<syntaxhighlight lang='yaml'>
##Recherche de texte

# search for "foo" in "foobar"
{{ 'foobar' | regex_search('(foo)') }}

# will return empty if it cannot find a match
{{ 'ansible' | regex_search('(foobar)') }}

# case insensitive search in multiline mode
{{ 'foo\nBAR' | regex_search("^bar", multiline=True, ignorecase=True) }}

# Return a list of all IPv4 addresses in the string
{{ 'Some DNS servers are 8.8.8.8 and 8.8.4.4' | regex_findall('\\b(?:[0-9]{1,3}\\.){3}[0-9]{1,3}\\b') }}

## Remplacement de texte

# convert "ansible" to "able"
{{ 'ansible' | regex_replace('^a.*i(.*)$', 'a\\1') }}

# convert "foobar" to "bar"
{{ 'foobar' | regex_replace('^f.*o(.*)$', '\\1') }}

# convert "localhost:80" to "localhost, 80" using named groups
{{ 'localhost:80' | regex_replace('^(?P<host>.+):(?P<port>\\d+)$', '\\g<host>, \\g<port>') }}

# convert "localhost:80" to "localhost"
{{ 'localhost:80' | regex_replace(':80') }}
</syntaxhighlight>

== Chemins de fichiers ==

<syntaxhighlight lang='yaml'>
#Récupérer foo dans /etc/bar/foo
{{ path | basename }}

#Pareil dans un chemin windows
{{ path | win_basename }}

#Virer la lettre de lecteur d'un chemin Windows
{{ path | win_splitdrive }}

#Prendre uniquement la lettre du lecteur
{{ path | win_splitdrive | first }}

#Prendre tout le chemin sans la lettre de lecteur
{{ path | win_splitdrive | last }}

#Récupérer le répertoire à partir d'un chemin:
{{ path | dirname }}

#Pareil en Windows
{{ path | win_dirname }}

#Afficher le chemin complet quand il contient un ~
{{ path | expanduser }}

#Afficher le chemin complet quand il contient des variables d'environnement
#Ne fonctionne que sur les variables locales
{{ path | expandvars }}

#Récupérer le vrai chemin d'un lien
{{ path | realpath }}

#Récupérer le chemin relatif d'un lien à partir d'un point donné
{{ path | relpath('/etc') }}

#Récupérer la racine et l'extension d'un chemin
# with path == 'nginx.conf' the return would be ('nginx', '.conf')
{{ path | splitext }}
</syntaxhighlight>

== Dates ==

<syntaxhighlight lang='yaml'>
#mapper un attribut de chaque item d'une liste dans une liste de variables
# get a comma-separated list of the mount points (e.g. "/,/mnt/stuff") on a host
{{ ansible_mounts | map(attribute='mount') | join(',') }}

# Get total amount of seconds between two dates. Default date format is %Y-%m-%d %H:%M:%S but you can pass your own format
{{ (("2016-08-14 20:00:12" | to_datetime) - ("2015-12-25" | to_datetime('%Y-%m-%d'))).total_seconds() }}

# Get remaining seconds after delta has been calculated. NOTE: This does NOT convert years, days, hours, etc to seconds. For that, use total_seconds()
{{ (("2016-08-14 20:00:12" | to_datetime) - ("2016-08-14 18:00:00" | to_datetime)).seconds }}
# This expression evaluates to "12" and not "132". Delta is 2 hours, 12 seconds

# get amount of days between two dates. This returns only number of days and discards remaining hours, minutes, and seconds
{{ (("2016-08-14 20:00:12" | to_datetime) - ("2015-12-25" | to_datetime('%Y-%m-%d'))).days }}
</syntaxhighlight>

== Autres filtres utiles ==

<syntaxhighlight lang='yaml'>
#Mettre des quotes pour un usage avec shell
- shell: echo {{ string_value | quote }}

#Une valeur si vrai et une autre si faux
{{ (name == "John") | ternary('Mr','Ms') }}

#Pareil mais avec une troisième valeur si null
{{ enabled | ternary('no shutdown', 'shutdown', omit) }}

#Travailler en base64
{{ encoded | b64decode }}
{{ decoded | b64encode }}

#On peut définir l'encodage
{{ encoded | b64decode(encoding='utf-16-le') }}
{{ decoded | b64encode(encoding='utf-16-le') }}

#Créer un UUID à partir d'un string
{{ hostname | to_uuid }}

#Retype les variables: On peut dire à Ansible que le string "test" est en réalité un booléen
- debug:
msg: test
when: some_string_value | bool

</syntaxhighlight>

Ansible : Filtres - Historique des versions

Justine le 22 juin 2022 à 10:05

Justine : Page créée avec « https://docs.ansible.com/ansible/latest/user_guide/playbooks_filters.html [https://jinja.palletsprojects.com/en/2.10.x/templates/#builtin-filters Liste des filtres de Jinj... »

Justine : Page créée avec « https://docs.ansible.com/ansible/latest/user_guide/playbooks_filters.html [https://jinja.palletsprojects.com/en/2.10.x/templates/#builtin-filters Liste des filtres de Jinj... »