Ejecuta hooks antes y después de la implementación

Ejecuta hooks antes y después de la implementación

En esta guía de inicio rápido, se muestra cómo ejecutar un hook de implementación, un programa arbitrario que se ejecuta antes o después de la implementación con Cloud Deploy.

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

1. Crea un clúster de GKE o un servicio de Cloud Run.

   También puedes usar un clúster de GKE Enterprise para esto, pero en este guía de inicio rápido solo se usan GKE y Cloud Run.

2. Crearás una configuración de Skaffold y un manifiesto de Kubernetes o una definición de servicio de Cloud Run.

   En el archivo de configuración de Skaffold, configuras los hooks de implementación para que se ejecuten. Identificas un contenedor para ejecutar antes de la implementación y uno para ejecutar después de la implementación.

3. Define la canalización de entrega y el destino de implementación de Cloud Deploy.

   En la configuración de la canalización de entrega, harás referencia a los hooks de implementación que se definieron en skaffold.yaml para ejecutarlos.

   Esta canalización incluye solo una etapa y usa solo un objetivo.

4. Crea una versión, que se implementará automáticamente en el destino.

   Uno de los hooks se ejecuta antes de que se implemente la aplicación y el otro después.

5. Consulta los resultados de los hooks previos y posteriores a la implementación en los registros de Cloud Build con la página Detalles del lanzamiento de Cloud Deploy en la consola de Google Cloud.

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 la 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.
• Para GKE:

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

• Para Cloud Run:

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

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
   

Crea tu entorno de ejecución

Si realizas la implementación en Cloud Run, puedes omitir este comando.

Para GKE, crea un clúster: deploy-hooks-cluster, con la configuración predeterminada. El extremo de API de Kubernetes del clúster debe ser accesible a través de la red desde la Internet pública. Los clústeres de GKE tienen acceso externo de forma predeterminada.

gcloud container clusters create-auto deploy-hooks-cluster \
                 --project=PROJECT_ID \
                 --region=us-central1

Prepara tu configuración de Skaffold y el manifiesto de la aplicación

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 identifica el manifiesto que se usará para implementar la app de ejemplo y también identifica los contenedores que se ejecutarán antes y después de la implementación (los hooks de implementación).

1. Abre una ventana de terminal.

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

   GKE

   mkdir deploy-hooks-gke-quickstart
   cd deploy-hooks-gke-quickstart
   

   Cloud Run

   mkdir deploy-hooks-run-quickstart
   cd deploy-hooks-run-quickstart
   

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

   GKE

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - k8s-pod.yaml
   deploy:
     kubectl: {}
   customActions:
   - name: predeploy-action
     containers:
     - name: predeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a predeploy action"' ]
   - name: postdeploy-action
     containers:
     - name: postdeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a postdeploy action"' ]
   

   Cloud Run

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - service.yaml
   deploy:
     cloudrun: {}
   customActions:
   - name: predeploy-action
     containers:
     - name: predeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a predeploy action"' ]
   - name: postdeploy-action
     containers:
     - name: postdeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a postdeploy action"' ]
   

   Este archivo incluye la estrofa customActions:. Esto define los contenedores que se ejecutarán antes y después de la implementación: los hooks.

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

4. Crea la definición de tu aplicación: una definición de servicio para Cloud Run o un manifiesto de Kubernetes para GKE.

   GKE

   Crea un archivo llamado k8s-pod.yaml con el siguiente contenido.

   apiVersion: v1
   kind: Pod
   metadata:
     name: my-hooks-pod
   spec:
     containers:
     - name: nginx
       image: my-app-image
   

   Este archivo es un manifiesto básico de Kubernetes, que se aplica al clúster para implementar la aplicación. La imagen de contenedor que se implementará se establece aquí como un marcador de posición, my-app-image, que se reemplaza por la imagen específica cuando creas la versión.

   Cloud Run

   Crea un archivo llamado service.yaml con el siguiente contenido.

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: my-hooks-run-service
   spec:
     template:
       spec:
         containers:
         - image: my-app-image
   

   Este archivo es una definición de servicio de Cloud Run simple, que se usa para implementar la aplicación. La imagen del contenedor que se implementará se establece aquí como un marcador de posición, my-app-image, que se reemplaza por la imagen específica cuando creas la versión.

Nota: Si quieres usar diferentes manifiestos por destino, lee este artículo sobre cómo administrar manifiestos para obtener más información para usar los perfiles de Skaffold.

Crea tu canalización de entrega y tu destino

