Despliegue Monaco SaaS: proyectos, plantillas y dry-run

Despliegue Monaco SaaS: organiza proyectos y plantillas JSON, declara las dependencias de Settings y valida con deploy –dry-run antes de desplegar.
Déploiement Monaco SaaS : projets, gabarits et dry-run

Módulo 4 del curso de Monaco SaaS: el despliegue Monaco SaaS, desde los proyectos y las plantillas JSON hasta el dry-run que valida el repositorio antes de cualquier llamada a la API.

Curso: Monaco SaaS · Módulo 4 · Duración: ~50 min · Nivel: Intermedio

Objetivos:

  • Organizar un repositorio en proyectos, archivos YAML y plantillas JSON
  • Escribir una configuración de tipo Settings (schema, scope) y sus parámetros
  • Declarar una dependencia entre dos configuraciones
  • Validar con monaco deploy --dry-run y luego apuntar a un proyecto o a un entorno

Requisitos previos: Monaco instalado y un manifiesto listo (módulo 2), idealmente una exportación ya leída (módulo 3) y un entorno de prueba de Dynatrace SaaS.

Una exportación es solo un punto de partida: el interés de la configuración como código es volver a desplegar, de forma idéntica o con variantes, en otro entorno. Este módulo cubre el despliegue Monaco SaaS: cómo lee Monaco un repositorio, cómo ordena las configuraciones y cómo se verifica el resultado sin romper nada. Para un SRE, es el momento en que la configuración deja de ser un gesto manual y se convierte en un cambio revisado, probado y reproducible. El contenido vale únicamente para Dynatrace SaaS.

Despliegue Monaco SaaS: proyectos, YAML y plantillas de un repositorio

Monaco se apoya en tres piezas, descritas en la documentación oficial: el manifiesto, los proyectos y las configuraciones. Cada configuración asocia dos archivos:

  • un archivo YAML que da el identificador, el tipo, el nombre, la plantilla y los parámetros;
  • una plantilla JSON que contiene la carga útil enviada a la API, con marcadores {{ .nom }} rellenados por los parámetros.

El manifiesto declara los proyectos (un nombre y una ruta) y los entornos de destino, agrupados en grupos. Este es el ejemplo de la guía de inicio de la documentación: un proyecto, un entorno, autenticación con un token de plataforma leído de una variable de entorno.

Árbol del repositorio de ejemplo de la documentación de Monaco y contenido del archivo manifest.yaml

Dos puntos que recordar. Primero, la ruta de un proyecto simple vale su nombre si se omite, y las rutas se escriben con barras oblicuas sea cual sea el sistema. Segundo, un proyecto de tipo grouping carga cada subcarpeta como un proyecto distinto: general/infrastructure y general/zones pasan a ser general.infrastructure y general.zones.

Escribir una configuración YAML y su plantilla

El archivo de configuración empieza por configs, una lista. Cada entrada exige id, type y config. El id es local a Monaco: debe ser único para un mismo tipo y un mismo proyecto, y no corresponde al identificador que asigna Dynatrace. Dentro de config están template (la plantilla), skip (no desplegar si es true) y parameters.

Ejemplo de la documentación, una configuración de tipo SLO con una lista de etiquetas:

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

En la plantilla, "name": "{{ .name }}" y "tags": {{ .tags }} retoman esos valores. Una lista se escribe sin corchetes adicionales en el JSON. La documentación recomienda mantener las plantillas simples y ceñirse a esta sintaxis de variable.

Los tipos de parámetros

Tipo Uso
value Valor fijo; forma corta posible para un escalar (threshold: 15)
environment Lee una variable de entorno (name, default opcional); el despliegue falla si falta y no existe default
reference Remite a otra configuración (project, configType, configId, property)
compound Ensambla otros parámetros en una cadena (format, references)
list Lista de valores (values)
file Carga el contenido de un archivo (a partir de Monaco 2.14.0)

Un parámetro solo se evalúa si una configuración que se va a desplegar lo referencia. Una variable de entorno ausente no bloquea, por tanto, un despliegue que no la usa.

Objetos Settings, scope y dependencias

Para un objeto Settings, el campo type toma un bloque settings con schema, un schemaVersion opcional y un scope. El scope puede ser un valor, una referencia o environment, que apunta al entorno completo. Referenciar el identificador de otra configuración permite parametrizar una entidad que Monaco acaba de crear. La documentación da este ejemplo: una aplicación web y luego sus ajustes de RUM.

Archivo config.yaml con una configuración application-web y un objeto Settings cuyo scope referencia esa aplicación

Esta referencia crea una dependencia. Monaco despliega las configuraciones en orden, y la configuración de la que se depende va primero. Un ciclo de dependencias hace fallar el despliegue con un error. Los campos insertAfter (orden de los objetos en los schemas ordenados) y permission también existen para Settings; la documentación precisa que no todos los schemas los aceptan.

Para la forma corta de una referencia basta una matriz: [ proyecto, configType, configId, propiedad ]. Se pueden omitir los niveles superiores: sin configType, se usa el proyecto actual. Para una configuración Settings, configType corresponde al identificador del schema.

Variantes por entorno

