Crea e implementa una función de Cloud Run de HTTP con Ruby (1ª gen.)

En esta guía, se explica el proceso para escribir una función de Cloud Run con el entorno de ejecución de Ruby. Existen dos tipos de funciones de Cloud Run:

• Una función de HTTP que se invoca a partir de solicitudes HTTP estándar
• Una función controlada por eventos, que se usa para manejar los eventos desde tu infraestructura de nube, como mensajes en un tema de Pub/Sub o cambios en un bucket de Cloud Storage

En el ejemplo, se muestra cómo crear una función de HTTP simple.

Más información: Para obtener más detalles, lee sobre las funciones de HTTP y las funciones basadas en eventos.

Antes de comenzar

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.

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Functions and Cloud Build APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Functions and Cloud Build APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

1. Instala y, luego, inicializa gcloud CLI.
2. Instala y actualiza los componentes de gcloud:

   gcloud components update

Nota: ¿Necesitas un símbolo del sistema? Puedes usar Cloud Shell. Cloud Shell es un entorno de línea de comandos que ya incluye Google Cloud CLI, por lo que no es necesario que la instales. Google Cloud CLI también viene preinstalado en las máquinas virtuales de Compute Engine.
3. Prepara tu entorno de desarrollo.

   Ir a la guía de configuración de Ruby

Crea una función

1. Crea un directorio en tu sistema local para el código de función:

   Linux o MacOS X

   mkdir ~/helloworld
   cd ~/helloworld
   

   Windows

   mkdir %HOMEPATH%\helloworld
   cd %HOMEPATH%\helloworld
   

2. Crea un archivo app.rb en el directorio helloworld con el siguiente contenido:

   require "functions_framework"
   require "cgi"
   require "json"
   
   FunctionsFramework.http "hello_http" do |request|
     # The request parameter is a Rack::Request object.
     # See https://www.rubydoc.info/gems/rack/Rack/Request
     name = request.params["name"] ||
            (request.body.rewind && JSON.parse(request.body.read)["name"] rescue nil) ||
            "World"
     # Return the response body as a string.
     # You can also return a Rack::Response object, a Rack response array, or
     # a hash which will be JSON-encoded into a response.
     "Hello #{CGI.escape_html name}!"
   end

   Esta función de ejemplo toma un nombre proporcionado en la solicitud HTTP y muestra un saludo o "Hello World!" cuando no se proporciona ningún nombre.

   Nota: Cloud Run Functions busca funciones que se puedan implementar en app.rb de forma predeterminada. Usa la marca --source cuando implementes la función a través de gcloud para especificar un directorio diferente que contenga un archivo app.rb.

Especifica las dependencias

Las dependencias en Ruby se administran con bundler y se expresan en un archivo llamado Gemfile.

Cuando implementas tu función, Cloud Run Functions descarga y, luego, instala las dependencias declaradas en Gemfile y Gemfile.lock con bundler.

El Gemfile enumera los paquetes que requiere tu función, junto con las restricciones de las versiones opcionales. Para una función de Cloud Run, uno de estos paquetes debe ser la gema functions_framework.

Para este ejercicio, crea un archivo llamado Gemfile en el mismo directorio que el archivo app.rb que contiene el código de tu función, con el siguiente contenido:

source "https://rubygems.org"

gem "functions_framework", "~> 0.7"

Ejecuta el siguiente comando para instalar la gema functions_framework y otras dependencias:

bundle install

Más información: Para obtener más detalles, lee acerca de especificar dependencias.

Compila y prueba de manera local

Antes de implementar la función, puedes compilarla y probarla de forma local. Ejecuta el siguiente comando para usar el ejecutable functions-framework-ruby y, así, iniciar un servidor web local que ejecute tu función hello_http:

bundle exec functions-framework-ruby --target hello_http
# ...starts the web server in the foreground

Si la función se compila de forma correcta, mostrará la URL que puedes visitar en tu navegador web para ver la función en acción: http://localhost:8080/. Deberías ver un mensaje de Hello World!.

Como alternativa, puedes enviar solicitudes a esta función con curl desde otra ventana de terminal:

curl localhost:8080
# Output: Hello World!

Consulta también la sección sobre probar funciones en la documentación de Functions Framework de Ruby.

Implementa la función

Ejecuta el siguiente comando en el directorio helloworld para implementar la función con un activador HTTP:

gcloud functions deploy hello_http --no-gen2 --runtime ruby34 --trigger-http --allow-unauthenticated

La marca --allow-unauthenticated te permite acceder a la función sin autenticación. Para solicitar la autenticación, omite la marca.

Más información: Para obtener más detalles, lee acerca de la implementación de Cloud Run Functions.

Prueba la función implementada

1. Cuando la función termine de implementarse, toma nota de la propiedad httpsTrigger.url o búscala con el siguiente comando:

   gcloud functions describe hello_http
   

   Se verá de la siguiente manera:

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_http

2. Visita esta URL en tu navegador. Deberías ver el mensaje "Hello World!".

   Intenta pasar un nombre en la solicitud HTTP, por ejemplo, mediante la siguiente URL:

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_http?name=NAME

   Deberías ver el mensaje "Hello NAME!"

Visualiza los registros

Puedes ver los registros de Cloud Run Functions en la IU de Cloud Logging o a través de Google Cloud CLI.

Visualiza registros con la herramienta de línea de comandos

Para ver los registros de tu función con gcloud CLI, usa el comando logs read seguido del nombre de la función.

gcloud functions logs read hello_http

El resultado debe parecerse al siguiente:

LEVEL  NAME       EXECUTION_ID  TIME_UTC                 LOG
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:25.983  Function execution started
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:26.001  Function execution took 19 ms, finished with status code: 200

Nota: Por lo general, hay un ligero retraso entre el momento en que se crean las entradas de registro y el momento en que se muestran en Cloud Logging.

Visualiza registros en el panel de Logging

También puedes ver los registros de Cloud Run Functions desde la consola deGoogle Cloud .

Más información: Para obtener más detalles, lee sobre cómo escribir y visualizar los registros, además de responder a ellos.