spacing

Added reindex API to REST API reference

_im-plugin/index-rollups/rollup-api.md

@@ -90,36 +90,36 @@ You can specify the following options.
 
 Options | Description | Type | Required
 :--- | :--- |:--- |:--- |
-`source_index` |  The name of the detector. | `string` | Yes
-`target_index` |  Specify the target index that the rolled up data is ingested into. You could either create a new target index or use an existing index. The target index cannot be a combination of raw and rolled up data. | `string` | Yes
-`schedule` |  Schedule of the index rollup job which can be an interval or a cron expression. | `object` | Yes
-`schedule.interval`  |  Specify the frequency of execution of the rollup job. | `object` | No
-`schedule.interval.start_time` | Start time of the interval. | `timestamp` | Yes
-`schedule.interval.period` |  Define the interval period. | `string` | Yes
-`schedule.interval.unit` | Specify the time unit of the interval. | `string` | Yes
-`schedule.interval.cron` | Optionally, specify a cron expression to define therollup frequency. | `list` | No
-`schedule.interval.cron.expression` | Specify a Unix cron expression. | `string` | Yes
-`schedule.interval.cron.timezone` | Specify timezones as defined by the IANA Time Zone Database. Defaults to UTC. | `string` | No
-`description` | Optionally, describe the rollup job. | `string` | No
-`enabled` | When true, the index rollup job is scheduled. Default is true. | `boolean` | Yes
-`continuous` | Specify whether or not the index rollup job continuously rolls up data forever or just executes over the current data set once and stops. Default is false. | `boolean` | Yes
-`error_notification` | Set up a Mustache message template sent for error notifications. For example, if an index rollup job fails, the system sends a message to a Slack channel. | `object` | No
-`page_size` | Specify the number of buckets to paginate through at a time while rolling up. | `number` | Yes
-`delay` | Specify time value to delay execution of the index rollup job. | `time_unit` | No
-`dimensions` | Specify aggregations to create dimensions for the roll up time window. | `object` | Yes
-`dimensions.date_histogram` | Specify either fixed_interval or calendar_interval, but not both. Either one limits what you can query in the target index. | `object` | No
-`dimensions.date_histogram.fixed_interval` | Specify the fixed interval for aggregations in milliseconds, seconds, minutes, hours, or days. | `string` | No
-`dimensions.date_histogram.calendar_interval` | Specify the calendar interval for aggregations in minutes, hours, days, weeks, months, quarters, or years. | `string` | No
-`dimensions.date_histogram.field` | Specify the date field used in date histogram aggregation. | `string` | No
-`dimensions.date_histogram.timezone` | Specify the timezones as defined by the IANA Time Zone Database. The default is UTC. | `string` | No
-`dimensions.terms` | Specify the term aggregations that you want to roll up. | `object` | No
-`dimensions.terms.fields` | Specify terms aggregation for compatible fields. | `object` | No
-`dimensions.histogram` | Specify the histogram aggregations that you want to roll up. | `object` | No
-`dimensions.histogram.field` | Add a field for histogram aggregations. | `string` | Yes
-`dimensions.histogram.interval` | Specify the histogram aggregation interval for the field. | `long` | Yes
-`dimensions.metrics` | Specify a list of objects that represent the fields and metrics that you want to calculate. | `nested object` | No
-`dimensions.metrics.field` | Specify the field that you want to perform metric aggregations on. | `string` | No
-`dimensions.metrics.field.metrics` | Specify the metric aggregations you want to calculate for the field. | `multiple strings` | No
+`source_index` |  The name of the detector. | String | Yes
+`target_index` |  Specify the target index that the rolled up data is ingested into. You could either create a new target index or use an existing index. The target index cannot be a combination of raw and rolled up data. | String | Yes
+`schedule` |  Schedule of the index rollup job which can be an interval or a cron expression. | Object | Yes
+`schedule.interval`  |  Specify the frequency of execution of the rollup job. | Object | No
+`schedule.interval.start_time` | Start time of the interval. | Timestamp | Yes
+`schedule.interval.period` |  Define the interval period. | String | Yes
+`schedule.interval.unit` | Specify the time unit of the interval. | String | Yes
+`schedule.interval.cron` | Optionally, specify a cron expression to define therollup frequency. | List | No
+`schedule.interval.cron.expression` | Specify a Unix cron expression. | String | Yes
+`schedule.interval.cron.timezone` | Specify timezones as defined by the IANA Time Zone Database. Defaults to UTC. | String | No
+`description` | Optionally, describe the rollup job. | String | No
+`enabled` | When true, the index rollup job is scheduled. Default is true. | Boolean | Yes
+`continuous` | Specify whether or not the index rollup job continuously rolls up data forever or just executes over the current data set once and stops. Default is false. | Boolean | Yes
+`error_notification` | Set up a Mustache message template sent for error notifications. For example, if an index rollup job fails, the system sends a message to a Slack channel. | Object | No
+`page_size` | Specify the number of buckets to paginate through at a time while rolling up. | Number | Yes
+`delay` | The number of milliseconds to delay execution of the index rollup job. | Long | No
+`dimensions` | Specify aggregations to create dimensions for the roll up time window. | Object | Yes
+`dimensions.date_histogram` | Specify either fixed_interval or calendar_interval, but not both. Either one limits what you can query in the target index. | Object | No
+`dimensions.date_histogram.fixed_interval` | Specify the fixed interval for aggregations in milliseconds, seconds, minutes, hours, or days. | String | No
+`dimensions.date_histogram.calendar_interval` | Specify the calendar interval for aggregations in minutes, hours, days, weeks, months, quarters, or years. | String | No
+`dimensions.date_histogram.field` | Specify the date field used in date histogram aggregation. | String | No
+`dimensions.date_histogram.timezone` | Specify the timezones as defined by the IANA Time Zone Database. The default is UTC. | String | No
+`dimensions.terms` | Specify the term aggregations that you want to roll up. | Object | No
+`dimensions.terms.fields` | Specify terms aggregation for compatible fields. | Object | No
+`dimensions.histogram` | Specify the histogram aggregations that you want to roll up. | Object | No
+`dimensions.histogram.field` | Add a field for histogram aggregations. | String | Yes
+`dimensions.histogram.interval` | Specify the histogram aggregation interval for the field. | Long | Yes
+`dimensions.metrics` | Specify a list of objects that represent the fields and metrics that you want to calculate. | Nested object | No
+`dimensions.metrics.field` | Specify the field that you want to perform metric aggregations on. | String | No
+`dimensions.metrics.field.metrics` | Specify the metric aggregations you want to calculate for the field. | Multiple strings | No
 
 
 #### Sample response

