Plantilla de Cloud Pub/Sub a Cloud Storage

Usa la plantilla Serverless para Apache Spark Cloud Pub/Sub a Cloud Storage para extraer datos de Pub/Sub a Cloud Storage.

Usar la plantilla

Ejecuta la plantilla con la CLI de gcloud o la API de Dataproc.

gcloud

Antes de usar los datos de los comandos que se indican a continuación, haz los siguientes cambios:

• PROJECT_ID: obligatorio. El ID de tu proyecto, que se indica en la sección Configuración de gestión de identidades y accesos. Google Cloud
• REGION: obligatorio. Región de Compute Engine.
• SUBNET: opcional. Si no se especifica ninguna subred, se seleccionará la subred de la red default de la región especificada.

  Ejemplo: projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME

• TEMPLATE_VERSION: obligatorio. Especifique latest para la versión más reciente de la plantilla o la fecha de una versión específica (por ejemplo, 2023-03-17_v0.1.0-beta). Consulte gs://dataproc-templates-binaries o ejecute gcloud storage ls gs://dataproc-templates-binaries para ver una lista de las versiones de plantilla disponibles.
• PUBSUB_SUBSCRIPTION_PROJECT_ID: obligatorio. El Google Cloud ID de proyecto que figura en la configuración de gestión de identidades y accesos que contiene la suscripción de Pub/Sub de entrada que se va a leer.
• SUBSCRIPTION: obligatorio. Nombre de la suscripción de Pub/Sub.
• CLOUD_STORAGE_OUTPUT_BUCKET_NAME: obligatorio. Nombre del segmento de Cloud Storage donde se almacenará el resultado.

  Nota: Los archivos de salida se almacenarán en la carpeta output/ del segmento.

