Implementa una app en Cloud Run con Cloud Deploy

Implementa una app en Cloud Run con Cloud Deploy

En esta página, se muestra cómo usar Cloud Deploy para entregar una imagen de aplicación de ejemplo llamada hello a una secuencia de dos servicios o dos trabajos de Cloud Run.

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

1. Crea una configuración de Skaffold

2. Crea archivos de configuración para dos servicios o dos trabajos de Cloud Run.

   Estos archivos definen los servicios o trabajos, y especifican las imágenes de contenedor (precompiladas) que se implementarán.

3. Definirás la canalización de entrega de Cloud Deploy y los destinos de implementación, que apuntarán a los dos servicios o a los dos trabajos.

4. Crearás una versión de la canalización de entrega, que se implementará de forma automática en el primer destino.

5. Ascenderás el lanzamiento al segundo destino.

6. Visualizarás ambos lanzamientos en la Google Cloud consola.

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.

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

Si usas un proyecto existente para esta guía, verifica que tengas los permisos necesarios a fin de completarla. Si creaste un proyecto nuevo, ya tienes los permisos necesarios.

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Deploy, Cloud Build, 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

Install the 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

Si usas un proyecto existente para esta guía, verifica que tengas los permisos necesarios a fin de completarla. Si creaste un proyecto nuevo, ya tienes los permisos necesarios.

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Deploy, Cloud Build, 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

Install the 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.

Roles obligatorios

Para obtener los permisos que necesitas para crear una canalización de entrega y una versión de Cloud Deploy, pídele a tu administrador que te otorgue el rol de IAM de ejecutor de trabajos de Cloud Deploy (roles/clouddeploy.jobrunner) en tu proyecto.

Para asegurarte de que la cuenta de servicio de Cloud Deploy tenga los permisos necesarios para ejecutar operaciones de Cloud Deploy y realizar implementaciones en Cloud Run, pídele a tu administrador que otorgue a la cuenta de servicio de Cloud Deploy los siguientes roles de IAM en tu proyecto:

Importante: Debes otorgar estos roles a la cuenta de servicio de Cloud Deploy, no a tu cuenta de usuario. Si no se otorgan los roles a la principal correcta, es posible que se produzcan errores de permisos.

• Desarrollador de Cloud Run (roles/run.developer)
• Usuario de cuenta de servicio de IAM (roles/iam.serviceAccountUser)

Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

Es posible que tu administrador también pueda otorgar a la cuenta de servicio de Cloud Deploy los permisos necesarios a través de roles personalizados o de otros roles predefinidos.

Prepara tu configuración de Skaffold

Cloud Deploy usa Skaffold para proporcionar los detalles sobre qué implementar y cómo hacerlo de forma correcta para tus destinos por separado.

En esta guía de inicio rápido, crearás un archivo skaffold.yaml, que identifica la definición del servicio o trabajo de Cloud Run que se usará para implementar la app de ejemplo.

1. Abre una ventana de terminal.

2. Crea un directorio nuevo llamado deploy-run-quickstart y navega hasta él.

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

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

   Servicios

   apiVersion: skaffold/v4beta7
   kind: Config
   metadata: 
     name: deploy-run-quickstart
   profiles:
   - name: dev
     manifests:
       rawYaml:
       - run-service-dev.yaml
   - name: prod
     manifests:
       rawYaml:
       - run-service-prod.yaml
   deploy:
     cloudrun: {}
   

   Trabajos

   apiVersion: skaffold/v4beta7
   kind: Config
   metadata: 
     name: deploy-run-quickstart
   profiles:
   - name: dev
     manifests:
       rawYaml:
       - run-job-dev.yaml
   - name: prod
     manifests:
       rawYaml:
       - run-job-prod.yaml
   deploy:
     cloudrun: {}
   

   Este archivo es una configuración mínima de Skaffold que identifica tus servicios o trabajos de Cloud Run. Consulta la referencia de skaffold.yaml para obtener más información sobre este archivo.

Prepara tus servicios o trabajos de Cloud Run

En esta guía de inicio rápido, crearás dos servicios de Cloud Run o dos trabajos de Cloud Run diferentes en el mismo proyecto. Cloud Deploy también admite la implementación en varios proyectos. Además, usamos perfiles de Skaffold para que sea posible tener dos servicios o trabajos en el mismo proyecto. Cuando usas proyectos diferentes, es posible que no necesites usar perfiles de Skaffold.

Servicios

1. Crea un archivo llamado run-service-dev.yaml con el contenido siguiente:

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

   Este archivo define un servicio de Cloud Run. Como implica el nombre deploy-run-service-dev, este es tu servicio dev y corresponde al primer destino en la progresión de tu canalización de entrega.

2. Crea un archivo llamado run-service-prod.yaml con el contenido siguiente:

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

   Este archivo define otro servicio de Cloud Run y, como implica el nombre deploy-run-service-prod, este es tu servicio prod y corresponde al segundo destino en la progresión de tu canalización de entrega.

