En este documento, se describe cómo crear un tipo de segmentación personalizado de Cloud Deploy y usarlo como segmentación en una canalización de entrega de Cloud Deploy.
El siguiente es el proceso de alto nivel para crear un tipo de destino personalizado y utilizándolos en tu canalización de entrega:
Crear una aplicación alojada en contenedores o que incluyen la funcionalidad para implementar en tu destino personalizado, y que entregan el servicio de Cloud Deploy requisitos para tipos de destinos personalizados.
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.Crea una definición de
CustomTargetType
. hagan referencia a la acción personalizada del paso anterior y la registren como Recurso de Cloud Deploy.Define un destino nuevo con una propiedad
customTarget
que identifica tu nuevo tipo de segmentación personalizada.Haz referencia a ese destino desde tu canalización de entrega. progreso.
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 el destino personalizado se define
aplicaciones, que proporcionas a Cloud Deploy con
hacer referencia a ellas desde tu archivo skaffold.yaml
. Cuándo
Tu canalización de entrega incluye un destino
que usa un tipo de destino personalizado.
Cloud Deploy llama a los contenedores de acción personalizada definidos para ese
un tipo de destino personalizado en Skaffold para ejecutar las acciones de renderización y de implementación
definido.
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 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 se
opcional, pero si no proporcionas uno, Cloud Deploy usa 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
.
Se configura cada acción personalizada para un destino personalizado en una customActions
.
estrofa. Para cualquier tipo de destino personalizado, creas una acción personalizada, en Skaffold, para la renderización y otra para la implementación. La CustomTargetType
definición identifica qué acción personalizada se usa para el procesamiento y cuál se usa
para 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. El La definición
CustomTargetType
hace referencia a este nombre, en el archivorenderAction
. o la propiedaddeployAction
.La estrofa
containers
incluye tu referencia y comandos para ejecutar esa 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 estás usando 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 utilizadas en
customActions
Define tu tipo de destino personalizado
Para definir un destino personalizado, primero crea un tipo de destino personalizado con el
Configuración de CustomTargetType
.
Puedes crear el CustomTargetType
en el mismo archivo que tu canalización de entrega.
definición, con las 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. Este nombre se hace referencia en el definición del objetivo para cualquier objetivo que usa el tipo de destino personalizado que definiste.
RENDER_ACTION_NAME
Es el nombre de la acción de renderización personalizada. Este valor es el
customAction.name
definido enskaffold.yaml
para el render.DEPLOY_ACTION_NAME
Es el nombre de la acción de implementación personalizada. Este valor es el
customAction.name
definido enskaffold.yaml
para el deploy.includeSkaffoldModules
Es una estrofa opcional para usar si usas configuraciones remotas de Skaffold. El 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, bucket de Cloud Storage o repositorio de Cloud Build de 2ª gen.. y hacer referencia a esos parámetros de configuración desde la definición del tipo de destino personalizado.
Si usas la configuración remota de Skaffold, implica que el skaffold.yaml
que proporciones en
la hora de lanzamiento no necesita tener definidas las acciones personalizadas. Esto permite que
compartir acciones personalizadas en toda tu organización.
Para usar los parámetros de configuración remotos de Skaffold, sigue estos pasos:
Crea una configuración de Skaffold con tu acción o acciones personalizadas.
Almacenar la configuración en un repositorio de Git o en un bucket de Cloud Storage.
En la definición del tipo de segmentación personalizada, agrega un Estrofa
customActions.includeSkaffoldModules
.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 conmetadata.name
. en cada configuración de Skaffold que se incluya. Si se omite, Cloud Deploy toma todas las configuraciones de la ruta especificada.Una estrofa
googleCloudStorage
,git
ogoogleCloudBuildRepo
.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 de acceso a un directorio de Cloud Storage, que termina en/*
, donde se almacenan las configuraciones de Skaffold. Descargas de Skaffold todos los archivos de este directorio encuentra el archivo de Skaffold relevante con la 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 la 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 Skaffold según la ruta de acceso relativa configurada.FILENAME
es el nombre del archivo que incluye las configuraciones de Skaffold. Esta propiedadpath:
es opcional. Si no la especificas, Cloud Deploy suponeskaffold.yaml
. Si no hayskaffold.yaml
o, si el nombre de archivo que especificas no está allí, el la creación de versiones falla.REPO_URL
es la URL que dirige al repositorio de Git.PATH_TO_FILE
es la ruta en ese repositorio al archivo que contiene el Configuración de Skaffold.BRANCH_NAME
es el nombre de la rama (por ejemplo,main
) desde la cual por ejemplo, toma la configuración de Skaffold.
Ejemplo
El siguiente YAML de tipo de destino personalizado es una estrofa customActions
con un
Estrofa includeSkaffoldModules
, que apunta a la configuración de Skaffold almacenada en una
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, y la acción personalizada que se muestra es 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 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 ella. 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á.
recurso. El CustomTargetType
debe estar en la misma región que Target
recurso que hace referencia a ella. No necesitas especificar la región si la configuraste como la región predeterminada para la CLI de gcloud.
Ahora que el CustomTargetType
se creó como un recurso de Cloud Deploy,
Ahora 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 objetivo para un tipo de destino admitido y
una definición del destino personalizado es que incluye un
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 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 el tipo de destino admitido. Es decir, no hay diferencia en la canalización de entrega el progreso entre objetivos de un tipo admitido y 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 Google Kubernetes Engine y algunos destinos personalizados.
Al igual que con los tipos de destinos admitidos, puede incluir implementar parámetros 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 destinos personalizados
Si tu acción personalizada cumple con los requisitos para destinos personalizados, puedes usar la consola de Google Cloud para ver los recursos artefactos.
Sigue estos pasos para ver el resultado de tu acción de renderización personalizada.
En la consola de Google Cloud, navega a Cloud Deploy La página Canalizaciones de entrega para ver tu canalización de entrega.
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.
Haz clic en el nombre de la versión.
Se mostrará la página Detalles de la versión.
Haz clic en la pestaña Artefactos.
En Artefactos de destino, haz clic en la flecha junto a Ver artefactos.
Se enumeran los artefactos renderizados, incluido el
skaffold.yaml
renderizado y renderizado, generado por el procesador personalizado. Y puedes haz clic en el vínculo Ubicación de almacenamiento junto a cada uno para ir al de bucket de Cloud Storage para ver esos archivos.También puedes hacer clic en el vínculo Ver artefactos para ver esos archivos: lanzamiento, por objetivo o por fase, con el Inspector de versiones.
¿Qué sigue?
Prueba la guía de inicio rápido: Define y usa un tipo de destino personalizado
Consulta los tipos de objetivos personalizados de muestra disponibles.
Obtén más información sobre cómo configurar destinos de Cloud Deploy