_opensearch/reindex-data.md

@@ -156,28 +156,6 @@ POST _reindex
 }
 ```
 
-## Reindex sorted documents
-
-You can copy certain documents after sorting specific fields in the document.
-
-This command copies the last 10 documents based on the `timestamp` field:
-
-```json
-POST _reindex
-{
-   "size":10,
-   "source":{
-      "index":"source",
-      "sort":{
-         "timestamp":"desc"
-      }
-   },
-   "dest":{
-      "index":"destination"
-   }
-}
-```
-
 ## Transform documents during reindexing
 
 You can transform your data during the reindexing process using the `script` option.
@@ -272,7 +250,6 @@ Option | Valid values | Description | Required
 `query` | Object | The search query to use for the reindex operation. | No
 `size` | Integer | The number of documents to reindex. | No
 `slice` | String | Specify manual or automatic slicing to parallelize reindexing. | No
-`sort` | List | Sort specific fields in the document before reindexing. | No
 
 ## Destination index options
 

_opensearch/rest-api/document-apis/reindex.md

@@ -0,0 +1,121 @@
+---
+layout: default
+title: Reindex
+parent: Document APIs
+grand_parent: REST API reference
+nav_order: 60
+---
+
+# Index document
+Introduced 1.0
+{: .label .label-purple}
+
+The reindex API operation lets you copy all or a subset of your data from a source index into a destination index.
+
+## Example
+
+```json
+POST /_reindex
+{
+   "source":{
+      "index":"my-source-index"
+   },
+   "dest":{
+      "index":"my-destination-index"
+   }
+}
+```
+
+## Path and HTTP methods
+
+```
+POST /_reindex
+```
+
+## URL parameters
+
+All URL parameters are optional.
+
+Parameter | Type | Description
+:--- | :--- | :---
+refresh | Boolean | If true, OpenSearch refreshes shards to make the reindex operation available to search results. Valid options are `true`, `false`, and `wait_for`, which tells OpenSearch to wait for a refresh before executing the operation. Default is `false`.
+timeout | Time | How long to wait for a response from the cluster. Default is `30s`.
+wait_for_active_shards | String | The number of active shards that must be available before OpenSearch processes the reindex request. Default is 1 (only the primary shard). Set to `all` or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have two replicas distributed across two additional nodes for the operation to succeed.
+wait_for_completion | Boolean | Waits for the matching tasks to complete. Default is `false`.
+requests_per_second | Integer | Specifies the request’s throttling in sub-requests per second. Default is -1, which means no throttling.
+require_alias | Boolean | Whether the destination index must be an index alias. Default is false.
+scroll | Time | How long to keep the search context open. Default is `5m`.
+slices | Integer | Number of sub-tasks OpenSearch should divide this task into. Default is 1, which means OpenSearch should not divide this task. Setting this parameter to `auto` indicates to OpenSearch that it should automatically decide how many slices to split the task into.
+max_docs | Integer | How many documents the update by query operation should process at most. Default is all documents.
+
+## Request body
+
+Your request body must contain the names of the source index and destination index. All other fields are optional.
+
+Field | Description
+:--- | :---
+conflicts | Indicates to OpenSearch what should happen if the delete by query operation runs into a version conflict. Valid options are `abort` and `proceed`. Default is abort.
+source | Information about the source index to include. Valid fields are `index`, `max_docs`, `query`, `remote`, `size`, `slice`, and `_source`.
+index | The name of the source index to copy data from.
+max_docs | The maximum number of documents to reindex.
+query | The search query to use for the reindex operation.
+remote | Information about a remote OpenSearch cluster to copy data from. Valid fields are `host`, `username`, `password`, `socket_timeout`, and `connect_timeout`.
+host | Host URL of the OpenSearch cluster to copy data from.
+username | Username to authenticate with the remote cluster.
+password | Password to authenticate with the remote cluster.
+socket_timeout | The wait time for socket reads. Default is 30s.
+connect_timeout | The wait time for remote connection timeouts. Default is 30s.
+size | The number of documents to reindex.
+slice | Whether to manually or automatically slice the reindex operation so it executes in parallel.
+_source | Whether to reindex source fields. Speicfy a list of fields to reindex or true to reindex all fields. Default is true.
+id | The ID to associate with manual slicing.
+max | Maximum number of slices.
+dest | Information about the destination index. Valid values are `index`, `version_type`, and `op_type`.
+index | Name of the destination index.
+version_type | The indexing operation's version type. Valid values are `internal`, `external`, `external_gt` (retrieve the document if the specified version number is greater than the document’s current version), and `external_gte` (retrieve the document if the specified version number is greater or equal to than the document’s current version).
+op_type | Whether to copy over documents that are missing in the destination index. Valid values are `create` (ignore documents with the same ID from the source index) and `index` (copy everything from the source index).
+script | A script that OpenSearch uses to apply transformations to the data during the reindex operation.
+source | The actual script that OpenSearch runs.
+lang | The scripting language. Valid options are `painless`, `expression`, `mustache`, and `java`.
+
+## Response
+```json
+{
+    "took": 28829,
+    "timed_out": false,
+    "total": 111396,
+    "updated": 0,
+    "created": 111396,
+    "deleted": 0,
+    "batches": 112,
+    "version_conflicts": 0,
+    "noops": 0,
+    "retries": {
+        "bulk": 0,
+        "search": 0
+    },
+    "throttled_millis": 0,
+    "requests_per_second": -1.0,
+    "throttled_until_millis": 0,
+    "failures": []
+}
+```
+
+## Response body fields
+
+Field | Description
+:--- | :---
+took | How long the operation took in milliseconds.
+timed_out | Whether the operation timed out.
+total | The total number of documents processed.
+updated | The number of documents updated in the destination index.
+created | The number of documents created in the destination index.
+deleted | The number of documents deleted.
+batches | Number of scroll responses.
+version_conflicts | Number of version conflicts.
+noops | How many documents OpenSearch ignored during the operation.
+retries | Number of bulk and search retry requests.
+throttled_millis | Number of throttled milliseconds during the request.
+requests_per_second | Number of requests executed per second during the operation.
+throttled_until_millis | The amount of time until OpenSearch executes the next throttled request.
+failures | Any failures that occurred during the operation.

_security-plugin/access-control/api.md

@@ -1159,6 +1159,12 @@ Introduced 1.0
 
 Updates the existing configuration using the REST API. This operation can easily break your existing configuration, so we recommend using `securityadmin.sh` instead, which is far safer. See [Access control for the API](#access-control-for-the-api) for how to enable this operation.
 
+Before you can execute the operation, you must first add the following line to `opensearch.yml`:
+
+```yml
+plugins.security.unsupported.restapi.allow_securityconfig_modification: true
+```
+
 #### Request
 
 ```json
