Cómo crear un segmento personalizado

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

El siguiente es el proceso de alto nivel para crear un tipo de segmentación personalizado y usarlo en tu canalización de publicación:

  1. Crea una aplicación contenedorizada 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 el comando o los comandos que se ejecutarán en él.

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

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

  5. Consulta ese objetivo en 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 que se implementará en tu destino personalizado se define en aplicaciones en contenedores, que le proporcionas a Cloud Deploy haciendo referencia a ellas desde tu archivo skaffold.yaml. Cuando tu canalización de publicación 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, para ejecutar las acciones de renderización y de implementación que definiste.

Tú decides el comportamiento de tus aplicaciones. Sin embargo, debe consumir las variables de entorno de entrada que proporciona Cloud Deploy y debe mostrar las salidas requeridas.

En la mayoría de los casos, crearás un contenedor para tu acción de renderización y uno para tu 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 usará el skaffold render predeterminado.

Define tus acciones personalizadas en Skaffold

Con las imágenes de contenedor de acción personalizada en su lugar, puedes hacer referencia a ellas desde tu archivo de configuración skaffold.yaml.

Cada acción personalizada se configura para un objetivo personalizado en una estancia customActions. Para cualquier tipo de destino personalizado, creas una acción personalizada, en Skaffold, para la renderización y otra para la implementación. La definición de CustomTargetType identifica qué acción personalizada se usa para la renderización y cuál se usa para la implementación.

La siguiente es la configuración para las acciones de renderización e implementació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, se cumplen las siguientes condiciones:

  • customActions.name

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

  • La estrofa containers incluye tu referencia, además de los comandos para ejecutar ese contenedor.

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

  • customActions.containers.name

    Es un nombre arbitrario para el contenedor específico que usas para esta acción. Como práctica recomendada, este nombre de contenedor siempre debe estar calificado como 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 para 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 segmentación personalizada

Para definir un objetivo personalizado, primero crea un tipo de objetivo personalizado con la configuración de CustomTargetType. Puedes crear el CustomTargetType en el mismo archivo que la definición de tu 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 esta definición de tipo de objetivo personalizado. Se hace referencia a este nombre en la definición del objetivo para cualquier objetivo que use el tipo de objetivo personalizado que definas.

  • 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 render.

  • 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 deploy.

  • includeSkaffoldModules

    Es una estrofa opcional que se usa si usas configuraciones remotas de Skaffold. Las propiedades de esta estrofa se muestran en la sección Cómo usar configuraciones remotas de Skaffold.

Usa configuraciones remotas de Skaffold

Puedes almacenar las configuraciones 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 esas configuraciones desde tu definición de 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 configuraciones remotas de Skaffold, haz lo siguiente:

  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 de tu tipo de objetivo 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 todas las configuraciones de la ruta especificada.

    • Es 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 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 de acceso a un directorio de Cloud Storage, que termina en /*, donde se almacenan las configuraciones de Skaffold. Skaffold descarga todos los archivos de este directorio y, luego, encuentra el archivo Skaffold relevante con las configuraciones, según la ruta de acceso relativa configurada.

      PATH_TO_GCB_REPO es la ruta de acceso al repositorio de Cloud Build de 2ª gen., en el que se almacenan las configuraciones 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 Skaffold según la ruta de acceso relativa configurada.

      FILENAME es el nombre del archivo que incluye las configuraciones de Skaffold. Esta propiedad path: es opcional. Si no la especificas, Cloud Deploy supone skaffold.yaml. Si no hay skaffold.yaml o si no está el nombre de archivo que especificaste, la creación de la versión fallará.

      REPO_URL es la URL del repositorio de Git.

      PATH_TO_FILE es la ruta de acceso en ese repositorio al archivo que contiene las configuraciones de Skaffold.

      BRANCH_NAME es el nombre de la rama (por ejemplo, main) de la que se deben tomar las configuraciones de Skaffold.

Ejemplo

El siguiente YAML de tipo de destino personalizado es una estrofa customActions con una estrofa includeSkaffoldModules que apunta a 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 hace referencia la acción personalizada que se muestra:

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 segmentación personalizada

Después de configurar 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 necesitas especificar 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 CustomTargetType se creó como un recurso de Cloud Deploy, ahora puedes usarlo en una definición de Target para crear tu objetivo 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 objetivo para un tipo de objetivo compatible y una definición de objetivo personalizada es que la definición de objetivo personalizada incluye una estrofa customTarget. La sintaxis de un customTarget es la siguiente:

customTarget:
  customTargetType: [CUSTOM_TARGET_TYPE_NAME]

En el que CUSTOM_TARGET_TYPE_NAME es el valor de la propiedad name definida en tu configuración de tipo de destino personalizado.

Agrega tu segmentación a la canalización de publicación

Puedes usar un objetivo personalizado en una canalización de entrega de la misma manera que usarías un tipo de objetivo compatible. Es decir, no hay diferencia en la progresión de la canalización de publicación entre los objetivos de un tipo de objetivo compatible y los objetivos personalizados.

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

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

Crea una versión

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

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

Cuando se crea la versión, se ejecuta tu acción de renderización personalizada para cada destino en la canalización de entrega, lo que incluye 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 personalizado.

Consulta el resultado de tus objetivos personalizados

Si tu acción personalizada satisface los requisitos para los objetivos 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 muestra 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 muestran los artefactos renderizados, incluido el skaffold.yaml renderizado y el archivo de manifiesto renderizado que genera el renderizador 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, por destino o por fase con el inspector de versiones.

¿Qué sigue?