M201 : Concevoir des templates performants et réutilisables
Construire un template, puis le compléter en copiant
La phase dev tâche par tâche, les phases int et prod par copie, un gate, et une première release.
Ce que vous allez faire
Vous construisez le template de déploiement de guestbook. La phase dev d'abord, tâche par tâche, puis les phases int et prod en copiant ce qui existe, le gate Go / No Go, et une première release déroulée jusqu'en production.
Votre point de départ
Vous partez d'un template vide, dans votre folder Sandbox. Si vous prenez du retard sur la phase dev, le pré-template Deploy guestbook (starter) la contient terminée : dupliquez-le, nommez la copie Deploy guestbook et reprenez au deuxième temps.
Ce qu'est un template, et ce qu'il n'est pas
Un template est un plan de release : des phases dans l'ordre, des tâches dans chaque phase, et pour chacune ce qu'il faut savoir pour l'exécuter. Il ne contient aucune date réelle et aucune valeur propre à une exécution ; c'est la release qui les porte. Un bon template se reconnaît à trois choses : on comprend le processus en le lisant de haut en bas, chaque tâche dit qui fait quoi et combien de temps ça prend, et rien n'y est écrit deux fois.
| Niveau | Ce qu'on y règle | Dans Deploy guestbook |
|---|---|---|
| Template | Titre, description, catégories, tags, logo, comportement en cas d'échec, releases simultanées autorisées, archivage, notifications | Catégorie Nexapay, tag guestbook, Abort on failure décoché |
| Phase | Titre, couleur, description, durée planifiée | dev, int et prod dans l'ordre, une couleur par environnement |
| Tâche | Type, titre, description, responsable ou team, durée planifiée, tags, précondition, gestionnaire d'échec, pièces jointes | Tout ce que le runbook disait en prose, rangé champ par champ |
La règle à retenir
Le template est la documentation du processus. Si un nouveau release manager ne peut pas exécuter la release en lisant seulement les titres et les descriptions des tâches, le template est incomplet. Et si on doit modifier le template avant chaque release, il contient une valeur qui aurait dû être une variable : c'est le module 205.
Les types de tâches
Quand vous cliquez Add task, Release propose les types de base, puis ceux des plugins installés.
| Type | Qui l'exécute | Ce qu'il fait | Dans Deploy guestbook |
|---|---|---|---|
| Task | Une personne | Une action à faire et à déclarer terminée | Les attentes de merge, tant qu'elles ne sont pas automatisées (module 301) |
| Gate | Release, sur décision humaine | Attend que des conditions soient cochées et des dépendances terminées | Go / No Go, en tête de prod |
| User Input | Une personne | Demande des valeurs et les range dans des variables | Non utilisé |
| Notification | Release | Envoie un mail, sujet et corps en variables | Non utilisé |
| Parallel group, Sequential group | Release | Un conteneur de tâches, lancées ensemble ou l'une après l'autre | Pour regrouper Créer et Synchroniser |
| Create Release | Release | Crée et démarre une autre release depuis un template | Module 206 : la montée de version |
| Script | Release | Exécute quelques lignes de script | Définir l'environnement |
| Webhook · JSON webhook | Release | Appelle une API et lit sa réponse | Module 206 : Redmine et Gitea |
| ArgoCD · Create Application, Sync Application | Release, par le plugin | Crée puis synchronise une application ArgoCD | Le déploiement de chaque environnement |
Réutiliser avant de créer
Une tâche, un groupe ou une phase se copient : menu de la tâche ou de la phase, Duplicate. La copie garde toute la configuration. C'est le geste de cet exercice, et la première règle d'un template réutilisable : ce qui ne change que par une valeur ne s'écrit qu'une fois, la valeur devient une variable.
Le gate : conditions et dépendances
Un gate est une tâche qui ne se termine pas toute seule et que personne ne termine à la main. Il s'ouvre quand toutes ses conditions sont cochées et que toutes ses dépendances sont terminées. Une condition est une case à cocher par une personne, avec un libellé : « Changement approuvé ». Une dépendance est un lien vers une tâche, une phase ou une release entière, ailleurs dans Release : « la release de mise à jour de la base de référence est terminée ». Le gate combine donc le jugement humain et l'état réel des autres travaux.
| Mécanisme | Qui l'ouvre | Exemple Nexapay |
|---|---|---|
| Condition | Une personne qui coche, le journal retient qui et quand | Changement approuvé · Recette int validée · Aucune anomalie bloquante |
| Dépendance | Release, quand la cible atteint Completed | La tâche « Validation métier » d'une autre release, la fenêtre de tir ouverte par l'astreinte |
Au module 301, vous verrez l'autre façon de bloquer une tâche : la précondition, une expression évaluée par Release sans intervention humaine. Le gate demande une décision ; la précondition applique une règle.
Exercice 2.1 · Construire le template jusqu'à la production
80 minutes, chacun sur sa plateforme, en trois temps.
Premier temps, 25 minutes : la phase dev.
- Créer le template. Dans
Sandbox, onglet Templates, créez un template nomméDeploy guestbook. Renommez sa phase endev. - Créer deux variables. Menu Variables, New variable, deux fois. Pour les deux, décochez Required et Show on Create Release form :
Name Type À quoi elle sert envText L'environnement en cours, fixé par un script en tête de chaque phase appnameText Le nom de l'application ArgoCD, rempli par la tâche de création - Fixer l'environnement. Dans la phase
dev, Add task, type Script, Jython Script, nomméeDéfinir l'environnement dev. Script :releaseVariables['env'] = "dev"
- Créer l'application. Add task, type ArgoCD, Create Application, nommée
Créer l'application ArgoCD guestbook-dev:Champ Valeur Server La connexion ArgoCD proposée dans la liste Application name ${release.owner}-guestbook-${env}Project participant-N, avec votre numéroAdresse du dépôt https://gitea.tulipe.arvida.tech/participant-N/guestbook.gitRevision ${env}: la branche porte le nom de l'environnementPath .Namespace tulipe-participant-NSortie Application name ${appname} - La synchroniser. Add task, type ArgoCD, Sync Application, nommée
Synchroniser l'application ArgoCD guestbook-dev: même Server, et Application name :${appname}. - Essayer. New release, titre
guestbook : essai dev, Create puis Start. Les trois tâches s'enchaînent seules. Vérifiez dans ArgoCD que votre applicationguestbook-devest synchronisée.
Deuxième temps, 25 minutes : les phases int et prod.
- Dupliquer la phase dev. Menu de la phase
dev, Duplicate. Renommez la copieintet donnez-lui une autre couleur. - Adapter la phase int. Renommez ses trois tâches en remplaçant
devparint. Dans la tâche Script, remplacez la valeur :releaseVariables['env'] = "int"
- Ajouter l'attente. En tête de la phase
int, ajoutez une tâche de type Task nomméeAttendre le merge vers int. Elle sera automatisée au module 301. - Créer la phase prod. Dupliquez
int, renommez enprod, adaptez les titres. Dans la tâche Script, la valeur estmain, le nom de la branche de production :releaseVariables['env'] = "main"
Renommez l'attente enMerger int vers main.
Troisième temps, 30 minutes : le gate et la première release.
- Poser le gate. En tête de la phase
prod, ajoutez une tâche de type Gate nomméeGo / No Go. Ajoutez trois conditions :Recette int validée,Ticket Redmine approuvé,Aucune anomalie bloquante. - Documenter. Sur le gate, renseignez une description d'une phrase et une durée planifiée d'une heure.
- Démarrer une release. Bouton New release, titre
guestbook : premier passage, puis Create et Start. - Dérouler. La phase dev se déroule seule. Terminez
Attendre le merge vers intà la main, laissez la phase int se dérouler, puis cochez les trois conditions du gate. - Terminer. Terminez
Merger int vers mainà la main et laissez la phase prod se finir.
Ce que vous devez observer
Dans ArgoCD, trois applications à votre nom : guestbook-dev, guestbook-int, guestbook-main, toutes synchronisées. Dans la release, le gate ne s'ouvre qu'à la troisième condition cochée.
Preuve attendue : la release à l'état Completed, et les trois applications ArgoCD à l'état Synced.
- La phase dev a été construite tâche par tâche et déploie guestbook-dev.
- Le template compte trois phases et un gate en tête de prod.
- Les phases int et prod viennent d'une copie, pas d'une saisie.
- Une release complète est allée jusqu'à prod.
Bonus · Regrouper Créer et Synchroniser
Facultatif, 5 minutes.
- Dans la phase dev, ajoutez un Sequential group nommé
Déployer sur devet glissez-y les deux tâches ArgoCD. - Repliez le groupe : la phase se lit en deux lignes au lieu de trois.
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.