@@ -1179,6 +1185,106 @@ PATCH _plugins/_security/api/securityconfig
 }
 ```
 
+---
+
+## Distinguished names
+
+These REST APIs let a super admin add, retrieve, update, or delete any distinguished names from an allow list to enable communication between clusters and/or nodes.
+
+Before you can use the REST API to configure the allow list, you must first add the following line to `opensearch.yml`:
+
+```yml
+plugins.security.nodes_dn_dynamic_config_enabled: true
+```
+
+
+### Get distinguished names
+
+Retrieves all distinguished names in the allow list.
+
+#### Request
+
+```
+GET _plugins/_security/api/nodesdn
+```
+
+#### Sample response
+
+```json
+{
+  "cluster1": {
+    "nodes_dn": [
+      "CN=cluster1.example.com"
+    ]
+  }
+}
+```
+
+To get the distinguished names from a specific cluster's or node's allow list, include the cluster's name in the request path.
+
+#### Request
+
+```
+GET _plugins/_security/api/nodesdn/<cluster-name>
+```
+
+#### Sample response
+
+```json
+{
+  "cluster3": {
+    "nodes_dn": [
+      "CN=cluster3.example.com"
+    ]
+  }
+}
+```
+
+
+### Update distinguished names
+
+Adds or updates the specified distinguished names in the cluster's or node's allow list.
+
+#### Request
+
+```json
+PUT _plugins/_security/api/nodesdn/<cluster-name>
+{
+  "nodes_dn": [
+    "CN=cluster3.example.com"
+  ]
+}
+```
+
+#### Sample response
+
+```json
+{
+  "status": "CREATED",
+  "message": "'cluster3' created."
+}
+```
+
+
+### Delete distinguished names
+
+Deletes all distinguished names in the specified cluster's or node's allow list.
+
+#### Request
+
+```
+DELETE _plugins/_security/api/nodesdn/<cluster-name>
+```
+
+#### Sample response
+
+```json
+{
+  "status": "OK",
+  "message": "'cluster3' deleted."
+}
+```
+
 
 ---
 
@@ -1188,101 +1294,38 @@ PATCH _plugins/_security/api/securityconfig
 Introduced 1.0
 {: .label .label-purple }
 
-Retrieves the current security plugin configuration in JSON format.
+Retrieves the cluster's security certificates.
 
 #### Request
 
 ```
