Define y usa un tipo de objetivo personalizado

Define y usa un tipo de objetivo personalizado

En esta guía de inicio rápido, se muestra cómo usar Cloud Deploy para crear un tipo de segmentación personalizado y, luego, realizar la implementación en un destino personalizado de ese tipo.

En esta guía de inicio rápido, harás lo siguiente:

1. Crea una configuración de Skaffold.

   En el archivo de configuración de Skaffold, configuras el comportamiento del objetivo. Esta configuración hace referencia a imágenes de contenedores y a comandos de shell para ejecutar en esas imágenes, que son las acciones de las operaciones de renderización y de implementación.

2. Define un tipo de objetivo personalizado y un objetivo que haga referencia a ese tipo.

3. Define tu canalización de entrega de Cloud Deploy.

   Esta canalización incluye solo una etapa y usa solo un objetivo. En esa etapa, harás referencia al objetivo que configuraste.

4. Crea una versión, que crea automáticamente un lanzamiento, lo que genera que se realicen las operaciones de renderización y de implementación personalizadas.

   Como parte de este lanzamiento, se ejecutan las operaciones de renderización y de implementación definidas en la configuración de Skaffold.

5. Consulta los resultados de las operaciones personalizadas. Esto incluye un archivo de configuración renderizado que se subió a Cloud Storage, una cadena escrita en ese archivo y un archivo de resultados que incluye el estado de la operación.

Antes de comenzar

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

   Enable the APIs

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

   Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

8. Make sure that billing is enabled for your Google Cloud project.

9. Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

   Enable the APIs

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

    Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

Si ya tienes instalada Google Cloud CLI, asegúrate de que estás ejecutando la versión más reciente:

gcloud components update

12. Asegúrate de que la cuenta de servicio predeterminada de Compute Engine tenga los permisos necesarios.

    Es posible que la cuenta de servicio ya tenga los permisos necesarios. Estos pasos se incluyen en los proyectos que inhabilitan la asignación automática de roles para las cuentas de servicio predeterminadas.

1. Primero, agrega el rol clouddeploy.jobRunner:

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --role="roles/clouddeploy.jobRunner"
   

2. Agrega el rol de desarrollador para tu entorno de ejecución específico.
3. Agrega el rol iam.serviceAccountUser, que incluye el permiso actAs para implementar en el entorno de ejecución:

   gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --role="roles/iam.serviceAccountUser" \
       --project=PROJECT_ID
   

Prepara tu configuración de Skaffold

Cloud Deploy usa Skaffold para proporcionar los detalles sobre qué implementar y cómo hacerlo en tu destino.

En esta guía de inicio rápido, crearás un archivo skaffold.yaml, que define acciones personalizadas que representan las operaciones de renderización y de implementación para el tipo de destino personalizado.

Ten en cuenta que las acciones personalizadas que se proporcionan en esta guía de inicio rápido no implementan ninguna aplicación en un entorno de ejecución. Tanto las acciones de renderización como las de implementación suben un archivo de resultados a Cloud Storage para cumplir con el contrato de destino personalizado entre Cloud Deploy y la renderización y la implementación definidas por el usuario.

1. Abre una ventana de terminal.

2. Crea un directorio nuevo y navega hasta él.

   mkdir custom-target-quickstart
   cd custom-target-quickstart
   

