OpenSearch Dashboards multi-tenancy

Tenants in OpenSearch Dashboards are spaces for saving index patterns, visualizations, dashboards, and other OpenSearch Dashboards objects. By default, all OpenSearch Dashboards users have access to two tenants: Private and Global. The global tenant is shared between every OpenSearch Dashboards user. The private tenant is exclusive to each user and can’t be shared.

Tenants are useful for safely sharing your work with other OpenSearch Dashboards users. You can control which roles have access to a tenant and whether those roles have read or write access.

You might use the private tenant for exploratory work, create detailed visualizations with your team in an analysts tenant, and maintain a summary dashboard for corporate leadership in an executive tenant.

If you share a visualization or dashboard with someone, you can see that the URL includes the tenant:

  1. http://<opensearch_dashboards_host>:5601/app/opensearch-dashboards?security_tenant=analysts#/visualize/edit/c501fa50-7e52-11e9-ae4e-b5d69947d32e?_g=()

Configuration

Multi-tenancy is enabled by default, but you can disable it or change its settings using plugins/opensearch-security/securityconfig/config.yml:

  1. config:
  2.   dynamic:
  3.     opensearch-dashboards:
  4.       multitenancy_enabled: true
  5.       server_username: kibanaserver
  6.       index: '.opensearch-dashboards'
  7.     do_not_fail_on_forbidden: false
SettingDescription
multitenancy_enabledEnable or disable multi-tenancy. Default is true.
server_usernameMust match the name of the OpenSearch Dashboards server user from opensearch_dashboards.yml. Default is kibanaserver.
indexMust match the name of the OpenSearch Dashboards index from opensearch_dashboards.yml. Default is .opensearch-dashboards.
do_not_fail_on_forbiddenIf true, the security plugin removes any content that a user is not allowed to see from search results. If false, the plugin returns a security exception. Default is false.

opensearch_dashboards.yml has some additional settings:

  1. opensearch.username: kibanaserver
  2. opensearch.password: kibanaserver
  3. opensearch.requestHeadersWhitelist: ["securitytenant","Authorization"]
  4. plugins.security.multitenancy.enabled: true
  5. plugins.security.multitenancy.tenants.enable_global: true
  6. plugins.security.multitenancy.tenants.enable_private: true
  7. plugins.security.multitenancy.tenants.preferred: ["Private", "Global"]
  8. plugins.security.multitenancy.enable_filter: false
SettingDescription
opensearch.requestHeadersWhitelistOpenSearch Dashboards requires that you whitelist all HTTP headers that it passes to OpenSearch. Multi-tenancy uses a specific header, securitytenant, that must be present with the standard Authorization header. If the securitytenant header is not whitelisted, OpenSearch Dashboards starts with a red status.
plugins.security.multitenancy.enabledEnables or disables multi-tenancy in OpenSearch Dashboards. Default is true.
plugins.security.multitenancy.tenants.enable_globalEnables or disables the global tenant. Default is true.
plugins.security.multitenancy.tenants.enable_privateEnables or disables the private tenant. Default is true.
plugins.security.multitenancy.tenants.preferredLets you change ordering in the Tenants tab of OpenSearch Dashboards. By default, the list starts with global and private (if enabled) and then proceeds alphabetically. You can add tenants here to move them to the top of the list.
plugins.security.multitenancy.enable_filterIf you have many tenants, you can add a search bar to the top of the list. Default is false.

Add tenants

To create tenants, use OpenSearch Dashboards, the REST API, or tenants.yml.

OpenSearch Dashboards

  1. Open OpenSearch Dashboards.
  2. Choose Security, Tenants, and Create tenant.
  3. Give the tenant a name and description.
  4. Choose Create.

REST API

See Create tenant.

tenants.yml

  1. ---
  2. _meta:
  3.   type: "tenants"
  4.   config_version: 2
  6. ## Demo tenants
  7. admin_tenant:
  8.   reserved: false
  9.   description: "Demo tenant for admin user"

Give roles access to tenants

After creating a tenant, give a role access to it using OpenSearch Dashboards, the REST API, or roles.yml.

  • Read-write (kibana_all_write) permissions let the role view and modify objects in the tenant.
  • Read-only (kibana_all_read) permissions let the role view objects, but not modify them.

OpenSearch Dashboards

  1. Open OpenSearch Dashboards.
  2. Choose Security, Roles, and a role.
  3. For Tenant permissions, add tenants, press Enter, and give the role read and/or write permissions to it.

REST API

See Create role.

roles.yml

  1. ---
  2. test-role:
  3.   reserved: false
  4.   hidden: false
  5.   cluster_permissions:
  6.   - "cluster_composite_ops"
  7.   - "indices_monitor"
  8.   index_permissions:
  9.   - index_patterns:
  10.     - "movies*"
  11.     dls: ""
  12.     fls: []
  13.     masked_fields: []
  14.     allowed_actions:
  15.     - "read"
  16.   tenant_permissions:
  17.   - tenant_patterns:
  18.     - "human_resources"
  19.     allowed_actions:
  20.     - "kibana_all_read"
  21.   static: false
  22. _meta:
  23.   type: "roles"
  24.   config_version: 2

Manage OpenSearch Dashboards indices

The open source version of OpenSearch Dashboards saves all objects to a single index: .opensearch-dashboards. The security plugin uses this index for the global tenant, but separate indices for every other tenant. Each user also has a private tenant, so you might see a large number of indices that follow two patterns:

  1. .opensearch_dashboards_<hash>_<tenant_name>
  2. .opensearch_dashboards_<hash>_<username>

The security plugin scrubs these index names of special characters, so they might not be a perfect match of tenant names and usernames.

To back up your OpenSearch Dashboards data, take a snapshot of all tenant indices using an index pattern such as .opensearch-dashboards*.