-GET _plugins/_security/api/securityconfig
-```
-
-
-### Update configuration
-Introduced 1.0
-{: .label .label-purple }
-
-Creates or updates the existing configuration using the REST API rather than `securityadmin.sh`. This operation can easily break your existing configuration, so we recommend using `securityadmin.sh` instead. See [Access control for the API](#access-control-for-the-api) for how to enable this operation.
-
-#### Request
-
-```json
-PUT _plugins/_security/api/securityconfig/config
-{
-  "dynamic": {
-    "filtered_alias_mode": "warn",
-    "disable_rest_auth": false,
-    "disable_intertransport_auth": false,
-    "respect_request_indices_options": false,
-    "opensearch-dashboards": {
-      "multitenancy_enabled": true,
-      "server_username": "kibanaserver",
-      "index": ".opensearch-dashboards"
-    },
-    "http": {
-      "anonymous_auth_enabled": false
-    },
-    "authc": {
-      "basic_internal_auth_domain": {
-        "http_enabled": true,
-        "transport_enabled": true,
-        "order": 0,
-        "http_authenticator": {
-          "challenge": true,
-          "type": "basic",
-          "config": {}
-        },
-        "authentication_backend": {
-          "type": "intern",
-          "config": {}
-        },
-        "description": "Authenticate via HTTP Basic against internal users database"
-      }
-    },
-    "auth_failure_listeners": {},
-    "do_not_fail_on_forbidden": false,
-    "multi_rolespan_enabled": true,
-    "hosts_resolver_mode": "ip-only",
-    "do_not_fail_on_forbidden_empty": false
-  }
-}
+GET _opendistro/_security/api/ssl/certs
 ```
 
 #### Sample response
 
 ```json
 {
-  "status": "OK",
-  "message": "'config' updated."
+  "http_certificates_list": [
+    {
+      "issuer_dn": "CN=Example Com Inc. Root CA,OU=Example Com Inc. Root CA,O=Example Com Inc.,DC=example,DC=com",
+      "subject_dn": "CN=node-0.example.com,OU=node,O=node,L=test,DC=de",
+      "san": "[[8, 1.2.3.4.5.5], [2, node-0.example.com]",
+      "not_before": "2018-04-22T03:43:47Z",
+      "not_after": "2028-04-19T03:43:47Z"
+    }
+  ],
+  "transport_certificates_list": [
+    {
+      "issuer_dn": "CN=Example Com Inc. Root CA,OU=Example Com Inc. Root CA,O=Example Com Inc.,DC=example,DC=com",
+      "subject_dn": "CN=node-0.example.com,OU=node,O=node,L=test,DC=de",
+      "san": "[[8, 1.2.3.4.5.5], [2, node-0.example.com]",
+      "not_before": "2018-04-22T03:43:47Z",
+      "not_after": "2028-04-19T03:43:47Z"
+    }
+  ]
 }
 ```
-
-
-### Patch configuration
-Introduced 1.0
-{: .label .label-purple }
-
-Updates the existing configuration using the REST API rather than `securityadmin.sh`. This operation can easily break your existing configuration, so we recommend using `securityadmin.sh` instead. See [Access control for the API](#access-control-for-the-api) for how to enable this operation.
-
-#### Request
-
-```json
-PATCH _plugins/_security/api/securityconfig
-[
-  {
-    "op": "replace", "path": "/config/dynamic/authc/basic_internal_auth_domain/transport_enabled", "value": "true"
-  }
-]
-```
-
-#### Sample response
-
-```json
-{
-  "status": "OK",
-  "message": "Resource updated."
-}
-```
-
 ---
 
 ## Cache

_security-plugin/access-control/impersonation.md

@@ -41,8 +41,8 @@ plugins.security.authcz.impersonation_dn:
 
 ## Impersonating Users
 
-To impersonate another user, submit a request to the system with the HTTP header `opensearch_security_impersonate_as` set to the name of the user to be impersonated. A good test is to make a GET request to the `_plugins/_security/authinfo` URI:
+To impersonate another user, submit a request to the system with the HTTP header `opendistro_security_impersonate_as` set to the name of the user to be impersonated. A good test is to make a GET request to the `_plugins/_security/authinfo` URI:
 
 ```bash
