jenkins_config

Rôle Ansible qui gère diverses options/configurations dans Jenkins.

Exigences

• Un service Jenkins et tous les plugins que vous prévoyez de configurer.
• La capacité d'exécuter jenkins_script contre ce service Jenkins.

Variables du rôle

IMPORTANT : Lorsqu'elles sont spécifiées, la plupart de ces variables remplaceront les options Jenkins précédemment définies. Faites attention à ne pas perdre de paramètres que vous avez configurés auparavant.

---

jenkins_config_url: http://localhost:8080
jenkins_config_user: admin
jenkins_config_password: admin

L'URL, le nom d'utilisateur et le mot de passe pour s'authentifier auprès de Jenkins. Sera utilisé pour exécuter jenkins_script.

---

jenkins_config_csrf_enabled: null

État de protection CSRF à définir dans les paramètres de Jenkins. Ce paramètre ne sera pas défini à moins qu'une des valeurs prises en charge ne soit spécifiée.

Valeurs prises en charge :

• true
• false

---

jenkins_config_global_environment_variables: []
# jenkins_config_global_environment_variables:
#   - name: FOO
#     value: bar
#   - name: TOKEN
#     value: xxxyyyzzz

Variables d'environnement globales de Jenkins à définir dans les paramètres de Jenkins. Ce paramètre ne sera pas défini si la liste est vide.

---

jenkins_config_pipeline_durability: ''

Niveau de rapidité/durabilité par défaut des pipelines à définir dans les paramètres de Jenkins. Ce paramètre ne sera pas défini à moins qu'une des valeurs prises en charge ne soit spécifiée.

Valeurs prises en charge :

• max_survivability
• performance_optimized
• survivable_nonatomic

---

jenkins_config_simple_theme_css_url: ''
# jenkins_config_simple_theme_css_url: https://cdn.rawgit.com/afonsof/jenkins-material-theme/gh-pages/dist/material-indigo.css

URL du CSS du thème à définir dans les paramètres du thème simple de Jenkins. Ce paramètre ne sera pas défini si cette valeur est vide.

---

jenkins_config_jenkins_url: ''

URL de Jenkins à définir dans les paramètres de Jenkins. Ce paramètre ne sera pas défini si cette valeur est vide.

---

jenkins_config_system_admin_email: ''

Adresse e-mail de l'administrateur système à définir dans les paramètres de Jenkins. Ce paramètre ne sera pas défini si cette valeur est vide.

---

jenkins_config_global_pipeline_libraries: []
# jenkins_config_global_pipeline_libraries:
#   - name: global-pipeline-library
#     default_version: master
#     load_implicitly: false
#     allow_default_version_override: true
#     scm_git_path: '[email protected]:example/global-pipeline-library.git'
#     scm_credentials_id: jenkins-ssh

Bibliothèques de pipeline globales à définir dans les paramètres de Jenkins. Tous les champs doivent contenir une valeur non nulle (vide / 0 / etc. selon le type). Ce paramètre ne sera pas défini si la liste est vide.

Champs obligatoires (ne peuvent pas être vides) :

• name
• scm_git_path
• scm_credentials_id

---

jenkins_config_email_notification: null
# jenkins_config_email_notification:
#   smtp_server: smtp.gmail.com
#   default_user_email_suffix: @example.com
#   smtp_auth_username: example
#   smtp_auth_password: "{{ secret_smtp_password }}"
#   use_ssl: false
#   smtp_port: 465
#   reply_to_address: ''
#   charset: UTF-8

Valeurs de notification par e-mail à définir dans les paramètres de Jenkins. Tous les champs doivent contenir une valeur non nulle (vide / 0 / etc. selon le type). Ce paramètre ne sera pas défini si jenkins_config_email_notification.smtp_server is undefined.

---

jenkins_config_credentials: []
# jenkins_config_credentials:
#   - kind: ssh_username_with_private_key
#     id: jenkins-ssh
#     username: jenkins
#     private_key: "{{ secret_key }}"
#     passphrase: ''
#     description: Clé ajoutée depuis Ansible

Identifiants à définir dans le scope global. Tous les champs doivent contenir une valeur non nulle (vide / 0 / etc. selon le type). Ce paramètre ne sera pas défini si la liste est vide.

Champs obligatoires (ne peuvent pas être vides) :

• kind
• id

Types kind pris en charge et champs supplémentaires nécessaires :

• username_with_password
  • id : chaîne
  • username : chaîne
  • password : chaîne
  • description : chaîne
• ssh_username_with_private_key
  • id : chaîne
  • username : chaîne
  • private_key : chaîne
  • passphrase : chaîne
  • description : chaîne

---

jenkins_config_nodes: []
# jenkins_config_nodes:
#   - name: slave0
#     description: Noeud ajouté depuis Ansible
#     num_of_executors: 2
#     remote_root_directory: /var/lib/jenkins
#     labels: étiquettes séparées par des espaces
#     usage: exclusif
#     launch_method:
#       type: via_ssh
#       host: slave0.example.com
#       port: 22
#       credentials_id: jenkins-ssh
#       verification_strategy:
#         type: manually_trusted_key
#         require_initial_manual_trust: true
#     availability:
#       type: always
#     environment_variables: # définition optionnelle
#       - name: FOO
#         value: bar
#     disable_deferred_wipeout: true # définition optionnelle

Nœuds à définir dans Jenkins. Tous les champs définis doivent contenir une valeur non nulle (vide / 0 / etc. selon le type). Ce paramètre ne sera pas défini si la liste est vide.

Champs obligatoires (ne peuvent pas être vides) :

• name
• num_of_executors
• remote_root_directory
• usage
• launch_method
• availability

Valeurs prises en charge pour usage :

• normal
• exclusive

Méthodes de lancement prises en charge : type et champs supplémentaires nécessaires :

• via_command
  • command : chaîne
• via_ssh
  • host : chaîne
  • port : entier
  • credentials_id : chaîne
  • Stratégies de vérification prises en charge : type et champs supplémentaires nécessaires :
    • known_hosts_file
    • manually_provided_key
      • ssh_key : chaîne
    • manually_trusted_key
      • require_initial_manual_trust : booléen
    • non_verifying

Disponibilité prise en charge : type et champs supplémentaires nécessaires :

• always
• schedule
  • startup_schedule : chaîne
  • scheduled_uptime : entier
  • keep_up_when_active : booléen
• demand
  • in_demand_delay : entier
  • idle_delay : entier

Exemple de Playbook

- hosts: servers
  roles:
    - { role: meierw.jenkins_config }

Licence

MIT

Informations sur l'auteur

• Auteur : Walter Meier