Menu Docs
Página inicial do Docs
/
MongoDB Atlas
/

Gerenciar registros de conexão

Nesta página

  • Pré-requisitos
  • Visualize conexões no registro de conexões
  • Adicione uma conexão ao registro de conexão
  • Modifique uma conexão a partir do registro de conexão
  • Exclua uma conexão do registro de conexão
  • Listar conexões de link privado
  • Ver uma conexão de link privado
  • Criar uma conexão de link privado
  • Excluir uma conexão de link privado

Cada instância de processamento de streaming armazena todas as conexões configuradas com uma fonte ou coletor de dados de streaming em seu registro de conexões. Os procedimentos desta página orientam você na criação e na configuração das conexões do Atlas Stream Processing.

Para criar e configurar conexões, você deve ter o seguinte:

  • UmprojetoAtlas

  • Um Atlas user com a função Project Owner ou Project Stream Processing Owner para gerenciar um registro de conexão

    Observação

    A função Project Owner permite que você crie sistemas de banco de dados, gerencie o acesso ao projeto e as configurações do projeto, gerencie entradas da lista de acesso IP e muito mais.

    A função Project Stream Processing Owner permite ações do Atlas Stream Processing, como visualizar, criar, excluir e editar instâncias de processamento de fluxo e visualizar, adicionar, modificar e excluir conexões no registro de conexões.

    Consulte Funções de projeto para saber mais sobre as diferenças entre as duas funções.

  • Um cluster do Atlas

Para visualizar uma conexão com sua instância de Atlas Stream Processing:

Para listar todas as conexões de uma instância de Atlas Stream Processing que você especifica utilizando o Atlas CLI, execute o seguinte comando:

atlas streams connections list [options]

Para retornar os detalhes de uma conexão de Atlas Stream Processing que você especifica utilizando o Atlas CLI, execute o seguinte comando:

