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

Despliegue Monaco Managed: estructura un proyecto, escribe config.yaml y plantillas JSON, gestiona las dependencias y valida con deploy –dry-run.
Module 4 — Déploiement Monaco Managed : projets, gabarits et dry-run

Módulo 4 del curso Monaco Managed: el despliegue Monaco Managed convierte una carpeta de archivos YAML y JSON en configuración activa en tu clúster, tras una validación en seco.

Ruta: Monaco Managed · Módulo 4/5 · Duración: ~45 min · Nivel: Intermedio

Objetivos:

  • Organizar un proyecto Monaco: carpetas, config.yaml y plantilla JSON
  • Parametrizar una plantilla con variables y referencias entre configuraciones
  • Sobrescribir un valor por entorno
  • Validar con deploy --dry-run y luego desplegar

Requisitos previos: la CLI monaco instalada y un manifiesto (módulo 2), un proyecto exportado con monaco download (módulo 3), un entorno Managed de pruebas.

Los módulos anteriores dejaron la herramienta lista y recuperaron una configuración existente. Este módulo trata el gesto central: el despliegue Monaco Managed. Consiste en escribir o modificar archivos, comprobar que son coherentes y enviarlos al entorno de destino. Esta secuencia sustituye los clics en la consola y hace que cada cambio se pueda revisar en Git.

El contenido vale solo para Dynatrace Managed: token de API, API de configuración clásicas y Settings 2.0. Los puntos verificados proceden de las páginas Managed de la documentación oficial y del código del repositorio Dynatrace/dynatrace-configuration-as-code.

Despliegue Monaco Managed: anatomía de un proyecto

Según la documentación, un proyecto es una carpeta. Contiene subcarpetas con el nombre de las API, y estas contienen a su vez los archivos de cada configuración. Una configuración se compone de dos elementos: un archivo YAML (parámetros, dependencias, nombre, plantilla) y una plantilla JSON, es decir, la carga que se envía a la API de Dynatrace.

Árbol de un proyecto Monaco llamado alerting con dos carpetas de API, y manifest.yaml que apunta a un entorno Managed mediante variables de entorno

El manifiesto indica los proyectos que se van a desplegar y los entornos de destino. Sus claves de primer nivel son manifestVersion, projects y environmentGroups. Cada entorno pertenece exactamente a un grupo. Los nombres de las carpetas de API (por ejemplo management-zone, alerting-profile, dashboard) figuran en la página «Configuration types and access permissions»; esa página también recoge los esquemas de Settings 2.0.

Elemento Función
manifest.yaml Qué proyectos, hacia qué entornos y con qué token (nombre de variable)
Carpeta de proyecto Agrupa lógicamente las configuraciones (un equipo, un servicio)
config.yaml Lista de configuraciones: id, type, config
Plantilla JSON Cuerpo del objeto, con variables {{ .nombre }}

En el manifiesto existen dos tipos de proyecto: simple (por defecto, con name y, opcionalmente, path) y grouping, que carga cada subcarpeta como un proyecto distinto, con el nombre del proyecto y un punto como prefijo (por ejemplo general.zones).

El archivo config.yaml

El archivo empieza con la clave configs, una lista. Cada entrada exige tres campos: id, type y config. El id solo existe para Monaco: debe ser único por tipo y por proyecto, y sirve sobre todo para las referencias. El type indica una API (api: dashboard, o la forma corta type: dashboard) o un esquema de Settings 2.0 (settings con schema y scope).

El bloque config contiene name, template y, de forma opcional, skip y parameters. En una API clásica, el name identifica el objeto en el entorno: sirve para decidir entre crear y actualizar. Por eso la plantilla debe usarlo tal cual, sin caracteres de más, con la forma "{{ .name }}". Un espacio sobrante explica los objetos duplicados que a veces se observan tras un despliegue.

Plantillas JSON y variables

