Guía de inicio rápido: Implementa una función en Cloud Run con gcloud CLI

Guía de inicio rápido: Implementa una función en Cloud Run con gcloud CLI

Vista previa — Cloud Run functions

Esta función está sujeta a las "Condiciones de las Ofertas de Fase Previa a la DG" de la sección Condiciones Generales del Servicio de las Condiciones Específicas del Servicio. Las funciones de fase previa a la DG están disponibles “tal cual” y podrían tener asistencia limitada. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

En esta página, se muestra cómo usar Cloud Run para implementar una función HTTP con gcloud CLI.

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.

   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

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Artifact Registry, Cloud Build, Cloud Run Admin API, and Cloud Logging APIs.

   Enable the APIs

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

   Note: If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update.

7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   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

8. Make sure that billing is enabled for your Google Cloud project.

9. Enable the Artifact Registry, Cloud Build, Cloud Run Admin API, and Cloud Logging APIs.

   Enable the APIs

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

    Note: If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update.
12. Para configurar el proyecto predeterminado para tu servicio de Cloud Run:

     gcloud config set project PROJECT_ID

    reemplaza PROJECT_ID por el nombre del proyecto que creaste para esta guía de inicio rápido.

13. Si estás bajo una política de la organización de restricción de dominios que restringe las invocaciones no autenticadas para tu proyecto, deberás acceder al servicio implementado como se describe en Prueba servicios privados.

14. Para que Cloud Build pueda compilar tus fuentes, otorga el rol de cuenta de servicio de Cloud Build a la cuenta de servicio predeterminada de Compute Engine mediante la ejecución de lo siguiente:

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member=serviceAccount:[e-mail] \
        --role=roles/cloudbuild.builds.builder
    

    Reemplaza PROJECT_NUMBER por el número de tu proyecto de Google Cloud y PROJECT_ID por el ID de tu proyecto de Google Cloud.

    Puedes encontrar el número y el ID del proyecto en la página de bienvenida de la consola de Google Cloud.

    Nota:

    La restricción de la política de la organización iam.automaticIamGrantsForDefaultServiceAccounts evita que el rol Editor se otorgue de forma automática a las cuentas de servicio predeterminadas. Si creaste tu organización después del 3 de mayo de 2024, esta restricción se aplica de forma predeterminada.

    Recomendamos que apliques esta restricción para inhabilitar la concesión automática de roles. Si inhabilitas la concesión automática de roles, debes decidir qué roles se deben otorgar a las cuentas de servicio predeterminadas y, luego, otorgar estos roles a ti mismo.

    Si la cuenta de servicio predeterminada ya tiene el rol de editor, te recomendamos que reemplaces el rol de editor por roles menos permisivos. Para modificar de forma segura los roles de la cuenta de servicio, usa Policy Simulator para ver el impacto del cambio y, luego, otorga y revoca los roles adecuados.

Escribe la función de muestra

Para escribir una aplicación, sigue estos pasos:

Node.js

1. Crea un directorio nuevo llamado helloworld y usa el comando de cambio de directorio en él:

      mkdir helloworld
      cd helloworld
   

2. Crea un archivo package.json en el directorio helloworld para especificar las dependencias de Node.js:

   {
     "name": "nodejs-docs-samples-functions-hello-world-get",
     "version": "0.0.1",
     "private": true,
     "license": "Apache-2.0",
     "author": "Google Inc.",
     "repository": {
       "type": "git",
       "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
     },
     "engines": {
       "node": ">=16.0.0"
     },
     "scripts": {
       "test": "c8 mocha -p -j 2 test/*.test.js --timeout=6000 --exit"
     },
     "dependencies": {
       "@google-cloud/functions-framework": "^3.1.0"
     },
     "devDependencies": {
       "c8": "^10.0.0",
       "gaxios": "^6.0.0",
       "mocha": "^10.0.0",
       "wait-port": "^1.0.4"
     }
   }
   

3. Crea un archivo index.js en el directorio helloworld con la siguiente muestra de Node.js:

   const functions = require('@google-cloud/functions-framework');
   
   // Register an HTTP function with the Functions Framework that will be executed
   // when you make an HTTP request to the deployed function's endpoint.
   functions.http('helloGET', (req, res) => {
     res.send('Hello World!');
   });

Python

