Implementa un servicio o trabajo de Cloud Run

En este documento, se describe cómo implementar tus aplicaciones, incluidos los trabajos y los servicios de Cloud Run.

Cloud Deploy te permite implementar tus cargas de trabajo basadas en contenedores en cualquier servicio de Cloud Run o trabajo. Todas las funciones de Cloud Deploy son compatibles cuando implementas en destinos de Cloud Run para servicios de Cloud Run, pero las implementaciones Canary no son compatibles con trabajos de Cloud Run.

En este documento, se describen las tres configuraciones principales que debes completar para implementar en Cloud Run:

Limitaciones

  • Solo puedes implementar un trabajo o servicio de Cloud Run por objetivo.

  • No puedes ejecutar una implementación Canary en un trabajo de Cloud Run.

    Sin embargo, los servicios de Cloud Run pueden usar una implementación de versiones canary.

Antes de comenzar

Crea tu configuración de destino

El destino se puede configurar en el archivo YAML de tu canalización de entrega o en un archivo separado. Además, puedes configurar más de un objetivo en el mismo archivo.

Los objetivos deben definirse en el mismo proyecto y la misma región que la canalización de publicación. Sin embargo, los servicios o trabajos a los que se implementan los destinos pueden estar en diferentes proyectos y regiones, siempre que la cuenta de servicio tenga acceso a esos proyectos.

En la definición del objetivo, crea una estrofa run para identificar la ubicación en la que se creará el servicio de Cloud Run.

La sintaxis para especificar el servicio o trabajo de Cloud Run en tu descripción del objetivo es la siguiente:

run:
 location: projects/[project_name]/locations/[region_name]

Este identificador de recursos usa los siguientes elementos:

  • [project_name] es el nombre del proyecto de Google Cloud en el que se creará tu trabajo o servicio de Cloud Run.

    Haz lo mismo para cada objetivo. Recomendamos un proyecto diferente para cada servicio o trabajo de Cloud Run. Si deseas tener más de un servicio o trabajo en el mismo proyecto, debes usar perfiles de Skaffold en tu archivo de configuración skaffold.yaml.

  • [region_name] es la región en la que se creará el servicio o la tarea. Tu servicio o trabajo puede estar en cualquier región que admita Cloud Run.

El siguiente es un ejemplo de configuración de destino que define el servicio o trabajo de Cloud Run que se creará:

      apiVersion: deploy.cloud.google.com/v1
      kind: Target
      metadata:
       name: dev
      description: development service
      run:
       location: projects/my-app/locations/us-central1

Puedes definir este destino dentro de una definición de canalización de entrega de Cloud Deploy o por separado. De cualquier manera, debes registrar el destino antes de crear la versión para implementar tu servicio o trabajo de Cloud Run.

Crea tu configuración de Skaffold

El siguiente es un ejemplo de archivo skaffold.yaml para una implementación de Cloud Run:

apiVersion: skaffold/v4beta7
kind: Config
metadata: 
  name: cloud-run-application
manifests:
  rawYaml:
  - service.yaml
deploy:
  cloudrun: {}

En este archivo skaffold.yaml, haz lo siguiente:

  • manifests.rawYaml proporciona los nombres de las definiciones de servicios de Cloud Run.

    En este ejemplo, service.yaml es el archivo que define un servicio de Cloud Run que implementará Skaffold. Este nombre de archivo puede ser cualquier cosa, pero, por convención, es service.yaml para un servicio y job.yaml para un trabajo.

  • La estrofa deploy especifica cómo deseas que se implemente el manifiesto, en particular, el proyecto y la ubicación. deploy es obligatorio.

    Te recomendamos que dejes el {} vacío. Cloud Deploy propaga esto durante la renderización, según el proyecto y la ubicación de la definición del destino.

    Sin embargo, para el desarrollo local, puedes proporcionar valores aquí. Sin embargo, Cloud Deploy siempre usa el proyecto y la ubicación de la definición del destino, independientemente de si se proporcionan valores aquí.

Crea las definiciones de tus servicios de Cloud Run

Para crear una definición de servicio de Cloud Run, puedes crear una manualmente o copiar una de un servicio existente. Ambos se describen en esta sección.

Opción 1: Crea un service.yaml de Cloud Run nuevo

service.yaml define tu servicio de Cloud Run. Cuando creas una versión, Skaffold usa esta definición para implementar tu servicio.

A continuación, se muestra un ejemplo simplificado:

apiVersion: serving.knative.dev/v1
kind: Service
metadata:
 name: [SERVICE_NAME]
spec:
 template:
  spec:
   containers:
   - image: [IMAGE_PATH]

Aquí:

  • [SERVICE_NAME] es un nombre para este servicio de Cloud Run.

  • [IMAGE_PATH] apunta a la imagen o las imágenes de contenedor que implementarás con este servicio.

