Crea un destino personalizado

En este documento, se describe cómo crear un tipo de destino personalizado de Cloud Deploy y usarlo como destino en una canalización de entrega de Cloud Deploy.

A continuación, se muestra el proceso de alto nivel para crear un tipo de destino personalizado y usarlo en la canalización de entrega:

  1. Crea una aplicación alojada en contenedores o aplicaciones que incluyan la funcionalidad para implementar en tu destino personalizado y que cumplan con los requisitos de Cloud Deploy para tipos de destinos personalizados.

  2. Define una acción personalizada en skaffold.yaml que haga referencia a ese contenedor y especifique los comandos que se ejecutarán en él.

  3. Crea una definición CustomTargetType que haga referencia a la acción personalizada del paso anterior y regístrala como un recurso de Cloud Deploy.

  4. Define un destino nuevo con una propiedad customTarget que identifique el nuevo tipo de objetivo personalizado.

  5. Haz referencia a ese destino desde la progresión de tu canalización de entrega.

  6. Crea una versión.

Cada uno de estos pasos se describe en detalle en el resto de este documento.

Crea tus aplicaciones alojadas en contenedores

La funcionalidad para implementar en tu destino personalizado se define en aplicaciones en contenedores, que proporcionas a Cloud Deploy mediante la referencia a estas desde tu archivo skaffold.yaml. Cuando tu canalización de entrega incluye un destino que usa un tipo de destino personalizado, Cloud Deploy llama a los contenedores de acciones personalizadas definidos para ese tipo de destino personalizado en Skaffold a fin de ejecutar las acciones de renderización y de implementación que definiste.

El comportamiento de tus aplicaciones depende de ti. Sin embargo, debe consumir las variables de entorno de entrada que proporciona Cloud Deploy y debe mostrar los resultados obligatorios.

En la mayoría de los casos, deberás crear un contenedor para la acción de renderización y uno para la acción de implementación para cada tipo de destino personalizado que crees. La acción de renderización es opcional, pero si no proporcionas una, Cloud Deploy usa la skaffold render predeterminada.

Define tus acciones personalizadas en Skaffold

Una vez implementadas las imágenes de contenedor de acciones personalizadas, puedes hacer referencia a ellas desde el archivo de configuración skaffold.yaml.

Se configura cada acción personalizada para un destino personalizado en una estrofa customActions. En cualquier tipo de destino personalizado, puedes crear una acción personalizada, en Skaffold, para la renderización y una para la implementación. La definición de CustomTargetType identifica qué acción personalizada se usa en el procesamiento y en la implementación.

A continuación, se muestra la configuración de las acciones de implementación y renderización personalizadas en skaffold.yaml:

apiVersion: skaffold/v4beta7
kind: Config
customActions:
# custom render action
- name:
  containers:
  - name:
    image:
    command:
    args:
# custom deploy action
- name:
  containers:
  - name:
    image:
    command:
    args:

En esta configuración de Skaffold, ocurre lo siguiente:

  • customActions.name

    Es un nombre arbitrario para la acción de renderización o implementación personalizada. La definición CustomTargetType hace referencia a este nombre, en la propiedad renderAction o deployAction.

  • La estrofa containers incluye tu referencia y comandos para ejecutar ese contenedor.

    La estrofa containers permite tener más de un contenedor, pero Google recomienda que uses solo uno.

  • customActions.containers.name

    Es un nombre arbitrario para el contenedor específico que estás usando para esta acción. Como práctica recomendada, este nombre de contenedor siempre debe estar calificado con SHA.

  • image

    Es la ruta de acceso a la imagen del contenedor.

  • command

    Es el comando o los comandos que se ejecutarán en el contenedor.

  • args

    Es una colección de argumentos de command.

Consulta la referencia de YAML de Skaffold para obtener documentación detallada sobre las propiedades de configuración que se usan en customActions.

Define tu tipo de destino personalizado

Para definir un destino personalizado, primero creas un tipo de destino personalizado con la configuración CustomTargetType. Puedes crear el CustomTargetType en el mismo archivo que tu definición de canalización de entrega, con definiciones de destino o en un archivo separado.

La definición de CustomTargetType es la siguiente:

# Custom target type config (preview)
apiVersion: deploy.cloud.google.com/v1
kind: CustomTargetType
metadata:
  name: [CUSTOM_TARGET_TYPE_NAME]
  annotations:
  labels:
description:
customActions:
  renderAction: [RENDER_ACTION_NAME]
  deployAction: [DEPLOY_ACTION_NAME]
  includeSkaffoldModules:

