Implementación de versiones canary de una aplicación en un destino

En esta guía de inicio rápido, se muestra cómo usar Cloud Deploy para entregar una imagen de aplicación de muestra en una implementación de versiones canary a Google Kubernetes Engine o a Cloud Run. También puedes ejecutar una implementación de versiones canary en GKE Enterprise, pero solo se muestran GKE y Cloud Run en esta guía de inicio rápido.

Una implementación de versiones canary divide el tráfico entre una versión de la aplicación ya implementada y la versión nueva. El tráfico de redistribución de Cloud Run según los porcentajes que configures en la canalización de entrega. GKE implementa la versión nueva en una proporción de Pods. Esta guía de inicio rápido se implementa primero en el 50% y, luego, en el 100%.

En esta guía de inicio rápido, solo hay un destino (prod). Por lo tanto, creamos solo un clúster de GKE o un servicio de Cloud Run para ejecutar la aplicación.

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

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

También puedes realizar implementaciones de versiones canary en clústeres de GKE Enterprise, pero en esta guía de inicio rápido solo se usan GKE y Cloud Run.
Crea una configuración de Skaffold y un manifiesto de Kubernetes para especificar la imagen de contenedor (compilada previamente) que se implementará.
Define la canalización de entrega de Cloud Deploy y el objetivo de implementación.
Invoca tu canalización de entrega a través de la creación de una versión que se implemente automáticamente en un destino.

Esta primera versión omite la fase de versión canary.
Visualiza la canalización de entrega y la versión en la consola de Google Cloud.
Crea una segunda versión, esta vez, ejecutando la etapa de versiones canary para implementar la aplicación al 50%.
Avanzar la versión para implementarla al 100%

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.

Go to project selector

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.

Habilita las API

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.

Go to project selector

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.

Habilita las API

Instala Google Cloud CLI.

Para inicializar la CLI de gcloud, ejecuta el siguiente comando:

gcloud init

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

gcloud components update

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 funciones 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 de desarrollador para tu entorno de ejecución específico.

Para GKE, y GKE con la API de puerta de enlace:

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 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)")-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

Crea tu entorno de ejecución

GKE

Crea un clúster de Autopilot de GKE:

 gcloud container clusters create-auto canary-quickstart-cluster \
                  --project=PROJECT_ID \
                  --region=us-central1

GKE y API de puerta de enlace

Crea un clúster de GKE con la configuración recomendada para admitir el uso con Istio:

gcloud container clusters create canary-quickstart-cluster \
       --machine-type=n1-standard-1 \
       --num-nodes 4 \
       --region=us-central1 \
       --project=PROJECT_ID

Obtén las credenciales del clúster:

gcloud container clusters get-credentials canary-quickstart-cluster \
       --project=PROJECT_ID \
       --region=us-central1

Instala las CRD de la API de Kubernetes Gateway si aún no están presentes en el clúster.

kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.6.2/standard-install.yaml

Instala Istio para habilitar la implementación del controlador de puerta de enlace de Istio.

curl -L https://istio.io/downloadIstio | ISTIO_VERSION=1.17.2 sh - \
&& ./istio-1.17.2/bin/istioctl install --set profile=minimal -y

Cloud Run

Si usas Cloud Run, puedes omitir este comando. No necesitas hacer nada aquí.

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

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

En esta guía de inicio rápido, crearás un archivo skaffold.yaml, que identifica el manifiesto de Kubernetes o la configuración del servicio de Cloud Run que se implementará.

Abre una ventana de la terminal.

Crea un directorio nuevo y navega hasta él.

GKE

mkdir deploy-canary-quickstart-gke
cd deploy-canary-quickstart-gke

GKE y API de puerta de enlace

mkdir deploy-canary-quickstart-gke-gatewayapi
cd deploy-canary-quickstart-gke-gatewayapi

Cloud Run

mkdir deploy-canary-quickstart-run
cd deploy-canary-quickstart-run

Crea un archivo llamado skaffold.yaml con el siguiente contenido:
GKE
```
apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - kubernetes.yaml
deploy:
  kubectl: {}
```
GKE y API de puerta de enlace
```
apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - kubernetes.yaml
deploy:
  kubectl: {}
```
Cloud Run
```
apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - run.yaml
deploy:
  cloudrun: {}
```
Este archivo es una configuración mínima de Skaffold que identifica tu manifiesto. Para esta guía de inicio rápido, debes crear el archivo. Sin embargo, 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.

Crea el manifiesto de tu aplicación.

GKE

Crea un archivo llamado kubernetes.yaml en el directorio deploy-canary-quickstart-gke 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.