atlas streams connections describe <streamConnectionName> [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a documentação do Atlas CLI para atlas streams connections list e atlas streams connections describe.

Dica

Veja: links relacionados

1
  1. Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.

  2. Se ainda não estiver exibido, selecione seu projeto no menu Projects na barra de navegação.

  3. Na barra lateral, clique em Stream Processing sob o título Services.

    A página Processamento de fluxo é exibida.

2
  1. Localize o painel de visão geral da instância de processamento de fluxo que contém o registro de conexão que deseja visualizar.

  2. Clique em Configure.

  3. Selecione a guia Connection Registry.

O Atlas Stream Processing exibe todas as conexões disponíveis no registro de conexões da sua instância.

A API de Administração do Atlas fornece diferentes endpoints para recuperar uma ou todas as conexões em um registro de conexão.

Visualizar uma conexão em um registro de conexão

Listar todas as conexões em um registro de conexão

Para listar todas as conexões disponíveis usando mongosh, use o método sp.listConnections(). Ele retorna uma lista de documentos que descrevem cada conexão no registro de conexão da instância de processamento de fluxo. Tem a seguinte sintaxe:

sp.listConnections()

O Atlas Stream Processing é compatível com os seguintes tipos de conexão:

Cada tipo tem requisitos de configuração diferentes.

Importante

O peering de VPC para o Atlas Stream Processing está atualmente em visualização privada. Para saber mais, entre em contato com sua equipe de conta.

Para adicionar uma conexão do Kafka à sua instância de processamento de fluxo:

Para criar uma conexão para a instância de Atlas Stream Processing que você especifica utilizando o Atlas CLI, execute o seguinte comando:

atlas streams connections create [connectionName] [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do Atlas CLI para criação de conexões de fluxos do Atlas.

Dica

Veja: links relacionados

Ao criar uma instância de processamento de fluxo usando o Atlas CLI, você deve fornecer um arquivo de configuração .json para definir os parâmetros da nova conexão. O formato deste arquivo depende do tipo de conexão que você define.

Para uma conexão Apache Kafka, forneça um arquivo de configuração com a seguinte sintaxe:

{
"name": "<name>",
"type": "Kafka",
"bootstrapServers": "<address:port>, ...",
"security": {
"protocol": "<protocol>"
},
"authentication": {
"mechanism": "<auth-mechanism>",
"username": "<username>",
"password": "<password>"
}
}
1
  1. Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.

  2. Se ainda não estiver exibido, selecione seu projeto no menu Projects na barra de navegação.

  3. Na barra lateral, clique em Stream Processing sob o título Services.

    A página Processamento de fluxo é exibida.

2
  1. Localize o painel de visão geral da instância de processamento de fluxo que você deseja modificar e clique em Configure.

  2. Selecione a guia Connection Registry.

3
4
  1. Selecione uma conexão Kafka.

  2. Forneça um Connection Name. Cada nome de conexão deve ser exclusivo dentro de uma instância de processamento de fluxo. Esse é o nome usado para fazer referência à conexão nas agregações do Atlas Stream Processing.

  3. Selecione um tipo Network Access. O Atlas Stream Processing suporta conexões Public IP ou VPC Peering .

    Clique no botão Public IP. Nenhuma configuração adicional é necessária para este tipo de acesso à rede.

    1. Clique no botão VPC Peering.

    2. Ative Enable VPC Peering. O Atlas Stream Processing seleciona automaticamente a conexão de emparelhamento VPC apropriada a partir de suas conexões configuradas.

      Se você não tiver uma conexão de emparelhamento de VPC, configure uma conexão de peering de rede Atlas.

  4. Especifique um endereço IP para um ou mais servidores de startup para seu sistema Apache Kafka.

  5. No menu suspenso, selecione um Security Protocol Method.

    O Atlas Stream Processing é compatível com SASL_PLAINTEXT ou SASL_SSL.

    SASL_PLAINTEXT é incompatível com emparelhamento de VPC. Para usar o emparelhamento VPC, você deve selecionar o método SASL_SSL.

    1. No menu suspenso, selecione um SASL Mechanism.

      O Atlas Stream Processing é compatível com:

      • PLAIN

      • SCRAM-SHA-256

      • SCRAM-SHA-512

    2. Forneça um Username para autenticação.

    3. Forneça uma senha para autenticação.

    4. Clique em Add connection.

    1. No menu suspenso, selecione um SASL Mechanism.

      O Atlas Stream Processing é compatível com:

      • PLAIN

      • SCRAM-SHA-256

      • SCRAM-SHA-512

    2. Clique em Upload para fazer upload do seu Certificate Authority PEM file

    3. Forneça um Username para autenticação.

    4. Forneça uma senha para autenticação.

    5. Clique em Add connection.

A API Atlas Administration fornece um endpoint para adicionar uma conexão a um registro de conexão.

Adicione uma conexão ao registro de conexão

Importante

Depois de adicionar uma conexão externa, como um cluster Apache Kafka ao registro de conexão, você deve adicionar endereços IP do Atlas a uma lista de acesso para essa conexão externa. Para obter mais informações, consulte Permitir acesso de ou para o plano de controle do Atlas.

Importante

O peering de VPC para o Atlas Stream Processing está atualmente em visualização privada. Para saber mais, entre em contato com sua equipe de conta.

Para adicionar uma conexão de banco de dados Atlas à sua instância de processamento de fluxo:

Para criar uma conexão para a instância de Atlas Stream Processing que você especifica utilizando o Atlas CLI, execute o seguinte comando:

atlas streams connections create [connectionName] [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do Atlas CLI para criação de conexões de fluxos do Atlas.

Dica

Veja: links relacionados

Ao criar uma instância de processamento de fluxo usando o Atlas CLI, você deve fornecer um arquivo de configuração .json para definir os parâmetros da nova conexão. O formato deste arquivo depende do tipo de conexão que você define.

Para uma conexão com o banco de dados Atlas, forneça um arquivo de configuração com a seguinte sintaxe:

{
"name": "<name>",
"type": "Cluster",
"clusterName": "<clusterName>"
}
1
  1. Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.

  2. Se ainda não estiver exibido, selecione seu projeto no menu Projects na barra de navegação.

  3. Na barra lateral, clique em Stream Processing sob o título Services.

    A página Processamento de fluxo é exibida.

2
  1. Localize o painel de visão geral da instância de processamento de fluxo que você deseja modificar e clique em Configure.

  2. Selecione a guia Connection Registry.

3
4

Para criar uma nova conexão com um fluxo de alterações do Atlas:

  1. Selecione uma conexão Atlas Database.

  2. Forneça um Connection Name. Cada nome de conexão deve ser exclusivo dentro de uma instância de processamento de fluxo. Este é o nome usado para referenciar a conexão nas agregações do Atlas Stream Processing.

  3. No menu suspenso, selecione um Atlas Cluster. O Atlas Stream Processing está disponível apenas em clusters de nível dedicado.

  4. Clique em Add connection.

A API Atlas Administration fornece um endpoint para adicionar uma conexão a um registro de conexão.

Adicione uma conexão ao registro de conexão

Para adicionar uma conexão HTTPS à sua Instância de Processamento de Stream:

No momento, não é possível criar uma conexão HTTPS para uma Instância de Processamento de Stream usando o Atlas CLI .

No momento, não é possível criar uma conexão HTTPS com uma Instância de Processamento de Stream usando a interface do usuário do Atlas .

A API Atlas Administration fornece um endpoint para adicionar uma conexão a um registro de conexão.

Criar uma conexão

Se o ponto de extremidade da API exigir autenticação, como uma chave de API ou autenticação de Token de Acesso ao Portador, você deverá adicionar detalhes de autenticação como cabeçalhos ao definir a conexão para evitar fornecê-los como texto simples como parte do operador $https .

Outros esquemas de autenticação, como Digest Auth ou OAuth, não são aceitos no momento.

Para saber como usar conexões HTTPS com o Atlas Stream Processing,$https consulte.

Exemplo:

curl --user "<publicApiKey>:<privateApiKey>" --digest \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.atlas.2023-02-01+json" \
--include \
--data '{"name": "HTTPSConnection","type": "Https","url": "<apiBasePath>"}' \
--request POST "https://cloud.mongodb.com/api/atlas/v2/groups/<projectID>/streams/<tenantName>/connections"

Para modificar uma conexão a partir de um registro de conexão:

Para modificar os detalhes de uma conexão na instância do Atlas Stream Processing que você especifica utilizando o Atlas CLI, execute o seguinte comando:

atlas streams connections update <connectionName> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação da Atlas CLI para 32 / 5,000Atualização de conexões de fluxos do Atlas.

Dica

Veja: links relacionados

1
  1. Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.

  2. Se ainda não estiver exibido, selecione seu projeto no menu Projects na barra de navegação.

  3. Na barra lateral, clique em Stream Processing sob o título Services.

    A página Processamento de fluxo é exibida.

2

Localize o painel de visão geral da instância de processamento de stream que contém o registro de conexão que você deseja modificar e clique em Configure no canto superior direito.

3
4
  1. Para a conexão que você deseja modificar na tabela, clique no ícone de lápis na coluna Actions .

    Você pode editar uma conexão somente se ela não estiver sendo usada atualmente por um processador de fluxo. Se você quiser editar uma conexão em uso, interrompa primeiro todos os processadores de fluxo que usam a conexão.

  2. Modifique os campos que você deseja modificar.

  3. Clique em Save changes.

A API de Administração do Atlas fornece um endpoint para edição de uma instância de processamento de fluxo.

Excluir uma instância de fluxo

Para excluir uma conexão de um registro de conexão:

Para remover uma conexão da instância de Atlas Stream Processing que você especifica utilizando o Atlas CLI, execute o seguinte comando:

atlas streams connections delete <connectionName> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do Atlas CLI para excluir conexões de fluxos do Atlas.

Dica

Veja: links relacionados

1
  1. Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.

  2. Se ainda não estiver exibido, selecione seu projeto no menu Projects na barra de navegação.

  3. Na barra lateral, clique em Stream Processing sob o título Services.

    A página Processamento de fluxo é exibida.

2
  1. Localize o painel de visão geral da instância de processamento de fluxo que contém o registro de conexão que você deseja modificar

  2. Clique em Configure no canto superior direito.

  3. Selecione a guia Connection Registry.

3
  1. Para a conexão que você deseja modificar na tabela, clique no ícone da lixeira na coluna Actions dessa entrada.

  2. Quando solicitado, clique em Delete.

A API de Administração do Atlas fornece um endpoint para edição de uma instância de processamento de fluxo.

Excluir uma instância de fluxo

A API de administração do Atlas fornece um endpoint para visualizar todas as conexões de link privado configuradas para o Atlas Stream Processing em um projeto específico.

Retornar todos os links privados

A API de administração do Atlas fornece um endpoint para visualizar os detalhes de uma conexão de link privado configurada para o Atlas Stream Processing em um projeto específico.

Retornar um link privado

Atualmente, o Atlas Stream Processing suporta a criação de conexões de link privado para clusters doAzure e do Confluent hospedados no AWS.

Para criar uma conexão de link privado para usar em seu projeto de Atlas Stream Processing :

Importante

Você não pode ter mais de uma conexão de link privado para um determinado cluster do Confluent por projeto do Atlas . Antes de iniciar esse procedimento, chame o endpoint Return All Private Link Connections. Se você tiver uma conexão de Link Privado existente com seu cluster Confluent no Atlas , mas não dentro de sua conta do Confluent, execute somente as etapas que configuram sua rede do lado do Confluent.

1

Você deve configurar seu cluster Confluent para aceitar conexões de entrada do seu projeto Atlas .

Importante

O confluent aceita conexões de entrada somente do Amazon Web Services. Para usar uma conexão Confluent Private Link, você deve hospedar suas instâncias de processamento de fluxo no Amazon Web Services.

  1. Ligue para o ID de conta de retorno e o ID de VPC para o grupo e a região do endpoint da API de administração do Atlas . Observe o valor de awsAccountId, você precisará disso em uma etapa posterior.

  2. Em sua conta do Confluent, navegue até o cluster ao qual deseja se conectar. Na interface de rede do cluster, navegue até os detalhes de rede do cluster.

  3. Adicionar acesso a link privado

Para um cluster dedicado do Confluent, forneça um nome de sua escolha. Para o número da conta AWS, forneça o valor do awsAccountId campo que você anotou anteriormente.

Observação

Esta etapa não é necessária para clusters sem servidor do Confluent.

2

A API de administração do Atlas fornece um endpoint para solicitar uma conexão de link privado configurada para o Atlas Stream Processing.

Criar um link privado

Para uma conexão do Amazon Web Services Private Link, você deve definir os seguintes pares de chave-valor:

Chave
Valor

serviceEndpointId

O VPC Endpoint service name do seu cluster Confluent.

dnsDomain

Nome de domínio totalmente qualificado do servidor de inicialização no seu cluster Confluent.

dnsSubDomain

Se o seu cluster não usa subdomínios, você deve definir isso para a array vazia []. Se o cluster usar subdomínios, você deverá definir isso como uma array que contenha um nome de subdomínio totalmente qualificado para cada um dos subdomínios do cluster.

Você pode encontrar estes valores nos detalhes de rede do seu cluster Confluent.

O comando de exemplo a seguir solicita uma conexão com seu cluster Confluent e ilustra uma resposta típica:

curl --location 'https://cloud.mongodb.com/api/atlas/v2/groups/8358217d3abb5c76c3434648/streams/privateLinkConnections' \
--digest \
--user "slrntglrbn:933fb118-ac62-4991-db05-ee67a3481fde" \
--header 'Content-Type: application/json' \
--header 'Accept: application/vnd.atlas.2023-02-01+json' \
--data '{ "vendor": "Confluent", "provider": "AWS",
"region": "us_east_1", "serviceEndpointId":
"com.amazonaws.vpce.us-east-1.vpce-svc-93da685022ee702a9",
"dnsDomain": "sample.us-east-1.aws.confluent.cloud",
"dnsSubDomain: [
"use1-az1.sample.us-east-1.aws.confluent.cloud",
"use1-az2.sample.us-east-1.aws.confluent.cloud",
"use1-az4.sample.us-east-1.aws.confluent.cloud"
]
}'
{"_id":"6aa12e7ccd660d4b2380b1c1","dnsDomain":"sample.us-east-1.aws.confluent.cloud.","vendor":"Confluent","provider":"AWS","region":"us_east_1","serviceEndpointId":"com.amazonaws.vpce.us-east-1.vpce-svc-93da685022ee702a9"}

Depois de enviar a solicitação, observe o valor do campo _id no corpo da resposta. Você precisará disso em uma etapa posterior.

3

Observação

Esta etapa se aplica apenas a clusters sem servidor do Confluent.

Ligue para o ponto de extremidade Retornar todas as conexões de link privado. Observe o valor de interfaceEndpointId.

Em sua conta do Confluent, navegue até o cluster ao qual deseja se conectar. Na interface de rede do cluster, navegue até os detalhes de rede do cluster. Navegue até a interface dos pontos de acesso e adicione um novo ponto de acesso. Quando o Confluent solicitar um ponto de extremidade da interface, forneça o valor de interfaceEndpointId que você anotou anteriormente.

4

Adicione uma conexão com os seguintes pares de valores-chave:

Chave
Valor

bootstrapServers

Endereço IP do servidor bootstrap Kafka do seu fornecedor de nuvem .

security.protocol

SASL_SSL

authentication.mechanism

"PLAIN"

authentication.password

A senha associada à sua chave de API Confluent

authentication.username

O nome de usuário associado à sua chave de API Confluent

type

"Kafka"

networking.access.type

"PRIVATE_LINK"

networking.access.connectionId

_id valor da sua resposta à solicitação de Link Privado

Defina todos os outros valores conforme necessário.

O seguinte comando de exemplo cria uma conexão Apache Kafka no Atlas:

curl --location 'https://cloud.mongodb.com/api/atlas/v2/groups/8358217d3abb5c76c3434648/streams/spinstance/connections' \
--digest \
--user "slrntglrbn:933fb118-ac62-4991-db05-ee67a3481fde" \
--header 'Content-Type: application/json' \
--header 'Accept: application/vnd.atlas.2023-02-01+json' \
--data '{
"name": "confluent_demo",
"bootstrapServers": "slr-ntgrbn.sample.us-east-1.aws.confluent.cloud:9092",
"security": {
"protocol": "SASL_SSL"
},
"authentication": {
"mechanism": "PLAIN",
"password": "apiSecretDemo",
"username": "apiUserDemo"
},
"type": "Kafka",
"networking": {
"access": {
"type": "PRIVATE_LINK",
"connectionId": "38972b0cbe9c2aa40a30a246"
}
}
}'
1

