Automatizar la promoción de lanzamientos y el avance de la implementación en Cloud Deploy

En esta página se muestra cómo usar Cloud Deploy para promover automáticamente una versión a un destino y avanzar un lanzamiento a su siguiente fase.

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

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

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

  3. Define tu flujo de procesamiento de entrega y tus destinos de implementación de Cloud Deploy.

    La canalización se desplegará en dos destinos: dev y staging. Además, el staging objetivo usa una estrategia de implementación canary.

  4. Define dos reglas de automatización:

    • Una automatización para promocionar la versión en el destino staging cuando se haya lanzado correctamente en dev.

    • Automatización para avanzar al lanzamiento a la fase stable cuando se haya completado correctamente la fase canary-25`.

  5. Instancia tu flujo de procesamiento de entrega creando una versión, que se desplegará automáticamente en el destino dev.

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

    Debido a la promoción automatizada, esta versión se promociona en la staging automáticamente.

    Como el destino staging usa una estrategia de despliegue canary y este es el primer despliegue en ese tiempo de ejecución, se omite la fase canary-25. Consulta Por qué se omiten a veces las fases para obtener más información sobre por qué se omite la fase canary la primera vez.

    Debido al avance automático de la fase, la implementación se ha adelantado a la fase stable.

Antes de empezar

  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.

    Go to project selector

  3. Verify 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. Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

  7. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init

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

    Go to project selector

  9. Verify that billing is enabled for your Google Cloud project.

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

    Enable the APIs

  11. Install the Google Cloud CLI.

  12. Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

  13. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init

    14. Si ya tienes instalada la CLI, asegúrate de que estás usando la versión más reciente:

    gcloud components update
  14. Comprueba que la cuenta de servicio predeterminada de Compute Engine tenga los permisos suficientes.

    Es posible que la cuenta de servicio ya tenga los permisos necesarios. Estos pasos se incluyen para los proyectos que inhabilitan las concesiones automáticas de roles para las cuentas de servicio predeterminadas.

    1. Primero, añade el rol clouddeploy.jobRunner: 
      gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --role="roles/clouddeploy.jobRunner"
    2. Añade el rol clouddeploy.releaser: 
      gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --role="roles/clouddeploy.releaser"
    3. Añade el rol de desarrollador para tu tiempo de ejecución específico.
      • En GKE: 
        gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --role="roles/container.developer"
      • En Cloud Run: 
        gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --role="roles/run.developer"
    4. Añade el rol iam.serviceAccountUser, que incluye el permiso actAs para que la cuenta de servicio predeterminada pueda implementar en el tiempo de ejecución: 
      gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --role="roles/iam.serviceAccountUser" \
    --project=PROJECT_ID
    5. Añade el rol iam.serviceAccountUser, incluido el permiso actAs, para usar la cuenta de servicio predeterminada: 
      gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --member=user:YOUR_EMAIL_ADDRESS \
    --role="roles/iam.serviceAccountUser" \
    --project=PROJECT_ID

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

    Crear entornos de ejecución

    Si vas a desplegar en Cloud Run, puedes omitir este comando.

    En GKE, crea dos clústeres: automation-quickstart-cluster-dev y automation-quickstart-cluster-staging, con la configuración predeterminada. Los endpoints de la API Kubernetes de los clústeres deben ser accesibles a través de la red pública de Internet. Los clústeres de GKE son accesibles externamente 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. Esto es necesario 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 --format="value(projectNumber)"

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

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

      PROJECT_NUMBER

    Preparar la configuración de Skaffold y el manifiesto de la aplicación

    Cloud Deploy usa Skaffold para proporcionar los detalles de qué desplegar y cómo desplegarlo correctamente en tus destinos.

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

    1. Abre una ventana de terminal.

    2. Crea un directorio y accede a é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. Sin embargo, también puedes pedirle a Cloud Deploy que cree uno por ti para aplicaciones sencillas que no sean 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 sencillo que se usa para desplegar la aplicación. La imagen del contenedor que se va a desplegar se define aquí como marcador de posición, my-app-image, que se sustituye por la imagen específica cuando creas la versió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

      Estos archivos son definiciones de servicios de Cloud Run sencillas que se usan para desplegar la aplicación. La imagen de contenedor que se va a desplegar se define aquí como marcador de posición, my-app-image, que se sustituye por la imagen específica cuando crea la versión.

    Crea tu flujo de procesamiento de entrega, tus objetivos y tu automatización

    Puedes definir tu canal de distribución y tus destinos en un archivo o en archivos independientes. También puedes definir una acción de automatización en un archivo independiente. 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 flujo de procesamiento 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: PROJECT_NUMBER-compute@developer.gserviceaccount.com
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: PROJECT_NUMBER-compute@developer.gserviceaccount.com
selector:
  targets:
  - id: automation-quickstart-staging
rules:
- advanceRolloutRule:
    name: "advance-rollout"
    sourcePhases: ["canary-25"]
    wait: 1m

      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: PROJECT_NUMBER-compute@developer.gserviceaccount.com
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: PROJECT_NUMBER-compute@developer.gserviceaccount.com
selector:
  targets:
  - id: automation-quickstart-staging
rules:
- advanceRolloutRule:
    name: "advance-rollout"
    sourcePhases: ["canary-25"]
    wait: 1m

    2. Registra tu canal y tus destinos en el servicio Cloud Deploy:

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

      Ahora tienes una canalización con un objetivo múltiple que incluye dos objetivos de GKE o Cloud Run, lista para desplegar tu aplicación.

    3. Confirma tu flujo de procesamiento y tus objetivos:

      En la Google Cloud consola, ve a la página Pipelines de entrega de Cloud Deploy para ver una lista de los pipelines de entrega disponibles.

      Abre la página Pipelines de entrega.

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

      visualización del flujo de procesamiento de entrega en la consola Google Cloud

    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. En Detalles de la canalización de entrega, selecciona la pestaña Automatizaciones.

      Se muestran las dos automatizaciones que has creado.

      Visualización del flujo de procesamiento de entrega en la consola Google Cloud

    Crear una versión

    Una versión es el recurso central de Cloud Deploy que representa los cambios que se van a implementar. El flujo de procesamiento de entrega define el ciclo de vida de esa versión. Consulta la arquitectura de servicio de Cloud Deploy para obtener más información sobre ese ciclo de vida.

    GKE

    Ejecuta el siguiente comando desde el directorio deploy-automation-gke-quickstart para crear un recurso release que represente la imagen del contenedor que se va a desplegar:

     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

    Fíjate en la marca --images=, que se usa para sustituir el marcador de posición (my-app-image) del manifiesto por la imagen específica cualificada con SHA. Google recomienda que uses plantillas de manifiestos de esta forma y que uses nombres de imágenes cualificados por SHA al crear lanzamientos.

    Cloud Run

    Ejecuta el siguiente comando desde el directorio deploy-automation-run-quickstart para crear un recurso release que represente la imagen del contenedor que se va a desplegar:

     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:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

    Fíjate en la marca --images=, que se usa para sustituir el marcador de posición (my-app-image) de la definición del servicio por la imagen específica cualificada con SHA. Google recomienda que crees plantillas de tus definiciones de servicios y trabajos de esta forma, y que uses nombres de imágenes cualificados con SHA al crear lanzamientos.

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

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

    • Una vez que se haya implementado correctamente en el primer destino, la versión se ascenderá automáticamente al segundo destino.

      La automatización de la promoción tiene un tiempo de espera de un minuto.

    • En el segundo destino, donde se ha configurado una versión canary del 25 %, la segunda automatización avanza el lanzamiento de canary-25 a stable.

      En esta primera versión, se omite la fase canary-25, ya que no hay ninguna versión anterior de la aplicación con la que hacer pruebas canary. El lanzamiento se ha avanzado automáticamente al stable.

      La automatización de avance tiene un retraso de un minuto.

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

    Si quieres obtener más información sobre cómo implementar una estrategia de lanzamiento canary, puedes probar la guía de inicio rápido de canary.

    Ver los resultados en la Google Cloud consola

    Puedes ver los resultados, incluidas las ejecuciones de automatización, en la consolaGoogle Cloud .

    1. Ve a la página Flujos de procesamiento de entrega de Cloud Deploy para ver tu flujo de procesamiento de entrega.

      Abre la página Pipelines de entrega.

    2. Haga clic en el nombre de su canal de distribución "my-automation-demo-app-1".

      La visualización de la canalización muestra el estado de la implementación de la aplicación. Si ha transcurrido suficiente tiempo, ambos objetivos se mostrarán en verde.

      Visualización del flujo de procesamiento de entrega en la consola Google Cloud

      Tu lanzamiento aparecerá en la pestaña Lanzamientos, en Detalles de la canalización de entrega.

    3. Haz clic en la pestaña Ejecuciones de automatización.

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

      Detalles de la ejecución de la automatización mostrados en la consola Google Cloud

    Limpieza

    Para evitar que se apliquen cargos en tu cuenta de Google Cloud por los recursos utilizados en esta página, sigue estos pasos.

    1. Elimina 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. Elimina la canalización de distribución, los destinos, las automatizaciones, la versión y los lanzamientos:

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

    3. Elimina los segmentos de Cloud Storage que haya creado Cloud Deploy.

      Una termina con _clouddeploy y la otra es [region].deploy-artifacts.[project].appspot.com.

      Abrir la página del navegador de Cloud Storage

    ¡Ya has completado esta guía de inicio rápido!

    Siguientes pasos