GKE y API de puerta de enlace

Crea un archivo llamado kubernetes.yaml en el directorio deploy-canary-quickstart-gke-gatewayapi con el siguiente contenido:

kind: Gateway
apiVersion: gateway.networking.k8s.io/v1beta1
metadata:
  name: my-gateway
  annotations:
    networking.istio.io/service-type: "ClusterIP"
spec:
  gatewayClassName: istio
  listeners:
  - name: default
    hostname: "*.example.com"
    port: 80
    protocol: HTTP
    allowedRoutes:
      namespaces:
        from: All
---
kind: HTTPRoute
apiVersion: gateway.networking.k8s.io/v1beta1
metadata:
  name: my-httproute
spec:
  parentRefs:
  - kind: Gateway
    name: my-gateway
  hostnames:
  - "test.example.com"
  rules:
  - backendRefs:
    - name: my-service
      port: 80
---
apiVersion: v1
kind: Service
metadata:
  name: my-service
spec:
  selector:
    app: my-app
  ports:
  - name: tcp-port
    protocol: TCP
    port: 80
    targetPort: 8080
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-deployment
  labels:
    app: my-app
spec:
  replicas: 1
  selector:
    matchLabels:
      app: my-app
  template:
    metadata:
      labels:
        app: my-app
    spec:
      containers:
      - name: nginx
        image: my-app-image

Este archivo es un manifiesto de Kubernetes que se aplica al clúster para implementar la aplicación. En este manifiesto, se incluyen los recursos de implementación y servicio necesarios para la implementación de versiones canary, además de un recurso HTTPRoute y el recurso de puerta de enlace necesario para usar la API de Gateway.

Cloud Run

Crea un archivo llamado run.yaml en el directorio deploy-canary-quickstart-run con el siguiente contenido:

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

Este es un archivo de configuración del servicio de Cloud Run, que se aplica en el momento de la implementación para crear el servicio en Cloud Run.

Crea la canalización de entrega y los destinos

Puedes definir tu canalización de entrega y destinos en un archivo o en archivos separados. En esta guía de inicio rápido, creamos un archivo para la canalización y nuestro único destino:

GKE

Crea un archivo llamado clouddeploy.yaml en el directorio deploy-canary-quickstart-gke con el siguiente contenido:

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: my-canary-demo-app-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: prod
    profiles: []
    strategy:
      canary:
        runtimeConfig:
          kubernetes:
            serviceNetworking:
              service: "my-service"
              deployment: "my-deployment"
        canaryDeployment:
          percentages: [50]
          verify: false
---
apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: prod
description: prod GKE cluster
gke:
 cluster: projects/PROJECT_ID/locations/us-central1/clusters/canary-quickstart-cluster

GKE y API de puerta de enlace

Crea un archivo llamado clouddeploy.yaml en el directorio deploy-canary-quickstart-gke-gatewayapi con el siguiente contenido:

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: my-canary-demo-app-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: prod
    profiles: []
    strategy:
      canary:
        runtimeConfig:
          kubernetes:
            gatewayServiceMesh:
              httpRoute: "my-httproute"
              service: "my-service"
              deployment: "my-deployment"
        canaryDeployment:
          percentages: [50]
          verify: false
---
apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: prod
description: prod GKE cluster
gke:
 cluster: projects/PROJECT_ID/locations/us-central1/clusters/canary-quickstart-cluster

Cloud Run

Crea un archivo llamado clouddeploy.yaml, en el directorio deploy-canary-quickstart-run, con el siguiente contenido:

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: my-canary-demo-app-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: prod
    profiles: []
    strategy:
      canary:
        runtimeConfig:
          cloudRun:
            automaticTrafficControl: true
        canaryDeployment:
          percentages: [50]
          verify: false
---
apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: prod
description: prod Run Service
run:
  location: projects/PROJECT_ID/locations/us-central1

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 objetivo configurado para una estrategia de implementación de versiones canary.
Confirma la canalización y los 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, y el destino que configuraste se muestra en la columna Destinos.

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 de servicio de Cloud Deploy para obtener detalles sobre ese ciclo de vida.

Para crear un recurso release que represente la imagen de contenedor que se implementará, ejecuta el siguiente comando desde el directorio deploy-canary-quickstart-gke, deploy-canary-quickstart-gke-gatewayapi o deploy-canary-quickstart-run:

GKE

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

GKE y API de puerta de enlace

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

Cloud Run

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

Cuando creas una versión, Cloud Deploy crea automáticamente un recurso de lanzamiento para realizar una implementación inmediata en tu destino, prod.