• FORMAT: obligatorio. Formato de los datos de salida. Opciones: avro o json.

  Nota: Si avro, debes añadir "file:///usr/lib/spark/connector/spark-avro.jar" a la marca jars de la CLI de gcloud o al campo de la API.

  Ejemplo (el prefijo file:// hace referencia a un archivo JAR de Serverless para Apache Spark):

  --jars=file:///usr/lib/spark/connector/spark-avro.jar, [ ... otros archivos JAR]
• TIMEOUT: opcional. Tiempo en milisegundos antes de la finalización de la emisión. El valor predeterminado es 60000.
• DURATION: opcional. Frecuencia en segundos de las escrituras en Cloud Storage. El valor predeterminado es 15 segundos.
• NUM_RECEIVERS: opcional. Número de flujos leídos de una suscripción de Pub/Sub en paralelo. El valor predeterminado es 5.
• BATCHSIZE: opcional. Número de registros que se insertarán en un viaje de ida y vuelta a Cloud Storage. El valor predeterminado es 1000.
• SERVICE_ACCOUNT: opcional. Si no se proporciona, se usa la cuenta de servicio predeterminada de Compute Engine.
• PROPERTY y PROPERTY_VALUE: opcional. Lista de pares propiedad de Spark=value separados por comas.
• LABEL y LABEL_VALUE: Opcionales. Lista de pares label=value separados por comas.
• LOG_LEVEL: opcional. Nivel de registro. Puede ser uno de los siguientes: ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE o WARN. Valor predeterminado: INFO.
• KMS_KEY: opcional. La clave de Cloud Key Management Service que se va a usar para el cifrado. Si no se especifica ninguna clave, los datos se cifran en reposo con una Google-owned and Google-managed encryption key.

  Ejemplo: projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME

Ejecuta el siguiente comando:

Linux, macOS o Cloud Shell

Nota: Asegúrate de haber inicializado la CLI de Google Cloud con la autenticación y un proyecto ejecutando uno de los siguientes comandos: gcloud init; o gcloud auth login y gcloud config set project.

gcloud dataproc batches submit spark \
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate \
    --version="1.2" \
    --project="PROJECT_ID" \
    --region="REGION" \
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar" \
    --subnet="SUBNET" \
    --kms-key="KMS_KEY" \
    --service-account="SERVICE_ACCOUNT" \
    --properties="PROPERTY=PROPERTY_VALUE" \
    --labels="LABEL=LABEL_VALUE" \
    -- --template=PUBSUBTOGCS \
    --templateProperty log.level="LOG_LEVEL" \
    --templateProperty pubsubtogcs.input.project.id="PUBSUB_SUBSCRIPTION_PROJECT_ID" \
    --templateProperty pubsubtogcs.input.subscription="SUBSCRIPTION" \
    --templateProperty pubsubtogcs.gcs.bucket.name="CLOUD_STORAGE_OUTPUT_BUCKET_NAME" \
    --templateProperty pubsubtogcs.gcs.output.data.format="FORMAT" \
    --templateProperty pubsubtogcs.timeout.ms="TIMEOUT" \
    --templateProperty pubsubtogcs.streaming.duration.seconds="DURATION" \
    --templateProperty pubsubtogcs.total.receivers="NUM_RECEIVERS" \
    --templateProperty pubsubtogcs.batch.size="BATCHSIZE"

Windows (PowerShell)

Nota: Asegúrate de haber inicializado la CLI de Google Cloud con la autenticación y un proyecto ejecutando uno de los siguientes comandos: gcloud init; o gcloud auth login y gcloud config set project.

gcloud dataproc batches submit spark `
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate `
    --version="1.2" `
    --project="PROJECT_ID" `
    --region="REGION" `
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar" `
    --subnet="SUBNET" `
    --kms-key="KMS_KEY" `
    --service-account="SERVICE_ACCOUNT" `
    --properties="PROPERTY=PROPERTY_VALUE" `
    --labels="LABEL=LABEL_VALUE" `
    -- --template=PUBSUBTOGCS `
    --templateProperty log.level="LOG_LEVEL" `
    --templateProperty pubsubtogcs.input.project.id="PUBSUB_SUBSCRIPTION_PROJECT_ID" `
    --templateProperty pubsubtogcs.input.subscription="SUBSCRIPTION" `
    --templateProperty pubsubtogcs.gcs.bucket.name="CLOUD_STORAGE_OUTPUT_BUCKET_NAME" `
    --templateProperty pubsubtogcs.gcs.output.data.format="FORMAT" `
    --templateProperty pubsubtogcs.timeout.ms="TIMEOUT" `
    --templateProperty pubsubtogcs.streaming.duration.seconds="DURATION" `
    --templateProperty pubsubtogcs.total.receivers="NUM_RECEIVERS" `
    --templateProperty pubsubtogcs.batch.size="BATCHSIZE"

Windows (cmd.exe)

Nota: Asegúrate de haber inicializado la CLI de Google Cloud con la autenticación y un proyecto ejecutando uno de los siguientes comandos: gcloud init; o gcloud auth login y gcloud config set project.

gcloud dataproc batches submit spark ^
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate ^
    --version="1.2" ^
    --project="PROJECT_ID" ^
    --region="REGION" ^
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar" ^
    --subnet="SUBNET" ^
    --kms-key="KMS_KEY" ^
    --service-account="SERVICE_ACCOUNT" ^
    --properties="PROPERTY=PROPERTY_VALUE" ^
    --labels="LABEL=LABEL_VALUE" ^
    -- --template=PUBSUBTOGCS ^
    --templateProperty log.level="LOG_LEVEL" ^
    --templateProperty pubsubtogcs.input.project.id="PUBSUB_SUBSCRIPTION_PROJECT_ID" ^
    --templateProperty pubsubtogcs.input.subscription="SUBSCRIPTION" ^
    --templateProperty pubsubtogcs.gcs.bucket.name="CLOUD_STORAGE_OUTPUT_BUCKET_NAME" ^
    --templateProperty pubsubtogcs.gcs.output.data.format="FORMAT" ^
    --templateProperty pubsubtogcs.timeout.ms="TIMEOUT" ^
    --templateProperty pubsubtogcs.streaming.duration.seconds="DURATION" ^
    --templateProperty pubsubtogcs.total.receivers="NUM_RECEIVERS" ^
    --templateProperty pubsubtogcs.batch.size="BATCHSIZE"

REST

Antes de usar los datos de la solicitud, haz las siguientes sustituciones:

• PROJECT_ID: obligatorio. El ID de tu proyecto, que se indica en la sección Configuración de gestión de identidades y accesos. Google Cloud
• REGION: obligatorio. Región de Compute Engine.
• SUBNET: opcional. Si no se especifica ninguna subred, se seleccionará la subred de la red default de la región especificada.

  Ejemplo: projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME

• TEMPLATE_VERSION: obligatorio. Especifique latest para la versión más reciente de la plantilla o la fecha de una versión específica (por ejemplo, 2023-03-17_v0.1.0-beta). Consulte gs://dataproc-templates-binaries o ejecute gcloud storage ls gs://dataproc-templates-binaries para ver una lista de las versiones de plantilla disponibles.
• PUBSUB_SUBSCRIPTION_PROJECT_ID: obligatorio. El Google Cloud ID de proyecto que figura en la configuración de gestión de identidades y accesos que contiene la suscripción de Pub/Sub de entrada que se va a leer.
• SUBSCRIPTION: obligatorio. Nombre de la suscripción de Pub/Sub.
• CLOUD_STORAGE_OUTPUT_BUCKET_NAME: obligatorio. Nombre del segmento de Cloud Storage donde se almacenará el resultado.

  Nota: Los archivos de salida se almacenarán en la carpeta output/ del segmento.

• FORMAT: obligatorio. Formato de los datos de salida. Opciones: avro o json.

  Nota: Si avro, debes añadir "file:///usr/lib/spark/connector/spark-avro.jar" a la marca jars de la CLI de gcloud o al campo de la API.

  Ejemplo (el prefijo file:// hace referencia a un archivo JAR de Serverless para Apache Spark):

  --jars=file:///usr/lib/spark/connector/spark-avro.jar, [ ... otros archivos JAR]
• TIMEOUT: opcional. Tiempo en milisegundos antes de la finalización de la emisión. El valor predeterminado es 60000.
• DURATION: opcional. Frecuencia en segundos de las escrituras en Cloud Storage. El valor predeterminado es 15 segundos.
• NUM_RECEIVERS: opcional. Número de flujos leídos de una suscripción de Pub/Sub en paralelo. El valor predeterminado es 5.
• BATCHSIZE: opcional. Número de registros que se insertarán en un viaje de ida y vuelta a Cloud Storage. El valor predeterminado es 1000.
• SERVICE_ACCOUNT: opcional. Si no se proporciona, se usa la cuenta de servicio predeterminada de Compute Engine.
• PROPERTY y PROPERTY_VALUE: opcional. Lista de pares propiedad de Spark=value separados por comas.
• LABEL y LABEL_VALUE: Opcionales. Lista de pares label=value separados por comas.
• LOG_LEVEL: opcional. Nivel de registro. Puede ser uno de los siguientes: ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE o WARN. Valor predeterminado: INFO.
• KMS_KEY: opcional. La clave de Cloud Key Management Service que se va a usar para el cifrado. Si no se especifica ninguna clave, los datos se cifran en reposo con una Google-owned and Google-managed encryption key.

  Ejemplo: projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME

Método HTTP y URL:

POST https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches

Cuerpo JSON de la solicitud:

{
  "environmentConfig":{
    "executionConfig":{
      "subnetworkUri":"SUBNET",
      "kmsKey": "KMS_KEY",
      "serviceAccount": "SERVICE_ACCOUNT"
    }
  },
  "labels": {
    "LABEL": "LABEL_VALUE"
  },
  "runtimeConfig": {
    "version": "1.2",
    "properties": {
      "PROPERTY": "PROPERTY_VALUE"
    }
  },
  "sparkBatch":{
    "mainClass":"com.google.cloud.dataproc.templates.main.DataProcTemplate",
    "args":[
      "--template","PUBSUBTOGCS",
      "--templateProperty","log.level=LOG_LEVEL",
      "--templateProperty","pubsubtogcs.input.project.id=PUBSUB_SUBSCRIPTION_PROJECT_ID",
      "--templateProperty","pubsubtogcs.input.subscription=SUBSCRIPTION",
      "--templateProperty","pubsubtogcs.gcs.bucket.name=CLOUD_STORAGE_OUTPUT_BUCKET_NAME",
      "--templateProperty","pubsubtogcs.gcs.output.data.format=FORMAT",
      "--templateProperty","pubsubtogcs.timeout.ms=TIMEOUT",
      "--templateProperty","pubsubtogcs.streaming.duration.seconds=DURATION",
      "--templateProperty","pubsubtogcs.total.receivers=NUM_RECEIVERS",
      "--templateProperty","pubsubtogcs.batch.size=BATCHSIZE"
    ],
    "jarFileUris":[
      "file:///usr/lib/spark/connector/spark-avro.jar", "gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar"
    ]
  }
}

Para enviar tu solicitud, despliega una de estas opciones:

curl (Linux, macOS o Cloud Shell)

Nota: En el siguiente comando se presupone que has iniciado sesión en la CLI de gcloud con tu cuenta de usuario ejecutando gcloud init o gcloud auth login , o bien usando Cloud Shell, que inicia sesión automáticamente en la CLI de gcloud . Para comprobar qué cuenta está activa, ejecuta gcloud auth list.

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches"

PowerShell (Windows)

Nota: El siguiente comando presupone que has iniciado sesión en la CLI de gcloud con tu cuenta de usuario ejecutando gcloud init o gcloud auth login . Para comprobar qué cuenta está activa, ejecuta gcloud auth list.

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches" | Select-Object -Expand Content

Deberías recibir una respuesta JSON similar a la siguiente:

{
  "name": "projects/PROJECT_ID/regions/REGION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.dataproc.v1.BatchOperationMetadata",
    "batch": "projects/PROJECT_ID/locations/REGION/batches/BATCH_ID",
    "batchUuid": "de8af8d4-3599-4a7c-915c-798201ed1583",
    "createTime": "2023-02-24T03:31:03.440329Z",
    "operationType": "BATCH",
    "description": "Batch"
  }
}