Acerca de las orientaciones personalizadas

En este documento, se describe cómo funcionan los destinos personalizados en Cloud Deploy.

Cloud Deploy incluye compatibilidad integrada para varios entornos de ejecución como destinos. Sin embargo, la lista de tipos de objetivos admitidos es finita. Con los destinos personalizados, puedes implementarlos en otros sistemas, además de los entornos de ejecución compatibles.

Un destino personalizado es aquel que representa un entorno de salida arbitrario, además de un entorno de ejecución compatible con Cloud Deploy.

En la página Crea un destino personalizado, se describe el proceso de definición de un tipo de destino personalizado y su implementación como destino en una canalización de entrega.

¿Qué incluye un destino personalizado?

Cada destino personalizado consta de los siguientes componentes:

  • Acciones personalizadas, definidas en skaffold.yaml

    Son similares a la forma en que defines hooks de implementación. En el archivo skaffold.yaml, debes definir customActions, en el que cada acción personalizada identifica una imagen de contenedor que se usará y los comandos que se ejecutarán en ese contenedor.

    De esta manera, el destino personalizado es simplemente una acción definida de forma personalizada o un conjunto de acciones.

    Para cualquier tipo de destino personalizado, debes configurar una acción de renderización personalizada y una acción de implementación personalizada. Estas acciones consumen valores que proporciona Cloud Deploy y deben cumplir con un conjunto de resultados obligatorios.

    La acción de renderización personalizada es opcional, pero debes crear una, a menos que tu destino personalizado funcione correctamente si lo renderiza skaffold render, que es la configuración predeterminada de Cloud Deploy.

  • Una definición de tipo de segmentación personalizada

    CustomTargetType es un recurso de Cloud Deploy que identifica las acciones personalizadas (definidas por separado en tu skaffold.yaml) que los destinos de este tipo usan para las actividades de renderización de versiones y de implementación de lanzamiento.

  • Una definición de objetivo

    La definición de un destino personalizado es la misma que la de cualquier tipo de destino, excepto que incluye la propiedad customTarget, cuyo valor es el nombre de CustomTargetType.

Con esos componentes implementados, puedes usar el destino como lo harías con cualquier objetivo, hacer referencia a él desde el progreso de la canalización de entrega y aprovechar por completo las funciones de Cloud Deploy, como la promoción y las aprobaciones y las reversiones.

Ejemplo

En la guía de inicio rápido Define y usa un tipo de destino personalizado, se crea un tipo de destino personalizado que incluye comandos simples que se ejecutan en una imagen de contenedor: un comando para la renderización y otro para la implementación. En este caso, los comandos solo agregan texto a los archivos de salida necesarios para la renderización y la implementación.

Para obtener más ejemplos, consulta Ejemplos de destinos personalizados.

Entradas y salidas obligatorias

Cualquier tipo de destino personalizado definido para Cloud Deploy debe cumplir con los requisitos de entrada y salida para la renderización y la implementación. En esta sección, se enumeran las entradas y salidas necesarias y cómo se proporcionan.

Cloud Deploy proporciona las entradas necesarias para la renderización y la implementación como variables de entorno. En las siguientes secciones, se enumeran estas entradas y las salidas que deben mostrar las acciones personalizadas de renderización y de implementación.

Implementa parámetros como variables de entorno

Además de las variables de entorno que se enumeran en esta sección, Cloud Deploy puede pasar a tus contenedores personalizados cualquier parámetro de implementación que hayas establecido.

Los parámetros de implementación previstos como entradas para los destinos personalizados deben comenzar con customTarget/, por ejemplo, customTarget/vertexAIModel. Cuando hagas referencia a un parámetro de implementación como una variable de entorno, usa la siguiente sintaxis:

CLOUD_DEPLOY_customTarget_[VAR_NAME]

En el ejemplo anterior, VAR_NAME es el nombre que aparece después de la barra en el nombre del parámetro de implementación. Por ejemplo, si defines un parámetro de implementación llamado customTarget/vertexAIModel, haz referencia a él como CLOUD_DEPLOY_customTarget_vertexAIModel.

Entradas para renderizar acciones

