Déploiement Monaco SaaS : projets, gabarits et dry-run

Déploiement Monaco SaaS : organisez projets et gabarits JSON, déclarez les dépendances Settings et validez avec deploy –dry-run avant de pousser.
Déploiement Monaco SaaS : projets, gabarits et dry-run

Module 4 du parcours Monaco SaaS : le déploiement Monaco SaaS, des projets et gabarits JSON jusqu’au dry-run qui valide le dépôt avant tout appel à l’API.

Parcours : Monaco SaaS · Module 4 · Durée : ~50 min · Niveau : Intermédiaire

Objectifs :

  • Organiser un dépôt en projets, fichiers YAML et gabarits JSON
  • Écrire une configuration de type Settings (schema, scope) et ses paramètres
  • Déclarer une dépendance entre deux configurations
  • Valider avec monaco deploy --dry-run puis cibler un projet ou un environnement

Prérequis : Monaco installé et un manifeste prêt (module 2), idéalement un export lu (module 3), un environnement Dynatrace SaaS de test.

Un export n’est qu’un point de départ : l’intérêt de la configuration as code est de redéployer, à l’identique ou avec des variantes, sur un autre environnement. Ce module couvre le déploiement Monaco SaaS : comment Monaco lit un dépôt, comment il ordonne les configurations et comment on vérifie le résultat sans rien casser. Pour un SRE, c’est le moment où la configuration cesse d’être un geste manuel et devient un changement relu, testé et reproductible. Le contenu vaut pour Dynatrace SaaS uniquement.

Déploiement Monaco SaaS : projets, YAML et gabarits d’un dépôt

Monaco repose sur trois briques, décrites dans la documentation officielle : le manifeste, les projets et les configurations. Chaque configuration associe deux fichiers :

  • un fichier YAML qui donne l’identifiant, le type, le nom, le gabarit et les paramètres ;
  • un gabarit JSON qui contient la charge utile envoyée à l’API, avec des emplacements {{ .nom }} remplis par les paramètres.

Le manifeste déclare les projets (un nom et un chemin) et les environnements cibles, regroupés en groupes. Voici l’exemple du guide de démarrage de la documentation : un projet, un environnement, authentification par jeton de plateforme lu dans une variable d’environnement.

Arborescence du dépôt d'exemple de la documentation Monaco et contenu du fichier manifest.yaml

Deux points à retenir. D’abord, le chemin d’un projet simple vaut son nom s’il est omis, et les chemins s’écrivent avec des barres obliques quel que soit le système. Ensuite, un projet de type grouping charge chaque sous-dossier comme un projet distinct : general/infrastructure et general/zones deviennent general.infrastructure et general.zones.

Écrire une configuration YAML et son gabarit

Le fichier de configuration commence par configs, une liste. Chaque entrée exige id, type et config. L’id est local à Monaco : il doit être unique pour un même type et un même projet, et il ne correspond pas à l’identifiant donné par Dynatrace. Dans config, on trouve template (le gabarit), skip (ne pas déployer si true) et parameters.

Exemple de la documentation, une configuration de type SLO avec une liste de balises :

configs:
- id: my-sample-slo
  config:
    name: mySampleSLO
    parameters:
      tags:
        type: list
        values: ["service:myService", "dt.owner:myTeam"]
    template: slo.json
    skip: false
  type: slo-v2

Dans le gabarit, "name": "{{ .name }}" et "tags": {{ .tags }} reprennent ces valeurs. Une liste s’écrit sans crochets supplémentaires dans le JSON. La documentation recommande de garder les gabarits simples et de s’en tenir à cette syntaxe de variable.

Les types de paramètres

Type Usage
value Valeur fixe ; forme courte possible pour un scalaire (threshold: 15)
environment Lit une variable d’environnement (name, default optionnel) ; le déploiement échoue si elle manque et si aucun default n’existe
reference Renvoie vers une autre configuration (project, configType, configId, property)
compound Assemble d’autres paramètres dans une chaîne (format, references)
list Liste de valeurs (values)
file Charge le contenu d’un fichier (à partir de Monaco 2.14.0)

Un paramètre n’est évalué que si une configuration à déployer le référence. Une variable d’environnement manquante ne bloque donc pas un déploiement qui ne l’utilise pas.

Objets Settings, scope et dépendances

Pour un objet Settings, le champ type prend un bloc settings avec schema, un schemaVersion facultatif et un scope. Le scope peut être une valeur, une référence ou environment, ce dernier visant l’environnement entier. Référencer l’identifiant d’une autre configuration permet de paramétrer une entité que Monaco vient de créer. La documentation donne cet exemple : une application web, puis ses réglages RUM.

Fichier config.yaml avec une configuration application-web et un objet Settings dont le scope référence cette application

Cette référence crée une dépendance. Monaco déploie les configurations dans l’ordre, la configuration dépendante en premier. Un cycle de dépendances fait échouer le déploiement avec une erreur. Les champs insertAfter (ordre des objets pour les schémas ordonnés) et permission existent aussi pour Settings ; la documentation précise que tous les schémas ne les acceptent pas.

Pour la forme courte d’une référence, un tableau suffit : [ projet, configType, configId, propriété ]. On peut omettre les niveaux du haut : sans configType, le projet courant est utilisé. Pour une configuration Settings, configType correspond à l’identifiant du schéma.

Variantes par environnement

Les champs facultatifs environmentOverrides et groupOverrides modifient une valeur pour un environnement ou un groupe, par exemple skip: true pour exclure une configuration de la production. C’est l’outil de la promotion dev vers prod, traitée plus loin dans le parcours.

