Crea un tema de importación

Un tema de importación te permite transferir datos de fuentes externas a Pub/Sub. Luego, puedes transmitir los datos a cualquiera de los destinos que admite Pub/Sub.

Pub/Sub admite Amazon Kinesis Data Streams como fuente externa para transferir datos a un tema de importación.

Descripción general de la importación de temas

Un tema de importación tiene habilitada la transferencia en el tema como una propiedad. Esto permite que un importar datos de transmisión de transferencia de temas. Puedes habilitar la transferencia con la consola, Google Cloud CLI, REST llamadas o bibliotecas cliente. Como parte de la administración del tema de importación, Google Cloud proporciona supervisión y escalamiento de la canalización de transferencia.

Sin un tema de importación, transmitir datos a Pub/Sub desde una fuente de datos requiere un servicio adicional. Este servicio adicional extrae datos de la fuente original y los publica en Pub/Sub. El servicio adicional puede ser un motor de transmisión como Apache Spark o un con un servicio de escritura personalizada. También debes configurar, implementar, ejecutar, escalar y supervisar este servicio.

La siguiente es una lista de información importante sobre temas de importación:

• Al igual que con un tema estándar, puedes publicar manualmente en un tema de importación.

• Solo puedes adjuntar una fuente de transferencia a un tema de importación.

Recomendamos importar temas para los datos de transmisión. Si estás considerando transferencia de datos por lotes a BigQuery en lugar de transmitir transferencia de datos, puedes intentar Servicio de transferencia de datos de BigQuery (BQ DTS). Si quieres transferir datos a Cloud Storage, Servicio de transferencia de almacenamiento (STS) es una buena opción.

Antes de comenzar

• Obtén más información sobre el servicio de Pub/Sub y su terminología.

• Obtén más información sobre el proceso de publicación de Pub/Sub.

• Configura los roles y permisos necesarios para administrar los temas de importación, lo que incluye agregar el rol de publicador de Pub/Sub a la cuenta de servicio de Pub/Sub y agregar el rol de usuario de la cuenta de servicio a la cuenta de servicio.

• Configura la federación de identidades para cargas de trabajo para que Google Cloud puede acceder al servicio de transmisión externo.

Roles y permisos obligatorios para administrar los temas de importación

A fin de obtener los permisos que necesitas para crear y administrar temas de importación, solicita a tu administrador que te otorgue el Editor de Pub/Sub(roles/pubsub.editor) IAM en tu tema o proyecto. Si quieres obtener más información para otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

Este rol predefinido contiene los permisos necesarios para crear y administrar temas de importación. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:

También puedes obtener estos permisos con roles personalizados o con otros roles predefinidos.

Puedes configurar el control de acceso en el nivel de proyecto a nivel de los recursos individuales.

Configura la identidad federada para acceder a Kinesis Data Streams

La federación de identidades para cargas de trabajo permite que los servicios de Google Cloud accedan a las cargas de trabajo que se ejecutan fuera de Google Cloud. Con la federación de identidades, no necesitas mantener o pasar credenciales a Google Cloud para acceder a tus recursos en otras nubes. En su lugar, puedes usar las identidades de las cargas de trabajo para autenticarte en Google Cloud y acceder a los recursos.

Crea una cuenta de servicio en Google Cloud

Este paso es opcional. Si ya tienes una cuenta de servicio, puedes usar en este procedimiento, en lugar de crear una cuenta de servicio nueva. Si usas una cuenta de servicio existente, ve a Registra el ID único de la cuenta de servicio para ver el siguiente paso.

Para un tema de importación, Pub/Sub usa la cuenta de servicio como la identidad para acceder a los recursos desde AWS.

Para obtener más información sobre cómo crear una cuenta de servicio, incluidos los requisitos previos, los roles y permisos requeridos, y los lineamientos para asignar nombres, consulta Crea cuentas de servicio. Después de crear una cuenta de servicio, es posible que debas esperar 60 segundos o más usar la cuenta de servicio. Este comportamiento sucede porque las operaciones de lectura tienen coherencia eventual. Es posible que la nueva cuenta de servicio tarde un poco más en ser visible.

Registra el ID único de la cuenta de servicio

Necesitas un ID único de cuenta de servicio para configurar un rol en la consola de AWS.