Para las acciones de renderización personalizadas, Cloud Deploy proporciona las siguientes entradas obligatorias, como variables de entorno. En el caso de los lanzamientos en varias fases (implementaciones de versiones canary), Cloud Deploy proporciona estas variables para cada fase.

  • CLOUD_DEPLOY_PROJECT

    El proyecto de Google Cloud en el que se crea el tipo de destino personalizado.

  • CLOUD_DEPLOY_LOCATION

    La región de Google Cloud para el tipo de destino personalizado.

  • CLOUD_DEPLOY_DELIVERY_PIPELINE

    El nombre de la canalización de entrega de Cloud Deploy que hace referencia al tipo de destino personalizado.

  • CLOUD_DEPLOY_RELEASE

    Es el nombre de la versión para la que se invoca la operación de renderización.

  • CLOUD_DEPLOY_TARGET

    El nombre del destino de Cloud Deploy que usa el tipo de destino personalizado.

  • CLOUD_DEPLOY_PHASE

    La fase de lanzamiento a la que corresponde la renderización.

  • CLOUD_DEPLOY_REQUEST_TYPE

    Para la acción de renderización personalizada, siempre es RENDER.

  • CLOUD_DEPLOY_FEATURES

    Una lista separada por comas de las características de Cloud Deploy que debe admitir el contenedor personalizado. Esta variable se propaga en función de las funciones configuradas en tu canalización de entrega.

    Si tu implementación no admite las funciones de esta lista, te recomendamos que falle durante la renderización.

    En el caso de las implementaciones estándar, este campo está vacío. Para las implementaciones de versiones canary, el valor es CANARY. Si el valor que proporciona Cloud Deploy es CANARY, se invoca tu acción de renderización para cada fase en la versión canary. El porcentaje de versiones canary de cada fase se proporciona en la variable de entorno CLOUD_DEPLOY_PERCENTAGE_DEPLOY.

  • CLOUD_DEPLOY_PERCENTAGE_DEPLOY

    El porcentaje de implementación asociado con esta operación de renderización. Si la variable de entorno CLOUD_DEPLOY_FEATURES se establece en CANARY, se llama a tu acción de renderización personalizada para cada fase, y esta variable se establece en el porcentaje de versiones canary de cada fase. Para las implementaciones estándar y las implementaciones de versiones canary que llegaron a la fase stable, esto es 100.

  • CLOUD_DEPLOY_STORAGE_TYPE

    El proveedor de almacenamiento. Siempre es GCS.

  • CLOUD_DEPLOY_INPUT_GCS_PATH

    La ruta de Cloud Storage del archivo de procesamiento que se escribió cuando se creó la versión.

  • CLOUD_DEPLOY_OUTPUT_GCS_PATH

    La ruta de acceso de Cloud Storage en la que se espera que el contenedor de renderización personalizada suba los artefactos que se usarán en la implementación. Ten en cuenta que la acción de renderización debe subir un archivo llamado results.json que contenga los resultados de esta operación de renderización. Para obtener más información, consulta Resultados de la acción de renderización.

Resultados de la acción de renderización

Tu acción de renderización personalizada debe proporcionar la información que se describe en esta sección. La información debe incluirse en el archivo de resultados, llamado results.json, ubicado en el bucket de Cloud Storage que proporciona Cloud Deploy.

  • Archivos o archivos de configuración renderizados

  • Un archivo results.json, que contiene la siguiente información:

    • Una indicación del estado de éxito o fracaso de la acción personalizada.

      Los valores válidos son SUCCEEDED y FAILED.

    • (Opcional) Cualquier mensaje de error que genere la acción personalizada

    • Ruta de Cloud Storage de los archivos de configuración renderizados.

      La ruta de acceso de todos los archivos de configuración renderizados es el URI completo. Debes propagarlo en parte con el valor de CLOUD_DEPLOY_OUTPUT_GCS_PATH proporcionado por Cloud Deploy.

      Debes proporcionar el archivo de configuración renderizado, incluso si está vacío. El contenido del archivo puede ser cualquier cosa, en cualquier formato, siempre que sea consumible por tu acción de implementación personalizada. Recomendamos que las personas puedan leer este archivo para que tú y otros usuarios de tu organización puedan verlo en el Inspector de versiones.

    • Un mapa de los metadatos que quieras incluir (opcional)

      Tu destino personalizado crea estos metadatos. Estos metadatos se almacenan en la versión, en el campo custom_metadata.

