Obtendo sequências de conexões

Para se conectar ao IBM Cloud® Databases for Elasticsearch, são necessários alguns usuários e sequências de conexões. As cadeias de conexão de sua implementação são exibidas na página Overview (Visão geral), no painel Endpoints. Essas sequências podem ser usadas com qualquer conjunto de credenciais que você gerar.

Painel de pontos de extremidade
Painel de pontos de extremidade

Uma implementação do Databases for Elasticsearch é provisionada com um usuário administrativo e, após você configurar a senha do administrador, será possível usar as suas credenciais para se conectar à sua implementação.

Obtenção de cadeias de conexão na CLI

Também é possível capturar sequências de conexões por meio da CLI.

ibmcloud cdb deployment-connections example-deployment -u <newusername> [--endpoint-type <endpoint type>]

Informações de conexão integrais são retornadas pelo comando ibmcloud cdb deployment-connections com a sinalização --all. Para recuperar todas as informações de conexão para uma implementação denominada "implementação de exemplo", use o comando a seguir.

ibmcloud cdb deployment-connections example-deployment -u <newusername> --all [--endpoint-type <endpoint type>]

Se você não especificar um usuário, os comandos deployment-connections retornarão informações para o usuário admin por padrão. Se você não especificar um tipo de terminal, a sequência de conexões retornará o terminal público por padrão. Se a sua implementação tiver apenas um terminal privado, você deverá especificar --endpoint-type private ou os comandos retornarão um erro. O tipo de usuário e de terminal não é imposto. Será possível usar qualquer usuário em sua implementação com qualquer terminal (se ambos existirem em sua implementação).

Para usar os comandos da CLI ibmcloud cdb, deve-se instalar o plug-in do Cloud Databases.

Obtenção de cadeias de conexão com a API

Para recuperar as sequências de conexões da API, use o terminal /users/{userid}/connections. Deve-se especificar no caminho qual usuário e qual tipo de terminal (público ou privado) deve ser usado nas sequências de conexões retornadas. O tipo de usuário e de terminal não é imposto. Será possível usar qualquer usuário em sua implementação com qualquer terminal (se ambos existirem em sua implementação).

curl -X GET -H "Authorization: Bearer $APIKEY" 'https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}/{user_id}/connections/{endpoint_type}'

Mais usuários e sequências de conexões

O acesso à sua implementação do Databases for Elasticsearch não é limitado ao usuário administrativo. Você pode criar usuários usando a página Credenciais do serviço, a CLI do IBM Cloud ou a API do IBM Cloud Databases.

Todos os usuários em sua implementação podem usar as sequências de conexões, incluindo sequências de conexões para terminais públicos ou privados.

Criação de usuários a partir da interface do usuário

  1. Navegue até a página de detalhes do recurso para seu serviço.
  2. Clique em Credenciais de serviço para abrir a página Credenciais de serviço.
  3. Clique em Nova credencial.
  4. Escolha um nome descritivo para a sua nova credencial.
  5. (Opcional) Especificar se as novas credenciais usam um terminal público ou privado. Use { "service-endpoints": "public" } / { "service-endpoints": "private" } no campo Incluir Parâmetros de Configuração Sequencial para gerar sequências de conexão usando o terminal especificado. O uso do ponto de extremidade não é obrigatório, pois ele controla quais nomes de host estão nas cadeias de conexão. Os terminais públicos são gerados por padrão.
  6. Clique em Incluir para provisionar as novas credenciais. Um nome do usuário e uma senha, bem como um usuário da Elasticsearch associado é gerado automaticamente.

As novas credenciais aparecem na tabela, e as sequências de conexão estarão disponíveis como JSON em um campo click-to-copy sob Visualizar Credenciais.

Criação de usuários a partir da CLI

