Automatiza la promoción de lanzamientos y el avance del lanzamiento en Cloud Deploy

Automatiza la promoción de lanzamientos y el avance del lanzamiento en Cloud Deploy

En esta página, se muestra cómo usar Cloud Deploy para ascender automáticamente un lanzarlo a un destino y hacer que el lanzamiento avance a la siguiente fase.

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

1. Crear dos clústeres de GKE o dos servicios de Cloud Run

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

3. Define la canalización de entrega y los destinos de implementación de Cloud Deploy.

   La canalización se implementará en dos destinos: dev y staging. Y el objetivo staging usa una estrategia de implementación Canary.

4. Define dos reglas de automatización:

   • Una automatización para promover la versión al destino staging cuando el lanzamiento a dev se realice correctamente

   • Una automatización para avanzar el lanzamiento a la fase stable una vez que se complete correctamente la fase canary-25.

5. Crea una instancia de tu canalización de entrega, se implementa en el destino dev.

6. Consulta la canalización de entrega y la versión en la consola de Google Cloud.

   Debido a la promoción automática, este lanzamiento se promociona en el staging automáticamente.

   Debido a que el objetivo staging usa una estrategia de implementación Canary y esta es la primera implementación en ese entorno de ejecución, se omite la fase canary-25. Consulta Por qué se omiten las fases a veces para obtener más información sobre por qué se omite la fase canary la primera vez.

   Debido al avance automático de fase, el lanzamiento avanza a la fase stable.

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 clouddeploy.releaser:

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

    3. 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"
      

    4. Agrega el rol iam.serviceAccountUser, que incluye el permiso actAs para que la cuenta de servicio predeterminada se implemente 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
       

    5. Agrega el rol iam.serviceAccountUser, incluido el permiso actAs para ti, para usar la cuenta de servicio predeterminada:

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

       En este caso, YOUR_EMAIL_ADDRESS es la dirección de correo electrónico que usas para acceder en Google Cloud.

Crea tus entornos de ejecución

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

Para GKE, crea dos clústeres: automation-quickstart-cluster-dev y automation-quickstart-cluster-staging, con la configuración predeterminada. El clústeres Se debe poder acceder a los extremos de la API de Kubernetes desde el público a Internet. Los clústeres de GKE son accesibles de forma externa de forma predeterminada.

gcloud container clusters create-auto automation-quickstart-cluster-dev \
                 --project=PROJECT_ID \
                 --region=us-central1 \
                 && gcloud container clusters create-auto automation-quickstart-cluster-staging \
                 --project=PROJECT_ID \
                 --region=us-central1

Obtén el número de tu proyecto.

Necesitas el número de tu proyecto para identificar la cuenta de servicio predeterminada. Este es necesarias para configurar el recurso de automatización.

1. Ejecuta el siguiente comando para obtener el número de tu proyecto:

   gcloud projects describe PROJECT_ID
   

2. Copia el número de proyecto del resultado de la línea de comandos y pégalo aquí.

   No es necesario que lo ejecutes como comando. Si lo pegas aquí, se propaga la referencia de la cuenta de servicio en la configuración de automatización más adelante en esta guía de inicio rápido.

   PROJECT_NUMBER
   

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 de forma correcta para tus destinos separados.

En esta guía de inicio rápido, debes crear un archivo skaffold.yaml, que identifica el el manifiesto de la aplicación que se usará para implementar la app de ejemplo.