Dónde

  • CUSTOM_TARGET_TYPE_NAME

    Es un nombre arbitrario que le asignas a la definición de este tipo de destino personalizado. Se hace referencia a este nombre en la definición del destino para cualquier destino que use el tipo de destino personalizado que estás definiendo.

  • RENDER_ACTION_NAME

    Es el nombre de la acción de renderización personalizada. Este valor es el customAction.name definido en skaffold.yaml para la acción de renderización.

  • DEPLOY_ACTION_NAME

    Es el nombre de la acción de implementación personalizada. Este valor es el customAction.name definido en skaffold.yaml para la acción de deploy.

  • includeSkaffoldModules

    Es una estrofa opcional para usar si usas configuraciones remotas de Skaffold. Las propiedades de esta estrofa se muestran en la sección Usa la configuración remota de Skaffold.

Usa la configuración remota de Skaffold

Puedes almacenar los parámetros de configuración de Skaffold en un repositorio público de Git, un bucket de Cloud Storage o un repositorio de Cloud Build de 2ª gen.. y hacer referencia a esos parámetros de configuración desde tu definición del tipo de destino personalizado.

El uso de configuraciones remotas de Skaffold significa que el skaffold.yaml que proporcionas en el momento del lanzamiento no necesita tener definidas las acciones personalizadas. Esto permite compartir acciones personalizadas en toda tu organización.