La plantilla se escribe en JSON, con la sintaxis de Go templates. La documentación recomienda mantenerla simple: en la mayoría de los casos basta con referenciar un parámetro con {{ .NOMBRE_DEL_PARAMETRO }}. Los valores YAML se escapan antes de insertarse, lo que garantiza un JSON válido incluso con comillas o saltos de línea.

Una trampa: algunas cargas ya contienen dobles llaves. Hay que escaparlas ({{`{{`}} para abrir, {{`}}`}} para cerrar). Monaco lo hace automáticamente con los archivos generados por monaco download.

Los parámetros existen en varios tipos: valor (forma corta: seuil: 15), environment (lee una variable de entorno, con un default opcional), reference, compound, list y file. Un parámetro solo se evalúa si una configuración desplegada lo referencia. Si falta una variable de entorno y no se ha definido ningún default, el despliegue falla. El módulo 5 vuelve sobre los secretos.

Dependencias entre configuraciones

Un parámetro reference lee una propiedad de otra configuración, casi siempre su id real de Dynatrace. Monaco deduce de ahí el orden: la configuración referenciada se despliega primero. Un ciclo de dependencias hace fallar el despliegue. La forma corta es [proyecto, type, configId, propiedad]; los niveles iniciales se pueden omitir si coinciden con los de la configuración actual.

Archivo config.yaml de un alerting-profile con una referencia a una management zone y una sobrescritura por entorno, y su plantilla profil.json con displayName y mzId

En el ejemplo, zoneId resuelve el identificador de la management zone zone-prod, definida en la carpeta management-zone del mismo proyecto. El campo mzId de la plantilla corresponde al de la API de perfiles de alertas; su tipo es una cadena. Como el valor se inserta entre comillas, el resultado sigue siendo JSON válido.

La sección environmentOverrides cambia valores para un entorno (aquí el nombre), y groupOverrides lo hace para todo un grupo. Con skip: true en una sobrescritura, una configuración no se despliega en ese grupo.

Validar con deploy –dry-run

El comando básico es monaco deploy manifest.yaml. Su opción --dry-run (abreviatura -d) valida la estructura del manifiesto, de los proyectos y de las configuraciones: resuelve los parámetros y genera las plantillas JSON. La documentación precisa que un dry-run no se conecta a Dynatrace y no puede validar el contenido de las cargas. Por tanto, un despliegue todavía puede fallar con un error HTTP 400 si una plantilla es incorrecta.

Otras opciones ayudan a acotar un despliegue:

  • --environment (-e): uno o varios entornos del manifiesto;
  • --group (-g): un grupo de entornos, excluyente con --environment;
  • --project (-p): un proyecto, con sus dependencias;
  • --continue-on-error (-c): continúa a pesar de los errores, con el riesgo de errores en cascada en las configuraciones dependientes.

Para un equipo SRE, el dry-run es un control barato que conviene colocar en cada merge request: detecta referencias rotas, variables ausentes y JSON mal formados antes de que lleguen a un entorno. No sustituye un despliegue en un entorno de pruebas.

Buenas prácticas

  • Partir de un objeto exportado con monaco download en lugar de escribir un JSON de memoria.
  • Mantener las plantillas simples; trasladar la lógica a los parámetros.
  • Desplegar primero en pruebas (-e) y después en el grupo de producción.
  • No escribir nunca un token en el manifiesto: solo figura el nombre de la variable.

Ejercicio práctico

Los comandos siguientes no se ejecutaron para redactar este módulo: el resultado esperado se apoya en la documentación y en el código de la CLI. Usa un entorno Managed de pruebas.

Paso 1 — Preparar el proyecto

Crea la carpeta monaco-demo con el manifiesto de la ilustración y un proyecto alerting. Exporta dos objetos existentes (una management zone y un perfil de alertas) con monaco download (módulo 3) para usarlos como plantillas. Resultado esperado: una carpeta por tipo de API, cada una con un config.yaml y un archivo JSON.