Estos archivos son definiciones de servicios de Cloud Run, que se usan para implementar la aplicación. 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.

Trabajos

1. Crea un archivo llamado run-job-dev.yaml con el contenido siguiente:

   apiVersion: run.googleapis.com/v1
   kind: Job
   metadata:
     name: deploy-run-job-dev
   spec:
     template:
       spec:
         template:
           spec:
             containers:
             - image: my-app-image
   

   Este archivo define un trabajo de Cloud Run. Como su nombre deploy-run-job-dev indica, este es tu trabajo dev y corresponde al primer destino en la progresión de tu canalización de entrega.

2. Crea un archivo llamado run-job-prod.yaml con el contenido siguiente:

   apiVersion: run.googleapis.com/v1
   kind: Job
   metadata:
     name: deploy-run-job-prod
   spec:
     template:
       spec:
         template:
           spec:
             containers:
             - image: my-app-image
   

   Este archivo define otro trabajo de Cloud Run. Como implica el nombre deploy-run-job-prod, este es tu trabajo prod y corresponde al segundo destino en la progresión de tu canalización de entrega.

Estos archivos son definiciones de trabajos de Cloud Run, que se usan para implementar la aplicación. 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 y tus destinos en un solo archivo o en archivos separados. En esta guía de inicio rápido, crearás un solo archivo.

1. En el directorio deploy-run-quickstart, crea un archivo nuevo: clouddeploy.yaml, con el siguiente contenido:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-run-demo-app-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: run-qsdev
       profiles: [dev]
     - targetId: run-qsprod
       profiles: [prod]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: run-qsdev
   description: Cloud Run development service
   run:
     location: projects/PROJECT_ID/locations/us-central1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: run-qsprod
   description: Cloud Run production service
   run:
     location: projects/PROJECT_ID/locations/us-central1
   

   Nota: En este archivo, los destinos se incluyen en la canalización de entrega, pero puedes definir destinos en un archivo o en varios archivos separados.

2. 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 destinos, lista para implementar tu aplicación en tu primer destino.

3. 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 enumeran los dos destinos 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.

Ejecuta el siguiente comando desde el directorio deploy-run-quickstart para crear un recurso release que represente la imagen del contenedor que se implementará:

Servicios

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

Trabajos

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

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

Al igual que con todas las versiones (a menos que incluyan --disable-initial-rollout), Cloud Deploy también crea automáticamente un recurso de lanzamiento. La aplicación se implementa automáticamente en el primer destino de la progresión.

Promueve la versión

Nota: Después de crear la versión, es posible que debas esperar unos minutos antes de continuar con este paso.

1. En la página Canalizaciones de entrega, haz clic en la canalización my-run-demo-app-1.

   Abrir la página Canalizaciones de entrega

   La página Detalles de la canalización de entrega muestra una representación gráfica del progreso de tu canalización de entrega. En este caso, se muestra que la versión se implementó en el destino run-qsdev.

   

2. En el primer objetivo de la visualización de la canalización de entrega, haz clic en Promover.

   Se muestra el cuadro de diálogo Promocionar la versión. Muestra los detalles del destino al que promocionarás.

3. Haz clic en Promover.

   Ahora, la versión está en cola para su implementación en run-qsprod. Cuando se completa la implementación, la visualización de la canalización de entrega la muestra como implementada:

   

Visualiza los resultados en la consola de Google Cloud

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

   Abrir la página Canalizaciones de entrega

2. Haz clic en el nombre de tu canalización de entrega “my-run-demo-app-1”.

   La visualización de la canalización muestra el progreso de la app a través de la canalización.

   

   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.

   

Cómo acceder a tu servicio de Cloud Run

De forma predeterminada, debes autenticarte para acceder a los servicios de Cloud Run creados recientemente. Consulta la Descripción general de la autenticación de Cloud Run para obtener información sobre cómo proporcionar credenciales y descubrir qué configuración de Identity and Access Management se requiere para acceder al servicio sin autenticación. Esto no se aplica a los trabajos de Cloud Run.

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 trabajo o el servicio de deploy-qs-dev Cloud Run:

   Servicios

   gcloud run services delete deploy-run-service-dev --region=us-central1 --project=PROJECT_ID
   

   Trabajos

   gcloud run jobs delete deploy-run-job-dev --region=us-central1 --project=PROJECT_ID
   

2. Borra el servicio deploy-qs-prod:

   Servicios

   gcloud run services delete deploy-run-service-prod --region=us-central1 --project=PROJECT_ID
   

   Trabajos

   gcloud run jobs delete deploy-run-job-prod --region=us-central1 --project=PROJECT_ID
   

3. Borra la canalización de entrega, los destinos, la versión y los lanzamientos:

   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.

• Lee el artículo instructivo para implementar en Cloud Run.

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