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

  1. 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.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

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

    Enable the APIs

  5. Install the Google Cloud CLI.

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

  7. Para inicializar gcloud CLI, ejecuta el siguiente comando:

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

    Go to project selector

  9. Verify that billing is enabled for your Google Cloud project.

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

    Enable the APIs

  11. Install the Google Cloud CLI.

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

  13. Para inicializar gcloud CLI, ejecuta el siguiente comando:

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

    gcloud components update
    

  15. 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. 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"
      

    2. Otorga a la cuenta de servicio de ejecución predeterminada actAs el permiso para implementar cargas de trabajo en Cloud Run:

      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
      

    3. Agrega los permisos de desarrollador de 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"
      

      Si tienes problemas para agregar cualquiera de estos roles, comunícate con el administrador de tu proyecto.

    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 siguiente contenido:

      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

    Para esta guía de inicio rápido, crearás dos servicios 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 siguiente contenido:

      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 siguiente contenido:

      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 servicio de Cloud Run simples 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 siguiente contenido:

      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 siguiente contenido:

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

      Canalización de entrega que se muestra en la consola de Google Cloud

    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

    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.

      Visualización de la canalización de entrega en la consola de Google Cloud

    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:

      Visualización de la canalización de entrega en la consola de Google Cloud , que muestra la versión implementada en producción.

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

      Visualización de la canalización de entrega en la consola de Google Cloud

      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 un lanzamiento para ver sus detalles, incluido el registro de implementación.

      Lanzamientos en la consola de Google Cloud

    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.

    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.

    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?