Se você gerenciar o seu serviço por meio da CLI da IBM Cloud e do plug-in de bancos de dados em nuvem, será possível criar um novo usuário com cdb user-create. Por exemplo, para criar um novo usuário para uma "implementação de exemplo", use o comando a seguir.

ibmcloud cdb user-create example-deployment <newusername> <newpassword>

Assim que a tarefa for concluída, será possível recuperar as novas sequências de conexões do usuário com o comando ibmcloud cdb deployment-connections.

Criação de usuários com a API

O Terminal de Fundação mostrado no painel Visão geral do seu serviço fornece a URL base para acessar essa implementação por meio da API. Para criar e gerenciar usuários, use a URL base com o terminal /users.

curl -X POST 'https://api.{region}.databases.cloud.ibm.com/v5/ibm/deployments/{id}/users/{user_type}' \
-H "Authorization: Bearer $APIKEY" \
-H "Content-Type: application/json" \
-d '{"user": {"username": "user", "password": "v3ry-1-secUre-pAssword-2"}}'

Para recuperar as sequências de conexões de um usuário, use a URL base com o terminal /users/{userid}/connections.

Adição de usuários a credenciais de serviço na interface do usuário

A criação de um novo usuário da CLI não preenche automaticamente as sequências de conexão desse usuário nas Credenciais de serviço. Se você desejar inclui-las lá, será possível criar uma nova credencial com as informações do usuário existentes.

Insira o nome de usuário e a senha no campo JSON Incluir parâmetros de configuração embutidos ou especifique um arquivo onde as informações JSON são armazenadas. Por exemplo, colocar {"existing_credentials":{"username":"Robert","password":"supersecure"}} no campo gera Credenciais de serviço com o nome de usuário "Robert" e a senha "superseguro" preenchidos nas sequências de conexão.

A geração de credenciais de um usuário existente não verifica ou cria esse usuário.

Detalhamento da sequência de conexões

A seção de HTTPS

A seção "https" de uma credencial criada na página Credenciais de serviço contém informações que são adequadas para aplicativos que fazem conexões com o Elasticsearch.

Informações de conexão Https/URI
Nome do campo Index Descrição
Type Tipo de conexão - para Elasticsearch, é "uri".
Scheme Esquema para um URI - para Elasticsearch, é "https".
Path Caminho para um URI.
Authentication Username O nome do usuário usado para se conectar.
Authentication Password Uma senha para o usuário - pode ser mostrada como $PASSWORD.
Authentication Method Como a autenticação ocorre; a autenticação "direta" é manipulada pelo driver.
Hosts 0... Um nome do host e uma porta aos quais se conectar.
Composed 0... Um URI que combina Scheme (esquema), Authentication (autenticação), Host (host) e Path (caminho).
Certificate Name O nome alocado para o certificado proprietário do serviço para a implementação do banco de dados.
Certificate Base64 Uma versão do certificado codificada em Base64.
  • 0... indica que pode haver uma ou mais dessas entradas em uma matriz.

A seção CLI

A seção "CLI" de uma credencial criada na página Credenciais de serviço contém informações adequadas para conexão com cURL.

informações de conexão curl
Nome do campo Index Descrição
Bin O binário recomendado para a criação de uma conexão; nesse caso, curl.
Composed Um comando formatado para estabelecer uma conexão com a sua implementação. O comando combina o executável Bin, as configurações da variável Environment e usa Arguments como parâmetros da linha de comandos.
Environment Uma lista de chaves/valores configurados como variáveis de ambiente.
Arguments 0... As informações transmitidas como argumentos para o comando mostrado no campo Bin.
Certificate Base64 Um certificado proprietário de serviço usado para confirmar que um aplicativo está se conectando ao servidor apropriado. Ele é codificado em base64.
Certificate Nome O nome alocado para o certificado de propriedade do serviço.
Type O tipo de pacote que usa essas informações de conexão; neste caso, cli.
  • 0... indica que pode haver uma ou mais dessas entradas em uma matriz.