PolarDB:PolarSearch quick start

Configuração via Dashboard

1. Criar um usuário:

   1. No painel de navegação à esquerda, acesse a página Management > Security, selecione Internal users e clique em Create internal user.

   2. Na página de criação de usuário, insira um nome de usuário e senha para criá-lo. Por exemplo, crie um usuário chamado testuser com a senha USER@test123 e clique em Create.

2. Criar uma função

   1. No painel de navegação à esquerda, acesse a página Management > Security, selecione Roles e clique em Create role.

   2. As permissões da função incluem permissões de cluster e de índice, configuráveis mediante a adição de grupos de ações. No campo Index, especifique um nome de índice ou utilize o caractere curinga * para corresponder a um conjunto de nomes de índice. Na seção Index permissions, selecione permissões específicas, como somente leitura ou leitura/escrita.

      Exemplo: Crie uma função chamada onlyreadrole com permissões totais de cluster (ilimitado equivale a permissões totais) e permissão de somente leitura para todos os índices com o prefixo indextest.

3. Mapear uma função para um usuário

   1. No painel de navegação à esquerda, acesse a página Management > Security, selecione Roles e clique na função desejada.

   2. Na aba Mapped users, adicione um mapeamento de usuário. Um usuário pode ser mapeado para várias funções e herda as permissões de todas as funções mapeadas.

      Exemplo: Mapeie a função onlyreadrole para o usuário testuser. Isso concede ao usuário testuser as permissões da função onlyreadrole.

Configuração via REST API

Os nós de busca suportam controle de acesso total por meio de APIs. Para mais detalhes, consulte a documentação da API do OpenSearch.

1. Criar um usuário

   curl -X PUT "http://<endpoint>:<port>/_plugins/_security/api/internalusers/<new_user>" \
     --user "<user_name>:<passwd>" \
     -H "Content-Type: application/json" \
     -d '{
       "password": "<new_password>",
       "backend_roles": [],
       "attributes": {}
     }'

   Exemplo: Crie um usuário chamado testuser com a senha USER@test123.

   curl -X PUT "http://<endpoint>:<port>/_plugins/_security/api/internalusers/testuser" \
     --user "<user_name>:<passwd>" \
     -H "Content-Type: application/json" \
     -d '{
       "password": "USER@test123",
       "backend_roles": [],
       "attributes": {}
     }'

2. Criar uma função

   curl -X PUT "http://<endpoint>:<port>/_plugins/_security/api/roles/<role_name>" \
     --user "<user_name>:<passwd>" \
     -H "Content-Type: application/json" \
     -d '{
       "cluster_permissions": ["*"],
       "index_permissions": [
         {
           "index_patterns": ["*"],
           "allowed_actions": ["*"]
         }
       ]
     }'

   • index_patterns: Especifica os índices a serem configurados. Utilize o caractere curinga * para configurar múltiplos índices simultaneamente.

   • allowed_actions: Define as permissões a conceder, como read e write.

   Exemplo: Crie uma função chamada onlyreadrole com permissões totais de cluster e permissão de somente leitura para todos os índices com o prefixo indextest.

   curl -X PUT "http://<endpoint>:<port>/_plugins/_security/api/roles/onlyreadrole" \
     --user "<user_name>:<passwd>" \
     -H "Content-Type: application/json" \
     -d '{
       "cluster_permissions": ["*"],
       "index_permissions": [
         {
           "index_patterns": ["indextest*"],
           "allowed_actions": ["read"]
         }
       ]
     }'

3. Mapear uma função

   curl -X PUT "http://<endpoint>:<port>/_plugins/_security/api/rolesmapping/<role_name>" \
     --user "<user_name>:<passwd>" \
     -H "Content-Type: application/json" \
     -d '{
       "backend_roles": [],
       "hosts": [],
       "users": ["<new_user>"]
     }'

   Exemplo: Mapeie a função onlyreadrole para o usuário testuser. Isso concede ao usuário testuser as permissões da função onlyreadrole.

   curl -X PUT "http://<endpoint>:<port>/_plugins/_security/api/rolesmapping/onlyreadrole" \
     --user "<user_name>:<passwd>" \
     -H "Content-Type: application/json" \
     -d '{
       "backend_roles": [],
       "hosts": [],
       "users": ["testuser"]
     }'