Pasamos a la fase estable

Con esta primera versión, omitimos la fase de versión canary y la implementaremos en el 100% (fase estable). Esto se debe a que la aplicación no se implementó antes, por lo que no hay forma de calcular el 50% de los Pods (para GKE) ni cómo se divide el tráfico para el servicio (en Cloud Run). Los Pods (GKE) o las revisiones (Cloud Run) aún no existen.

Después de omitir la fase de versión canary, tenemos todo listo para iniciar la fase estable, que lleva el tráfico al 100%. Después, crearemos otro lanzamiento para ejecutar la versión canary.

En una situación real, por lo general, ejecutarás una implementación de versiones canary en la que tu aplicación ya se esté ejecutando, por lo que esta fase de omisión será poco frecuente.

Ver la versión en la consola de Google Cloud

Ahora que creaste la primera versión, se crea el lanzamiento, y puedes verlos y el lanzamiento en la consola de Google Cloud. También puedes ver la visualización de la canalización, que muestra el estado actual de la versió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 my-canary-demo-app-1.

Abrir la página Canalizaciones de entrega
Haz clic en el nombre de tu canalización de entrega “my-canary-demo-app-1”.

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

Y la versión aparece en la pestaña Versiones, en Detalles de la canalización de entrega.
Haz clic en el nombre de la versión, test-release-001.

Los lanzamientos aparecerán en Lanzamientos. Puedes hacer clic en un lanzamiento para ver sus detalles, incluido el registro de implementación.

Ten en cuenta que el estado del lanzamiento es “Avance pendiente” y el objetivo que se muestra en la visualización de la canalización tiene un vínculo a “Avanzar a la versión estable”.

Avanzar en la fase de lanzamiento

Después del primer lanzamiento, se omitió la fase canary y se espera el lanzamiento de la fase “estable”, que implementa la aplicación al 100%:

En la visualización de la canalización, haz clic en Avanzar a la versión estable.
Cuando se te solicite, haz clic en Avanzar para confirmar.

Después de unos minutos, el lanzamiento está ahora en la fase “estable” y la aplicación se implementa al 100%.

canalización de entrega en fase estable

Ejecuta la implementación de versiones canary

Debido a que la primera versión omitió la fase de versión canary, ahora crearemos otra versión que, esta vez, ejecuta una implementación de versiones canary.

Para crear un release nuevo, ejecuta el siguiente comando desde el directorio deploy-canary-quickstart-gke, deploy-canary-quickstart-gke-gatewayapi o deploy-canary-quickstart-run:

GKE

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

GKE y API de puerta de enlace

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

Cloud Run

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

Después de unos minutos, se crea un lanzamiento y, esta vez, se ejecuta la etapa de versión canary:

fase canary inicial de la canalización de entrega

Cuando finalice la primera fase de lanzamiento, el lanzamiento estará ahora en la fase de versiones canary:

Visualización de la canalización de entrega en la consola de Google Cloud, con la aplicación implementada al 50%

Esto significa que la aplicación ahora está implementada al 50%. Para GKE basado en serviceNetworking, se implementa en la mitad de tus Pods. Para GKE basado en la API de Gateway y el tráfico de Cloud Run, el tráfico se asigna al 50%.

Haz clic en Advance Rollout y, luego, en Advance cuando se te solicite.

Esto hace que el lanzamiento avance a la fase “estable” y se implemente la aplicación al 100%.

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 el clúster canary-quickstart-cluster (solo GKE):

gcloud container clusters delete canary-quickstart-cluster --region=us-central1 --project=PROJECT_ID

Borra el servicio my-canary-run-service (solo Cloud Run):

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

Borra la canalización de entrega, el destino y todos los recursos de versiones y 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.

Abrir la página del navegador de Cloud Storage

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

Implementación de versiones canary de una aplicación en un destino

Antes de comenzar

Crea tu entorno de ejecución

GKE

GKE y API de puerta de enlace

Cloud Run

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

GKE

GKE y API de puerta de enlace

Cloud Run

GKE

GKE y API de puerta de enlace

Cloud Run

GKE

GKE y API de puerta de enlace

Cloud Run

Crea la canalización de entrega y los destinos

GKE

GKE y API de puerta de enlace

Cloud Run

Crea una versión

GKE

GKE y API de puerta de enlace

Cloud Run

Pasamos a la fase estable

Ver la versión en la consola de Google Cloud

Avanzar en la fase de lanzamiento

Ejecuta la implementación de versiones canary

GKE

GKE y API de puerta de enlace

Cloud Run

Limpia

¿Qué sigue?