3. Crea un archivo llamado skaffold.yaml con el siguiente contenido:

   apiVersion: skaffold/v4beta7
   kind: Config
   customActions:
   - name: custom-render
     containers:
     - name: render
       image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:66e2681aa3099b4e517e4cdcdefff8f2aa45d305007124ccdc09686f6712d018
       command: ['/bin/bash']
       args:
         - '-c'
         - |-
           echo "Sample manifest rendered content" > manifest.txt
           gcloud storage cp manifest.txt $CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt
           echo {\"resultStatus\": \"SUCCEEDED\", \"manifestFile\": \"$CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt\"} > results.json
           gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json
   - name: custom-deploy
     containers:
     - name: deploy
       image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:66e2681aa3099b4e517e4cdcdefff8f2aa45d305007124ccdc09686f6712d018
       command: ['/bin/bash']
       args:
         - '-c'
         - |-
           echo {\"resultStatus\": \"SUCCEEDED\"} > results.json
           gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json
   

   Este archivo incluye la estrofa customActions:, que define una acción de renderización personalizada y una acción de implementación personalizada. Cada una de estas acciones personalizadas hace referencia a una imagen de contenedor para ejecutar y a los comandos que se ejecutarán en ese contenedor.

   Consulta la referencia de skaffold.yaml para obtener más información sobre este archivo de configuración.

Crea tu canalización de entrega, tu tipo de segmentación personalizada y tu segmentación

Puedes definir tu canalización de entrega, el tipo de destino personalizado y el destino en un archivo o en archivos separados. En esta guía de inicio rápido, crearás un solo archivo con los tres.

1. En el directorio custom-target-quickstart, crea un archivo nuevo, clouddeploy.yaml, con el siguiente contenido:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: custom-targets-pipeline
   serialPipeline:
     stages:
     - targetId: sample-env
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: sample-env
   customTarget:
     customTargetType: basic-custom-target
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: CustomTargetType
   metadata:
     name: basic-custom-target
   customActions:
     renderAction: custom-render
     deployAction: custom-deploy
   

   Nota: El tipo de objetivo personalizado y el objetivo se incluyen en la canalización de entrega en este archivo, pero puedes definirlos en un archivo separado o en varios archivos separados.

2. Registra tu canalización y tus destinos con el servicio de Cloud Deploy:

   gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
   

   Ahora tienes una canalización de entrega con un destino. Este es tu objetivo con el tipo de objetivo personalizado, y esta canalización no implementa una aplicación en un entorno de ejecución.

3. Confirma tu canalización y tus objetivos:

   En la consola de Google Cloud, navega a la página Canalizaciones de entrega de Cloud Deploy para ver una lista de las canalizaciones de entrega disponibles.

   Abrir la página Canalizaciones de entrega

   Se muestra la canalización de entrega que acabas de crear, con un destino en la columna Destinos.

   

Crea una versión

Una versión es el recurso central de Cloud Deploy que representa los cambios que se implementarán. La canalización de entrega define el ciclo de vida de esa versión. Consulta la arquitectura del servicio de Cloud Deploy para obtener detalles sobre ese ciclo de vida.

Ejecuta el siguiente comando desde el directorio custom-target-quickstart para crear un recurso release que represente la acción personalizada que se implementará:

gcloud deploy releases create test-release-001 \
  --project=PROJECT_ID \
  --region=us-central1 \
  --delivery-pipeline=custom-targets-pipeline

Al igual que con todas las versiones (a menos que incluyan --disable-initial-rollout), Cloud Deploy también crea automáticamente un recurso de lanzamiento. Y se ejecutan todas las fases de ese lanzamiento, incluidas la renderización y la implementación.

Visualiza los resultados en la consola de Google Cloud

Después de unos minutos, se completará la implementación. En este caso, como las dos acciones personalizadas son comandos para mostrar cadenas en un archivo y subirlo a Cloud Storage, no se implementa nada en ningún entorno de ejecución de destino.

Sin embargo, puedes ver el archivo y las cadenas en él:

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 (custom-targets-pipeline).

   Abrir la página Canalizaciones de entrega

2. Haz clic en el nombre de tu canalización de entrega (custom-targets-pipeline).

   La visualización de la canalización muestra el estado de implementación de la app. Debido a que solo hay una etapa en la canalización, la visualización solo muestra un nodo.

   

   Y la 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 el vínculo VER ARTEFACTOS.

   Se muestra el archivo de manifiesto renderizado. En este caso, el archivo es el resultado de la acción de renderización personalizada que definiste en el archivo de configuración skaffold.yaml, que contiene la cadena "Sample manifest rendered content".

   

6. Busca los buckets de Cloud Storage que creó esta versión.

   Abrir la página del navegador de Cloud Storage

   Aparecerá la página Buckets, que muestra los dos buckets creados para esta versión. Un bucket contiene el archivo de configuración de la canalización de entrega y el skaffold.yaml renderizado. El otro incluye el archivo de salida que nuestra acción personalizada está configurada para crear.

7. Haz clic en el bucket cuyo nombre comienza con us-central1.deploy-artifacts…

   

8. Haz clic en la carpeta cuyo nombre comienza con custom-targets-pipeline- y, luego, en la carpeta test-release-001.

9. Haz clic en la carpeta cuyo nombre sea el de tu lanzamiento, que debería ser test-release-001-to-sample-env-0001.

10. Haz clic en la carpeta que se muestra, que es un UUID, y, luego, en la carpeta custom-output.

11. Haz clic en results.json y, luego, en la URL con hipervínculo del campo URL autenticada.

    Este archivo contiene la cadena que configuraste como salida de la acción custom-deploy en tu skaffold.yaml:

    

Nota: También puedes ver los resultados de la compilación en el bucket de Cloud Storage, pero es más rápido usar el Inspector de lanzamientos, como se muestra en los primeros pasos de este procedimiento.

Limpia

Sigue estos pasos para evitar que se apliquen cargos a tu cuenta de Google Cloud por los recursos que usaste en esta página.

1. Borra la canalización de entrega, el destino, la versión y el lanzamiento:

   gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
   

2. Borra los dos buckets de Cloud Storage que creó Cloud Deploy.

   Abrir la página del navegador de Cloud Storage

Eso es todo, finalizaste la guía de inicio rápido.

¿Qué sigue?

• Obtén más información sobre los objetivos personalizados.

• Consulta los tipos de objetivos personalizados de muestra disponibles.

• Obtén más información sobre Cloud Deploy.

• Aprende los conceptos básicos de la implementación de aplicaciones.

• Prueba la explicación de Cloud Deploy.