A API de administração do Atlas fornece um endpoint para solicitar uma conexão de link privado configurada para o Atlas Stream Processing.

Criar um link privado

Para uma conexão do Azure Private Link, você deve definir os seguintes pares de chave-valor:

Chave
Valor

serviceEndpointId

Seu endpoint donamespace EventHub

dnsDomain

Nome de domínio totalmente qualificado, com número da porta, do servidor de inicialização em seu namespace do Hub de Eventos do Azure. Este nome de domínio está em conformidade com o formato descrito aqui.

O seguinte comando de exemplo solicita uma conexão com seu Azure Event Hub e ilustra uma resposta típica:

curl --location 'https://cloud.mongodb.com/api/atlas/v2/groups/8358217d3abb5c76c3434648/streams/privateLinkConnections' \
--digest \
--user "slrntglrbn:933fb118-ac62-4991-db05-ee67a3481fde" \
--header 'Content-Type: application/json' \
--header 'Accept: application/vnd.atlas.2023-02-01+json' \
--data '{ "provider": "AZURE", "region": "US_EAST_2", "serviceEndpointId": "/subscriptions/b82d6aa0-0b0a-ffa3-7c22-e167dc44f5b0/resourceGroups/asp/providers/Microsoft.EventHub/namespaces/sample", "dnsDomain": "sample.servicebus.windows.net" }'
{"_id":"6aa12e7ccd660d4b2380b1c1","dnsDomain":"sample.servicebus.windows.net","provider":"AZURE","region":"US_EAST_2","serviceEndpointId":"/subscriptions/b82d6aa0-0b0a-ffa3-7c22-e167dc44f5b0/resourceGroups/asp/providers/Microsoft.EventHub/namespaces/sample"}