-curl -XGET -u 'admin:admin' -k -H "opensearch_security_impersonate_as: user_1" https://localhost:9200/_plugins/_security/authinfo?pretty
+curl -XGET -u 'admin:admin' -k -H "opendistro_security_impersonate_as: user_1" https://localhost:9200/_plugins/_security/authinfo?pretty
 ```

_security-plugin/access-control/permissions.md

@@ -7,58 +7,129 @@ nav_order: 50
 
 # Permissions
 
-This page is a complete list of available permissions in the security plugin. Each permission controls access to a data type or API.
+Each permission in the security plugin controls access to some action that the OpenSearch cluster can perform, such as indexing a document or checking cluster health.
 
-Rather than creating new action groups from individual permissions, you can often achieve your desired security posture using some combination of the default action groups. To learn more, see [Default Action Groups]({{site.url}}{{site.baseurl}}/security-plugin/access-control/default-action-groups/).
+Most permissions are self-describing. For example, `cluster:admin/ingest/pipeline/get` lets you retrieve information about ingest pipelines. _In many cases_, a permission correlates to a specific REST API operation, such as `GET _ingest/pipeline`.
+
+Despite this correlation, permissions do **not** directly map to REST API operations. Operations such as `POST _bulk` and `GET _msearch` can access many indices and perform many actions in a single request. Even a simple request, such as `GET _cat/nodes`, performs several actions in order to generate its response.
+
+In short, controlling access to the REST API is insufficient. Instead, the security plugin controls access to the underlying OpenSearch actions.
+
+For example, consider the following `_bulk` request:
+
+```json
+POST _bulk
+{ "delete": { "_index": "test-index", "_id": "tt2229499" } }
+{ "index": { "_index": "test-index", "_id": "tt1979320" } }
+{ "title": "Rush", "year": 2013 }
+{ "create": { "_index": "test-index", "_id": "tt1392214" } }
+{ "title": "Prisoners", "year": 2013 }
+{ "update": { "_index": "test-index", "_id": "tt0816711" } }
+{ "doc" : { "title": "World War Z" } }
+
+```
+
+For this request to succeed, you must have the following permissions for `test-index`:
+
+- indices:data/write/bulk*
+- indices:data/write/delete
+- indices:data/write/index
+- indices:data/write/update
+
+These permissions also allow you add, update, or delete documents (e.g. `PUT test-index/_doc/tt0816711`), because they govern the underlying OpenSearch actions of indexing and deleting documents rather than a specific API path and HTTP method.
+
+
+## Test permissions
+
+If you want a user to have the absolute minimum set of permissions necessary to perform some function---the [principle of least privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege)----the best way is to send representative requests to your cluster as a new test user. In the case of a permissions error, the security plugin is very explicit about which permissions are missing. Consider this request and response:
+
+```json
+GET _cat/shards?v
+
+{
+  "error": {
+    "root_cause": [{
+      "type": "security_exception",
+      "reason": "no permissions for [indices:monitor/stats] and User [name=test-user, backend_roles=[], requestedTenant=null]"
+    }]
+  },
+  "status": 403
+}
+```
+
+[Create a user and a role]({{site.url}}{{site.baseurl}}/security-plugin/access-control/users-roles/), map the role to the user, and start sending signed requests using curl, Postman, or any other client. Then gradually add permissions to the role as you encounter errors. Even after you resolve one permissions error, the same request might generate new errors; the plugin only returns the first error it encounters, so keep trying until the request succeeds.
+
+Rather than individual permissions, you can often achieve your desired security posture using a combination of the default action groups. See [Default action groups]({{site.url}}{{site.baseurl}}/security-plugin/access-control/default-action-groups/) for descriptions of the permissions that each group grants.
 {: .tip }
 
 
-## Cluster
+## Cluster permissions
+
+These permissions are for the cluster and can't be applied granularly. For example, you either have permissions to take snapshots (`cluster:admin/snapshot/create`) or you don't. You can't have permissions to take snapshots only for certain indices.
 
 - cluster:admin/ingest/pipeline/delete
 - cluster:admin/ingest/pipeline/get
 - cluster:admin/ingest/pipeline/put
 - cluster:admin/ingest/pipeline/simulate
 - cluster:admin/ingest/processor/grok/get
-- cluster:admin/opensearch/ad/detector/delete
-- cluster:admin/opensearch/ad/detector/jobmanagement
-- cluster:admin/opensearch/ad/detector/run
-- cluster:admin/opensearch/ad/detector/search
-- cluster:admin/opensearch/ad/detector/stats
-- cluster:admin/opensearch/ad/detector/write
-- cluster:admin/opensearch/ad/detectors/get
-- cluster:admin/opensearch/ad/result/search
-- cluster:admin/opensearch/alerting/alerts/ack
-- cluster:admin/opensearch/alerting/alerts/get
-- cluster:admin/opensearch/alerting/destination/delete
-- cluster:admin/opensearch/alerting/destination/email_account/delete
-- cluster:admin/opensearch/alerting/destination/email_account/get
-- cluster:admin/opensearch/alerting/destination/email_account/search
-- cluster:admin/opensearch/alerting/destination/email_account/write
-- cluster:admin/opensearch/alerting/destination/email_group/delete
-- cluster:admin/opensearch/alerting/destination/email_group/get
-- cluster:admin/opensearch/alerting/destination/email_group/search
-- cluster:admin/opensearch/alerting/destination/email_group/write
-- cluster:admin/opensearch/alerting/destination/get
-- cluster:admin/opensearch/alerting/destination/write
-- cluster:admin/opensearch/alerting/monitor/delete
-- cluster:admin/opensearch/alerting/monitor/execute
-- cluster:admin/opensearch/alerting/monitor/get
-- cluster:admin/opensearch/alerting/monitor/search
-- cluster:admin/opensearch/alerting/monitor/write
-- cluster:admin/opensearch/asynchronous_search/stats
-- cluster:admin/opensearch/asynchronous_search/delete
-- cluster:admin/opensearch/asynchronous_search/get
-- cluster:admin/opensearch/asynchronous_search/submit
-- cluster:admin/opensearch/reports/definition/create
-- cluster:admin/opensearch/reports/definition/delete
-- cluster:admin/opensearch/reports/definition/get
-- cluster:admin/opensearch/reports/definition/list
-- cluster:admin/opensearch/reports/definition/on_demand
-- cluster:admin/opensearch/reports/definition/update
-- cluster:admin/opensearch/reports/instance/get
-- cluster:admin/opensearch/reports/instance/list
-- cluster:admin/opensearch/reports/menu/download
+- cluster:admin/opendistro/ad/detector/delete
+- cluster:admin/opendistro/ad/detector/info
+- cluster:admin/opendistro/ad/detector/jobmanagement
+- cluster:admin/opendistro/ad/detector/preview
+- cluster:admin/opendistro/ad/detector/run
+- cluster:admin/opendistro/ad/detector/search
+- cluster:admin/opendistro/ad/detector/stats
+- cluster:admin/opendistro/ad/detector/write
+- cluster:admin/opendistro/ad/detectors/get
+- cluster:admin/opendistro/ad/result/search
+- cluster:admin/opendistro/ad/tasks/search
+- cluster:admin/opendistro/alerting/alerts/ack (acknowledge)
+- cluster:admin/opendistro/alerting/alerts/get
+- cluster:admin/opendistro/alerting/destination/delete
+- cluster:admin/opendistro/alerting/destination/email_account/delete
+- cluster:admin/opendistro/alerting/destination/email_account/get
+- cluster:admin/opendistro/alerting/destination/email_account/search
+- cluster:admin/opendistro/alerting/destination/email_account/write
+- cluster:admin/opendistro/alerting/destination/email_group/delete
+- cluster:admin/opendistro/alerting/destination/email_group/get
+- cluster:admin/opendistro/alerting/destination/email_group/search
+- cluster:admin/opendistro/alerting/destination/email_group/write
+- cluster:admin/opendistro/alerting/destination/get
+- cluster:admin/opendistro/alerting/destination/write
+- cluster:admin/opendistro/alerting/monitor/delete
+- cluster:admin/opendistro/alerting/monitor/execute
+- cluster:admin/opendistro/alerting/monitor/get
+- cluster:admin/opendistro/alerting/monitor/search
+- cluster:admin/opendistro/alerting/monitor/write
+- cluster:admin/opendistro/asynchronous_search/stats
+- cluster:admin/opendistro/asynchronous_search/delete
+- cluster:admin/opendistro/asynchronous_search/get
+- cluster:admin/opendistro/asynchronous_search/submit
+- cluster:admin/opendistro/ism/managedindex/add
+- cluster:admin/opendistro/ism/managedindex/change
+- cluster:admin/opendistro/ism/managedindex/remove
+- cluster:admin/opendistro/ism/managedindex/explain
+- cluster:admin/opendistro/ism/managedindex/retry
+- cluster:admin/opendistro/ism/policy/write
+- cluster:admin/opendistro/ism/policy/get
+- cluster:admin/opendistro/ism/policy/search
+- cluster:admin/opendistro/ism/policy/delete
+- cluster:admin/opendistro/rollup/index
+- cluster:admin/opendistro/rollup/get
+- cluster:admin/opendistro/rollup/search
+- cluster:admin/opendistro/rollup/delete
+- cluster:admin/opendistro/rollup/start
+- cluster:admin/opendistro/rollup/stop
+- cluster:admin/opendistro/rollup/explain
+- cluster:admin/opendistro/reports/definition/create
+- cluster:admin/opendistro/reports/definition/update
+- cluster:admin/opendistro/reports/definition/on_demand
+- cluster:admin/opendistro/reports/definition/delete
+- cluster:admin/opendistro/reports/definition/get
+- cluster:admin/opendistro/reports/definition/list
+- cluster:admin/opendistro/reports/instance/list
+- cluster:admin/opendistro/reports/instance/get
+- cluster:admin/opendistro/reports/menu/download
 - cluster:admin/reindex/rethrottle
 - cluster:admin/repository/delete
 - cluster:admin/repository/get
@@ -94,7 +165,9 @@ Rather than creating new action groups from individual permissions, you can ofte
 - cluster:monitor/tasks/list
 
 
-## Indices
+## Index permissions
+
+These permissions apply to an index or index pattern. You might want a user to have read access to all indices (i.e. `*`), but write access to only a few (e.g. `web-logs` and `product-catalog`).
 
 - indices:admin/aliases
 - indices:admin/aliases/exists
@@ -102,13 +175,22 @@ Rather than creating new action groups from individual permissions, you can ofte
 - indices:admin/analyze
 - indices:admin/cache/clear
 - indices:admin/close
-- indices:admin/create
-- indices:admin/delete
+- indices:admin/close*
+- indices:admin/create (create indices)
+- indices:admin/data_stream/create
+- indices:admin/data_stream/delete
+- indices:admin/data_stream/get
+- indices:admin/delete (delete indices)
 - indices:admin/exists
 - indices:admin/flush
 - indices:admin/flush*
 - indices:admin/forcemerge
-- indices:admin/get
+- indices:admin/get (retrieve index and mapping)
+- indices:admin/index_template/delete
+- indices:admin/index_template/get
+- indices:admin/index_template/put
+- indices:admin/index_template/simulate
+- indices:admin/index_template/simulate_index
 - indices:admin/mapping/put
 - indices:admin/mappings/fields/get
 - indices:admin/mappings/fields/get*
@@ -137,22 +219,23 @@ Rather than creating new action groups from individual permissions, you can ofte
 - indices:data/read/mget*
 - indices:data/read/msearch
 - indices:data/read/msearch/template
-- indices:data/read/mtv
+- indices:data/read/mtv (multi-term vectors)
 - indices:data/read/mtv*
 - indices:data/read/scroll
 - indices:data/read/scroll/clear
 - indices:data/read/search
 - indices:data/read/search*
 - indices:data/read/search/template
-- indices:data/read/tv
+- indices:data/read/tv (term vectors)
 - indices:data/write/bulk
 - indices:data/write/bulk*
-- indices:data/write/delete
+- indices:data/write/delete (delete documents)
 - indices:data/write/delete/byquery
-- indices:data/write/index
+- indices:data/write/index (add documents to existing indices)
 - indices:data/write/reindex
 - indices:data/write/update
 - indices:data/write/update/byquery
+- indices:monitor/data_stream/stats
 - indices:monitor/recovery
 - indices:monitor/segments
 - indices:monitor/settings/get

_security-plugin/configuration/ldap.md

@@ -11,7 +11,6 @@ Active Directory and LDAP can be used for both authentication and authorization
 
 In most cases, you want to configure both authentication and authorization. You can also use authentication only and map the users retrieved from LDAP directly to security plugin roles.
 
-{% comment %}
 
 ## Docker example
 
@@ -38,7 +37,7 @@ We provide a fully functional example that can help you understand how to use an
 1. Index a document as `psantos`:
 
    ```bash