Si necesitas examinar el archivo results.json, por ejemplo, para depuración, puedes encontrar el URI de Cloud Storage en los registros de Cloud Build.

Ejemplo de archivo de resultados de renderización

A continuación, se muestra un archivo results.json de muestra del resultado de una acción de renderización personalizada:

{
  "resultStatus": "SUCCEEDED",
  "manifestFile": "gs://bucket/my-pipeline/release-001/rollout-a/01234/custom-output/manifest.yaml",
  "failureMessage": "",
  "metadata": {
    "key1": "val",
    "key2": "val"
  }
}

Entradas para implementar acciones

Para las acciones de implementación personalizadas, Cloud Deploy proporciona las siguientes entradas obligatorias, como variables de entorno:

  • CLOUD_DEPLOY_PROJECT

    El proyecto de Google Cloud en el que se crea el destino personalizado.

  • CLOUD_DEPLOY_LOCATION

    La región de Google Cloud para el tipo de destino personalizado.

  • CLOUD_DEPLOY_DELIVERY_PIPELINE

    El nombre de la canalización de entrega de Cloud Deploy que hace referencia al destino que usa el tipo de destino personalizado.

  • CLOUD_DEPLOY_RELEASE

    El nombre de la versión para la que se invoca la operación de implementación.

  • CLOUD_DEPLOY_ROLLOUT

    El nombre del lanzamiento de Cloud Deploy para el que se realiza esta implementación.

  • CLOUD_DEPLOY_TARGET

    El nombre del destino de Cloud Deploy que usa el tipo de destino personalizado.

  • CLOUD_DEPLOY_PHASE

    La fase de lanzamiento a la que corresponde la implementación.

  • CLOUD_DEPLOY_REQUEST_TYPE

    Para la acción de implementación personalizada, siempre es DEPLOY.

  • CLOUD_DEPLOY_FEATURES

    Una lista separada por comas de las características de Cloud Deploy que debe admitir el contenedor personalizado. Esta variable se propaga en función de las funciones configuradas en tu canalización de entrega.

    Si tu implementación no admite las funciones de esta lista, te recomendamos que falle durante la renderización.

    En el caso de las implementaciones estándar, este campo está vacío. Para las implementaciones de versiones canary, el valor es CANARY. Si el valor que proporciona Cloud Deploy es CANARY, se invoca tu acción de renderización para cada fase en la versión canary. El porcentaje de versiones canary de cada fase se proporciona en la variable de entorno CLOUD_DEPLOY_PERCENTAGE_DEPLOY.

  • CLOUD_DEPLOY_PERCENTAGE_DEPLOY

    El porcentaje de implementación asociado con esta operación de implementación. Si la variable de entorno CLOUD_DEPLOY_FEATURES se establece en CANARY, se llama a tu acción de implementación personalizada para cada fase y esta variable se establece en el porcentaje de versiones canary de cada fase. Tu acción de implementación debe ejecutarse para cada fase.

  • CLOUD_DEPLOY_STORAGE_TYPE

    El proveedor de almacenamiento. Siempre es GCS.

  • CLOUD_DEPLOY_INPUT_GCS_PATH

    Ruta de acceso de Cloud Storage en la que el procesador personalizado escribió los archivos de configuración renderizados.

  • CLOUD_DEPLOY_SKAFFOLD_GCS_PATH

    Ruta de acceso de Cloud Storage a la configuración renderizada de Skaffold.

  • CLOUD_DEPLOY_MANIFEST_GCS_PATH

    Ruta de acceso de Cloud Storage al archivo de manifiesto renderizado.

  • CLOUD_DEPLOY_OUTPUT_GCS_PATH

    Es la ruta de acceso al directorio de Cloud Storage en el que se espera que el contenedor de implementación personalizado suba artefactos de implementación. Para obtener más información, consulta Resultados de la acción de implementación.

Resultados de la acción de implementación

Tu acción de implementación personalizada debe escribir un archivo de salida results.json. Este archivo debe estar ubicado en el bucket de Cloud Storage que proporciona Cloud Deploy (CLOUD_DEPLOY_OUTPUT_GCS_PATH).