1. Abre una ventana de terminal.

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

   GKE

   mkdir deploy-automation-gke-quickstart
   cd deploy-automation-gke-quickstart
   

   Cloud Run

   mkdir deploy-automation-run-quickstart
   cd deploy-automation-run-quickstart
   

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

   GKE

   apiVersion: skaffold/v4beta7
   kind: Config
   metadata:
     name: gke-automation
   manifests:
     rawYaml:
     - k8s-deployment.yaml
   deploy:
     kubectl: {}
   

   Cloud Run

   apiVersion: skaffold/v4beta7
   kind: Config
   metadata:
     name: run-automation
   profiles:
   - name: dev
     manifests:
       rawYaml:
       - run-dev.yaml
   - name: staging
     manifests:
       rawYaml:
       - run-staging.yaml
   deploy:
     cloudrun: {}
   

   Este archivo es una configuración mínima de Skaffold. En esta guía de inicio rápido, crearás el archivo. Pero también puedes hacer que Cloud Deploy cree uno por ti para aplicaciones simples que no son de producción.

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

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

   GKE

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

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: my-deployment
     labels:
       app: my-app
     namespace: default
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: my-app
     template:
       metadata:
         labels:
           app: my-app
       spec:
         containers:
         - name: nginx
           image: my-app-image
   ---
   apiVersion: v1
   kind: Service
   metadata:
     name: my-service
     namespace: default
   spec:
     selector:
       app: my-app
     ports:
       - protocol: TCP
         port: 80
   

   Este archivo es un manifiesto de Kubernetes simple que se aplica al clúster para implementar la aplicación.

   Cloud Run

   1. Crea un archivo llamado run-dev.yaml con el siguiente contenido.

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

   2. Crea un archivo llamado run-staging.yaml con el siguiente contenido.

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

   Este archivo es una definición de servicio de Cloud Run simple, que se usa en el momento de la implementación para crear tu servicio de Cloud Run.

Crea tu canalización de entrega, destinos y automatización

Puedes definir la canalización de entrega y los destinos en un archivo o en archivos. También puedes definir una acción de automatización en un archivo separado. En esta guía de inicio rápido, se usa un archivo para la canalización, los destinos y la automatización.

1. Crea tu canalización de entrega, las definiciones de destino y la acción de automatización:

   GKE

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-automation-demo-app-1
   description: Automation demonstration pipeline
   serialPipeline:
     stages:
     - targetId: automation-quickstart-dev
     - targetId: automation-quickstart-staging
       profiles: []
       strategy:
         canary:
           runtimeConfig:
             kubernetes:
               serviceNetworking:
                 service: "my-service"
                 deployment: "my-deployment"
           canaryDeployment:
             percentages: [25]
             verify: false
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-dev
   description: Dev cluster to demonstrate deploy automation
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/automation-quickstart-cluster-dev
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-staging
   description: Staging cluster to demonstrate deploy automation
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/automation-quickstart-cluster-staging
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/promote
   description: promotes a release
   suspended: false
   serviceAccount: [e-mail]
   selector:
     targets:
     - id: automation-quickstart-dev
   rules:
   - promoteReleaseRule:
       name: "promote-release"
       wait: 1m
       toTargetId: "@next"
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/advance
   description: advances a rollout
   suspended: false
   serviceAccount: [e-mail]
   selector:
     targets:
     - id: automation-quickstart-staging
   rules:
   - advanceRolloutRule:
       name: "advance-rollout"
       sourcePhases: ["canary-25"]
       wait: 1m
   

   Nota: En este archivo, se incluyen los destinos y la configuración de las automatizaciones con la canalización de entrega, pero puedes definir destinos en o varios archivos separados, y las automatizaciones en un archivo o .

   Cloud Run

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-automation-demo-app-1
   description: Automation demonstration pipeline
   serialPipeline:
     stages:
     - targetId: automation-quickstart-dev
       profiles: [dev]
     - targetId: automation-quickstart-staging
       profiles: [staging]
       strategy:
         canary:
           runtimeConfig:
             cloudRun:
               automaticTrafficControl: true
           canaryDeployment:
             percentages: [25]
             verify: false
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-dev
   description: Dev cluster to demonstrate deploy automation
   run:
     location: projects/PROJECT_ID/locations/us-central1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: automation-quickstart-staging
   description: Staging cluster to demonstrate deploy automation
   run:
     location: projects/PROJECT_ID/locations/us-central1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/promote
   description: Promotes a release to the next target
   suspended: false
   serviceAccount: [e-mail]
   selector:
     targets:
     - id: automation-quickstart-dev
   rules:
   - promoteReleaseRule:
       name: "promote-release"
       wait: 1m
       toTargetId: "@next"
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Automation
   metadata:
     name: my-automation-demo-app-1/advance
   description: advances a rollout
   suspended: false
   serviceAccount: [e-mail]
   selector:
     targets:
     - id: automation-quickstart-staging
   rules:
   - advanceRolloutRule:
       name: "advance-rollout"
       sourcePhases: ["canary-25"]
       wait: 1m
   

   Nota: En este archivo, los destinos y la configuración de las automatizaciones se incluyen con la canalización de entrega, pero puedes definir los destinos en un archivo o en varios archivos separados, y las automatizaciones en un archivo o 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, con un destino múltiple que consta de dos destinos de GKE o Cloud Run, lista para implementar tu aplicación.

