AdminSysGNULinux

Outils pour utilisateurs

Outils du site

Piste :
tech:bonnes_pratiques_ansible

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentesRévision précédente
Prochaine révision		Révision précédente
tech:bonnes_pratiques_ansible [2025/10/29 15:08] – Jean-Baptistetech:bonnes_pratiques_ansible [2025/11/20 16:27] (Version actuelle) – Jean-Baptiste
Ligne 74: Ligne 74:
 Éviter d'utiliser les **M(script)** et **M(command)** \\ Éviter d'utiliser les **M(script)** et **M(command)** \\
 Privilégier **M(command)** à **M(shell)** \\ Privilégier **M(command)** à **M(shell)** \\
-Si variables Jinja en argument à M(command) ou M(shell) : utiliser ''quote'' pour échapper les caractères spéciaux.+Si variables Jinja en argument à M(shell) : utiliser ''quote'' pour échapper les caractères spéciaux.
 Pour **M(command)**, **M(shell)**, **M(script)**, contrôler le code de retour avec  Pour **M(command)**, **M(shell)**, **M(script)**, contrôler le code de retour avec 
 * ''register'' * ''register''
Ligne 179: Ligne 179:
  
 Éviter d’utiliser ''delegate_to'' surtout, dans les rôles (RA_QUA_N1) Éviter d’utiliser ''delegate_to'' surtout, dans les rôles (RA_QUA_N1)
 +
 +
 +Pour les templates et les fichiers, systématiquement sauf si non applicable mettre en commentaire que ce fichier est géré par Ansible. (RA_QUA_N1)
 +
 +Exemple :
 +''all.yml''
 +<code yaml>
 +ansible_managed: This file is managed by ansible. Manual changes are likely to be overwritten !
 +</code>
 +
 +
 +=== Pièges
 +
 +==== Run_once
 +
 +
 +
 +run_once will be executed at each serial execution in the play. That means, if you choose serial = 1, it will be asked to confirm as many times as the quantity of targets on the play.
 +
 +Check Ansible docs: https://docs.ansible.com/ansible/latest/user_guide/playbooks_strategies.html#running-on-a-single-machine-with-run-once
 +
 +When used together with serial, tasks marked as run_once will be run on one host in each serial batch. If the task must run only once regardless of serial mode, use ''when: inventory_hostname == ansible_play_hosts_all[0]'' construct.
 +
 +Attention aux slicing !
 +
 +
 +
 +=== Limiter l'usage des ressources
 +
 +<code yaml>
 +- name: Installation d'un logiciel sur plusieurs serveurs avec throttle
 +  ansible.builtin.apt:
 +    name: nginx
 +    state: present
 +  async: 600  # Exécution en mode asynchrone avec un délai maximum de 10 minutes
 +  poll: 5     # Vérification toutes les 5 secondes
 +  throttle: 3  # Limite à 3 installations simultanées
 +  when: inventory_hostname in groups['webservers']
 +</code>
 +
  
  
Ligne 196: Ligne 236:
 Variable Management for Inventory - Keeping variable data along with the hosts and groups definitions (see the inventory editor) is encouraged, rather than using group_vars/ and host_vars/ Variable Management for Inventory - Keeping variable data along with the hosts and groups definitions (see the inventory editor) is encouraged, rather than using group_vars/ and host_vars/
  
-Autoscaling - Using the “callback” feature to allow newly booting instances to request configuration is very useful for auto-scaling scenarios or provisioning integration.+Autoscaling - Using the “callback” feature to allow newly booting instances to request configuration is very useful for auto-scaling scenarios or provisioning integration.$
  
 Larger Host Counts - Consider setting “forks” on a job template to larger values to increase parallelism of execution runs. Voir : Strategy, Mitogen, Slicing, Async (Asynchronous) (RA_PERF_N3) Larger Host Counts - Consider setting “forks” on a job template to larger values to increase parallelism of execution runs. Voir : Strategy, Mitogen, Slicing, Async (Asynchronous) (RA_PERF_N3)
Ligne 202: Ligne 242:
 Ne pas utiliser Verbosity à 4 ou 5. Eviter d'augmenter la verbosité si l'inventaire est conséquent Ne pas utiliser Verbosity à 4 ou 5. Eviter d'augmenter la verbosité si l'inventaire est conséquent
  
-Ne pas mettre les facts des noeuds dans la base de données - Ne pas activer "Enable Fact Storage"+Ne pas mettre les facts des nœuds dans la base de données - Ne pas activer "Enable Fact Storage"
 Le cache des facts doit être sur les managed_hosts et non coté serveur (RA_GEN_N1) Le cache des facts doit être sur les managed_hosts et non coté serveur (RA_GEN_N1)
 +
 +Ne pas faire de ''command: ansible-galaxy'' ni de ''shell: ansible-galaxy'', mais utiliser la manière native de AAP / AWX (RA_QUA_N1)
 +
 +
  
  
Ligne 259: Ligne 303:
 * ''module_defaults'' (If you frequently call the same module with the same arguments) * ''module_defaults'' (If you frequently call the same module with the same arguments)
 * En utilisant import* et include* (attention aux notify avec include) * En utilisant import* et include* (attention aux notify avec include)
 +* En utilsant ''block''
  
 Utiliser SonarQube ou équivalent (RA_GEN_N4) Utiliser SonarQube ou équivalent (RA_GEN_N4)
