Implementa en Cloud Run con Cloud Build

En esta página, se explica cómo implementar automáticamente los servicios de Cloud Run con Cloud Build. Si estás dando los primeros pasos en Cloud Build, lee primero las guías de inicio rápido y la descripción general de la configuración de compilación.

Cloud Run te permite ejecutar imágenes sin estado en un entorno sin servidores. Con Cloud Build, puedes implementar imágenes de Container Registry (obsoleto) y Artifact Registry en Cloud Run. Puedes implementar una imagen existente, compilar e implementar una imagen, o automatizar la implementación.

Nota: También puedes usar Cloud Deploy para configurar una canalización de entrega continua a fin de implementar en Cloud Run. Más información.

Antes de comenzar

• Enable the Cloud Build, Cloud Run, Container Registry, and Resource Manager APIs.

  Enable the APIs

• Ten preparado el código fuente de la aplicación. Tu código fuente debe almacenarse en un repositorio, como Cloud Source Repositories, GitHub o Bitbucket.

• Para ejecutar los comandos de gcloud de esta página, instala Google Cloud CLI.

• Si usas los Controles del servicio de VPC, configura un grupo privado en el perímetro de los Controles del servicio de VPC. También debes configurar Cloud Run para los Controles del servicio de VPC.

Precaución: Container Registry está obsoleto y se programó para el cierre. Las organizaciones que no usaron Container Registry antes del 8 de enero de 2024 tendrán nuevos repositorios de gcr.io alojados en Artifact Registry de forma predeterminada. A partir del 15 de mayo de 2024, los proyectos Google Cloud sin uso anterior de Container Registry solo admitirán el hosting y la administración de imágenes para el dominio gcr.io en Artifact Registry.

Container Registry está programado para cerrarse el 18 de marzo de 2025. Para obtener detalles sobre la baja, consulta Baja de Container Registry.

Precaución: A partir del 17 de junio de 2024, Cloud Source Repositories no estará disponible para clientes nuevos. Si tu organización no usó anteriormente Cloud Source Repositories, no puedes habilitar la API ni usar Cloud Source Repositories Los proyectos nuevos que no estén conectados a una organización no podrán habilitar la API de Cloud Source Repositories. Las organizaciones que usaron Cloud Source Repositories antes del 17 de junio de 2024 no se verán afectadas por este cambio.

Permisos necesarios de Identity and Access Management

Para obtener los permisos que necesitas para implementar en Cloud Run con Cloud Build, pídele a tu administrador que te otorgue los siguientes roles de IAM en la cuenta de servicio predeterminada de Cloud Build:

• Desarrollador de Cloud Run (roles/run.developer)
• Escritor de registros (roles/logging.logWriter)
• Escritor de Artifact Registry (roles/artifactregistry.writer)
• Usuario de cuenta de servicio (roles/iam.serviceAccountUser)
• Administrador de almacenamiento (roles/storage.admin)

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

También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.

Compila e implementa una imagen

Cloud Build te permite compilar una imagen, almacenarla en Artifact Registry y, luego, implementarla en Cloud Run.

Para compilar y, luego, implementar una imagen, haz lo siguiente:

1. En el directorio raíz del proyecto, crea un archivo de configuración llamado cloudbuild.yaml.