-   curl -XPUT https://localhost:9200/new-index/_doc/1 -H 'Content-Type: application/json' -d '{"title": "Spirited Away"}' -u psantos:password -k
+   curl -XPUT 'https://localhost:9200/new-index/_doc/1' -H 'Content-Type: application/json' -d '{"title": "Spirited Away"}' -u 'psantos:password' -k
    ```
 
    If you try the same request as `jroe`, it fails. The `Developers` group is mapped to the `readall`, `manage_snapshots`, and `kibana_user` roles and has no write permissions.
@@ -46,14 +45,13 @@ We provide a fully functional example that can help you understand how to use an
 1. Search for the document as `jroe`:
 
    ```bash
-   curl -XGET https://localhost:9200/new-index/_search?pretty -u jroe:password -k
+   curl -XGET 'https://localhost:9200/new-index/_search?pretty' -u 'jroe:password' -k
    ```
 
    This request succeeds, because the `Developers` group is mapped to the `readall` role.
 
 1. If you want to examine the contents of the various containers, run `docker ps` to find the container ID and then `docker exec -it <container-id> /bin/bash`.
 
-{% endcomment %}
 
 ## Connection settings
 

_security-plugin/configuration/saml.md

@@ -11,7 +11,6 @@ The security plugin supports user authentication through SAML single sign-on. Th
 
 This profile is meant for use with web browsers. It is not a general-purpose way of authenticating users against the security plugin, so its primary use case is to support OpenSearch Dashboards single sign-on.
 
-{% comment %}
 
 ## Docker example
 
@@ -35,7 +34,6 @@ We provide a fully functional example that can help you understand how to use SA
 
    In particular, you might find it helpful to review the contents of the `/var/www/simplesamlphp/config/` and `/var/www/simplesamlphp/metadata/` directories.
 
-{% endcomment %}
 
 ## Activating SAML
 
@@ -300,13 +298,13 @@ authc:
 
 Because most of the SAML-specific configuration is done in the security plugin, just activate SAML in your `opensearch_dashboards.yml` by adding the following:
 
-```
-plugins.security.auth.type: "saml"
+```yml
+opensearch_security.auth.type: "saml"
 ```
 
 In addition, the OpenSearch Dashboards endpoint for validating the SAML assertions must be whitelisted:
 
