Implementación en Cloud Run Functions

En esta página, se explica cómo implementar aplicaciones en Cloud Run Functions mediante Cloud Build. Si eres nuevo en Cloud Build, primero lee las guías de inicio rápido y la descripción general de la configuración de compilación.

Cloud Run Functions es un entorno de ejecución sin servidores que sirve para compilar y conectar servicios en la nube. Con funciones de Cloud Run, puedes escribir funciones de un solo propósito que se vinculan a eventos emitidos desde tu infraestructura de nube y tus servicios. La función se activa cuando ocurre un evento que se está supervisando. Para obtener más información sobre Cloud Run Functions, consulta la documentación de Cloud Run Functions.

Antes de comenzar

• Habilita la API de Cloud Run Functions:

  Habilita la API de Cloud Run Functions

• Ten preparado el código fuente de la aplicación. El código fuente debe almacenarse en un repositorio como GitHub o Bitbucket.

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

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 de Identity and Access Management obligatorios

1. En la Google Cloud consola, ve a la página Permisos de Cloud Build:

   Ir a Permisos

2. Para tu cuenta de servicio de Cloud Build especificada o cuenta de servicio de Cloud Build predeterminada, establece el estado de los siguientes roles en Habilitado:

   • Desarrollador de Cloud Functions (roles/cloudfunctions.developer) | Para implementar y administrar funciones
     • En el panel Asignar rol de usuario de cuenta de servicio, elige una cuenta de servicio para usar la identidad y, luego, haz clic en Otorgar permiso.
   • Administrador de Cloud Run (roles/run.admin) | Permite que tu cuenta de servicio de Cloud Build implemente versiones nuevas en Cloud Run
   • Administrador de almacenamiento (roles/storage.admin) | Permite leer y escribir desde Cloud Storage
   • Escritor de Artifact Registry (roles/artifactregistry.writer) | Permite extraer imágenes de Artifact Registry y escribir en él
   • Escritor de registros (roles/logging.logWriter) | Permite que las entradas de registro se escriban en Cloud Logging
   • Editor de Cloud Build (roles/cloudbuild.builds.editor) | Permite que tu cuenta de servicio ejecute compilaciones

Configura la implementación

Cloud Build te permite usar cualquier imagen de contenedor disponible a nivel público para ejecutar tareas. Para ello, especifica la imagen en un step de compilación en el archivo de configuración de Cloud Build.

Cloud Run Functions proporciona el comando de gcloud functions deploy, mediante el cual se implementa la función desde el directorio que contiene tu código de función. Puedes usar la cloud-sdk imagen como un paso de compilación en tu archivo de configuración para invocar gcloud comandos dentro de la imagen. Los argumentos que se pasan a este paso de compilación se pasan directamente a Google Cloud CLI, lo que te permite ejecutar cualquier comando de gcloud en esta imagen.

Para implementar una aplicación en Cloud Run Functions, sigue estos pasos:

1. En el directorio raíz del proyecto, crea el archivo de configuración de Cloud Build con el nombre cloudbuild.yaml o cloudbuild.json.

2. En el archivo de configuración, haz lo siguiente:

   • Agrega un campo name y especifica el paso de compilación de gcloud.
   • Agrega functions deploy al campo args para invocar el comando gcloud functions deploy. Para ver las opciones de configuración disponibles, consulta la referencia de gcloud functions deploy.

   • --source=. implica que el código fuente está en el directorio de trabajo actual.

   YAML

   steps:
   - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
     args:
     - gcloud
     - functions
     - deploy
     - FUNCTION_NAME
     - --region=FUNCTION_REGION
     - --source=.
     - --trigger-http
     - --runtime=RUNTIME
   

   JSON

   {
    "steps": [
     {
        "name": "gcr.io/google.com/cloudsdktool/cloud-sdk",
        "args": [
          "gcloud",
          "functions",
          "deploy",
           [
             "FUNCTION_NAME"
           ],
           "--region=FUNCTION_REGION",
           "--source=.",
           "--trigger-http",
           "--runtime=RUNTIME"
        ]
      }
     ]
   }
   

   Reemplaza los valores de marcador de posición en el archivo de configuración anterior por lo siguiente:

   • FUNCTION_NAME es el nombre de la función de Cloud Run Functions que estás implementando. Si actualizas una función existente, este valor debe coincidir con el nombre de la función que actualizas.
   • FUNCTION_REGION es la región en la que implementas Cloud Run Functions. Para obtener una lista de las regiones compatibles, consulta Ubicaciones de Cloud Run Functions.
   • --trigger-http es el tipo de activador de esta función, en este caso, una solicitud HTTP (webhook).
   • RUNTIME es el entorno de ejecución en el que se ejecuta la función.

   Para obtener más información sobre el uso de gcloud functions deploy, consulta la documentación de Cloud Run Functions.