2. En el archivo de configuración de compilación, agrega pasos de compilación docker para compilar la imagen y enviarla a Artifact Registry y, luego, agrega un paso de compilación gcloud para invocar el comando gcloud run deploy a fin de implementar la imagen en Cloud Run:

   steps:
   # Build the image
   - name: 'gcr.io/cloud-builders/docker'
     args: ['build', '-t', 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE', '.']
   # Push the image to Artifact Registry
   - name: 'gcr.io/cloud-builders/docker'
     args: ['push', 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE']
   # Deploy image to Cloud Run
   - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
     entrypoint: gcloud
     args: ['run', 'deploy', 'SERVICE_NAME', '--image', 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE', '--region', 'SERVICE_REGION']
   images:
   - 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE'
   

   Aquí:

   • REPOSITORY es el nombre del repositorio de Artifact Registry desde el que implementas tu imagen.
   • LOCATION es la ubicación de tu repositorio de Artifact Registry, como us-east1.
   • PROJECT_ID es el ID de tu proyecto Google Clouden el que se almacena la imagen.
   • SERVICE_NAME es el nombre del servicio de Cloud Run.
   • SERVICE_REGION es la región del servicio de Cloud Run que estás implementando.
   • IMAGE es el nombre de tu imagen en Artifact Registry.

3. Navega al directorio raíz de tu proyecto y ejecuta el siguiente comando, en el que LOCATION es una de las regiones de compilación compatibles para ejecutar la compilación:

    gcloud builds submit --region=LOCATION
   

Una vez que la compilación se completa de manera correcta, se muestra un mensaje de éxito, además de la URL del servicio implementado.

Implementación continua

Puedes automatizar la implementación de tu software en Cloud Run si creas activadores de Cloud Build. Puedes configurar los activadores para compilar y, luego, implementar imágenes cada vez que actualices el código fuente.

Para automatizar tu implementación, sigue estos pasos:

1. En la raíz del repositorio, agrega un archivo de configuración llamado cloudbuild.yaml con los pasos necesarios para compilar la imagen y enviarla a Container Registry y, luego, invoca el comando gcloud run deploy:

   steps:
   # Build the image
   - name: 'gcr.io/cloud-builders/docker'
     args: ['build', '-t', 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE/SERVICE_NAME:$COMMIT_SHA', '.']
   # Push the image to Artifact Registry
   - name: 'gcr.io/cloud-builders/docker'
     args: ['push', 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE/SERVICE_NAME:$COMMIT_SHA']
   # Deploy image to Cloud Run
   - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
     entrypoint: gcloud
     args: 
       - 'run'
       - 'deploy'
       - 'SERVICE_NAME'
       - '--image'
       - 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE/SERVICE_NAME:$COMMIT_SHA'
       - 'region'
       - 'SERVICE_REGION'
   images:
   - 'LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY/IMAGE/SERVICE_NAME:$COMMIT_SHA'
   

   Aquí:

   • REPOSITORY es el nombre del repositorio de Artifact Registry desde el que implementas tu imagen.
   • LOCATION es la ubicación de tu repositorio de Artifact Registry, como us-east1.
   • PROJECT_ID es el ID de tu proyecto Google Clouden el que se almacena tu imagen.
   • SERVICE_NAME es el nombre del servicio de Cloud Run.
   • SERVICE_REGION es la región del servicio de Cloud Run que estás implementando.
   • IMAGE es el nombre de tu imagen en Artifact Registry.

   Cloud Build propaga la variable de reemplazo $COMMIT_SHA cuando se activa desde un repositorio de Git.

2. Crea un activador de compilación con el archivo de configuración que creaste en el paso anterior:

   1. Abrir la página Activadores:

      Ir a la página Activadores

   2. Haz clic en Crear activador.

   3. En el campo Nombre, ingresa un nombre para el activador.

   4. En Región, selecciona la región para tu activador.

      Nota: La región del activador debe coincidir con la región del servicio de Cloud Run en la que lo implementarás.

   5. En Evento, selecciona el evento del repositorio para iniciar el activador.

   6. En Fuente, selecciona el repositorio y el nombre de la rama o de la etiqueta que iniciará el activador. Para obtener más información sobre cómo especificar qué ramas se deben compilar de manera automática, consulta Crea un activador de compilación.

   7. En Configuración, selecciona Archivo de configuración de Cloud Build (YAML o JSON).

   8. En el campo Ubicación del archivo de configuración de Cloud Build, escribe cloudbuild.yaml después de /.

   9. Haz clic en Crear para guardar el activador de compilación.

   Ahora, cuando envíes código nuevo a tu repositorio, Cloud Build invocará una compilación y, luego, implementará el servicio en Cloud Run.

Nota: Para hacer público el servicio implementado, realiza un cambio único en la configuración de administración de identidades y accesos del servicio.

Para obtener más información sobre cómo crear activadores de Cloud Build, consulta Crea y administra activadores de compilación.

Usa permisos mínimos de IAM

Cuando se implementa una imagen en un servicio de Cloud Run, esta se ejecuta con la identidad de la cuenta de servicio del entorno de ejecución del servicio de Cloud Run. Debido a que Cloud Build puede implementar imágenes nuevas de forma automática, Cloud Build debe poder actuar como la cuenta de servicio del entorno de ejecución de tu servicio de Cloud Run.

Para otorgar acceso limitado a Cloud Build para implementar en un servicio de Cloud Run, sigue estos pasos:

Console

1. Ve a la página Cuentas de servicio de la consola de Google Cloud:

   Ir a Cuentas de servicio

2. Haz clic en la dirección de correo electrónico de la cuenta de servicio del entorno de ejecución del servicio de Cloud Run (de forma predeterminada, es [e-mail]).

3. Haz clic en la pestaña Permisos.

4. Haz clic en Grant access.

5. Ingresa la cuenta de servicio de Cloud Build ([e-mail]).

6. En el menú desplegable Seleccionar un rol, selecciona la función Cuentas de servicio > Usuario de cuenta de servicio.

7. Haz clic en Guardar.

gcloud

Usa el comando gcloud iam service-accounts add-iam-policy-binding, en el que PROJECT_NUMBER es el ID numérico de tu proyecto:

gcloud iam service-accounts add-iam-policy-binding \
  [e-mail] \
  --member="serviceAccount:[e-mail]" \
  --role="roles/iam.serviceAccountUser"

Reemplaza PROJECT_NUMBER por el ID del proyecto.

Si usas Cloud Run con una identidad de servicio personalizada, reemplaza [e-mail] por la dirección de tu cuenta de servicio.

Consulta Permisos de implementación para obtener más información.

Ejemplos de código

Estos son algunos repositorios de muestra. Cada uno contiene una aplicación de muestra y un archivo de configuración de compilación para implementar la aplicación en Cloud Run:

• deploy-prebuilt: Un ejemplo de código con el que se muestra cómo implementar una imagen ya compilada en Cloud Run.
• run-example-builddeploy: Un ejemplo de código con el que se muestra cómo compilar y, también, implementar una imagen en Cloud Run.

¿Qué sigue?

• Obtén más información para usar Cloud Deploy para implementar en Cloud Run.
• Consulta Implementa en GKE.
• Obtén información para implementar funciones de Cloud Run.
• Consulta Implementa en App Engine.
• Consulta Implementa en Firebase.
• Obtén información para realizar implementaciones azul-verde en Compute Engine.
• Obtén más información para solucionar errores de compilación.