Implementa una aplicación en versión canary en un destino

Implementa una aplicación en versión canary 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 en Google Kubernetes Engine o en Cloud Run. (También puedes ejecutar una implementación de versiones canary en clústeres adjuntos de GKE, pero en este inicio rápido solo se muestran GKE y Cloud Run).

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. Cloud Run asigna el tráfico según los porcentajes que configures en la canalización de entrega. GKE implementa la versión nueva en una proporción de Pods. Este 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 que solo creamos un clúster de GKE o un servicio de Cloud Run para ejecutar tu aplicación.

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

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

   También puedes realizar implementaciones canary en clústeres adjuntos de GKE, pero en este inicio rápido solo se usan GKE y Cloud Run.

2. Crearás una configuración de Skaffold y un manifiesto de Kubernetes para especificar la imagen de contenedor (precompilada) que implementarás.

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

4. Invocarás tu canalización de entrega creando una versión, que se implementará automáticamente en un destino.

   En esta primera versión, se omite la fase de versión canary.

5. Visualiza la canalización de entrega y la versión en la consola de Google Cloud .

6. Crea una segunda versión y, esta vez, ejecuta la etapa de canary para implementar la aplicación en el 50% de los usuarios.

7. Avanza el lanzamiento para implementarlo en el 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.
Roles required to select or create a project
• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.
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
Verify that billing is enabled for your Google Cloud project.
Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.
Enable the APIs
Instala Google Cloud CLI.
Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.
Para inicializar gcloud CLI, ejecuta el siguiente comando:
gcloud init
Nota: Puedes ejecutar gcloud CLI en la consola de Google Cloud sin instalar Google Cloud CLI. Para ejecutar la gcloud CLI en la consola de Google Cloud , usa Cloud Shell.

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

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

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Instala Google Cloud CLI.

Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.

Para inicializar gcloud CLI, ejecuta el siguiente comando:

gcloud init

Nota: Puedes ejecutar gcloud CLI en la consola de Google Cloud sin instalar Google Cloud CLI. Para ejecutar la gcloud CLI en la consola de Google Cloud , usa Cloud Shell.

Si ya instalaste la CLI, asegúrate de ejecutar la versión más reciente:

gcloud components update

1. 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 y GKE con la API de Gateway:

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

   • En Cloud Run, haz lo siguiente:

     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

GKE

Crea un clúster de GKE Autopilot:

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

API de GKE y Gateway

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

2. Obtén las credenciales del clúster:

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

3. Instala las CRD de la API de Gateway de Kubernetes 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
   

4. Habilita la implementación del controlador de puerta de enlace de Istio instalando 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 es necesario que hagas nada aquí.

Prepara la 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 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á.

1. Abre una ventana de terminal.

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

   GKE

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

   API de GKE y Gateway

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

   Cloud Run

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

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

   GKE

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - kubernetes.yaml
   deploy:
     kubectl: {}
   

   API de GKE y Gateway

   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. En esta guía de inicio rápido, crearás el archivo. Sin embargo, también puedes hacer que Cloud Deploy cree uno por ti para aplicaciones simples que no sean de producción.

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

4. 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 de Kubernetes, que se aplica al clúster para implementar la aplicación. Este manifiesto incluye los recursos de Service y Deployment necesarios para la implementación de versiones canary, además de un recurso de HTTPRoute y Gateway que se necesitan para usar la API de Gateway.

   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.

   API de GKE y Gateway

   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. Este manifiesto incluye los recursos de Service y Deployment necesarios para la implementación de versiones canary, además de un recurso de HTTPRoute y Gateway que se necesitan para usar la API de Gateway.

   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 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 archivo es una definición básica del servicio de Cloud Run, que se aplica en el momento de la implementación para crear tu servicio en Cloud Run. 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.

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

Crea la canalización de entrega y los destinos

Puedes definir tu canalización de entrega y tus destinos en un solo archivo o en archivos separados. En esta guía de inicio rápido, crearemos un archivo para nuestra 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

API de GKE y Gateway

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

1. 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 configurado para una estrategia de implementación de versiones canary.

2. 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 y se enumera el destino que configuraste 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 la arquitectura del servicio de Cloud Deploy para obtener detalles sobre ese ciclo de vida.

Para crear un recurso de release que represente la imagen del 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 + API de Gateway

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

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

Cuando creas una versión, Cloud Deploy también crea automáticamente un recurso de lanzamiento para realizar la implementación de inmediato en tu único destino, prod.

Pasamos a la fase estable

Con este primer lanzamiento, omitimos la fase de versión canary y realizamos la implementación 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) o cómo se divide el tráfico para el servicio (para Cloud Run). Los Pods (GKE) o las revisiones (Cloud Run) aún no existen.

Como omitimos la fase de canary, ahora estamos listos para comenzar la fase estable, que lleva el tráfico al 100%. Después, crearemos otra versión, y eso 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 será poco frecuente que omitas esta fase.

Visualiza la versión en Google Cloud console

Ahora que creaste la primera versión, se creó el lanzamiento y puedes ver la versión y el lanzamiento en Google Cloud console. También puedes ver la visualización de la canalización, que muestra el estado actual de la versión.

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 my-canary-demo-app-1.

   Abrir la página Canalizaciones de entrega

2. 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. Debido a que solo hay una etapa en la canalización, la visualización muestra un solo nodo.

   

   Y la versión aparece en la pestaña Versiones, en Detalles de la canalización de entrega.

3. Haz clic en el nombre de la versión, test-release-001.

   Tus lanzamientos aparecerán en Lanzamientos. Puedes hacer clic en una versión para ver sus detalles, incluido el registro de implementación.

   

   Observa que el estado del lanzamiento es "Pendiente de avance" y que el destino que se muestra en la visualización de la canalización tiene un vínculo a "Avanzar a estable".

Cómo avanzar la fase de lanzamiento

Después del primer lanzamiento, se omitió la fase canary y el lanzamiento está esperando para comenzar la fase "estable", que implementa la aplicación en el 100%:

1. En la visualización de la canalización, haz clic en Advance to stable.

2. Cuando se te solicite, haz clic en Avanzar para confirmar.

Después de unos minutos, la versión ahora está en la fase "estable" y la aplicación se implementó en un 100%.

Ejecuta la implementación de versiones canary

Como la primera versión se saltó la fase de Canary, ahora crearemos otra versión que sí ejecute una implementación de Canary.

1. Para crear un nuevo release, 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 + API de Gateway

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

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

   

   Cuando finaliza la primera fase del lanzamiento, este pasa a la fase de versión canary:

   

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

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

   Esto avanza el lanzamiento a la fase "estable", en la que se implementa la aplicación al 100%.

   

Realiza una limpieza

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 canary-quickstart-cluster (solo en GKE):

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

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

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

3. Borra la canalización de entrega, el destino y todos los recursos de lanzamiento y lanzamiento:

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

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

• Obtén información para administrar tus manifiestos.

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