for cluster manager term update (#691)

* for cluster manager term update

Signed-off-by: alicejw <alicejw@amazon.com>

* for small fix

Signed-off-by: alicejw <alicejw@amazon.com>

* to change  to

Signed-off-by: alicejw <alicejw@amazon.com>
This commit is contained in:
Alice Williams 2022-06-20 11:53:51 -07:00 committed by GitHub
parent 2e6f38487d
commit 8909564891
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 9 deletions

View File

@ -39,15 +39,15 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensear
Parameter | Type | Description Parameter | Type | Description
:--- | :--- | :--- :--- | :--- | :---
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false. local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is false.
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds. cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
## Response ## Response
``` ```
name | index_patterns order version composed_of name | index_patterns order version composed_of
tenant_template | [kibana*] | 0 | tenant_template | [opensearch-dashboards*] | 0 |
``` ```
To learn more about index templates, see [Index templates]({{site.url}}{{site.baseurl}}/opensearch/index-templates). To learn more about index templates, see [Index templates]({{site.url}}{{site.baseurl}}/opensearch/index-templates).

View File

@ -36,7 +36,7 @@ config:
dynamic: dynamic:
opensearch-dashboards: opensearch-dashboards:
multitenancy_enabled: true multitenancy_enabled: true
server_username: kibanaserver server_username: opensearch
index: '.opensearch-dashboards' index: '.opensearch-dashboards'
do_not_fail_on_forbidden: false do_not_fail_on_forbidden: false
``` ```
@ -44,15 +44,15 @@ config:
Setting | Description Setting | Description
:--- | :--- :--- | :---
`multitenancy_enabled` | Enable or disable multi-tenancy. Default is true. `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 `kibanaserver`. `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 `.opensearch-dashboards`.
`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. `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: `opensearch_dashboards.yml` has some additional settings:
```yml ```yml
opensearch.username: kibanaserver opensearch.username: dashboardserver
opensearch.password: kibanaserver opensearch.password: dashboardserver
opensearch.requestHeadersAllowlist: ["securitytenant","Authorization"] opensearch.requestHeadersAllowlist: ["securitytenant","Authorization"]
opensearch_security.multitenancy.enabled: true opensearch_security.multitenancy.enabled: true
opensearch_security.multitenancy.tenants.enable_global: true opensearch_security.multitenancy.tenants.enable_global: true
@ -158,8 +158,8 @@ _meta:
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: `.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:
``` ```
.kibana_<hash>_<tenant_name> .opensearch-dashboards_<hash>_<tenant_name>
.kibana_<hash>_<username> .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. The security plugin scrubs these index names of special characters, so they might not be a perfect match of tenant names and usernames.