Opción 2: Copia un service.yaml de un servicio existente con la consola de Google Cloud

Puedes crear un servicio con la consola de Google Cloud o usar uno existente, y copiar tu service.yaml desde allí.

Para obtener el service.yaml con Google Cloud CLI, sigue estos pasos:

gcloud run services describe [service_name] --format=export

Para obtener el service.yaml de la consola de Google Cloud, sigue estos pasos:

  1. En la consola de Google Cloud, ve a la página Servicios de Cloud Run.

  2. Selecciona el servicio existente cuya definición deseas usar.

También puedes crear uno nuevo y, luego, seleccionarlo. Cuando selecciones el servicio, se mostrará la página Detalles del servicio:

Página de detalles del servicio de la consola de Google Cloud, que muestra la pestaña YAML

  1. Selecciona la pestaña YAML.

  2. Haz clic en Editar y, luego, copia el contenido del archivo YAML en un archivo nuevo llamado service.yaml, en tu sistema de archivos, de modo que Skaffold pueda usarlo cuando crees una versión.

Crea tus definiciones de trabajos de Cloud Run

Para implementar una definición de trabajo de Cloud Run, puedes crear una manualmente o copiar una de un trabajo existente. Ambos se describen en esta sección.

Ten en cuenta que los trabajos no se ejecutan necesariamente cuando Cloud Deploy los implementa. Esto es diferente de los servicios, que ejecutan aplicaciones después de que se implementan. La forma en que se invoca una tarea depende de la tarea en sí.

Opción 1: Crea un job.yaml de Cloud Run nuevo

job.yaml define tu trabajo de Cloud Run. Cuando creas una versión, Skaffold usa esta definición para implementar el trabajo.

A continuación, se muestra un ejemplo simplificado:

apiVersion: run.googleapis.com/v1
kind: Job
metadata:
 name: [JOB_NAME]
spec:
  template:
  spec:
   containers:
   - image: [IMAGE_PATH]

Aquí:

  • [JOB_NAME] es un nombre para este trabajo de Cloud Run.

  • [IMAGE_PATH] apunta a la imagen de contenedor que implementarás para este trabajo.

Opción 2: Copia un job.yaml de un trabajo existente con la consola de Google Cloud

Puedes crear un trabajo con la consola de Google Cloud o usar uno existente, y copiar tu job.yaml desde allí.

Para obtener el job.yaml con Google Cloud CLI, sigue estos pasos:

gcloud run jobs describe [job_name] --format=export

Para obtener el job.yaml de la consola de Google Cloud, sigue estos pasos:

  1. En la consola de Google Cloud, ve a la página trabajos de Cloud Run.

  2. Selecciona el trabajo existente cuya definición deseas usar.

También puedes crear uno nuevo y, luego, seleccionarlo. Cuando selecciones el trabajo, se mostrará la página Detalles del trabajo:

Página de detalles del trabajo de la consola de Google Cloud, que muestra la pestaña YAML

  1. Selecciona la pestaña YAML.

  2. Haz clic en Editar y, luego, copia el contenido del archivo YAML en un archivo nuevo llamado job.yaml, en tu sistema de archivos, de modo que Skaffold pueda usarlo cuando crees una versión.

Revisión general

Ahora que tienes tu servicio o definición de trabajo de Cloud Run, tu configuración de skaffold.yaml y tu definición de destino de Cloud Deploy, y registraste tu destino como un recurso de Cloud Deploy, puedes invocar tu canalización de entrega para crear una versión y avanzar a través de la progresión de los destinos definidos en la canalización.

En la guía de inicio rápido Implementa una app en Cloud Run con Cloud Deploy, se muestra todo esto en acción.

Comportamiento de los servicios en las revisiones

Cuando vuelves a implementar un servicio, la nueva revisión se basa en el service.yaml implementado recientemente. No se mantiene nada de la revisión anterior, a menos que sea igual en el YAML implementado recientemente. Por ejemplo, si hay parámetros de configuración o etiquetas en la revisión anterior que no están en el YAML nuevo, esos parámetros de configuración o etiquetas no estarán en la revisión nueva.

Activación de trabajos de Cloud Run

Después de implementar una tarea, puedes activarla como se describe en la documentación de Cloud Run.

Implementa trabajos y servicios de Cloud Run en varios proyectos

Si necesitas implementar servicios o trabajos que se encuentran en proyectos diferentes, tu cuenta de servicio de ejecución necesita permiso para acceder a los proyectos en los que se definen esos servicios o trabajos.

Consulta Cuenta de servicio de ejecución de Cloud Deploy y Roles y permisos de Identity and Access Management para obtener más información.

¿Qué sigue?