3. Inicia la compilación con el archivo de configuración creado en el paso anterior mediante el siguiente comando:

    gcloud builds submit --region=REGION --config CONFIG_FILE_PATH SOURCE_DIRECTORY
   

   Reemplaza los valores de marcador de posición en el archivo de configuración anterior por lo siguiente:

   • CONFIG_FILE_PATH es la ruta de acceso al archivo de configuración de compilación.
   • SOURCE_DIRECTORY es la ruta o la URL del código fuente.
   • REGION es una de las regiones de compilación compatibles.

   Si no se especifica CONFIG_FILE_PATH ni SOURCE_DIRECTORY en el comando gcloud builds submit, Cloud Build da por hecho que el archivo de configuración y el código fuente están en el directorio de trabajo actual.

Implementación continua

Puedes automatizar la implementación del software en Cloud Run Functions mediante la creación de activadores de Cloud Build. Puedes configurar tus activadores para compilar y, luego, implementar imágenes cada vez que actualices tu código fuente.

Para automatizar tu implementación en Cloud Run Functions, sigue estos pasos:

1. En la raíz de tu repositorio, agrega un archivo de configuración con pasos para invocar el comando gcloud functions deploy:

   YAML

   steps:
   - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
     args:
     - gcloud
     - functions
     - deploy
     - FUNCTION_NAME
     - --region=FUNCTION_REGION
     - --source=.
     - --trigger-http
     - --runtime=RUNTIME
   

   JSON

   {
    "steps": [
     {
        "name": "gcr.io/google.com/cloudsdktool/cloud-sdk",
        "args": [
          "gcloud",
          "functions",
          "deploy",
           [
             "FUNCTION_NAME"
           ],
           "--region=FUNCTION_REGION",
           "--source=.",
           "--trigger-http",
           "--runtime=RUNTIME"
        ]
      }
     ]
   }
   

   Reemplaza los valores de marcador de posición en el archivo de configuración anterior por lo siguiente:

   • FUNCTION_NAME es el nombre de la función de Cloud Run Functions que estás implementando. Si actualizas una función existente, este valor debe coincidir con el nombre de la función que actualizas.
   • FUNCTION_REGION es la región en la que implementas Cloud Run Functions. Para obtener una lista de las regiones compatibles, consulta Ubicaciones de Cloud Run Functions.
   • --trigger-http es el tipo de activador de esta función, en este caso, una solicitud HTTP (webhook).
   • RUNTIME es el entorno de ejecución en el que se ejecuta la función.

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

   1. Abre la página Activadores en la Google Cloud consola:

      Abrir la página Activadores

   2. Selecciona el proyecto en el menú desplegable del selector de proyectos, que se ubica en la parte superior de la página.

   3. Haz clic en Crear activador.

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

   5. En Región, selecciona la región de tu activador.

      Nota: La región de tu activador debe coincidir con la región de la función en la que realizas la implementación.

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

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

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

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

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

Cada vez que envíes código nuevo a tu repositorio, se activará de forma automática una compilación y una implementación en Cloud Run Functions.

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

¿Qué sigue?

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