Implementa una aplicación en un destino con Canary
En esta guía de inicio rápido, se muestra cómo usar Cloud Deploy para entregar una imagen de aplicación de ejemplo en una implementación Canary a Google Kubernetes Engine o a Cloud Run. (También puedes ejecutar una implementación Canary en GKE Enterprise, pero solo se muestran GKE y Cloud Run en este guía de inicio rápido).
Una implementación de versiones canary divide el tráfico entre una versión ya implementada del de tu aplicación y la nueva versión. Tráfico de las distribuciones 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. En este guía de inicio rápido, primero se implementa el 50% y, luego, el 100%.
En esta guía de inicio rápido, solo hay un objetivo,
(prod
).
Así que creamos solo un clúster de GKE o uno
servicio de Cloud Run para ejecutar tu 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 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 (precompilada) que se implementará.
Define la canalización de entrega y la implementación de Cloud Deploy objetivo.
Crea una versión para invocar tu canalización de entrega, que se implementará de forma automática en un destino.
Esta primera versión omite la fase de versión canary.
Consulta la canalización de entrega y la versión en la consola de Google Cloud.
Crea una segunda versión. Esta vez, ejecuta la etapa canary para implementar la aplicación al 50%.
Avanzar la versión para que se implemente al 100%
Antes de comenzar
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
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 la asignación automática de roles 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 a 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 el rol
iam.serviceAccountUser
, que incluye el permisoactAs
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
- Primero, agrega el rol
Si ya tienes instalada la CLI, asegúrate de que estás ejecutando la versión más reciente:
gcloud components update
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 + API de Gateway
Crea un clúster de GKE con la configuración recomendada para admitir su 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
Habilita la implementación del controlador de la puerta de enlace de Istio mediante la instalación 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 app
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, debes crear un archivo skaffold.yaml
, que identifica el
manifiesto de Kubernetes o la configuración del servicio de Cloud Run
cuando se implementa un plan.
Abre una ventana de terminal.
Crea un directorio nuevo y navega hasta él.
GKE
mkdir deploy-canary-quickstart-gke cd deploy-canary-quickstart-gke
GKE + API de 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
Crea un archivo llamado
skaffold.yaml
con el siguiente contenido:GKE
apiVersion: skaffold/v4beta7 kind: Config manifests: rawYaml: - kubernetes.yaml deploy: kubectl: {}
GKE + API de 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.Crea el manifiesto de tu aplicación.
GKE
Crea un archivo llamado
kubernetes.yaml
en el archivodeploy-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 archivo de Kubernetes manifest, que se aplica al clúster para implementar la aplicación.
GKE + API de Gateway
Crea un archivo llamado
kubernetes.yaml
en el directoriodeploy-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 Deployment y servicio necesarios para la además de una HTTPRoute y el recurso Gateway necesarios para usar API de puerta de enlace.
Cloud Run
Crea un archivo llamado
run.yaml
en el archivodeploy-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 tu servicio en Cloud Run.
Crea la canalización de entrega y los destinos
Puedes definir tu canalización de entrega y tus destinos en un archivo o en archivos separados. En esta guía de inicio rápido, crearemos un archivo para nuestra canalización y nuestro único objetivo:
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 + API de 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 archivo 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 destino configurado para una implementación de versiones canary de administración de amenazas.
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 y el único objetivo que configuraste se enumera en la columna Destinos.
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 lanzamiento. Consulta Arquitectura de servicios de Cloud Deploy para obtener detalles sobre ese ciclo de vida.
Para crear un recurso 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:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4
Cuando creas una versión, Cloud Deploy crea automáticamente un
lanzar un recurso para implementarlo de inmediato en tu único destino, prod
.
Nos saltamos a la fase estable
Con esta primera versión, omitimos la fase de versiones canary y, luego, implementamos el 100% (estable fase). Esto se debe a que la aplicación no se implementó anteriormente, por lo que no hay forma de calcular el 50% de los Pods (para GKE) ni de cómo el tráfico se divide por el servicio (para Cloud Run). Los pods (GKE) o las revisiones (Cloud Run) aún no existen.
Ahora que omitimos la fase de versiones canary, podemos comenzar la estable lo que lleva el tráfico al 100%. Después de eso, crearemos otra versión que ejecutará la canary.
Por lo general, en una situación real, ejecutarás una de implementación de versiones canary en la que tu aplicación ya se está ejecutando, por lo que esta fase omitir será raro.
Cómo ver la versión en la consola de Google Cloud
Ahora que creaste la primera versión, se creará el lanzamiento y podrás ver la versión 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 del lanzamiento.
En la consola de Google Cloud, navega a Cloud Deploy Página Canalizaciones de entrega para ver tu my-canary-demo-app-1 canalización de entrega continua.
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 solo muestra 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
.Tus lanzamientos aparecerán en Lanzamientos. Puedes hacer clic en un lanzamiento para ver sus detalles, incluido el registro de implementación.
Observen que el estado del lanzamiento es "Pendiente de avance" y el objetivo que se muestra en la visualización de la canalización tiene un vínculo para “Avanzar a estable”.
Avanza la fase de lanzamiento
Después del primer lanzamiento, se omitió la fase de versiones canary y se realizará el lanzamiento esperando para iniciar el entorno “estable” de implementación, que implementa la aplicación en un 100%:
En la visualización de la canalización, haz clic en Advance to stable.
Cuando se te solicite, haz clic en Siguiente para confirmar.
Después de unos minutos, el lanzamiento se encuentra en la fase "estable" y la aplicación se implementa al 100%.
Ejecuta la implementación de versiones canary
Como el primer lanzamiento omitió la fase de versión canary, Ahora crearemos otro lanzamiento que, esta vez, ejecuta un comando de Google Workspace.
Para crear un
release
nuevo, ejecuta el siguiente comando desdedeploy-canary-quickstart-gke
,deploy-canary-quickstart-gke-gatewayapi
o Directoriodeploy-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:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4
Después de unos minutos, se crea un lanzamiento y, esta vez, la etapa de versión canary ejecutado:
Cuando finaliza la primera fase de lanzamiento, este ahora se encuentra en la fase de versión canary:
Esto significa que la aplicación ahora se implementa en un 50%. Para GKE basado en serviceNetworking, se implementa en la mitad Pods. En el caso de GKE y Cloud Run basados en la API de Gateway, el tráfico se asigna al 50%.
Haz clic en Lanzamiento avanzado y, luego, en Avanzado cuando se te solicite.
Esto hace que el lanzamiento avance a un nivel “estable” de implementación de la aplicación 100%
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.
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 en 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 lanzamiento y lanzamiento:
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.
¿Qué sigue?
Aprende los conceptos básicos de la implementación de aplicaciones.
Obtén información para administrar tus manifiestos.