Crea una función de Cloud Run que devuelva resultados de Spanner

En este instructivo, se muestra cómo escribir una función de HTTP de Cloud Run que muestra resultados de Spanner.

Objetivos

Escribe, implementa y activa una función de HTTP que tenga acceso a Spanner.

Costos

En este documento, se usan Spanner y Cloud Run, que son componentes facturables de Google Cloud.

  • Para obtener información sobre el costo de usar Spanner, consulta Precios de Spanner.

  • Para obtener información sobre el costo del uso de Cloud Run, incluidas las invocaciones gratuitas, consulta Precios de Cloud Run.

Antes de comenzar

  1. En este documento, se supone que tienes una instancia de Spanner llamada test-instance y una base de datos llamada example-db que usa el esquema de la aplicación de música . Para obtener instrucciones sobre cómo crear una instancia y una base de datos con el esquema de aplicación de música, consulta la guía de inicio rápido sobre el uso de Console o los instructivos sobre introducción a Node.js, o Python.

  2. Habilita las APIs de Cloud Run y Cloud Build.

    Habilitar las API

  3. Instala e inicializa la CLI de gcloud.

    Si ya tienes instalada gcloud CLI, ejecuta el siguiente comando para actualizarla:

    gcloud components update

  4. Prepara tu entorno de desarrollo:

    Node.js

    Consulta la guía de configuración de Node.js.

    Python

    Consulta la guía de configuración de Python.

Roles obligatorios

Para obtener los permisos que necesitas para implementar servicios de Cloud Run desde la fuente, pídele a tu administrador que te otorgue los siguientes roles de IAM:

Para obtener una lista de los roles y los permisos de IAM asociados con Cloud Run, consulta los roles de IAM de Cloud Run y los permisos de IAM de Cloud Run. Si tu servicio de Cloud Run interactúa con Google Cloud las APIs, como las bibliotecas cliente de Cloud, consulta la guía de configuración de identidades del servicio. Para obtener más información sobre cómo otorgar roles, consulta permisos de implementación y administra el acceso.

Roles para la cuenta de servicio de Cloud Build

Tú o tu administrador deben otorgar a la cuenta de servicio de Cloud Build el siguiente rol de IAM.

Haz clic para ver los roles necesarios para la cuenta de servicio de Cloud Build

Cloud Build uses automáticamente la cuenta de servicio predeterminada de Compute Engine como la cuenta de servicio predeterminada de Cloud Build para compilar tu código fuente y el recurso de Cloud Run, a menos que anules este comportamiento. Para que Cloud Build compile tus fuentes, pídele a tu administrador que otorgue el rol de compilador de Cloud Run (roles/run.builder) a la cuenta de servicio predeterminada de Compute Engine en tu proyecto:

  gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
      --role=roles/run.builder

Reemplaza PROJECT_NUMBER por el número de tu Google Cloud proyecto y PROJECT_ID por el ID de tu Google Cloud proyecto. Para obtener instrucciones detalladas sobre cómo encontrar el ID del proyecto y el número de tu proyecto, consulta Crea y administra proyectos.

El otorgamiento del rol de compilador de Cloud Run a la cuenta de servicio predeterminada de Compute Engine tarda un par de minutos en propagarse.

Roles para la identidad de servicio

Debes otorgar a la identidad de servicio que usas para el servicio de Cloud Run el siguiente rol de IAM.

  • Lector de base de datos de Spanner (roles/spanner.databaseReader)

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

Prepara la aplicación

  1. Clona el repositorio de la app de muestra en tu máquina local:

    Node.js 

    git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

    De manera opcional, puedes descargar la muestra como un archivo zip y extraerla.

    Python 

    git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git

    De manera opcional, puedes descargar la muestra como un archivo zip y extraerla.

  2. Cambia al directorio que contiene el código de muestra de Cloud Run Functions para acceder a Spanner:

    Node.js 

    cd nodejs-docs-samples/functions/spanner

    Python 

    cd python-docs-samples/functions/spanner

  3. Ve el código de muestra:

    Node.js 

    // Imports the Google Cloud client library
