Formation Arvida›Digital.ai Release›Cas d'usage Nexapay›Module 205

Sommaire
ARVIDA OFFRE DE SERVICE Digital.ai Release · OFR0004-205

M205 : Maîtriser les variables pour automatiser vos tickets

Remplacer ce qui est écrit en dur par des variables

Variables de release, de folder et globales : la bonne valeur au bon niveau.

Durée 30 minExercice 20 minJour 1

Ce que vous allez faire

Votre template fonctionne, mais il ne fonctionne que pour vous : le projet ArgoCD, le namespace et l'adresse du dépôt y sont écrits en dur. Vous les remplacez par des variables, au bon niveau, pour que le même template serve à toute une équipe.

Votre point de départ

Le pré-template Deploy guestbook (201 done) est dans votre folder Sandbox si vous n'avez pas terminé le module 201. Les variables env et appname existent déjà, vous les avez créées au module 201 : appname reçoit le nom de l'application ArgoCD, rempli par la tâche de création.

À quoi sert une variable

Une variable est une valeur nommée, qu'on écrit ${nom} et que Release remplace au moment où il en a besoin : dans un titre, une description, un champ de tâche automatisée, un script.

SituationDans Deploy guestbook
La valeur n'est pas connue quand on écrit le templateLe numéro du ticket Redmine, le numéro de la pull request
La même valeur sert à plusieurs endroits${env} dans les titres et les champs des trois phases
La valeur change d'une équipe à l'autreLe projet ArgoCD, l'adresse du dépôt
Une tâche produit une valeur que les suivantes utilisentLe ticket créé par une tâche, lu par la suivante

Trois niveaux, trois écritures

Une variable appartient à un périmètre. Plus il est large, plus la valeur doit être stable.

NiveauOù on la créeÉcritureQui la voitPour quoi faire
ReleaseDans le template, menu Variables, New variable${application}Cette release seulementCe qui est propre à une livraison : ticket, pull request, résultats intermédiaires
FolderSur le folder, onglet Variables${folder.repoUrl}Tous les templates et releases du folder et de ses sous-foldersCe qui est commun à une équipe : adresses des outils, projet, destinataires
GlobalConfiguration, Global variables, réservé aux administrateurs${global.compte.applicatif.username}Toute la plateformeCe qui est vrai partout : le compte technique
GLOBAL · Home › Configuration › Global Variables · une valeur par plateforme ${global.x} compte.applicatif.username Text · le compte de service compte.applicatif.password Password · masqué partout Run automated tasks as user des propriétés du template FOLDER · Nexapay › Sandbox · une valeur différente par folder ${folder.x} argoProject Projet ArgoCD de l'équipe repoUrl Adresse du dépôt guestbook redmineUrl Adresse de Redmine RELEASE · Deploy guestbook · une valeur différente par release ${x} Demandées au démarrage Required · Show on Create Release form application composants Text · défaut guestbook · module 205 List · frontend, api, base · module 206 Le nom de l'application ArgoCD ${release.owner}-${application}-${env} Secrets Password · saisi une fois giteaToken Compte de service Gitea créée au module 202 ******** jamais affiché, ni dans la History ni dans le formulaire Internes, remplies par la release ni Required ni sur le formulaire env appname namespace ticketRedmine prNumber dev, int, main le nom de l'application ArgoCD défaut tulipe-participant-N le numéro du ticket le numéro de la pull request Script en tête de phase · 201 Create Application · 201 valeur par défaut · 205 Créer le ticket Redmine · 206 Trouver la PR · 206 QUI LES REMPLIT L'administrateur Une fois, pour toute la plateforme La team Folder Owner Une fois par équipe · Edit folder variables La personne qui démarre Formulaire New release, à chaque release. Deux champs, et le template n'est plus jamais retouché. Les tâches automatisées En cours de route : chaque tâche écrit dans une variable, les tâches suivantes la lisent. Vous, au module 202 Le jeton du compte de service, collé une fois dans le template. Plus le périmètre est large, moins on y touche, plus la valeur est stable.