El archivo debe incluir lo siguiente:

  • Una indicación del estado de éxito o fracaso de la acción de implementación personalizada.

    Los siguientes son los estados válidos:

  • Una lista de archivos de artefactos de implementación en forma de rutas de acceso de Cloud Storage (opcional)

    La ruta de acceso es el URI completo. Lo propagas en parte con el valor de CLOUD_DEPLOY_OUTPUT_GCS_PATH que proporciona Cloud Deploy.

    Los archivos que se enumeran aquí se propagan en los recursos de ejecución de trabajos como artefactos de implementación.

  • Un mensaje de error (opcional) si la acción de implementación personalizada no tiene éxito (se muestra un estado FAILED)

    Este mensaje se usa para propagar el failure_message en la ejecución del trabajo de esta acción de implementación.

  • Un mensaje de omisión para proporcionar información adicional si la acción muestra un estado SKIPPED (opcional)

  • Un mapa de los metadatos que quieras incluir (opcional)

    Tu destino personalizado crea estos metadatos. Estos metadatos se almacenan en la ejecución del trabajo y en el lanzamiento, en el campo custom_metadata.

Si necesitas examinar el archivo results.json, por ejemplo, para la depuración, puedes encontrar el URI de Cloud Storage correspondiente en los registros de renderización de la versión de Cloud Build.

Ejemplo de archivo de resultados de implementación

El siguiente es un resultado del archivo results.json de muestra de una acción de implementación personalizada:

{
  "resultStatus": "SUCCEEDED",
  "artifactFiles": [
    "gs://bucket/my-pipeline/release-001/rollout-a/01234/custom-output/file1.yaml",
    "gs://bucket/my-pipeline/release-001/rollout-a/01234/custom-output/file2.yaml"
  ],
  "failureMessage": "",
  "skipMessage": "",
  "metadata": {
    "key1": "val",
    "key2": "val"
  }
}

Más información sobre las acciones personalizadas

A continuación, se incluyen algunos aspectos que debes tener en cuenta cuando configures y uses tipos de destinos personalizados.

Cómo ejecutar las acciones personalizadas

Las acciones de implementación y renderización personalizadas se ejecutan en el entorno de ejecución de Cloud Deploy. No puedes configurar tus acciones personalizadas para que se ejecuten en un clúster de Google Kubernetes Engine.

Usa parámetros de configuración de Skaffold reutilizables y remotos

Como se describe en este documento, debes configurar tu acción personalizada en el archivo skaffold.yaml proporcionado cuando se crea la versión. Sin embargo, también puedes almacenar las opciones de configuración de Skaffold en un repositorio de Git o en un bucket de Cloud Storage y hacer referencia a ellas desde la definición del tipo de destino personalizado. Esto te permite usar acciones personalizadas definidas y almacenadas en una única ubicación compartida, en lugar de incluir las acciones personalizadas con el archivo skaffold.yaml de cada versión.

Objetivos personalizados y estrategias de implementación

Los destinos personalizados son totalmente compatibles con las implementaciones estándar.

Cloud Deploy admite implementaciones de versiones canary, siempre y cuando el procesador y el implementador personalizados admitan la función de versiones canary.

Debes usar la configuración de versiones canary personalizada. No se admiten las versiones canary automatizadas y personalizadas.

Destinos personalizados e parámetros de implementación

Puedes usar parámetros de implementación con destinos personalizados. Puedes establecerlos en la etapa de la canalización de entrega, en el destino que usa un tipo de destino personalizado o en la versión.

Los parámetros de implementación se pasan a tus contenedores personalizados de renderización y de implementación, como variables de entorno, además de los que ya se proporcionaron.

Ejemplos de destinos personalizados

El repositorio cloud-deploy-samples contiene un conjunto de implementaciones de destino personalizadas de muestra. Están disponibles las siguientes muestras:

  • GitOps

  • Vertex AI

  • Terraform

  • Infrastructure Manager

  • Helm

Cada muestra incluye una guía de inicio rápido.

Estas muestras no son un producto compatible de Google Cloud y no están cubiertas por un contrato de asistencia de Google Cloud. Para informar errores o solicitar funciones en un producto de Google Cloud, comunícate con el equipo de asistencia de Google Cloud.

¿Qué sigue?