-```
+```yml
 server.xsrf.whitelist: ["/_plugins/_security/saml/acs"]
 ```
 

_security-plugin/configuration/yaml.md

@@ -126,7 +126,7 @@ plugins.security.restapi.password_validation_error_message: "Password must be mi
 
 ## whitelist.yml
 
-You can use `whitelist.yml` to allow list any endpoints and HTTP requests. If enabled, all users except the SuperAdmin are allowed access to only the specified endpoints and HTTP requests, and all other HTTP requests associated with the endpoint are denied. For example, if GET `_cluster/settings` is allow listed, users cannot submit PUT requests to `_cluster/settings` to update cluster settings.
+You can use `whitelist.yml` to add any endpoints and HTTP requests to a list of allowed endpoints and requests. If enabled, all users except the super admin are allowed access to only the specified endpoints and HTTP requests, and all other HTTP requests associated with the endpoint are denied. For example, if GET `_cluster/settings` is added to the allow list, users cannot submit PUT requests to `_cluster/settings` to update cluster settings.
 
 Note that while you can configure access to endpoints this way, for most cases, it is still best to configure permissions using the security plugin's users and roles, which have more granular settings.
 
@@ -165,7 +165,7 @@ requests:
     - PUT
 ```
 
-You can also allow list custom indices. `whitelist.yml` doesn't support wildcards, so you must manually specify all of the indices you want to allow list.
+You can also add custom indices to the allow list. `whitelist.yml` doesn't support wildcards, so you must manually specify all of the indices you want to add.
 
 ```yml
 requests: # Only allow GET requests to /sample-index1/_doc/1 and /sample-index2/_doc/1
@@ -315,6 +315,10 @@ _meta:
 
 ## tenants.yml
 
+You can use this file to specify and add any number of OpenSearch Dashboards tenants to your OpenSearch cluster. For more information about tenants, see [OpenSearch Dashboards multi-tenancy]({{site.url}}{{site.baseurl}}/security-plugin/access-control/multi-tenancy).
+
+Like all of the other YAML files, we recommend you use `tenants.yml` to add any tenants you must have in your cluster, and then use OpenSearch Dashboards or the [REST API]({{site.url}}{{site.baseurl}}/security-plugin/access-control/api/#tenants) if you need to further configure or create any other tenants.
+
 ```yml
 ---
 _meta:
@@ -325,9 +329,12 @@ admin_tenant:
   description: "Demo tenant for admin user"
 ```
 
-
 ## nodes_dn.yml
 
+`nodes_dn.yml` lets you add certificates' [distinguished names (DNs)]({{site.url}}{{site.baseurl}}/security-plugin/configuration/generate-certificates/#add-distinguished-names-to-opensearchyml) an allow list to enable communication between any number of nodes and/or clusters. For example, a node that has the DN `CN=node1.example.com` in its allow list accepts communication from any other node or certificate that uses that DN.
+
+The DNs get indexed into a [system index]({{site.url}}{{site.baseurl}}/security-plugin/configuration/system-indices) that only a super admin or an admin with a Transport Layer Security (TLS) certificate can access. If you want to programmatically add DNs to your allow lists, use the [REST API]({{site.url}}{{site.baseurl}}/security-plugin/access-control/api/#distinguished-names).
+
 ```yml
 ---
 _meta:

_upgrade-to/upgrade-to.md