1. En la consola de Google Cloud, ve a la página de detalles de la Cuenta de servicio.

   Ir a la cuenta de servicio

2. Haz clic en la cuenta de servicio que acabas de crear o en la que planean usar.

3. En la página Detalles de la cuenta de servicio, registra el número de ID único.

   Necesitarás el ID como parte del Sección Crea una función en AWS con una política de confianza personalizada.

Agrega el rol de creador de tokens de cuentas de servicio a la cuenta de servicio de Pub/Sub

El rol de creador de tokens de cuentas de servicio (roles/iam.serviceAccountTokenCreator) permite a las principales crear credenciales de corta duración para una cuenta de servicio. Estos tokens o credenciales se usan para suplantar a la cuenta de servicio.

Para obtener más información sobre el uso de la identidad de cuentas de servicio, consulta Uso de la identidad de cuentas de servicio.

También puedes agregar el rol de publicador de Pub/Sub (roles/pubsub.publisher). durante el procedimiento. Para obtener más información sobre el rol y por qué lo estás agregando, consulta Cómo agregar la función de publicador de Pub/Sub a la cuenta de servicio de Pub/Sub.

1. En la consola de Google Cloud, ve a la página IAM.

   Ir a IAM

2. Habilita la opción Incluir otorgamientos de roles proporcionados por Google.

3. Busca la cuenta de servicio que tiene el formato service-{PROJECT_NUMBER}@gcp-sa-pubsub.iam.gserviceaccount.com.

4. Para esta cuenta de servicio, haz clic en el botón Editar principal.

5. Si es necesario, haz clic en Agregar otro rol.

6. Busca y selecciona el rol de creador de tokens de cuentas de servicio (roles/iam.serviceAccountTokenCreator).

7. Haz clic en Guardar.

Crea una política en AWS

Necesitas una política en AWS para permitir que Pub/Sub se autentique con AWS para que Pub/Sub pueda transferir datos de Kinesis de AWS en tiempo real. Antes de crear una política de AWS, crea un flujo de datos de Kinesis y un consumidor registrado en él. Te recomendamos práctica para restringir los permisos a la transmisión específica.

• Para obtener más información sobre cómo crear un flujo de datos de AWS Kinesis, consulta Flujo de datos de Kinesis.

• Para obtener más información sobre la API de flujo de datos de AWS Kinesis que se usa para para registrar consumidores, consulta RegisterStreamConsumer.

• Para obtener más métodos y más información sobre cómo crear una política en AWS, consulta Crea políticas de IAM.

Para crear una política en AWS, sigue estos pasos:

1. Accede a la consola de administración de AWS y abre la Consola de IAM.

2. En el panel de navegación de la consola de IAM, haz clic en Administración de acceso > Políticas.

3. Haz clic en Crear política.

4. En Seleccionar un servicio, selecciona Kinesis.

5. En Acción permitida, selecciona lo siguiente:

   • Lista > ListShards.

     Esta acción otorga permiso para enumerar los fragmentos de un flujo y proporciona información sobre cada uno de ellos.

   • Leer > SubscribeToShard.

     Esta acción otorga permiso para escuchar un fragmento específico con fan-out mejorado.

   • Leer > DescribeStreamConsumer.

     Esta acción otorga permiso para obtener la descripción de un consumidor de transmisiones registrado.

   Estos permisos abarcan la lectura de la transmisión. Pub/Sub solo admite la lectura de un flujo de Kinesis con fan-out mejorado mediante la API de SubscribeToShard de transmisión.

6. En Recursos, si deseas restringir la política a un flujo o consumidor específico (recomendado), especifica el ARN del consumidor y el ARN del flujo.

7. Haz clic en Agregar más permisos.

8. En Selecciona un servicio, ingresa y selecciona STS.

9. En Acción permitida, selecciona Escritura > AssumeRoleWithWebIdentity.

   Esta acción otorga permiso para obtener un conjunto de medidas de seguridad temporales credenciales para que Pub/Sub se autentique en datos de Kinesis con la federación de identidades.

10. Haz clic en Siguiente.

11. Ingresa un nombre y una descripción para la política.

12. Haz clic en Crear política.

Crea un rol en AWS con una política de confianza personalizada

Debes crear un rol en AWS para que Pub/Sub pueda autenticarse a AWS para transferir datos de Kinesis Data Streams.