Puedes definir tu canalización y tu objetivo en un archivo o en archivos separados. En esta guía de inicio rápido, crearás un solo archivo.

1. Crea tu canalización de entrega y definición de destino:

   GKE

   En el directorio deploy-hooks-gke-quickstart, crea un archivo nuevo: clouddeploy.yaml, con el siguiente contenido:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-hooks-demo-app-gke-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: hooks-staging
       profiles: []
       strategy:
         standard:
           predeploy:
             actions: ["predeploy-action"]
           postdeploy:
             actions: ["postdeploy-action"]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: hooks-staging
   description: hooks staging cluster
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-hooks-cluster
   

   Cloud Run

   En el directorio deploy-hooks-run-quickstart, crea un archivo nuevo: clouddeploy.yaml, con el siguiente contenido:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-hooks-demo-app-run-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: hooks-staging
       profiles: []
       strategy:
         standard:
           predeploy:
             actions: ["predeploy-action"]
           postdeploy:
             actions: ["postdeploy-action"]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: hooks-staging
   description: staging Run service
   run:
     location: projects/PROJECT_ID/locations/us-central1
   

   Nota: En este archivo, el destino se incluye en la canalización de entrega, pero puedes definir destinos en un archivo 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, lista para implementar tu aplicación y ejecutar tus tareas previas y posteriores a la implementació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.

GKE

Ejecuta el siguiente comando desde el directorio deploy-hooks-gke-quickstart para crear un recurso release que represente la imagen del contenedor que se implementará:

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-hooks-demo-app-gke-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

Observa la marca --images=, que usas para reemplazar el marcador de posición (my-app-image) en el manifiesto por la imagen específica calificada por SHA. Google recomienda que generes plantillas de tus manifiestos de esta manera y que uses nombres de imágenes calificados por SHA cuando crees la versión.

Cloud Run

Ejecuta el siguiente comando desde el directorio deploy-hooks-run-quickstart para crear un recurso release que represente la imagen del contenedor que se implementará:

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-hooks-demo-app-run-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4

Observa la marca --images=, que usas para reemplazar el marcador de posición (my-app-image) en la definición del servicio con la imagen específica calificada por SHA. Google recomienda que generes plantillas de tus definiciones de trabajos y servicios de esta manera, y que uses nombres de imágenes calificados por SHA cuando crees la versión.

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. La aplicación se implementa automáticamente en el único destino configurado para esta canalización de entrega.

Además, la tarea de preimplementación se ejecuta antes de que se implemente la aplicación, y la tarea de postimplementación se ejecuta después.

Visualiza los resultados en la consola de Google Cloud

Después de unos minutos, la versión se implementará en el entorno de ejecución de destino.

Los hooks previos y posteriores a la implementación que configuramos (a modo de ejemplo) imprimen cadenas en los registros de Cloud Build. Podemos ver esos registros para confirmar que los hooks funcionaron según lo esperado.

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 ("deploy-hooks-demo-app-gke-1" o "deploy-hooks-demo-app-run-1").

   Abrir la página Canalizaciones de entrega

2. Haz clic en el nombre de tu canalización de entrega ("deploy-hooks-demo-app-gke-1" o "deploy-hooks-demo-app-run-1").

   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 la pestaña Lanzamientos, en Detalles de la canalización de publicación.

4. Haz clic en el nombre del lanzamiento para ver sus detalles.

   

   Predeploy y Postdeploy aparecen como trabajos.

5. Haz clic en Preimplementar.

   Se muestra el registro de ejecución del trabajo.

6. Desplázate hacia abajo en la lista de entradas de registro para encontrar predeploy-echo y haz clic en él.

   

   Observa el textPayload. Esa cadena es la que se configuró en predeploy-action en tu configuración de Skaffold.

7. Haz clic en el trabajo Postdeploy y busca la entrada de registro postdeploy-echo.

   

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 el clúster de GKE o el servicio de Cloud Run:

   GKE

   gcloud container clusters delete deploy-hooks-cluster --region=us-central1 --project=PROJECT_ID
   

   Cloud Run

   gcloud run services delete my-hooks-run-service --region=us-central1 --project=PROJECT_ID
   

2. 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
   

3. Borra los buckets de Cloud Storage que creó Cloud Deploy.

   Uno termina con _clouddeploy y el otro es [region].deploy-artifacts.[project].appspot.com.

   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 Cloud Deploy.

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

• Prueba la explicación de Cloud Deploy.

• Aprende a combinar las herramientas de CI/CD de Google Cloud para desarrollar y entregar software de manera eficaz a GKE.