3. Confirma tu canalización y tus objetivos:

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

   Abrir la página Canalizaciones de entrega

   Se muestra la canalización de entrega que acabas de crear, con dos destinos enumerados en la columna Destinos.

   

4. Haz clic en el nombre de la canalización para abrir la visualización y los detalles de la canalización de entrega.

5. Selecciona la pestaña Automatizaciones en Detalles de la canalización de publicación.

   Se muestran las dos automatizaciones que creaste.

   

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 deploy-automation-gke-quickstart. para crear un recurso release que represente al contenedor para implementar:

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

Cloud Run

Ejecuta el siguiente comando desde deploy-automation-run-quickstart. para crear un recurso release que represente al contenedor para implementar:

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

De forma predeterminada, cuando creas una versión, se crea automáticamente un lanzamiento para el primer destino de tu canalización.

Dado que esta guía de inicio rápido incluye dos automatizaciones, ocurren dos cosas: automáticamente:

• Después de una implementación exitosa en el primer destino, la versión se se asciende automáticamente al segundo objetivo.

  Hay un tiempo de espera de un minuto en la automatización de promoción.

• En el segundo objetivo, donde se configuró una versión canary del 25%, la automatización avanza el lanzamiento del canary-25 al stable.

  Para esta primera versión, se omite la fase canary-25, ya que no hay una versión preexistente de la app para comparar. Y el lanzamiento es avanza automáticamente a stable.

  Hay una demora de un minuto en la automatización avanzada.

Cuando todo termine, la aplicación se implementará correctamente en ambos objetivos sin que tengas que hacer nada más.

Si deseas obtener más información para ejecutar una estrategia de implementación de canary, puedes probar la guía de inicio rápido de canary.

Visualiza los resultados en la consola de Google Cloud

Puedes ver los resultados, incluidas las ejecuciones de automatización, en la Consola de Google Cloud

1. 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 “my-automation-demo-app-1”.

   La visualización de la canalización muestra el estado de implementación de la app. Si transcurrió suficiente tiempo, ambos objetivos aparecerán en verde.

   

   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 Ejecuciones de automatización.

   Hay dos entradas, una para cada una de las dos automatizaciones que creaste. Puedes hacer clic en cualquiera de ellos para ver los detalles de esa ejecución de automatización.

   

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 los clústeres de GKE o los servicios de Cloud Run:

   GKE

   gcloud container clusters delete automation-quickstart-cluster-dev --region=us-central1 --project=PROJECT_ID \
   && gcloud container clusters delete automation-quickstart-cluster-staging --region=us-west1 --project=PROJECT_ID
   

   Cloud Run

   gcloud run services delete my-automation-run-service-dev --region=us-central1 --project=PROJECT_ID \
   && gcloud run services delete my-automation-run-service-staging --region=us-central1 --project=PROJECT_ID
   

2. Borra la canalización de entrega, los destinos, las automatizaciones, las versiones y los lanzamientos:

   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 ofrecer el software de forma eficaz a GKE.