Depois de enviar a solicitação, observe o valor do campo _id no corpo da resposta. Você precisará disso em uma etapa posterior.

2

Aceite a conexão solicitada em sua conta do provedor de nuvem .

Para conexões de Link Privado com o Azure , navegue até a página de rede do Event Hub e selecione a Private endpoint connections aba. Na tabela de conexões, identifique sua conexão recém-solicitada e aprove-a.

3

Adicione uma conexão com os seguintes pares de valores-chave:

Chave
Valor

bootstrapServers

Endereço IP do servidor bootstrap Kafka do seu fornecedor de nuvem .

security.protocol

SASL_SSL

authentication.mechanism

"PLAIN"

authentication.password

authentication.username

"$ConnectionString"

type

"Kafka"

networking.access.type

"PRIVATE_LINK"

networking.access.connectionId

_id valor da sua resposta à solicitação de Link Privado

Defina todos os outros valores conforme necessário.

O seguinte comando de exemplo cria uma conexão Apache Kafka no Atlas:

curl --location 'https://cloud.mongodb.com/api/atlas/v2/groups/8358217d3abb5c76c3434648/streams/spinstance/connections' \
--digest \
--user "slrntglrbn:933fb118-ac62-4991-db05-ee67a3481fde" \
--header 'Content-Type: application/json' \
--header 'Accept: application/vnd.atlas.2023-02-01+json' \
--data '{ "name": "eventhubpl33333", "bootstrapServers": "sample.servicebus.windows.net:9093", "security": { "protocol": "SASL_SSL" }, "authentication": { "mechanism": "PLAIN", "password": "Endpoint=sb://sample.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=Irlo3OoRkc27T3ZoGOlbhEOqXQRXzb12+Q2hNXm0lc=", "username": "$ConnectionString" }, "type": "Kafka", "networking": { "access": { "type": "PRIVATE_LINK", "connectionId": "38972b0cbe9c2aa40a30a246" } } }'

A API de administração do Atlas fornece um endpoint para excluir uma conexão Private Link configurada para Atlas Stream Processing dentro de um projeto especificado.

Excluir um link privado

Voltar

Gerencie instâncias de processamento de fluxo