Para crear un rol con una política de confianza personalizada, sigue estos pasos:

1. Accede a la consola de administración de AWS y abre la consola de IAM.

2. En el panel de navegación de la consola de IAM, haz clic en Roles.

3. Haz clic en Crear rol.

4. En Seleccionar entidad de confianza, selecciona Política de confianza personalizada.

5. En la sección Política de confianza personalizada, ingresa o pega lo siguiente:

   {
     "Version": "2012-10-17",
     "Statement": [
       {
        "Effect": "Allow",
        "Principal": {
           "Federated": "accounts.google.com"
        },
        "Action": "sts:AssumeRoleWithWebIdentity",
        "Condition": {
            "StringEquals": {
              "accounts.google.com:sub": "<SERVICE_ACCOUNT_UNIQUE_ID>"
            }
         }
       }
     ]
   }
   

   Reemplaza <SERVICE_ACCOUNT_UNIQUE_ID> por el ID único de la cuenta de servicio que registraste en Registra el ID único de la cuenta de servicio.

6. Haz clic en Siguiente.

7. En Agregar permisos, busca y selecciona la política personalizada que acabas de crear.

8. Haz clic en Siguiente.

9. Ingresa el nombre y la descripción del rol.

10. Haz clic en Crear rol.

Agrega el rol de publicador de Pub/Sub a la cuenta de servicio de Pub/Sub

Debes asignar un rol de publicador a la cuenta de servicio de Pub/Sub para que Pub/Sub pueda publicar en el tema de importación desde Kinesis de AWS Data Streams.

• Para habilitar la publicación desde todos los temas en un proyecto, consulta Habilita la publicación desde todos los temas.

• Para habilitar la publicación desde un tema específico (recomendado), consulta Habilita la publicación desde un solo tema.

Habilitar la publicación desde todos los temas

1. En la consola de Google Cloud, ve a la página IAM.

   Ir a IAM

2. Habilita la opción Incluir otorgamientos de roles proporcionados por Google.

3. Busca la cuenta de servicio que tenga el formato service-{PROJECT_NUMBER}@gcp-sa-pubsub.iam.gserviceaccount.com

4. Para esta cuenta de servicio, haz clic en el botón Editar principal.

5. Si es necesario, haz clic en Agregar otro rol.

6. Busca y selecciona el rol de publicador de Pub/Sub (roles/pubsub.publisher).

7. Haz clic en Guardar.

Habilitar la publicación desde un solo tema

Si quieres otorgar el permiso de publicación solo a un tema de importación específico, sigue estos pasos:

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

   At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

2. Ejecuta el comando gcloud pubsub topics add-iam-policy-binding:

   gcloud pubsub topics add-iam-policy-binding TOPIC_ID\
      --member="serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com"\
      --role="roles/pubsub.publisher"

   Reemplaza lo siguiente:

   • TOPIC_ID es el ID del tema de importación.

   • PROJECT_NUMBER es el número del proyecto. Cómo ver el proyecto consulta Identifica proyectos.

Agrega el rol de usuario de la cuenta de servicio a la cuenta de servicio

El rol de usuario de cuenta de servicio (roles/iam.serviceAccountUser) incluye el permiso iam.serviceAccounts.actAs que permite que una principal adjunte un cuenta de servicio a la configuración de transferencia del tema de importación y usar esa tener en cuenta la identidad federada.

Sigue los siguientes pasos:

1. En la consola de Google Cloud, ve a la página IAM.

   Ir a IAM

2. Para la principal que emite las llamadas a crear o actualizar temas, haz clic en el botón Editar principal.

3. Si es necesario, haz clic en Agregar otro rol.

4. Busca y selecciona el rol de usuario de la cuenta de servicio (roles/iam.serviceAccountUser).

5. Haz clic en Guardar.

Crea un tema de importación

Para obtener más información sobre las propiedades asociadas con un tema, consulta Propiedades de un tema.

Asegúrate de haber completado los siguientes procedimientos:

• Configura la identidad federada para acceder a Kinesis Data Streams

• Agrega el rol de publicador de Pub/Sub a la cuenta de servicio de Pub/Sub

• Agrega el rol del usuario de la cuenta de servicio a la cuenta de servicio

Para crear un tema de importación, sigue estos pasos:

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/pubsub"
)

func createTopicWithKinesisIngestion(w io.Writer, projectID, topicID string) error {
	// projectID := "my-project-id"
	// topicID := "my-topic"
	streamARN := "stream-arn"
	consumerARN := "consumer-arn"
	awsRoleARN := "aws-role-arn"
	gcpServiceAccount := "gcp-service-account"

	ctx := context.Background()
	client, err := pubsub.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("pubsub.NewClient: %w", err)
	}
	defer client.Close()

	cfg := &pubsub.TopicConfig{
		IngestionDataSourceSettings: &pubsub.IngestionDataSourceSettings{
			Source: &pubsub.IngestionDataSourceAWSKinesis{
				StreamARN:         streamARN,
				ConsumerARN:       consumerARN,
				AWSRoleARN:        awsRoleARN,
				GCPServiceAccount: gcpServiceAccount,
			},
		},
	}
	t, err := client.CreateTopicWithConfig(ctx, topicID, cfg)
	if err != nil {
		return fmt.Errorf("CreateTopic: %w", err)
	}
	fmt.Fprintf(w, "Kinesis topic created: %v\n", t)
	return nil
}

import com.google.cloud.pubsub.v1.TopicAdminClient;
import com.google.pubsub.v1.IngestionDataSourceSettings;
import com.google.pubsub.v1.Topic;
import com.google.pubsub.v1.TopicName;
import java.io.IOException;

public class CreateTopicWithKinesisIngestionExample {
  public static void main(String... args) throws Exception {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "your-project-id";
    String topicId = "your-topic-id";
    // Kinesis ingestion settings.
    String streamArn = "stream-arn";
    String consumerArn = "consumer-arn";
    String awsRoleArn = "aws-role-arn";
    String gcpServiceAccount = "gcp-service-account";

    createTopicWithKinesisIngestionExample(
        projectId, topicId, streamArn, consumerArn, awsRoleArn, gcpServiceAccount);
  }

  public static void createTopicWithKinesisIngestionExample(
      String projectId,
      String topicId,
      String streamArn,
      String consumerArn,
      String awsRoleArn,
      String gcpServiceAccount)
      throws IOException {
    try (TopicAdminClient topicAdminClient = TopicAdminClient.create()) {
      TopicName topicName = TopicName.of(projectId, topicId);

      IngestionDataSourceSettings.AwsKinesis awsKinesis =
          IngestionDataSourceSettings.AwsKinesis.newBuilder()
              .setStreamArn(streamArn)
              .setConsumerArn(consumerArn)
              .setAwsRoleArn(awsRoleArn)
              .setGcpServiceAccount(gcpServiceAccount)
              .build();
      IngestionDataSourceSettings ingestionDataSourceSettings =
          IngestionDataSourceSettings.newBuilder().setAwsKinesis(awsKinesis).build();

      Topic topic =
          topicAdminClient.createTopic(
              Topic.newBuilder()
                  .setName(topicName.toString())
                  .setIngestionDataSourceSettings(ingestionDataSourceSettings)
                  .build());

      System.out.println("Created topic with Kinesis ingestion settings: " + topic.getAllFields());
    }
  }
}

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID';
// const roleArn = 'arn:aws:iam:...';
// const gcpServiceAccount = 'ingestion-account@...';
// const streamArn = 'arn:aws:kinesis:...';
// const consumerArn = 'arn:aws:kinesis:...';

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

// Creates a client; cache this for further use
const pubSubClient = new PubSub();

async function createTopicWithKinesisIngestion(
  topicNameOrId,
  awsRoleArn,
  gcpServiceAccount,
  streamArn,
  consumerArn
) {
  // Creates a new topic with a schema. Note that you might also
  // pass Encodings.Json or Encodings.Binary here.
  await pubSubClient.createTopic({
    name: topicNameOrId,
    ingestionDataSourceSettings: {
      awsKinesis: {
        awsRoleArn,
        gcpServiceAccount,
        streamArn,
        consumerArn,
      },
    },
  });
  console.log(`Topic ${topicNameOrId} created with AWS Kinesis ingestion.`);
}

from google.cloud import pubsub_v1
from google.pubsub_v1.types import Topic
from google.pubsub_v1.types import IngestionDataSourceSettings

# TODO(developer)
# project_id = "your-project-id"
# topic_id = "your-topic-id"
# stream_arn = "your-stream-arn"
# consumer_arn = "your-consumer-arn"
# aws_role_arn = "your-aws-role-arn"
# gcp_service_account = "your-gcp-service-account"

publisher = pubsub_v1.PublisherClient()
topic_path = publisher.topic_path(project_id, topic_id)

request = Topic(
    name=topic_path,
    ingestion_data_source_settings=IngestionDataSourceSettings(
        aws_kinesis=IngestionDataSourceSettings.AwsKinesis(
            stream_arn=stream_arn,
            consumer_arn=consumer_arn,
            aws_role_arn=aws_role_arn,
            gcp_service_account=gcp_service_account,
        )
    ),
)

topic = publisher.create_topic(request=request)

print(f"Created topic: {topic.name} with AWS Kinesis Ingestion Settings")

namespace pubsub = ::google::cloud::pubsub;
namespace pubsub_admin = ::google::cloud::pubsub_admin;
[](pubsub_admin::TopicAdminClient client, std::string project_id,
   std::string topic_id, std::string stream_arn, std::string consumer_arn,
   std::string aws_role_arn, std::string gcp_service_account) {
  google::pubsub::v1::Topic request;
  request.set_name(
      pubsub::Topic(std::move(project_id), std::move(topic_id)).FullName());
  auto* aws_kinesis =
      request.mutable_ingestion_data_source_settings()->mutable_aws_kinesis();
  aws_kinesis->set_stream_arn(stream_arn);
  aws_kinesis->set_consumer_arn(consumer_arn);
  aws_kinesis->set_aws_role_arn(aws_role_arn);
  aws_kinesis->set_gcp_service_account(gcp_service_account);

  auto topic = client.CreateTopic(request);
  // Note that kAlreadyExists is a possible error when the library retries.
  if (topic.status().code() == google::cloud::StatusCode::kAlreadyExists) {
    std::cout << "The topic already exists\n";
    return;
  }
  if (!topic) throw std::move(topic).status();

  std::cout << "The topic was successfully created: " << topic->DebugString()
            << "\n";
}

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const topicNameOrId = 'YOUR_TOPIC_NAME_OR_ID';
// const roleArn = 'arn:aws:iam:...';
// const gcpServiceAccount = 'ingestion-account@...';
// const streamArn = 'arn:aws:kinesis:...';
// const consumerArn = 'arn:aws:kinesis:...';

// Imports the Google Cloud client library
import {PubSub} from '@google-cloud/pubsub';

// Creates a client; cache this for further use
const pubSubClient = new PubSub();

async function createTopicWithKinesisIngestion(
  topicNameOrId: string,
  awsRoleArn: string,
  gcpServiceAccount: string,
  streamArn: string,
  consumerArn: string
) {
  // Creates a new topic with a schema. Note that you might also
  // pass Encodings.Json or Encodings.Binary here.
  await pubSubClient.createTopic({
    name: topicNameOrId,
    ingestionDataSourceSettings: {
      awsKinesis: {
        awsRoleArn,
        gcpServiceAccount,
        streamArn,
        consumerArn,
      },
    },
  });
  console.log(`Topic ${topicNameOrId} created with AWS Kinesis ingestion.`);
}

Para obtener más información sobre los ARN, consulta Nombres de recursos de Amazon (ARN) e Identificadores de IAM.

Si tienes problemas, consulta Cómo solucionar problemas con un tema de importación.

Cómo editar un tema de importación

Puedes editar la configuración de la fuente de datos de transferencia de un tema de importación. Sigue los siguientes pasos:

Cuotas y límites para los temas de importación

La capacidad de procesamiento del publicador para los temas de importación está vinculada por la cuota de publicación del tema. Para obtener más información, consulta Cuotas y límites de Pub/Sub.

¿Qué sigue?

• Supervisa un tema de importación.

• Elige el tipo de suscripción de tu tema.

• Obtén más información para publicar un mensaje en un tema.

• Crear o modificar un tema con gcloud CLI APIs de REST o bibliotecas cliente.

• Soluciona problemas de un tema de importación.

• Pasos para configurar el trabajo de transferencia de almacenamiento para transferir datos de AWS S3 a GCS.