const {Spanner} = require('@google-cloud/spanner');

// Imports the functions framework to register your HTTP function
const functions = require('@google-cloud/functions-framework');

// Instantiates a client
const spanner = new Spanner();

// Your Cloud Spanner instance ID
const instanceId = 'test-instance';

// Your Cloud Spanner database ID
const databaseId = 'example-db';

/**
 * HTTP Cloud Function.
 *
 * @param {Object} req Cloud Function request context.
 * @param {Object} res Cloud Function response context.
 */
functions.http('spannerQuickstart', async (req, res) => {
  // Gets a reference to a Cloud Spanner instance and database
  const instance = spanner.instance(instanceId);
  const database = instance.database(databaseId);

  // The query to execute
  const query = {
    sql: 'SELECT * FROM Albums',
  };

  // Execute the query
  try {
    const results = await database.run(query);
    const rows = results[0].map(row => row.toJSON());
    rows.forEach(row => {
      res.write(
        `SingerId: ${row.SingerId}, ` +
          `AlbumId: ${row.AlbumId}, ` +
          `AlbumTitle: ${row.AlbumTitle}\n`
      );
    });
    res.status(200).end();
  } catch (err) {
    res.status(500).send(`Error querying Spanner: ${err}`);
  }
});

    Python 

    import functions_framework
from google.cloud import spanner

instance_id = "test-instance"
database_id = "example-db"

client = spanner.Client()
instance = client.instance(instance_id)
database = instance.database(database_id)


@functions_framework.http
def spanner_read_data(request):
    query = "SELECT * FROM Albums"

    outputs = []
    with database.snapshot() as snapshot:
        results = snapshot.execute_sql(query)

        for row in results:
            output = "SingerId: {}, AlbumId: {}, AlbumTitle: {}".format(*row)
            outputs.append(output)

    return "\n".join(outputs)

    La función envía una consulta en SQL para recuperar todos los datos de Albums de tu base de datos. La función se ejecuta cuando haces una solicitud HTTP al extremo de la función.

Implementa la función

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

Node.js 

gcloud run deploy nodejs-spanner-function \
    --source . \
    --region REGION \
    --function spannerQuickstart \
    --base-image RUNTIME_ID \
    --log-http

Python 

gcloud run deploy python-spanner-function \
    --source . \
    --region REGION \
    --function spanner_read_data \
    --base-image RUNTIME_ID \
    --log-http

Reemplaza lo siguiente:

La implementación de la función puede tardar hasta dos minutos.

Ten en cuenta el valor de url que se muestra cuando tu función termina de implementarse. Lo usarás cuando actives la función.

Puedes ver las funciones implementadas en la página de Cloud Run en la Google Cloud consola. También puedes crear y editar funciones en esa página, en la que, además, puedes obtener detalles y diagnósticos de tus funciones.

Activa la función

Haz una solicitud HTTP a tu función:

curl URL

Reemplaza URL por el valor de la URL que se muestra cuando la función se termina de implementar.

Deberías ver un resultado que muestre el producto de la consulta en SQL, si es que trabajaste con un instructivo de introducción y completaste la base de datos:

SingerId: 2, AlbumId: 2, AlbumTitle: Forever Hold Your Peace
SingerId: 1, AlbumId: 2, AlbumTitle: Go, Go, Go
SingerId: 2, AlbumId: 1, AlbumTitle: Green
SingerId: 2, AlbumId: 3, AlbumTitle: Terrified
SingerId: 1, AlbumId: 1, AlbumTitle: Total Junk

También puedes visitar la URL de la función en tu navegador para ver los resultados de tu consulta en SQL.

Limpia

Para evitar incurrir en cargos adicionales en tu Google Cloud cuenta de por los recursos de Spanner y Cloud Run Functions utilizados en este documento, haz lo siguiente:

  1. Borra la instancia:

    gcloud CLI instances delete test-instance

  2. Usa este comando para borrar el servicio de Cloud Run que implementaste en este instructivo:

    Node.js 

    gcloud run services delete nodejs-spanner-function

    Python 

    gcloud run services delete python-spanner-function

¿Qué sigue?