PolarDB:PolarSearch quick start

Dashboard configuration

1. Create a user:

   1. In the left-side navigation pane, go to the Management > Security page, select Internal users, and then click Create internal user.

   2. On the user creation page, enter a username and password to create the user. For example, create a user named testuser with the password USER@test123, and then click Create.

2. Create a role

   1. In the left-side navigation pane, go to the Management > Security page, select Roles, and then click Create role.

   2. Role permissions include cluster permissions and index permissions, which you can configure by adding action groups. In the Index field, specify an index name or use the * wildcard to match a set of index names. In the Index permissions section, select specific permissions, such as read-only or read/write.

      Example: Create a role named onlyreadrole that has full cluster permissions (unlimited is equivalent to full permissions) and read-only permission for all indexes prefixed with indextest.

3. Map a role to a user

   1. In the left-side navigation pane, go to the Management > Security page, select Roles, and then click the target role.

   2. On the Mapped users tab, add a user mapping. A user can be mapped to multiple roles and inherits the permissions of all mapped roles.

      Example: Map the onlyreadrole role to the testuser user. This grants the testuser user the permissions of the onlyreadrole role.

REST API configuration

Search nodes support full access control by using APIs. For more information, see the OpenSearch API documentation.

1. Create a user

   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": {}
     }'

   Example: Create a user named testuser with the password 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. Create a role

   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: Specifies the indexes to be configured. You can use the * wildcard to configure multiple indexes at once.

   • allowed_actions: Specifies the permissions to grant, such as read and write.

   Example: Create a role named onlyreadrole with full cluster permissions and read-only permission for all indexes prefixed with 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. Map a role

   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>"]
     }'

   Example: Map the onlyreadrole role to the testuser user. This grants the testuser user the permissions of the onlyreadrole role.

   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"]
     }'