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 a Google Kubernetes Engine o a Cloud Run. (También puedes ejecutar una implementación de versiones canary en clústeres adjuntos de GKE, pero en esta guía de 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. En este inicio rápido, primero se realiza la implementación 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:
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.
Crearás una configuración de Skaffold y un manifiesto de Kubernetes para especificar la imagen de contenedor (precompilada) que implementarás.
Define tu canalización de entrega de Cloud Deploy y el destino de implementación.
Invocarás tu canalización de entrega creando una versión, que se implementará automáticamente en un destino.
En este primer lanzamiento, se omite la fase de lanzamiento canario.
Visualiza la canalización de entrega y la versión en la consola de Google Cloud .
Crea una segunda versión y, esta vez, ejecuta la etapa de canary para implementar la aplicación en el 50% de los usuarios.
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 theresourcemanager.projects.createpermission. Learn how to grant roles.
-
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
serviceusage.services.enablepermission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.-
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 -
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 theresourcemanager.projects.createpermission. Learn how to grant roles.
-
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
serviceusage.services.enablepermission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.-
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 - 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 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)")-compute@developer.gserviceaccount.com \ --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)")-compute@developer.gserviceaccount.com \ --role="roles/run.developer" -
Agrega el rol
iam.serviceAccountUser, que incluye el permisoactAspara 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 instalaste la CLI, asegúrate de ejecutar la versión más reciente:
gcloud components update
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
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_IDObtén las credenciales del clúster:
gcloud container clusters get-credentials canary-quickstart-cluster \ --project=PROJECT_ID \ --region=us-central1Instala 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.yamlHabilita 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á.
Abre una ventana de terminal.
Crea un directorio nuevo y navega hasta él.
GKE
mkdir deploy-canary-quickstart-gke cd deploy-canary-quickstart-gkeAPI de GKE y Gateway
mkdir deploy-canary-quickstart-gke-gatewayapi cd deploy-canary-quickstart-gke-gatewayapiCloud Run
mkdir deploy-canary-quickstart-run cd deploy-canary-quickstart-runCrea un archivo llamado
skaffold.yamlcon 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.yamlpara obtener más información sobre este archivo.Crea el manifiesto de tu aplicación.
GKE
Crea un archivo llamado
kubernetes.yamlen el directoriodeploy-canary-quickstart-gkecon 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: 80Este 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.yamlen el directoriodeploy-canary-quickstart-gke-gatewayapicon 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-imageEste 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.yamlen el directoriodeploy-canary-quickstart-runcon el siguiente contenido:apiVersion: serving.knative.dev/v1 kind: Service metadata: name: my-canary-run-service spec: template: spec: containers: - image: my-app-imageEste 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.
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
Registra tu canalización y tus destinos con el servicio de Cloud Deploy:
gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_IDAhora tienes una canalización con un destino configurado para una estrategia de implementación de versiones canary.
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.