1. Crea un directorio nuevo llamado helloworld y usa el comando de cambio de directorio en él:

      mkdir helloworld
      cd helloworld
   

2. Crea un archivo requirements.txt en el directorio helloworld para especificar las dependencias de Python:

   functions-framework==3.5.0
   flask==3.0.3
   google-cloud-error-reporting==1.9.1
   MarkupSafe==2.1.3
   

   Esto agrega los paquetes que necesita la muestra.

3. Crea un archivo main.py en el directorio helloworld con la siguiente muestra de Python:

   import functions_framework
   
   @functions_framework.http
   def hello_get(request):
       """HTTP Cloud Function.
       Args:
           request (flask.Request): The request object.
           <https://flask.palletsprojects.com/en/1.1.x/api/#incoming-request-data>
       Returns:
           The response text, or any set of values that can be turned into a
           Response object using `make_response`
           <https://flask.palletsprojects.com/en/1.1.x/api/#flask.make_response>.
       Note:
           For more information on how Flask integrates with Cloud
           Functions, see the `Writing HTTP functions` page.
           <https://cloud.google.com/functions/docs/writing/http#http_frameworks>
       """
       return "Hello World!"
   
   

Go

1. Crea un directorio nuevo llamado helloworld y usa el comando de cambio de directorio en él:

      mkdir helloworld
      cd helloworld
   

2. Crea un archivo go.mod para declarar el módulo de go:

   module github.com/GoogleCloudPlatform/golang-samples/functions/helloworld
   
   go 1.19
   
   require github.com/GoogleCloudPlatform/functions-framework-go v1.8.1
   
   require (
   	github.com/cloudevents/sdk-go/v2 v2.15.2 // indirect
   	github.com/google/go-cmp v0.6.0 // indirect
   	github.com/google/uuid v1.6.0 // indirect
   	github.com/json-iterator/go v1.1.12 // indirect
   	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
   	github.com/modern-go/reflect2 v1.0.2 // indirect
   	go.uber.org/multierr v1.11.0 // indirect
   	go.uber.org/zap v1.27.0 // indirect
   	golang.org/x/time v0.5.0 // indirect
   )
   

   Puedes crear el archivo go.mod directamente en el formato como se muestra arriba, o puedes inicializarlo desde el directorio del proyecto con lo siguiente:

      go mod init github.com/GoogleCloudPlatform/golang-samples/functions/functionsv2/helloworld/go.mod
   

3. Crea un archivo hello_http.go en el directorio helloworld con la siguiente muestra de código Go:

   
   // Package helloworld provides a set of Cloud Functions samples.
   package helloworld
   
   import (
   	"fmt"
   	"net/http"
   
   	"github.com/GoogleCloudPlatform/functions-framework-go/functions"
   )
   
   func init() {
   	functions.HTTP("HelloGet", helloGet)
   }
   
   // helloGet is an HTTP Cloud Function.
   func helloGet(w http.ResponseWriter, r *http.Request) {
   	fmt.Fprint(w, "Hello, World!")
   }
   

Java

1. Crea un directorio nuevo llamado helloworld y usa el comando de cambio de directorio en él:

      mkdir helloworld
      cd helloworld
   

2. Crea la siguiente estructura de proyecto a fin de que contenga el directorio fuente y el archivo de origen:

   mkdir -p ~/helloworld/src/main/java/functions
   touch ~/helloworld/src/main/java/functions/HelloWorld.java
   

3. Actualiza el archivo HelloWorld.java con la siguiente muestra de código de Java:

   
   package functions;
   
   import com.google.cloud.functions.HttpFunction;
   import com.google.cloud.functions.HttpRequest;
   import com.google.cloud.functions.HttpResponse;
   import java.io.BufferedWriter;
   import java.io.IOException;
   
   public class HelloWorld implements HttpFunction {
     // Simple function to return "Hello World"
     @Override
     public void service(HttpRequest request, HttpResponse response)
         throws IOException {
       BufferedWriter writer = response.getWriter();
       writer.write("Hello World!");
     }
   }