@@ -179,3 +179,116 @@ If you are upgrading an Open Distro for Elasticsearch cluster, we recommend firs
      }
    }
    ```
+
+## Upgrade tool
+
+The `opensearch-upgrade` tool lets you automate some of the steps in [Upgrade to OpenSearch]({{site.url}}{{site.baseurl}}/upgrade-to/upgrade-to/#upgrade-to-opensearch), eliminating the need for error-prone manual operations.
+
+The `opensearch-upgrade` tool performs the following functions:
+
+- Imports any existing configurations and applies it to the new installation of OpenSearch.
+- Installs any existing core plugins.
+
+### Limitations
+
+The `opensearch-upgrade` tool doesn't perform an end-to-end upgrade:
+
+- You need to run the tool on each node of the cluster individually as part of the upgrade process.
+- The tool doesn't provide a rollback option after you've upgraded a node, so make sure you follow best practices and take backups.
+- You must install all community plugins (if available) manually.
+- The tool only validates any keystore settings at service start-up time, so you must manually remove any unsupported settings for the service to start.
+
+### Using the upgrade tool
+
+To perform a rolling upgrade using the [OpenSearch tarball]({{site.url}}{{site.baseurl}}/opensearch/install/tar/) distribution:
+
+Check [Upgrade paths]({{site.url}}{{site.baseurl}}/upgrade-to/upgrade-to/#upgrade-paths) to make sure that the version you’re upgrading to is supported and whether you need to upgrade to a supported Elasticsearch OSS version first.
+{: .note }
+
+1. Disable shard allocation to prevent Elasticsearch OSS from replicating shards as you shut down nodes:
+
+   ```json
+   PUT _cluster/settings
+   {
+     "persistent": {
+       "cluster.routing.allocation.enable": "primaries"
+     }
+   }
+   ```
+
+1. On any one of the nodes, download and extract the OpenSearch tarball to a new directory.
+
+1. Make sure the following environment variables are set:
+
+    - `ES_HOME` - Path to the existing Elasticsearch installation home.
+
+      ```bash
+      export ES_HOME = /home/workspace/upgrade-demo/node1/elasticsearch-7.10.2
+      ```
+
+    - `ES_PATH_CONF` - Path to the existing Elasticsearch config directory.
+
+      ```bash
+      export ES_PATH_CONF = /home/workspace/upgrade-demo/node1/os-config
+      ```
+
+    - `OPENSEARCH_HOME` - Path to the OpenSearch installation home.
+
+      ```bash
+      export OPENSEARCH_HOME = /home/workspace/upgrade-demo/node1/opensearch-1.0.0
+      ```
+
+    - `OPENSEARCH_PATH_CONF` - Path to the OpenSearch config directory.
+
+      ```bash
+      export OPENSEARCH_PATH_CONF = /home/workspace/upgrade-demo/node1/opensearch-config
+      ```
+
+1. The `opensearch-upgrade` tool is in the `bin` directory of the distribution. Run the following command from the distribution home:
+
+   Make sure you run this tool as the same user running the current Elasticsearch service.
+   {: .note }
+
+   ```json
+   ./bin/opensearch-upgrade
+   ```
+
+1. Stop Elasticsearch OSS on the node.
+
+   On Linux distributions that use systemd, use this command:
+
+   ```bash
+   sudo systemctl stop elasticsearch.service
+   ```
+
+   For tarball installations, find the process ID (`ps aux`) and kill it (`kill <pid>`).
+
+1. Start OpenSearch on the node:
+
+   ```json
+   ./bin/opensearch -d.
+   ```
+
+1. Repeat steps 2--6 until all nodes are using the new version.
+
+1. After all nodes are using the new version, re-enable shard allocation:
+
+   ```json
+   PUT _cluster/settings
+   {
+    "persistent": {
+       "cluster.routing.allocation.enable": "all"
+     }
+   }
+   ```
+
+### How it works
+
+Behind the scenes, the `opensearch-upgrade` tool performs the following tasks in sequence:
+
+1. Looks for a valid Elasticsearch installation on the current node. After it finds the installation, it reads the `elasticsearch.yml` file to get the endpoint details and connects to the locally running Elasticsearch service. If the tool can't find an Elasticsearch installation, it tries to get the path from the `ES_HOME` location.
+1. Verifies if the existing version of Elasticsearch is compatible with the OpenSearch version. It prints a summary of the information gathered to the console and prompts you for a confirmation to proceed.
+1. Imports the settings from the `elasticsearch.yml` config file into the `opensearch.yml` config file.
+1. Copies across any custom JVM options from the `$ES_PATH_CONF/jvm.options.d` directory into the `$OPENSEARCH_PATH_CONF/jvm.options.d` directory. Similarly, it also imports the logging configurations from the `$ES_PATH_CONF/log4j2.properties` file into the `$OPENSEARCH_PATH_CONF/log4j2.properties` file.
+1. Installs the core plugins that you’ve currently installed in the `$ES_HOME/plugins` directory. You must install all other third-party community plugins manually.
+1. Imports the secure settings from the `elasticsearch.keystore` file (if any) into the `opensearch.keystore` file. If the keystore file is password protected, the `opensearch-upgrade` tool prompts you to enter the password.

index.md

@@ -37,7 +37,7 @@ Component | Purpose
 [Anomaly Detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/) | Identify atypical data and receive automatic notifications
 [Asynchronous Search]({{site.url}}{{site.baseurl}}/search-plugins/async/) | Run search requests in the background
 
-Most of OpenSearch plugins have a corresponding OpenSearch Dashboards plugin that provide a convenient, unified user interface.
+Most OpenSearch plugins have corresponding OpenSearch Dashboards plugins that provide a convenient, unified user interface.
 
 For specifics around the project, see the [FAQ](https://opensearch.org/faq/).