Paso 2 — Parametrizar la plantilla

En el JSON del perfil, sustituye el nombre por "{{ .name }}" y el identificador de la zona por una variable alimentada por una referencia a la management zone, como en el ejemplo. Resultado esperado: no queda en el código ningún valor propio de un entorno, salvo los de los parámetros.

Paso 3 — Validar en seco

export DT_PREPROD_URL="<URL de votre environnement Managed de recette>"
export DT_PREPROD_TOKEN="<jeton d'API de test>"
monaco deploy manifest.yaml --dry-run

Resultado esperado: el código fuente de la CLI registra «Validation finished without errors» cuando todo es coherente (texto no confirmado en todas las versiones).

Paso 4 — Provocar un error deliberado

Sustituye el configId de la referencia por un identificador inexistente, vuelve a lanzar --dry-run y después restáuralo. Resultado esperado: un error al cargar o al validar, sin ninguna llamada al entorno.

Paso 5 — Desplegar

monaco deploy manifest.yaml -e preprod-managed

Resultado esperado: la management zone se crea antes que el perfil de alertas, que está asociado a ella. Vuelve a lanzar el comando: el objeto se actualiza, no se duplica, porque el name es idéntico.

Cuestionario

  1. ¿Cuáles son los tres campos obligatorios de una entrada de configs? a) name, template, skip b) id, type, config c) id, name, scope d) project, type, parameters
  2. ¿Qué comprueba --dry-run? a) Que la API de Dynatrace acepta la carga JSON b) La estructura de los archivos y el resultado de las plantillas, sin conexión c) Los ámbitos del token de API d) Nada, despliega en solo lectura
  3. Un parámetro de tipo reference sirve para: a) leer una variable de entorno b) leer una propiedad de otra configuración e imponer el orden de despliegue c) importar un archivo d) desactivar una configuración
  4. ¿Cómo desplegar solo en un entorno concreto? a) --group b) --project c) --environment d) --continue-on-error

Soluciones

  1. b) Cada configuración exige id, type y config.
  2. b) El dry-run no se conecta a Dynatrace: el contenido de las cargas no se valida.
  3. b) La referencia crea una dependencia: la configuración apuntada se despliega primero.
  4. c) -e apunta a uno o varios entornos del manifiesto.

Para ir más lejos

← Módulo 3: exportación Monaco Managed · Índice de la ruta · Módulo 5: secretos Monaco Managed →

Preguntas frecuentes

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

No. Valida la estructura y el resultado de las plantillas, sin contactar con Dynatrace. Una carga JSON no válida para la API todavía puede provocar un error HTTP 400 en el despliegue real.

¿Por qué se crea un objeto duplicado en lugar de actualizarse?

En una API clásica, el name identifica el objeto. Si el nombre de la plantilla difiere del del YAML (un espacio o un carácter de más), Monaco no encuentra el objeto existente. Comprueba que la plantilla usa "{{ .name }}" sin nada alrededor.

¿Se puede forzar el orden de despliegue?

Sí, mediante las dependencias: un parámetro reference impone que la configuración referenciada pase primero. Para el orden de ciertos objetos de Settings 2.0, la documentación describe además un parámetro insertAfter (CLI 2.14.0 o posterior).

Ya sabes estructurar un proyecto, enlazar configuraciones, validar en seco y desplegar hacia un entorno concreto. El módulo siguiente trata los secretos, los entornos múltiples y el comando delete.

span.observer es un blog independiente de la comunidad, no afiliado a Dynatrace LLC. Esta ruta no sustituye las formaciones y 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 3 — Export Monaco SaaS : télécharger sa configuration Dynatrace

Módulo 3 — Exportación Monaco SaaS: descargar tu configuración de Dynatrace

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

Despliegue Monaco SaaS: proyectos, plantillas y dry-run

Related Posts