OpenSearch Dashboards multi-tenancy

Private - This tenant is exclusive to each user and can’t be shared. You can’t use it to access routes or index patterns made by the user’s global tenant.
Global - This tenant is shared between every OpenSearch Dashboards user.

The global tenant is not a primary tenant such that any action done within the global tenant is not replicated to a user’s private tenant. If you make a change to your global tenant, you won’t see that change reflected in your private tenant. Some example changes include, but are not limited to:

Change advanced settings
Create index patterns

You might use the private tenant for exploratory work, create detailed visualizations with your team in an 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:

config:
  dynamic:
    opensearch-dashboards:
      multitenancy_enabled: true
      server_username: opensearch
      index: '.kibana'
    do_not_fail_on_forbidden: false

opensearch_dashboards.yml has some additional settings:

Setting	Description
`opensearch.requestHeadersAllowlist`	OpenSearch Dashboards requires that you add all HTTP headers to the allow list so that the headers pass to OpenSearch. Multi-tenancy uses a specific header, `securitytenant`, that must be present with the standard `Authorization` header. If the `securitytenant` header is not on the allow list, OpenSearch Dashboards starts with a red status.
`opensearch_security.multitenancy.enabled`	Enables or disables multi-tenancy in OpenSearch Dashboards. Default is true.
`opensearch_security.multitenancy.tenants.enable_global`	Enables or disables the global tenant. Default is true.
`opensearch_security.multitenancy.tenants.enable_private`	Enables or disables the private tenant. Default is true.
`opensearch_security.multitenancy.tenants.preferred`	Lets 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.
`opensearch_security.multitenancy.enable_filter`	If you have many tenants, you can add a search bar to the top of the list. Default is false.

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

OpenSearch Dashboards

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

REST API

See .

tenants.yml

---
  type: "tenants"
  config_version: 2
## Demo tenants
admin_tenant:
  reserved: false
  description: "Demo tenant for admin user"

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

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

REST API

See .

roles.yml

The open source version of OpenSearch Dashboards saves all objects to a single index: .kibana. 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:

.kibana_<hash>_<tenant_name>

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