Los campos opcionales environmentOverrides y groupOverrides modifican un valor para un entorno o un grupo, por ejemplo skip: true para excluir una configuración de producción. Es la herramienta de la promoción de dev a prod, que se trata más adelante en el curso.

Validar y luego desplegar

El comando es monaco deploy <manifest.yaml>. Sus opciones, releídas en el código del repositorio dynatrace-configuration-as-code y en la página de referencia de los comandos:

Extracto del archivo command.go de Monaco con las opciones environment, group, project, dry-run y continue-on-error
  • --dry-run (-d): verifica la estructura del manifiesto, de los proyectos y de las configuraciones, resuelve los parámetros y genera las plantillas. No se conecta a Dynatrace: un error HTTP 400 sigue siendo posible en el despliegue real si el contenido del JSON no es válido;
  • --environment (-e) o --group (-g), mutuamente excluyentes: sin ninguno de los dos, se apunta a todos los entornos;
  • --project (-p): despliega solo ese proyecto y las configuraciones de las que depende;
  • --continue-on-error (-c): continúa pese a un error, con el riesgo de errores en cascada en las configuraciones dependientes.

Sin argumento de archivo, el comando espera un manifiesto en .yaml. Un dry-run correcto termina con el mensaje «Validation finished without errors», según la guía de inicio.

Ejercicio práctico

Para realizar en un entorno de prueba de Dynatrace SaaS. Los comandos siguientes son los de la documentación; no se ejecutaron para redactar este módulo.

Paso 1 — Crear el árbol de carpetas

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

Resultado esperado: el árbol de la primera captura.

Paso 2 — Rellenar los archivos

Copie el manifiesto de la captura, el YAML del SLO y una plantilla slo.json que retome {{ .name }} y {{ .tags }}. La guía de inicio proporciona la plantilla completa. El token de plataforma debe tener los permisos slo:slos:read, slo:slos:write y slo:objective-templates:read para este ejemplo.

Paso 3 — Exportar las variables

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

No ponga nunca el token en un archivo versionado. Resultado esperado: las dos variables son visibles en el shell, no en el repositorio.

Paso 4 — Validar

monaco deploy --dry-run manifest.yaml

Resultado esperado: se listan el proyecto y el entorno, y luego «Validation finished without errors». Rompa a propósito el JSON de la plantilla para observar el fallo y después corríjalo.

Paso 5 — Desplegar y luego acotar

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

Resultado esperado: el SLO aparece en el entorno de prueba. Vuelva a lanzar el comando: el objeto debe actualizarse, no duplicarse.

Cuestionario

  1. ¿Qué contiene una plantilla JSON? a) Los identificadores de los entornos b) La carga útil enviada a la API, con variables c) El token de API d) La lista de proyectos
  2. ¿Qué no puede detectar --dry-run? a) Un YAML mal formado b) Una plantilla que no es JSON c) Un contenido JSON rechazado por la API de Dynatrace d) Un parámetro que no se encuentra
  3. ¿Cómo se declara que un objeto Settings depende de una aplicación creada por Monaco? a) Con un scope de tipo reference b) Con un nombre idéntico c) Con la opción -c d) Con un segundo manifiesto
  4. ¿Qué ocurre con un ciclo de dependencias? a) Monaco lo ignora b) El despliegue falla con un error c) Monaco elige el orden alfabético d) Solo falla el dry-run

Soluciones

  1. b) El YAML describe la configuración, la plantilla lleva el JSON de la API.
  2. c) El dry-run no se conecta a Dynatrace; solo el despliegue real revela un JSON rechazado.
  3. a) La referencia hace que se despliegue primero la configuración referenciada.
  4. b) La documentación indica que el despliegue falla con un error.

Para ir más lejos

← Módulo 3: exportación de Monaco SaaS · Índice del curso · Módulo 5: OAuth de Monaco SaaS →

Preguntas frecuentes

¿Garantiza el dry-run que el despliegue tendrá éxito?

No. Valida la estructura y el renderizado de las plantillas, pero no contacta con Dynatrace. Un JSON válido para Monaco todavía puede ser rechazado por la API.

¿Hace falta un nombre en cada configuración?

Para los tipos api, sí: el nombre identifica el objeto. Desde Monaco 2.7.0 es opcional para los demás tipos, que se identifican por su coordenada (proyecto, tipo, identificador) o por originObjectId.

¿Cómo desplegar en un solo entorno?

Con --environment (o --group para un grupo). Las dos opciones se excluyen mutuamente.

Ya sabe estructurar un repositorio, declarar dependencias y validar antes de desplegar. El módulo siguiente trata la autenticación con OAuth y con token de plataforma, los secretos y la eliminación.

span.observer es un blog independiente de la comunidad, no afiliado a Dynatrace LLC. Dynatrace es una marca de Dynatrace LLC. Este curso no sustituye las formaciones ni las certificaciones oficiales de Dynatrace University. Comprueba siempre las funciones en la documentación oficial correspondiente a tu versión.

Total
0
Shares
Leave a Reply

Your email address will not be published. Required fields are marked *

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

Módulo 4 — Despliegue Monaco Managed: proyectos, plantillas y dry-run

Next Post
Secrets Monaco Managed : variables, environnements et delete

Secretos Monaco Managed: variables, entornos y delete

Related Posts