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 promover de forma automática una versión en un destino y avanzar un lanzamiento a su siguiente fase.
En esta guía de inicio rápido, harás lo siguiente:
Crear dos clústeres de GKE o dos servicios de Cloud Run
Crea una configuración de Skaffold y un manifiesto de Kubernetes o una definición del servicio de Cloud Run.
Define la canalización de entrega y los destinos de implementación de Cloud Deploy.
La canalización se implementará en dos destinos:
dev
ystaging
. Y el objetivostaging
usa una estrategia de implementación de versiones canary.Define dos reglas de automatización:
Una automatización para promover la versión en el destino
staging
en el lanzamiento exitoso endev
Una automatización para avanzar el lanzamiento a la fase
stable
cuando se complete correctamente la fasecanary-25
Para crear una instancia de tu canalización de entrega, crea una versión, que se implemente de forma automática en el destino
dev
.Visualiza la canalización de entrega y la versión en la consola de Google Cloud.
Debido a la promoción automática, esta versión se promueve a
staging
automáticamente.Debido a que el destino
staging
usa una estrategia de implementación de versiones canary y esta es la primera implementación en ese entorno de ejecución, se omite la fasecanary-25
. Consulta Por qué a veces se omiten fases para comprender más sobre por qué se omite la fase de versión canary la primera vez.Debido al avance de fase automatizado, el lanzamiento se avanza a la fase
stable
.
Antes de comenzar
- Accede a tu cuenta de Google Cloud. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.
-
Habilita las API de Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.
- Instala Google Cloud CLI.
-
Para inicializar la CLI de gcloud, ejecuta el siguiente comando:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.
-
Habilita las API de Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.
- Instala Google Cloud CLI.
-
Para inicializar la CLI de gcloud, ejecuta el siguiente comando:
gcloud init
- 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 las asignaciones de funciones automáticas para las cuentas de servicio predeterminadas.
- Primero, agrega 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"
- Agrega 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"
- Agrega el rol de desarrollador a 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)")-compute@developer.gserviceaccount.com \ --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)")-compute@developer.gserviceaccount.com \ --role="roles/run.developer"
-
Agrega la función
iam.serviceAccountUser
, que incluye el permisoactAs
para que la cuenta de servicio predeterminada implemente en el entorno 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
-
Agrega la función
iam.serviceAccountUser
, incluido el permisoactAs
, 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 electrónico que usas para acceder a Google Cloud.
- Primero, agrega el rol
Si ya tienes instalada la CLI, asegúrate de estar ejecutando la versión más reciente:
gcloud components update
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. Los extremos de la API de Kubernetes de los clústeres deben ser accesibles en la red desde la Internet pública. 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 del 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.
Ejecuta el siguiente comando para obtener el número de tu proyecto:
gcloud projects describe PROJECT_ID
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 la pegas aquí, se propagará 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 la configuración de Skaffold y el manifiesto de la app
Cloud Deploy usa Skaffold para proporcionar los detalles sobre qué implementar y cómo hacerlo correctamente en tus destinos independientes.
En esta guía de inicio rápido, debes crear un archivo skaffold.yaml
, que identifica el manifiesto de la aplicación que se usará para implementar la app de muestra.
Abre una ventana de la terminal.
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
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. Para esta guía de inicio rápido, debes crear el archivo. Sin embargo, también puedes hacer que Cloud Deploy cree una 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.Crea la definición de tu aplicación: un par de definiciones de servicios 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 simple de Kubernetes que se aplica al clúster para implementar la aplicación.
Cloud Run
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
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 sencilla del servicio de Cloud Run, que se usa en el momento de la implementación para crear el 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 separados. 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.
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: 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
Registra tu canalización y 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 comprende dos destinos de GKE o de Cloud Run, lista para implementar tu aplicación.
Confirma tu canalización y tus destinos:
En la consola de Google Cloud, navega a la página Canalizaciones de entrega de Cloud Deploy para ver la lista de canalizaciones de entrega disponibles.
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.
Haz clic en el nombre de la canalización para abrir la visualización y los detalles de la canalización de entrega.
Selecciona la pestaña Automatizaciones en Detalles de la canalización de entrega.
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 implementan. La canalización de entrega define el ciclo de vida de esa versión. Consulta Arquitectura del servicio de Cloud Deploy para obtener detalles 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 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 el directorio deploy-automation-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=my-automation-demo-app-1 \
--images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:6063adf8f687702b4065151acddba6781c47bc602167eb9f3bec8aebc9ce95cc
De forma predeterminada, cuando creas una versión, se crea un lanzamiento automáticamente para el primer destino de tu canalización.
Debido a que esta guía de inicio rápido incluye dos automatizaciones, ocurren dos procesos automáticamente:
Después de una implementación exitosa en el primer destino, la versión asciende de forma automática al segundo destino.
Hay un tiempo de espera de un minuto en la automatización de promoción.
En el segundo objetivo, donde hay una versión canary del 25% configurada, la segunda automatización hace que el lanzamiento avance de
canary-25
astable
.En esta primera versión, se omite la fase
canary-25
, ya que no hay una versión preexistente de la app para realizar versiones canary otra vez. Y el lanzamiento avanza automáticamente astable
.Hay una demora de un minuto en la automatización avanzada.
Cuando todo finaliza, la aplicación se implementa de forma correcta en ambos destinos sin que tengas que hacer nada más.
Si deseas obtener más información sobre cómo ejecutar una estrategia de implementación de versiones canary, puedes probar la guía de inicio rápido de versiones canary.
Ve los resultados en la consola de Google Cloud
Puedes ver los resultados, incluidas las ejecuciones de automatización, en la consola de Google Cloud.
Navega a la página Canalizaciones de entrega de Cloud Deploy para ver tu canalización de entrega.
Haz clic en el nombre de la 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 ha transcurrido suficiente tiempo, ambos objetivos se mostrarán en verde.
Y la versión aparece en la pestaña Versiones, en Detalles de la canalización de entrega.
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 se usaron en esta página.
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
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
Borra los buckets de Cloud Storage que creó Cloud Deploy.
Uno termina con
_clouddeploy
y el otro es[region].deploy-artifacts.[project].appspot.com
.
Eso es todo, finalizaste la guía de inicio rápido.