Ligne 275: Ligne 320:
  
  
-=== Utiliser les modules déjà présent / ne pas réinventer la roue (RA_GEN_N1)+=== Utiliser les modules déjà existant / ne pas réinventer la roue (RA_GEN_N1) 
  
  
Ligne 386: Ligne 432:
 You cannot use loops on 'import_tasks' statements. You should use 'include_tasks' instead. You cannot use loops on 'import_tasks' statements. You should use 'include_tasks' instead.
 </code> </code>
- 
- 
- 
- 
  
  
Ligne 408: Ligne 450:
  
 Utiliser ''no_log: true'' pour les taches utilisant des secrets (RA_SEC_N1) Utiliser ''no_log: true'' pour les taches utilisant des secrets (RA_SEC_N1)
 +
 +Pour les données sensibles utiliser ansible-vault ou les Crendential AWX (RA_SEC_N1)
  
 Troubleshooting untrusted templates  Troubleshooting untrusted templates 
Ligne 430: Ligne 474:
  
  
 +Eviter de boucler innutilement - vérifier si le module prends des listes (RA_PERF_N2)
  
 +<code yaml> 
 +- name: Install packages 
 +  ansible.builtin.package: 
 +    name: "{{ item }}" 
 +    state: present 
 +  loop: 
 +    - curl 
 +    - wget 
 +</code> 
 +  
 +<code yaml> 
 +- name: Install packages 
 +  ansible.builtin.package: 
 +    name: 
 +      - curl 
 +      - wget 
 +</code>
  
  
Ligne 450: Ligne 511:
 == Convention de nommage  == Convention de nommage 
  
-Si beaucoup de templates dans le role : utiliser une arborescence du style : +=== Naming things 
-* files/etc/nginx/sites-available/plop+ 
 +* Use valid Python identifiers following standard naming conventions of being in snake_case_naming_schemes for all YAML or Python files, variables, arguments, repositories, and other such names (like dictionary keys). 
 + 
 +* Do not use special characters other than underscore in variable names, even if YAML/JSON allow them. 
 + 
 +Source : https://redhat-cop.github.io/automation-good-practices/#_naming_things 
 + 
 + 
 +=== name 
 + 
 +For example, if you have a task named **Restart server** inside a file named ''tasks/deploy.yml'', this rule suggests renaming it to **deploy | Restart server** 
 +Source : https://ansible.readthedocs.io/projects/lint/rules/name/#nameprefix 
 + 
 +=== role-name 
 + 
 +(snake case) 
 +Role names must contain only lowercase alphanumeric characters and the underscore _ character. Role names must also start with an alphabetic character. 
 +Source : https://ansible.readthedocs.io/projects/lint/rules/role-name/ 
 + 
 + 
 +=== var-naming 
 + 
 +... 
 +Variable names must contain only lowercase alphanumeric characters and the underscore _ character. Variable names must also start with either an alphabetic or underscore _ character. 
 +... 
 +role_name_ as a prefix 
 +... 
 +Source : https://ansible.readthedocs.io/projects/lint/rules/var-naming/ 
 + 
 + 
 +=== Extra_vars 
  
 Voir : https://github.com/openshift/openshift-ansible/blob/master/docs/style_guide.adoc Voir : https://github.com/openshift/openshift-ansible/blob/master/docs/style_guide.adoc
  
-Convention pour les **register**+Exemple : ''cli_plop'' 
 + 
 + 
 +=== Register  
 + 
 +Convention pour les **register**. 
 +Exemple ''r_foo'' 
 + 
 + 
 +=== Autres 
  
 Les listes seront nommées avec un **s** finals. L'emploi du pluriel indique plusieurs éléments possibles Les listes seront nommées avec un **s** finals. L'emploi du pluriel indique plusieurs éléments possibles
Ligne 466: Ligne 566:
 * Variables internes * Variables internes
  
-Nommer les templates Jinja avec l’extension **j2** (RA_CONV_O)+Nommer les templates Jinja avec l’extension **j2** (RA_CONV_REQ)
  
  
-Préférer les variables a plat plutôt que les variables dictionnaires (RA_CONV_F)+Préférer les variables a plat plutôt que les variables dictionnaires (RA_CONV_OPT)
 <code yaml> <code yaml>
 endpoint_url: endpoint_url:
Ligne 486: Ligne 586:
 === Boucles === Boucles
  
-De préférence nommer la variable de boucle (''loop_var'') à la place d'utiliser le nom par défaut ''item'' (RA_CONV_O)+De préférence nommer la variable de boucle (''loop_var'') à la place d'utiliser le nom par défaut ''item'' (RA_CONV_OPT)
  
 C'est plus lisible, et cela permet un fonctionnement non équivoque en cas de boucles imbriqués. C'est plus lisible, et cela permet un fonctionnement non équivoque en cas de boucles imbriqués.
Ligne 508: Ligne 608:
 === Fichiers / templates === Fichiers / templates
  
-Pour les roles contenants beaucoup de fichiers dans "files/" privilégier une arborescence comme suit (RA_CONV_F)+Pour les roles contenants beaucoup de fichiers dans "files/" privilégier une arborescence comme suit (RA_CONV_OPT)
 * files/etc/nginx/sites-available/plop * files/etc/nginx/sites-available/plop
 * files/etc/systemd/system/plop.service * files/etc/systemd/system/plop.service
tech/bonnes_pratiques_ansible.1761746887.txt.gz · Dernière modification : de Jean-Baptiste
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki