Um tópico de importação do Amazon Managed Streaming for Apache Kafka (Amazon MSK) permite-lhe carregar continuamente dados do Amazon MSK como uma origem externa e para o Pub/Sub. Em seguida, pode transmitir os dados para qualquer um dos destinos suportados pelo Pub/Sub.
Este documento mostra como criar e gerir tópicos de importação do Amazon MSK. Para criar um tópico padrão, consulte o artigo Crie um tópico padrão.
Para mais informações sobre tópicos de importação, consulte o artigo Acerca dos tópicos de importação.
Antes de começar
Saiba mais sobre o processo de publicação do Pub/Sub.
Configure as funções e as autorizações necessárias para gerir tópicos de importação do Amazon MSK, incluindo o seguinte:
Configure a federação de identidade da carga de trabalho para que o Trusted Cloud possa aceder ao serviço de streaming externo.
Funções e autorizações necessárias
Para receber as autorizações de que
precisa para criar e gerir tópicos de importação do Amazon MSK,
peça ao seu administrador para lhe conceder a função de IAM de
editor do Pub/Sub (roles/pubsub.editor
)
no seu tópico ou projeto.
Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.
Esta função predefinida contém as autorizações necessárias para criar e gerir tópicos de importação do Amazon MSK. Para ver as autorizações exatas que são necessárias, expanda a secção Autorizações necessárias:
Autorizações necessárias
São necessárias as seguintes autorizações para criar e gerir tópicos de importação do Amazon MSK:
-
Crie um tópico de importação:
pubsub.topics.create
-
Elimine um tópico de importação:
pubsub.topics.delete
-
Obtenha um tópico de importação:
pubsub.topics.get
-
Indique um tópico de importação:
pubsub.topics.list
-
Publicar num tópico de importação:
pubsub.topics.publish and pubsub.serviceAgent
-
Atualize um tópico de importação:
pubsub.topics.update
-
Obtenha a Política IAM para um tópico de importação:
pubsub.topics.getIamPolicy
-
Configure a política IAM para um tópico de importação:
pubsub.topics.setIamPolicy
Também pode conseguir estas autorizações com funções personalizadas ou outras funções predefinidas.
Pode configurar o controlo de acesso ao nível do projeto e ao nível do recurso individual.
Configure a identidade federada para aceder ao Amazon MSK
A federação de identidades da carga de trabalho permite que os Trusted Cloud serviços acedam a cargas de trabalho executadas fora do Trusted Cloud. Com a federação de identidades, não precisa de manter nem transmitir credenciais para Trusted Cloud aceder aos seus recursos noutras nuvens. Em alternativa, pode usar as identidades das próprias cargas de trabalho para fazer a autenticação no Trusted Cloud e aceder aos recursos.
Crie uma conta de serviço em Trusted Cloud
Este passo é opcional. Se já tiver uma conta de serviço, pode usá-la neste procedimento em vez de criar uma nova conta de serviço. Se estiver a usar uma conta de serviço existente, aceda a Registe o ID exclusivo da conta de serviço para o passo seguinte.
Para tópicos de importação do Amazon MSK, o Pub/Sub usa a conta de serviço como a identidade para aceder a recursos da AWS.
Para mais informações sobre como criar uma conta de serviço, incluindo pré-requisitos, funções e autorizações necessárias, e diretrizes de nomenclatura, consulte o artigo Crie contas de serviço. Depois de criar uma conta de serviço, pode ter de aguardar 60 segundos ou mais antes de usar a conta de serviço. Este comportamento ocorre porque as operações de leitura são eventualmente consistentes. Pode demorar algum tempo até que a nova conta de serviço fique visível.
Registe o ID exclusivo da conta de serviço
Precisa de um ID exclusivo da conta de serviço para configurar uma função na consola da AWS.
Na Trusted Cloud consola, aceda à página de detalhes da conta de serviço.
Clique na conta de serviço que acabou de criar ou na que planeia usar.
Na página Detalhes da conta de serviço, registe o número do ID exclusivo.
Precisa do ID como parte do fluxo de trabalho para configurar uma função na consola da AWS.
Adicione a função de criador de tokens da conta de serviço à conta de serviço do Pub/Sub
A função de criador de tokens de contas de serviço (roles/iam.serviceAccountTokenCreator
)
permite que os principais criem credenciais de curta duração
para uma conta de serviço. Estes tokens ou credenciais são usados para se fazer passar pela conta de serviço.
Para mais informações sobre a simulação da conta de serviço, consulte o artigo Simulação da conta de serviço.
Também pode adicionar a função de publicador do Pub/Sub (roles/pubsub.publisher
)
durante este procedimento. Para mais informações sobre a função e o motivo pelo qual a está a adicionar,
consulte o artigo Adicione a função de publicador do Pub/Sub à conta de serviço do Pub/Sub.
Na Trusted Cloud consola, aceda à página IAM.
Clique na caixa de verificação Incluir concessões de funções fornecidas pela Google. S3NS
Procure a conta de serviço com o formato
service-{PROJECT_NUMBER}@gcp-sa-pubsub.s3ns-system.iam.gserviceaccount.com
.Para esta conta de serviço, clique no botão Editar principal.
Se necessário, clique em Adicionar outra função.
Pesquise e clique na função Criador de tokens de conta de serviço (
roles/iam.serviceAccountTokenCreator
).Clique em Guardar.
Crie uma política na AWS
Precisa de uma política na AWS para permitir que o Pub/Sub se autentique na AWS, de modo que o Pub/Sub possa carregar dados do Amazon MSK.
- Para ver mais métodos e informações sobre como criar uma política na AWS, consulte o artigo Criar políticas de IAM.
Para criar uma política na AWS, siga estes passos:
Inicie sessão na AWS Management Console e abra a consola do IAM.
No painel de navegação da consola do IAM, clique em Gestão de acesso > Políticas.
Clique em Criar política.
Para Clique num serviço, clique em MSK.
Para Ação permitida,clique em Ler > GetBootstrapBrokers.
Esta ação concede autorização para obter os agentes de arranque que o Pub/Sub usa para se ligar ao cluster MSK.
Clique em Adicionar mais autorizações.
Para Selecionar um serviço, clique em APIs Apache Kafka para MSK.
Para Ação permitida, selecione o seguinte:
List > DescribeTopic
Esta ação concede autorização para permitir que o tópico de carregamento do Pub/Sub obtenha detalhes sobre o tópico do Amazon MSK Kafka.
Read > ReadData
Esta ação concede autorização para ler dados do tópico do Amazon MSK Kafka.
Escrever > Ligar
Esta ação concede autorização para estabelecer ligação e autenticar no cluster Kafka do Amazon MSK.
Para Recursos, especifique o ARN do cluster (se quiser restringir a política a clusters específicos, o que é recomendado).
Clique em Adicionar mais autorizações.
Em Selecionar um serviço, clique em STS.
Para Ação permitida, clique em Escrever > AssumeRoleWithWebIdentity.
Esta ação concede autorização para obter um conjunto de credenciais de segurança temporárias para o Pub/Sub para autenticar no Amazon MSK através da federação de identidades.
Clicar em Seguinte.
Introduza um nome e uma descrição para a política.
Clique em Criar política.
Crie uma função na AWS com uma política de confiança personalizada
Tem de criar uma função na AWS para que o Pub/Sub possa autenticar-se na AWS para carregar dados do Amazon MSK.
Inicie sessão na AWS Management Console e abra a consola do IAM.
No painel de navegação da consola do IAM, clique em Funções.
Clique em Criar função.
Em Selecionar entidade fidedigna, clique em Política de fidedignidade personalizada.
Na secção Política de fidedignidade personalizada, introduza ou cole o seguinte:
{ "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>" } } } ] }
Substitua
<SERVICE_ACCOUNT_UNIQUE_ID>
pelo ID exclusivo da conta de serviço que registou em Registe o ID exclusivo da conta de serviço.Clicar em Seguinte.
Para Adicionar autorizações, pesquise e clique na política personalizada que acabou de criar.
Clicar em Seguinte.
Introduza um nome e uma descrição para a função.
Clique em Criar função.
Adicione a função de publicador do Pub/Sub ao principal do Pub/Sub
Para ativar a publicação, tem de atribuir uma função de publicador à conta de serviço do Pub/Sub para que o Pub/Sub possa publicar no tópico de importação do Amazon MSK.
Adicione a função de agente de serviço do Pub/Sub à conta de serviço do Pub/Sub
Para permitir que o Pub/Sub use a quota de publicação do projeto do tópico de importação, o agente de serviço do Pub/Sub requer a autorização serviceusage.services.use
no projeto do tópico de importação.
Para conceder esta autorização, recomendamos que adicione a função de agente do serviço Pub/Sub à conta de serviço Pub/Sub.
Se a conta de serviço do Pub/Sub não tiver a função de agente de serviço do Pub/Sub, pode ser concedida da seguinte forma:
Na Trusted Cloud consola, aceda à página IAM.
Clique na caixa de verificação Incluir concessões de funções fornecidas pela Google. S3NS
Procure a conta de serviço com o formato
service-{PROJECT_NUMBER}@gcp-sa-pubsub.s3ns-system.iam.gserviceaccount.com
.Para esta conta de serviço, clique no botão Editar principal.
Se necessário, clique em Adicionar outra função.
Pesquise e clique na função de agente do serviço Pub/Sub (
roles/pubsub.serviceAgent
).Clique em Guardar.
Ative a publicação de todos os tópicos
Use este método se não tiver criado tópicos de importação do Amazon MSK.
Na Trusted Cloud consola, aceda à página IAM.
Clique na caixa de verificação Incluir concessões de funções fornecidas pela Google. S3NS
Procure a conta de serviço com o formato
service-{PROJECT_NUMBER}@gcp-sa-pubsub.s3ns-system.iam.gserviceaccount.com
.Para esta conta de serviço, clique no botão Editar principal.
Se necessário, clique em Adicionar outra função.
Pesquise e clique na função de publicador do Pub/Sub (
roles/pubsub.publisher
).Clique em Guardar.
Ative a publicação a partir de um único tópico
Use este método apenas se o tópico de importação do Amazon MSK já existir.
In the Trusted Cloud console, activate Cloud Shell.
At the bottom of the Trusted 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.
Execute o 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.s3ns-system.iam.gserviceaccount.com" \ --role="roles/pubsub.publisher"
Substitua o seguinte:
TOPIC_ID
: o ID do tópico do tópico de importação do Amazon MSK.PROJECT_NUMBER
: o número do projeto. Para ver o número do projeto, consulte o artigo Identificar projetos.
Na Trusted Cloud consola, aceda à página IAM.
Para o principal que está a emitir as chamadas de criação ou atualização de tópicos, clique no botão Editar principal.
Se necessário, clique em Adicionar outra função.
Pesquise e clique na função Utilizador da conta de serviço (
roles/iam.serviceAccountUser
).Clique em Guardar.
A criação do tópico e da subscrição em separado, mesmo que seja feita em rápida sucessão, pode levar à perda de dados. Existe um curto período durante o qual o tópico existe sem uma subscrição. Se forem enviados dados para o tópico durante este período, estes são perdidos. Se criar primeiro o tópico, criar a subscrição e, em seguida, converter o tópico num tópico de importação, garante que não perde nenhuma mensagem durante o processo de importação.
Se precisar de recriar o tópico do Kafka de um tópico de importação existente com o mesmo nome, não pode apenas eliminar o tópico do Kafka e recriá-lo. Esta ação pode invalidar a gestão de deslocamentos do Pub/Sub, o que pode levar à perda de dados. Para mitigar esta situação, siga estes passos:
- Elimine o tópico de importação do Pub/Sub.
- Elimine o tópico do Kafka.
- Crie o tópico do Kafka.
- Crie o tópico de importação do Pub/Sub.
Os dados de um tópico do Amazon MSK Kafka são sempre lidos a partir do desvio mais antigo.
Adicione a função de publicador do Pub/Sub à conta de serviço do Pub/Sub
Adicione a função de utilizador da conta de serviço à conta de serviço
Na Trusted Cloud consola, aceda à página Tópicos.
Clique em Criar tópico.
No campo ID do tópico, introduza um ID para o tópico de importação do Amazon MSK. Para mais informações sobre a nomenclatura de tópicos, consulte as diretrizes de nomenclatura.
Selecione Adicionar uma subscrição predefinida.
Selecione Ativar carregamento.
Para a origem da ingestão, selecione Amazon MSK.
Introduza os seguintes detalhes:
- ARN do cluster: o ARN do Amazon MSK que está a carregar para o Pub/Sub. O formato ARN é o seguinte:
arn:aws:kafka:${Region}:${Account}:cluster/${ClusterName}/${ClusterId}
. - Tópico: o nome do tópico do Amazon MSK Kafka que está a carregar para o Pub/Sub.
- ARN da função do AWS: o ARN da função do AWS. O formato ARN da função é o seguinte:
arn:aws:iam::${Account}:role/${RoleName}
. - Conta de serviço: a conta de serviço que criou em Crie uma conta de serviço em Trusted Cloud.
- ARN do cluster: o ARN do Amazon MSK que está a carregar para o Pub/Sub. O formato ARN é o seguinte:
Clique em Criar tópico.
-
In the Trusted Cloud console, activate Cloud Shell.
At the bottom of the Trusted 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.
Execute o comando
gcloud pubsub topics create
:gcloud pubsub topics create TOPIC_ID \ --aws-msk-ingestion-cluster-arn MSK_CLUSTER_ARN \ --aws-msk-ingestion-topic MSK_TOPIC \ --aws-msk-ingestion-aws-role-arn MSK_ROLE_ARN \ --aws-msk-ingestion-service-account PUBSUB_SERVICE_ACCOUNT
Substitua o seguinte:
TOPIC_ID
: o nome ou o ID do tópico do Pub/Sub.MSK_CLUSTER_ARN
: o ARN do cluster do Amazon MSK que está a carregar para o Pub/Sub. O formato ARN é o seguinte:arn:aws:kafka:${Region}:${Account}:cluster/${ClusterName}/${ClusterId}
.MSK_TOPIC
: o nome do tópico do Kafka do Amazon MSK que está a carregar para o Pub/Sub.MSK_ROLE_ARN
: o ARN da função do AWS. O formato ARN da função é o seguinte:arn:aws:iam::${Account}:role/${RoleName}
.PUBSUB_SERVICE_ACCOUNT
: a conta de serviço que criou em Crie uma conta de serviço no Google Cloud.
Na Trusted Cloud consola, aceda à página Tópicos.
Clique no tópico de importação do Amazon MSK.
Na página de detalhes do tópico, clique em Editar.
Atualize os campos que quer alterar.
Clique em Atualizar.
-
In the Trusted Cloud console, activate Cloud Shell.
At the bottom of the Trusted 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.
Execute o comando
gcloud pubsub topics update
com todas as flags mencionadas no seguinte exemplo:gcloud pubsub topics update TOPIC_ID \ --aws-msk-ingestion-cluster-arn MSK_CLUSTER_ARN \ --aws-msk-ingestion-topic MSK_TOPIC \ --aws-msk-ingestion-aws-role-arn MSK_ROLE_ARN \ --aws-msk-ingestion-service-account PUBSUB_SERVICE_ACCOUNT
Substitua o seguinte:
- TOPIC_ID: o nome ou o ID do seu tópico do Pub/Sub.
- MSK_CLUSTER_ARN: o ARN do cluster do Amazon MSK que está a carregar para o Pub/Sub. O formato ARN
é o seguinte:
arn:aws:kafka:${Region}:${Account}:cluster/${ClusterName}/${ClusterId}
. - MSK_TOPIC: o nome do tópico do Amazon MSK Kafka que está a carregar para o Pub/Sub.
- MSK_ROLE_ARN: o ARN da função do AWS. O formato ARN da função é o seguinte:
arn:aws:iam::${Account}:role/${RoleName}
. - PUBSUB_SERVICE_ACCOUNT: a conta de serviço que criou em Crie uma conta de serviço no Google Cloud.
Escolha o tipo de subscrição para o seu tópico.
Saiba como publicar uma mensagem num tópico.
Crie ou modifique um tópico com a CLI gcloud, as APIs REST ou as bibliotecas cliente.
Adicione a função de utilizador da conta de serviço à conta de serviço
A função de utilizador da conta de serviço (roles/iam.serviceAccountUser
) inclui a autorização iam.serviceAccounts.actAs
que permite a um principal anexar uma conta de serviço às definições de carregamento do tópico de importação do Amazon MSK e usar essa conta de serviço para a identidade federada.
Use tópicos de importação do Amazon MSK
Pode criar um novo tópico de importação ou editar um tópico existente.
Considerações
Crie tópicos de importação do Amazon MSK
Para saber mais sobre as propriedades associadas a um tópico, consulte o artigo Propriedades de um tópico.
Certifique-se de que concluiu os seguintes procedimentos:
Para criar um tópico de importação do Amazon MSK, siga estes passos:
Consola
gcloud
C++
Antes de experimentar este exemplo, siga as instruções de configuração do C++ no artigo Início rápido: usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API C++ do Pub/Sub.
Ir
O exemplo seguinte usa a versão principal da biblioteca de cliente Go Pub/Sub (v2). Se ainda estiver a usar a biblioteca v1, consulte o guia de migração para a v2. Para ver uma lista de exemplos de código da v1, consulte os exemplos de código descontinuados.
Antes de experimentar este exemplo, siga as instruções de configuração do Go em Início rápido: usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Go do Pub/Sub.
Java
Antes de experimentar este exemplo, siga as instruções de configuração do Java no artigo Início rápido: usar bibliotecas cliente. Para mais informações, consulte a documentação de referência da API Java do Pub/Sub.
Node.js
Antes de experimentar este exemplo, siga as instruções de configuração do Node.js em Início rápido: usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Node.js do Pub/Sub.
Node.ts
Antes de experimentar este exemplo, siga as instruções de configuração do Node.js em Início rápido: usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Node.js do Pub/Sub.
Python
Antes de experimentar este exemplo, siga as instruções de configuração do Python em Início rápido: usar bibliotecas cliente. Para mais informações, consulte a documentação de referência da API Python Pub/Sub.
Para mais informações sobre ARNs, consulte os artigos Nomes de recursos da Amazon (ARNs) e Identificadores do IAM.
Se tiver problemas, consulte o artigo Resolução de problemas de um tópico de importação do Amazon MSK.
Edite tópicos de importação do Amazon MSK
Para editar as definições da origem de dados de carregamento de um tópico de importação do Amazon MSK, siga estes passos:
Consola
gcloud
Quotas e limites
O débito do publicador para tópicos de importação está limitado pela quota de publicação do tópico. Para mais informações, consulte o artigo Quotas e limites do Pub/Sub.