4. Crea un archivo pom.xml en el directorio helloworld y agrega las siguientes dependencias de Java:

   <?xml version="1.0" encoding="UTF-8"?>
   
   <!--
     Copyright 2020 Google LLC
   
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
     You may obtain a copy of the License at
   
     http://www.apache.org/licenses/LICENSE-2.0
   
     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     See the License for the specific language governing permissions and
     limitations under the License.
   -->
   
   <project xmlns="http://maven.apache.org/POM/4.0.0"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
   
     <groupId>com.example.functions</groupId>
     <artifactId>functions-hello-world</artifactId>
     <version>1.0.0-SNAPSHOT</version>
   
     <parent>
       <groupId>com.google.cloud.samples</groupId>
       <artifactId>shared-configuration</artifactId>
       <version>1.2.0</version>
     </parent>
   
     <dependencyManagement>
       <dependencies>
         <dependency>
           <artifactId>libraries-bom</artifactId>
           <groupId>com.google.cloud</groupId>
           <scope>import</scope>
           <type>pom</type>
           <version>26.32.0</version>
         </dependency>
       </dependencies>
     </dependencyManagement>
   
     <properties>
       <maven.compiler.target>11</maven.compiler.target>
       <maven.compiler.source>11</maven.compiler.source>
     </properties>
   
     <dependencies>
       <!-- Required for Function primitives -->
       <dependency>
         <groupId>com.google.cloud.functions</groupId>
         <artifactId>functions-framework-api</artifactId>
         <version>1.1.0</version>
         <scope>provided</scope>
       </dependency>
   
       <!-- The following dependencies are only required for testing -->
       <dependency>
         <groupId>com.google.truth</groupId>
         <artifactId>truth</artifactId>
         <version>1.4.0</version>
         <scope>test</scope>
       </dependency>
       <dependency>
         <groupId>com.google.guava</groupId>
         <artifactId>guava-testlib</artifactId>
         <scope>test</scope>
       </dependency>
       <dependency>
         <groupId>org.mockito</groupId>
         <artifactId>mockito-core</artifactId>
         <version>5.10.0</version>
         <scope>test</scope>
       </dependency>
     </dependencies>
   
     <build>
       <plugins>
         <plugin>
           <!--
             Google Cloud Functions Framework Maven plugin
   
             This plugin allows you to run Cloud Functions Java code
             locally. Use the following terminal command to run a
             given function locally:
   
             mvn function:run -Drun.functionTarget=your.package.yourFunction
           -->
           <groupId>com.google.cloud.functions</groupId>
           <artifactId>function-maven-plugin</artifactId>
           <version>0.11.0</version>
           <configuration>
             <functionTarget>functions.HelloWorld</functionTarget>
           </configuration>
         </plugin>
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-surefire-plugin</artifactId>
           <!-- version 3.0.0-M4 does not load JUnit5 correctly -->
           <!-- see https://issues.apache.org/jira/browse/SUREFIRE-1750 -->
           <version>3.2.5</version>
           <configuration>
             <includes>
               <include>**/*Test.java</include>
             </includes>
             <skipTests>${skipTests}</skipTests>
             <reportNameSuffix>sponge_log</reportNameSuffix>
             <trimStackTrace>false</trimStackTrace>
           </configuration>
         </plugin>
       </plugins>
     </build>
   </project>
   

.NET

1. Instala el SDK de .NET 6.0. Esta guía de inicio rápido solo funciona para la versión 6 de .NET.

2. Desde la consola, crea un proyecto web vacío nuevo con el comando de dotnet:

   dotnet new web -o helloworld-csharp
   

3. Cambia el directorio a helloworld-csharp:

4. Reemplaza el código de muestra en el archivo del proyecto helloworld-csharp.csproj por lo siguiente:

   <Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
       <OutputType>Exe</OutputType>
       <TargetFramework>net6.0</TargetFramework>
     </PropertyGroup>
   
     <ItemGroup>
       <PackageReference Include="Google.Cloud.Functions.Hosting" Version="2.2.1" />
     </ItemGroup>
   </Project>

5. Reemplaza el código de muestra del archivo Program.cs por lo siguiente:

   
   using Google.Cloud.Functions.Framework;
   using Microsoft.AspNetCore.Http;
   using System.Threading.Tasks;
   
   namespace HelloWorld;
   
   public class Function : IHttpFunction
   {
       public async Task HandleAsync(HttpContext context)
       {
           await context.Response.WriteAsync("Hello World!", context.RequestAborted);
       }
   }

Implementa la función

Importante: En esta guía de inicio rápido, se supone que tienes roles de propietario o de editor en el proyecto que usas para la guía de inicio rápido. De lo contrario, consulta el rol del desarrollador de fuente de Cloud Run para conocer los permisos necesarios para implementar un recurso de Cloud Run desde la fuente.

Para implementar tu función de Cloud Run, sigue estos pasos:

1. Para implementar la función, ejecuta el siguiente comando en el directorio que contiene el código de muestra:

   Node.js

   gcloud beta run deploy nodejs-http-function \
         --source . \
         --function helloGET \
         --base-image=us-central1-docker.pkg.dev/serverless-runtimes/google-22/runtimes/nodejs20 \
         --region REGION \
         --allow-unauthenticated
   

   Reemplaza REGION por la región de Google Cloud del servicio en el que deseas implementar tu función. Por ejemplo, us-central1.

   Python

   gcloud beta run deploy python-http-function \
         --source . \
         --function hello_get \
         --base-image=us-central1-docker.pkg.dev/serverless-runtimes/google-22/runtimes/python312 \
         --region REGION \
         --allow-unauthenticated
   

   Reemplaza REGION por la región de Google Cloud del servicio en la que deseas implementar tu función. Por ejemplo, us-central1.

   Go

   gcloud beta run deploy go-http-function \
          --source . \
          --function HelloGet \
          --base-image=us-central1-docker.pkg.dev/serverless-runtimes/google-22/runtimes/go122 \
          --region REGION \
          --allow-unauthenticated
   

   Reemplaza REGION por la región de Google Cloud del servicio en el que deseas implementar tu función. Por ejemplo, us-central1.

   Java

   Ejecuta el siguiente comando en el directorio que contiene el archivo pom.xml:

   gcloud beta run deploy java-http-function \
          --source . \
          --function functions.HelloWorld \
          --base-image=us-central1-docker.pkg.dev/serverless-runtimes/google-22/runtimes/java21 \
          --region REGION \
          --allow-unauthenticated
   

   Reemplaza REGION por la región de Google Cloud del servicio en la que deseas implementar tu función. Por ejemplo, us-central1.

   .NET

   gcloud beta run deploy csharp-http-function \
         --source . \
         --function HelloWorld.Function \
         --base-image=us-central1-docker.pkg.dev/serverless-runtimes/google-22/runtimes/dotnet6 \
         --region REGION \
         --allow-unauthenticated
   

   Reemplaza REGION por la región de Google Cloud del servicio en el que deseas implementar tu función. Por ejemplo, us-central1.

2. Cuando se complete la implementación, Google Cloud CLI mostrará una URL en la que se ejecuta el servicio. Abre la URL en tu navegador para ver el resultado de la función.

Para obtener instrucciones sobre cómo agregar activadores de Eventarc a tu función, consulta la guía para implementar una función.

Limpia

Si bien Cloud Run no cobra cuando el servicio no se usa, es posible que se te cobre por el almacenamiento de la imagen de contenedor en Artifact Registry. Puedes borrar la imagen de contenedor o borrar el proyecto de Google Cloud para evitar que se apliquen cargos. Si borras tu proyecto de Google Cloud, se dejan de facturar todos los recursos que usaste en ese proyecto.

Precaución: Borrar un proyecto tiene las siguientes consecuencias:
• Se borra todo en el proyecto. Si usaste un proyecto existente para las tareas de este documento, cuando lo borres, también se borrará cualquier otro trabajo que hayas realizado en el proyecto.
• Se pierden los ID personalizados de proyectos. Cuando creaste este proyecto, es posible que hayas creado un ID del proyecto personalizado que desees utilizar en el futuro. Para conservar las URL que utilizan el ID del proyecto, como una URL appspot.com, borra los recursos seleccionados dentro del proyecto en lugar de borrar todo el proyecto.
1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

¿Qué sigue?

• Activar funciones desde Cloud Storage con Eventarc

• Para implementar una función de muestra en Cloud Run mediante la consola de Google Cloud, consulta la Guía de inicio rápido: Implementa una función en Cloud Run mediante la consola de Google Cloud.

• Para implementar funciones y crear activadores con la consola de Google Cloud y Google Cloud CLI, consulta Implementa funciones.

• Para ver y borrar funciones existentes, consulta Administra revisiones de servicios.

• Para compilar contenedores de funciones en tu propia cadena de herramientas y, luego, implementarlos en Cloud Run, consulta Compila funciones.