Les trois périmètres, les variables du template Deploy guestbook, et qui remplit chacune. Elles arrivent au fil des modules 201 à 206.

Release fournit aussi des valeurs prêtes à l'emploi : ${release.title}, ${release.owner}, ${release.id}. Le modèle s'en sert pour nommer les applications ArgoCD : ${release.owner}-guestbook-${env}.

Créer une variable à la volée

Tapez ${ticketRedmine} dans un champ de tâche : si la variable n'existe pas, Release propose de la créer. Pratique, mais relisez ensuite son type et ses options dans le menu Variables.

Types et options

TypeCe qu'il apporteDans Deploy guestbook
TextUne chaîne libre, le type par défautapplication, env, ticketRedmine
PasswordMasquée à l'écran et dans la HistorygiteaToken
List boxUn choix fermé, sans faute de frappeUne liste d'applications
Checkbox, Number, DateUne valeur typée, contrôlée à la saisieUne date de fenêtre de mise en production
OptionEffet
Label, DescriptionCe que la personne lit dans le formulaire de démarrage
RequiredLa release ne démarre pas sans valeur
Show on Create Release formLa variable est demandée au démarrage. Une variable remplie en cours de route reste décochée
Default valuePré-remplit le formulaire

Exercice 3.1 · Sortir du template ce qui est écrit en dur

20 minutes, chacun sur sa plateforme.

  1. Repérer. Ouvrez la tâche Créer l'application ArgoCD guestbook-dev. Trois champs portent une valeur qui vous est propre : Project, Namespace et l'adresse du dépôt. Un quatrième, Application name, contient le mot guestbook en dur.
  2. Créer deux variables de folder. Sur le folder Sandbox, onglet Variables :
    CléTypeValeur
    folder.argoProjectTextparticipant-N, avec votre numéro
    folder.repoUrlTexthttps://gitea.tulipe.arvida.tech/participant-N/guestbook.git
  3. Créer une variable de release. Dans le template, menu Variables : clé namespace, type Text, valeur par défaut tulipe-participant-N, non demandée au démarrage.
  4. Remplacer dans la tâche dev. Dans la tâche de création ArgoCD de la phase dev, remplacez les trois valeurs par ${folder.argoProject}, ${namespace} et ${folder.repoUrl}.
  5. Reporter sur int et prod. Faites la même chose dans les deux autres tâches de création.
  6. Demander l'application au démarrage. Créez une variable de release application : label Application à livrer, valeur par défaut guestbook, Required et Show on Create Release form cochés. Dans les trois tâches de création, le champ Application name devient ${release.owner}-${application}-${env}.
  7. Vérifier. Démarrez une release : le formulaire demande l'application. Laissez la phase dev se dérouler puis abandonnez la release avec Abort.

Ce que vous devez observer

Le formulaire de démarrage affiche « Application à livrer ». La tâche de création ArgoCD réussit comme avant : Release a remplacé les trois variables par leurs valeurs, visibles dans la tâche terminée.

Preuve attendue : les deux variables dans l'onglet Variables du folder, et la tâche de création ArgoCD de la phase dev réussie.

  • Plus aucune valeur participant-N en dur dans les trois tâches de création.
  • Deux variables de folder et deux variables de release créées.
  • application est demandée au démarrage avec un libellé lisible.

Bonus · Une variable créée à la volée

Facultatif, 5 minutes.

  1. Dans la description du gate Go / No Go, écrivez Ticket Redmine : ${ticketRedmine} et acceptez la création de la variable.
  2. Dans le menu Variables, décochez Required et Show on Create Release form : une tâche la remplira au module 206.

Support d'exercices de l'offre de service Digital.ai Release - Administration (ACOSS) (OFR0004). Le cas Nexapay est fictif et l'outil Redmine est simulé pour la formation. Une erreur, une suggestion ? Écris à William Gravier, wgravier@arvida.fr.