Skip to content

Commit

Permalink
Update default index name to .kibana instead of .opensearch-dashboards (
Browse files Browse the repository at this point in the history
#742) (#743)

Signed-off-by: jeffhuss <[email protected]>
(cherry picked from commit d708863)

Co-authored-by: Jeff Huss <[email protected]>
  • Loading branch information
opensearch-trigger-bot[bot] and Jeff Huss authored Jun 30, 2022
1 parent b2e1c61 commit 889ab48
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions _security-plugin/access-control/multi-tenancy.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@ config:
opensearch-dashboards:
multitenancy_enabled: true
server_username: opensearch
index: '.opensearch-dashboards'
index: '.kibana'
do_not_fail_on_forbidden: false
```
Setting | Description
:--- | :---
`multitenancy_enabled` | Enable or disable multi-tenancy. Default is true.
`server_username` | Must match the name of the OpenSearch Dashboards server user from `opensearch_dashboards.yml`. Default is `dashboardserver`.
`index` | Must match the name of the OpenSearch Dashboards index from `opensearch_dashboards.yml`. Default is `.opensearch-dashboards`.
`index` | Must match the name of the OpenSearch Dashboards index from `opensearch_dashboards.yml`. Default is `.kibana`.
`do_not_fail_on_forbidden` | If 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:
Expand Down Expand Up @@ -155,14 +155,14 @@ _meta:

## 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:
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:

```
.opensearch-dashboards_<hash>_<tenant_name>
.opensearch-dashboards_<hash>_<username>
.kibana_<hash>_<tenant_name>
.kibana_<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.
{: .tip }

To back up your OpenSearch Dashboards data, [take a snapshot]({{site.url}}{{site.baseurl}}/opensearch/snapshot-restore/) of all tenant indices using an index pattern such as `.opensearch-dashboards*`.
To back up your OpenSearch Dashboards data, [take a snapshot]({{site.url}}{{site.baseurl}}/opensearch/snapshot-restore/) of all tenant indices using an index pattern such as `.kibana*`.

0 comments on commit 889ab48

Please sign in to comment.