Para usar los parámetros de configuración remotos de Skaffold, sigue estos pasos:

  1. Crea una configuración de Skaffold con tu acción o acciones personalizadas.

  2. Almacena la configuración en un repositorio de Git o en un bucket de Cloud Storage.

  3. En la definición del tipo de destino personalizado, agrega una estrofa customActions.includeSkaffoldModules.

  4. En includeSkaffoldModules, especifica lo siguiente:

    • De manera opcional, uno o más elementos configs:

      - configs: ["name1", "name2"]

      El valor de configs es una lista de cadenas que coinciden con la propiedad metadata.name en cada configuración de Skaffold que se incluirá. Si se omite, Cloud Deploy toma todos los parámetros de configuración de la ruta especificada.

    • Una estrofa googleCloudStorage, git o googleCloudBuildRepo.

      Para Cloud Storage:

      googleCloudStorage:
  source: PATH_TO_GCS_BUCKET
  path: FILENAME

      Para Git:

      git:
  repo: REPO_URL
  path: PATH_TO_FILE
  ref: BRANCH_NAME

      Para los repositorios de Cloud Build (2ª gen..):

       googleCloudBuildRepo:
  repository: PATH_TO_GCB_REPO
  path: PATH_TO_FILE
  ref: BRANCH_NAME

      Aquí:

      PATH_TO_GCS_BUCKET es la ruta a un directorio de Cloud Storage, que termina con /*, en la que se almacenan los parámetros de configuración de Skaffold. Skaffold descarga todos los archivos de este directorio y, luego, encuentra el archivo relevante con los parámetros de configuración, según la ruta relativa configurada.

      PATH_TO_GCB_REPO es la ruta de acceso al repositorio de Cloud Build de 2ª gen.. en el que se almacenan los parámetros de configuración de Skaffold. La ruta tiene el siguiente formato: projects/{project}/locations/{location}/connections/{connection}/repositories/{repository}. Skaffold descarga todos los archivos de este directorio y, luego, encuentra el archivo, según la ruta relativa configurada.

      FILENAME es el nombre del archivo que incluye los parámetros de configuración de Skaffold. Esta propiedad path: es opcional; si no la especificas, Cloud Deploy supone skaffold.yaml. Si no hay una skaffold.yaml o si el nombre de archivo que especificas no está allí, la creación de la versión fallará.

      REPO_URL es la URL que dirige al repositorio de Git.

      PATH_TO_FILE es la ruta en ese repositorio al archivo que contiene los parámetros de configuración de Skaffold.

      BRANCH_NAME es el nombre de la rama (por ejemplo, main) desde la que se toman los parámetros de configuración de Skaffold.

Ejemplo

El siguiente YAML de tipo de destino personalizado es una estrofa customActions con una estrofa includeSkaffoldModules que apunta a las configuraciones de Skaffold almacenadas en un bucket de Cloud Storage:

customActions:
  renderAction: my-custom-action
  deployAction: my-custom-action
  includeSkaffoldModules:
    - configs: ["myConfig"]
      googleCloudStorage:
        source: "gs://my-custom-target-bucket/my-custom/*"
        path: "skaffold.yaml

El siguiente YAML es una configuración de Skaffold, a la que la acción personalizada que se muestra hace referencia:

apiVersion: skaffold/v4beta7
kind: Config
metadata:
  name: myConfig
customActions:
  - name: my-custom-action
    containers:
      - name: my-custom-container
        image: us-east1-docker.pkg.dev/abcdefg/foldername/myimage@sha256:c56fcf6e0a7637ddf0df3d56a0dd23bfce03ceca06a6fc527b0e0e7430e6e9f9

Registra tu tipo de destino personalizado

Después de configurar el CustomTargetType, ejecuta el comando gcloud deploy apply para registrar el recurso CustomTargetType en un proyecto de Google Cloud:

gcloud deploy apply --file=[FILE] --project=[PROJECT] --region=[REGION]

Aquí:

FILE es el nombre del archivo en el que definiste este tipo de destino personalizado.

PROJECT es el proyecto de Google Cloud en el que se creará este recurso. El CustomTargetType debe estar en el mismo proyecto que el recurso Target que hace referencia a él. No es necesario que especifiques el proyecto si lo configuraste como tu proyecto predeterminado para Google Cloud CLI.

REGION es la región (por ejemplo, us-centra1) en la que se creará este recurso. El CustomTargetType debe estar en la misma región que el recurso Target que hace referencia a él. No necesitas especificar la región si la configuraste como la región predeterminada para gcloud CLI.

Ahora que el CustomTargetType se creó como un recurso de Cloud Deploy, puedes usarlo en una definición de Target para crear tu destino personalizado.

Para obtener más información sobre la definición de CustomTargetType, consulta la referencia del esquema de configuración de Cloud Deploy.

Define tu objetivo

La única diferencia entre una definición de destino para un tipo de destino compatible y una definición de destino personalizado es que la definición de destino personalizado incluye una estrofa customTarget. La sintaxis de un customTarget es la siguiente:

customTarget:
  customTargetType: [CUSTOM_TARGET_TYPE_NAME]

Donde CUSTOM_TARGET_TYPE_NAME es el valor de la propiedad name que se define en la configuración del tipo de segmentación personalizada.

Agrega tu destino a la canalización de entrega

Puedes usar un destino personalizado en una canalización de entrega exactamente como lo harías con un tipo de destino compatible. Es decir, no hay diferencia en la progresión de la canalización de entrega entre los destinos de un tipo de destino compatible y los destinos personalizados.

Todos los destinos de una canalización de entrega deben usar el mismo tipo de destino. Por ejemplo, no puedes tener una canalización de entrega con algunos destinos que se implementen en Google Kubernetes Engine y otros destinos personalizados.

Al igual que con los tipos de destinos admitidos, puedes incluir parámetros de implementación en la etapa de canalización.

Crea una versión

Con un tipo de destino personalizado completamente definido y un destino creado para usar ese tipo, ahora puedes crear una versión de la manera normal:

gcloud deploy releases create [RELEASE_NAME] \
  --project=[PROJECT_NAME] \
  --region=[REGION] \
  --delivery-pipeline=[PIPELINE_NAME]

Cuando se crea la versión, tu acción de renderización personalizada se ejecuta para cada destino de la canalización de entrega, incluido el procesamiento de los parámetros de implementación configurados en la versión, los destinos o la canalización de entrega. Cloud Deploy proporciona los parámetros de implementación como entrada al contenedor de renderización personalizada.

Consulta el resultado de tus destinos personalizados

Si tu acción personalizada cumple con los requisitos de los destinos personalizados, puedes usar la consola de Google Cloud para ver los artefactos renderizados.

Sigue estos pasos para ver el resultado de tu acción de renderización personalizada.

  1. En la consola de Google Cloud, navega a la página Canalizaciones de entrega de Cloud Deploy para ver tu canalización de entrega.

    Abrir la página Canalizaciones de entrega

  2. Haz clic en el nombre de tu canalización de entrega.

    La visualización de la canalización muestra el estado de implementación de la app, y tu versión aparece en la pestaña Versiones en Detalles de la canalización de entrega.

  3. Haz clic en el nombre de la versión.

    Se mostrará la página Detalles de la versión.

  4. Haz clic en la pestaña Artefactos.

  5. En Artefactos de destino, haz clic en la flecha junto a Ver artefactos.

    Se enumeran los artefactos renderizados, incluido el skaffold.yaml renderizado y el archivo de manifiesto renderizado que genera el procesador personalizado. Además, puedes hacer clic en el vínculo Ubicación de almacenamiento junto a cada uno para ir al bucket de Cloud Storage y ver esos archivos.

    También puedes hacer clic en el vínculo Ver artefactos para ver esos archivos por versión, destino o fase con el Inspector de versiones.

¿Qué sigue?