Valider puis déployer

La commande est monaco deploy <manifest.yaml>. Ses options, relues dans le code du dépôt dynatrace-configuration-as-code et dans la page de référence des commandes :

Extrait du fichier command.go de Monaco listant les options environment, group, project, dry-run et continue-on-error
  • --dry-run (-d) : vérifie la structure du manifeste, des projets et des configurations, résout les paramètres et génère les gabarits. Il ne se connecte pas à Dynatrace : une erreur HTTP 400 reste possible au vrai déploiement si le contenu du JSON est invalide ;
  • --environment (-e) ou --group (-g), exclusifs entre eux : sans l’un ni l’autre, tous les environnements sont ciblés ;
  • --project (-p) : ne déploie que ce projet et les configurations dont il dépend ;
  • --continue-on-error (-c) : poursuit malgré une erreur, au risque d’erreurs en cascade sur les configurations dépendantes.

Sans argument de fichier, la commande attend un manifeste en .yaml. Un dry-run réussi se termine par le message « Validation finished without errors », selon le guide de démarrage.

Exercice pratique

À réaliser sur un environnement de test Dynatrace SaaS. Les commandes ci-dessous sont celles de la documentation ; elles n’ont pas été exécutées pour rédiger ce module.

Étape 1 — Créer l’arborescence

mkdir -p monaco-getting-started/project-example/slo
cd monaco-getting-started/project-example/slo
touch slo.json slo.yaml
cd ../..
touch manifest.yaml

Résultat attendu : l’arborescence de la première capture.

Étape 2 — Renseigner les fichiers

Copiez le manifeste de la capture, le YAML SLO et un gabarit slo.json qui reprend {{ .name }} et {{ .tags }}. Le guide de démarrage fournit le gabarit complet. Le jeton de plateforme doit porter les portées slo:slos:read, slo:slos:write et slo:objective-templates:read pour cet exemple.

Étape 3 — Exporter les variables

export DT_ENV_URL="https://<votre-environnement>.apps.dynatrace.com"
export PLATFORM_TOKEN="<votre-jeton>"

Ne placez jamais le jeton dans un fichier versionné. Résultat attendu : les deux variables sont visibles dans le shell, pas dans le dépôt.

Étape 4 — Valider

monaco deploy --dry-run manifest.yaml

Résultat attendu : le projet et l’environnement sont listés, puis « Validation finished without errors ». Cassez volontairement le JSON du gabarit pour observer l’échec, puis corrigez.

Étape 5 — Déployer puis cibler

monaco deploy manifest.yaml -p my-slo-project -e development-environment

Résultat attendu : le SLO apparaît dans l’environnement de test. Relancez la commande : l’objet doit être mis à jour, non dupliqué.

Quiz

  1. Que contient un gabarit JSON ? a) Les identifiants des environnements b) La charge utile envoyée à l’API, avec des variables c) Le jeton d’API d) La liste des projets
  2. Que ne peut pas détecter --dry-run ? a) Un YAML mal formé b) Un gabarit qui n’est pas du JSON c) Un contenu JSON refusé par l’API Dynatrace d) Un paramètre introuvable
  3. Comment déclare-t-on qu’un objet Settings dépend d’une application créée par Monaco ? a) Par un scope de type reference b) Par un nom identique c) Par l’option -c d) Par un second manifeste
  4. Que se passe-t-il avec un cycle de dépendances ? a) Monaco l’ignore b) Le déploiement échoue avec une erreur c) Monaco choisit l’ordre alphabétique d) Seul le dry-run échoue

Corrigé

  1. b) Le YAML décrit la configuration, le gabarit porte le JSON de l’API.
  2. c) Le dry-run ne se connecte pas à Dynatrace ; seul le déploiement réel révèle un JSON refusé.
  3. a) La référence fait déployer la configuration référencée en premier.
  4. b) La documentation indique que le déploiement échoue avec une erreur.

Pour aller plus loin

← Module 3 : Export Monaco SaaS · Sommaire du parcours · Module 5 : OAuth Monaco SaaS →

Questions fréquentes

Le dry-run garantit-il que le déploiement réussira ?

Non. Il valide la structure et le rendu des gabarits, mais ne contacte pas Dynatrace. Un JSON valide pour Monaco peut encore être refusé par l’API.

Faut-il un nom dans chaque configuration ?

Pour les types api, oui : le nom identifie l’objet. Depuis Monaco 2.7.0, il est facultatif pour les autres types, identifiés par leur coordonnée (projet, type, identifiant) ou par originObjectId.

Comment déployer vers un seul environnement ?

Avec --environment (ou --group pour un groupe). Les deux options s’excluent mutuellement.

Vous savez maintenant structurer un dépôt, déclarer des dépendances et valider avant de déployer. Le module suivant traite l’authentification par OAuth et par jeton de plateforme, les secrets et la suppression.

span.observer est un blog indépendant de la communauté, non affilié à Dynatrace LLC. Ce parcours ne remplace pas les formations et certifications officielles de Dynatrace University. Vérifiez les fonctionnalités dans la documentation officielle de votre version.

Total
0
Shares
Laisser un commentaire

Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont indiqués avec *

Previous Post
Module 4 — Déploiement Monaco Managed : projets, gabarits et dry-run

Module 4 — Déploiement Monaco Managed : projets, gabarits et dry-run

Next Post
Secrets Monaco Managed : variables, environnements et delete

Secrets Monaco Managed : variables, environnements et delete

Related Posts