Added Gradle dependency

OpenSearch High-Level REST Client

.gitignore

@@ -4,3 +4,4 @@ _site
 .DS_Store
 Gemfile.lock
 .idea
+.jekyll-cache

Gemfile

@@ -8,22 +8,22 @@ source "https://rubygems.org"
 #
 # This will help ensure the proper Jekyll version is running.
 # Happy Jekylling!
-# gem "jekyll", "~> 3.9.0"
+gem "jekyll", "~> 4.2.0"
 
 # This is the default theme for new Jekyll sites. You may change this to anything you like.
 gem "just-the-docs", "~> 0.3.3"
+gem "jekyll-remote-theme", "~> 0.4"
+gem "jekyll-redirect-from", "~> 0.16"
 
 # If you want to use GitHub Pages, remove the "gem "jekyll"" above and
 # uncomment the line below. To upgrade, run `bundle update github-pages`.
 
-gem 'github-pages', group: :jekyll_plugins
+# gem 'github-pages', group: :jekyll_plugins
 
 # If you have any plugins, put them here!
-# group :jekyll_plugins do
-#   # gem "jekyll-feed", "~> 0.6"
-#   gem "jekyll-remote-theme"
-#   gem "jekyll-redirect-from"
-# end
+group :jekyll_plugins do
+  gem "jekyll-sitemap"
+end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]

NOTICE

@@ -1 +1 @@
-Copyright 2021 OpenSearch contributors.
+Copyright OpenSearch contributors.

README.md

@@ -1,6 +1,8 @@
+<img src="https://opensearch.org/assets/img/opensearch-logo-themed.svg" height="64px">
+
 # OpenSearch documentation
 
-This repository contains the documentation for OpenSearch, the search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more. You can find the rendered documentation at [docs-beta.opensearch.org](https://docs-beta.opensearch.org).
+This repository contains the documentation for OpenSearch, the search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more. You can find the rendered documentation at [opensearch.org/docs](https://opensearch.org/docs).
 
 Community contributions remain essential in keeping this documentation comprehensive, useful, well-organized, and up-to-date.
 
@@ -11,9 +13,9 @@ Community contributions remain essential in keeping this documentation comprehen
 
   Often, engineering teams can keep existing documentation up-to-date with minimal effort, thus freeing up the documentation team to focus on larger projects.
 
-- Do you have expertise in a particular area of OpenSearch? Cluster sizing? The query DSL? Painless scripting? Aggregations? JVM settings? Take a look at the [current content](https://docs-beta.opensearch.org/docs/opensearch/) and see where you can add value. The [documentation team](#points-of-contact) is happy to help you polish and organize your drafts.
+- Do you have expertise in a particular area of OpenSearch? Cluster sizing? The query DSL? Painless scripting? Aggregations? JVM settings? Take a look at the [current content](https://opensearch.org/docs/opensearch/) and see where you can add value. The [documentation team](#points-of-contact) is happy to help you polish and organize your drafts.
 
-- Are you an OpenSearch Dashboards expert? How did you set up your visualizations? Why is a particular dashboard so valuable to your organization? We have [very little](https://docs-beta.opensearch.org/docs/opensearch-dashboards/) on how to use OpenSearch Dashboards, only how to install it.
+- Are you an OpenSearch Dashboards expert? How did you set up your visualizations? Why is a particular dashboard so valuable to your organization? We have [very little](https://opensearch.org/docs/opensearch-dashboards/) on how to use OpenSearch Dashboards, only how to install it.
 
 - Are you a web developer? Do you want to add an optional dark mode to the documentation? A "copy to clipboard" button for our code samples? Other improvements to the design or usability? See [major changes](#major-changes) for information on building the website locally.
 
@@ -30,11 +32,9 @@ If you encounter problems or have questions when contributing to the documentati
 - [snyder114](https://github.com/snyder114)
 
 
-## How we build the website
+## How the website works
 
-After each commit to this repository, GitHub Pages automatically uses [Jekyll](https://jekyllrb.com) to rebuild the [website](https://docs-beta.opensearch.org). The whole process takes around 30 seconds.
-
-This repository contains many [Markdown](https://guides.github.com/features/mastering-markdown/) files in the `/docs` directory. Each Markdown file correlates with one page on the website.
+This repository contains many [Markdown](https://guides.github.com/features/mastering-markdown/) files organized into Jekyll "collections" (e.g. `_search-plugins`, `_opensearch`, etc.). Each Markdown file correlates with one page on the website.
 
 Using plain text on GitHub has many advantages:
 
@@ -133,15 +133,15 @@ If you're making major changes to the documentation and need to see the rendered
    sh build.sh
    ```
 
-1. If the build script doesn't automatically open your web browser (it should), open [http://localhost:4000/](http://localhost:4000/).
+1. If the build script doesn't automatically open your web browser (it should), open [http://localhost:4000/docs/](http://localhost:4000/docs/).
 
 1. Create a new branch.
 
-1. Edit the Markdown files in `/docs`.
+1. Edit the Markdown files in each collection (e.g. `_security-plugin/`).
 
    If you're a web developer, you can customize `_layouts/default.html` and `_sass/custom/custom.scss`.
 
-1. When you save a file, marvel as Jekyll automatically rebuilds the site and refreshes your web browser. This process takes roughly 30 seconds.
+1. When you save a file, marvel as Jekyll automatically rebuilds the site and refreshes your web browser. This process can take anywhere from 10-30 seconds.
 
 1. When you're happy with how everything looks, commit, push your changes to your fork, and submit a pull request.
 
@@ -196,17 +196,17 @@ If you're making major changes to the documentation and need to see the rendered
 ## New releases
 
 1. Branch.
-1. Change the `opensearch_version` and `opensearch_major_version` variables in `_config.yml`.
+1. Change the `opensearch_version`, `opensearch_major_minor_version`, and `lucene_version` variables in `_config.yml`.
 1. Start up a new cluster using the updated Docker Compose file in `docs/install/docker.md`.
 1. Update the version table in `version-history.md`.
 
-   Use `curl -XGET https://localhost:9200 -u admin:admin -k` to verify the OpenSearch version.
+   Use `curl -XGET https://localhost:9200 -u admin:admin -k` to verify the OpenSearch and Lucene versions.
 
-1. Update the plugin compatibility table in `docs/install/plugin.md`.
+1. Update the plugin compatibility table in `_opensearch/install/plugin.md`.
 
    Use `curl -XGET https://localhost:9200/_cat/plugins -u admin:admin -k` to get the correct version strings.
 
-1. Update the plugin compatibility table in `docs/opensearch-dashboards/plugins.md`.
+1. Update the plugin compatibility table in `_dashboards/install/plugins.md`.
 
    Use `docker ps` to find the ID for the OpenSearch Dashboards node. Then use `docker exec -it <opensearch-dashboards-node-id> /bin/bash` to get shell access. Finally, run `./bin/opensearch-dashboards-plugin list` to get the plugins and version strings.
 
@@ -225,7 +225,7 @@ This documentation uses a modified version of the [just-the-docs](https://github
 
 ## Get started
 New
-{: .label .label-green :}
+{: .label .label-green }
 ```
 
 * Labels come in default (blue), green, purple, yellow, and red.
@@ -238,6 +238,27 @@ These classes can help with readability, but should be used *sparingly*. Each ad
 Besides, standard Markdown elements suffice for most documentation.
 
 
+## Labels for APIs
+
+Each API operation has a label indicating when it was introduced. For most operations, this label is 1.0:
+
+```
+## Get roles
+Introduced 1.0
+{: .label .label-purple }
+```
+
+If we introduce a breaking change to an operation, add an additional label with a link to the release note for that breaking change:
+
+```
+## Get roles
+Introduced 1.0
+{: .label .label-purple }
+[Last breaking change 2.0](https://example.com)
+{: .label .label-red }
+```
+
+
 ## Math
 
 If you want to use the sorts of pretty formulas that [MathJax](https://www.mathjax.org) allows, add `has_math: true` to the Jekyll page metadata. Then insert LaTeX math into HTML tags with the rest of your Markdown content:
@@ -273,4 +294,4 @@ This project is licensed under the Apache-2.0 License.
 
 ## Copyright
 
-Copyright 2021 OpenSearch contributors.
+Copyright OpenSearch contributors.

_clients/agents-and-ingestion-tools/index.md

@@ -4,22 +4,42 @@ title: Agents and ingestion tools
 nav_order: 100
 has_children: false
 has_toc: false
+redirect_from:
+  - /clients/agents-and-ingestion-tools/
 ---
 
 # Agents and ingestion tools
 
 Historically, many multiple popular agents and ingestion tools have worked with Elasticsearch OSS, such as Beats, Logstash, Fluentd, FluentBit, and OpenTelemetry. OpenSearch aims to continue to support a broad set of agents and ingestion tools, but not all have been tested or have explicitly added OpenSearch compatibility.
 
-As an intermediate solution, we are adding a [version value](https://github.com/opensearch-project/OpenSearch/issues/693) to `opensearch.yml`. This change will let you set OpenSearch 1.x clusters to report version 7.10.2 (or any other arbitrary value). By reporting 7.10.2, the cluster will be able to connect with tools that check for a particular version number.
+As an intermediate compatibility solution, OpenSearch has a setting that instructs the cluster to return version 7.10.2 rather than its actual version.
 
-For a longer term solution, we plan to create an OpenSearch output plugin for Logstash. This plugin *does not exist yet*, but we've included it in the compatibility matrices below based on its expected behavior.
+If you use clients that include a version check, such as recent versions of Logstash OSS or Filebeat OSS, enable the setting:
+
+```json
+PUT _cluster/settings
+{
+  "persistent": {
+    "compatibility": {
+      "override_main_response_version": true
+    }
+  }
+}
+```
+
+[Just like any other setting]({{site.url}}{{site.baseurl}}/opensearch/configuration/), the alternative is to add the following line to `opensearch.yml` on each node and then restart the node:
+
+```yml
+compatibility.override_main_response_version: true
+```
 
 
 ## Downloads
 
-These versions of Logstash and Beats offer the best compatibility with OpenSearch. For more information, see the [compatibility matrices](#compatibility-matrices).
+You can download the OpenSearch output plugin for Logstash from [OpenSearch downloads](https://opensearch.org/downloads.html). The Logstash output plugin is compatible with OpenSearch and Elasticsearch OSS (7.10.2 or lower).
+
+These are the latest versions of Beats OSS with OpenSearch compatibility. For more information, see the [compatibility matrices](#compatibility-matrices).
 
-- [Logstash OSS 7.12.1](https://www.elastic.co/downloads/past-releases/logstash-oss-7-12-1)
 - [Filebeat OSS 7.12.1](https://www.elastic.co/downloads/past-releases/filebeat-oss-7-12-1)
 - [Metricbeat OSS 7.12.1](https://www.elastic.co/downloads/past-releases/metricbeat-oss-7-12-1)
 - [Packetbeat OSS 7.12.1](https://www.elastic.co/downloads/past-releases/packetbeat-oss-7-12-1)
@@ -27,6 +47,9 @@ These versions of Logstash and Beats offer the best compatibility with OpenSearc
 - [Winlogbeat OSS 7.12.1](https://www.elastic.co/downloads/past-releases/winlogbeat-oss-7-12-1)
 - [Auditbeat OSS 7.12.1](https://elastic.co/downloads/past-releases/auditbeat-oss-7-12-1)
 
+Some users report compatibility issues with ingest pipelines on these versions of Beats. If you use ingest pipelines with OpenSearch, consider using the 7.10.2 versions of Beats instead.
+{: .note }
+
 
 ## Compatibility Matrices
 
@@ -35,28 +58,26 @@ These versions of Logstash and Beats offer the best compatibility with OpenSearc
 
 ### Compatibility Matrix for Logstash
 
-| | Logstash OSS 7.x to 7.11.x | Logstash OSS 7.12.x\* | Logstash 7.13.x without OpenSearch output plugin | Logstash 7.13.x with OpenSearch output plugin\*\* |
+| | Logstash OSS 7.x to 7.11.x | Logstash OSS 7.12.x\* | Logstash 7.13.x without OpenSearch output plugin | Logstash 7.13.x with OpenSearch output plugin |
 | :---| :--- | :--- | :--- | :--- |
-| Elasticsearch OSS v7.x to v7.9.x | *Yes* | *Yes* | *No* | *Yes* |
-| Elasticsearch OSS v7.10.2 | *Yes* | *Yes* | *No* | *Yes* |
-| ODFE OSS v1.x to 1.12 | *Yes* | *Yes* | *No* | *Yes* |
+| Elasticsearch OSS 7.x to 7.9.x | *Yes* | *Yes* | *No* | *Yes* |
+| Elasticsearch OSS 7.10.2 | *Yes* | *Yes* | *No* | *Yes* |
+| ODFE 1.x to 1.12 | *Yes* | *Yes* | *No* | *Yes* |
 | ODFE 1.13 | *Yes* | *Yes* | *No* | *Yes* |
-| OpenSearch 1.0 | [Yes via version setting](https://github.com/opensearch-project/OpenSearch/issues/693) | [Yes via version setting](https://github.com/opensearch-project/OpenSearch/issues/693) | *No* | *Yes* |
+| OpenSearch 1.0 | Yes via version setting | Yes via version setting | *No* | *Yes* |
 
 \* Most current compatible version with Elasticsearch OSS.
 
-\*\* Planning to build.
-
 
 ### Compatibility Matrix for Beats
 
 | | Beats OSS 7.x to 7.11.x\*\* | Beats OSS 7.12.x\* | Beats 7.13.x |
 | :--- | :--- | :--- | :--- |
-| Elasticsearch OSS v7.x to v7.9.x | *Yes* | *Yes* | No |
-| Elasticsearch OSS v7.10.2 | *Yes* | *Yes* | No |
-| ODFE OSS v1.x to 1.12 | *Yes* | *Yes* | No |
+| Elasticsearch OSS 7.x to 7.9.x | *Yes* | *Yes* | No |
+| Elasticsearch OSS 7.10.2 | *Yes* | *Yes* | No |
+| ODFE 1.x to 1.12 | *Yes* | *Yes* | No |
 | ODFE 1.13 | *Yes* | *Yes* | No |
-| OpenSearch 1.0 | [Yes via version setting](https://github.com/opensearch-project/OpenSearch/issues/693) | [Yes via version setting](https://github.com/opensearch-project/OpenSearch/issues/693) | No |
+| OpenSearch 1.0 | Yes via version setting | Yes via version setting | No |
 | Logstash OSS 7.x to 7.11.x | *Yes* | *Yes* | *Yes* |
 | Logstash OSS 7.12.x\* | *Yes* | *Yes* | *Yes* |
 | Logstash 7.13.x with OpenSearch output plugin | *Yes* | *Yes* | *Yes* |

_clients/cli.md

@@ -3,9 +3,6 @@ layout: default
 title: OpenSearch CLI
 nav_order: 52
 has_children: false
-redirect_from:
-  - /docs/odfe-cli/
-  - /docs/cli/
 ---
 
 # OpenSearch CLI

_clients/go.md

@@ -0,0 +1,145 @@
+---
+layout: default
+title: Go client
+nav_order: 80
+---
+
+# Go client
+
+The OpenSearch Go client lets you connect your Go application with the data in your OpenSearch cluster.
+
+
+## Setup
+
+If you're creating a new project:
+
+```go
+go mod init
+```
+
+To add the client to your project, import it like any other module:
+
+```go
+go get github.com/opensearch-project/opensearch-go
+```
+
+## Sample code
+
+This sample code creates a client, adds an index with non-default settings, inserts a document, searches for the document, deletes the document, and finally deletes the index:
+
+```go
+package main
+import (
+    "os"
+    "context"
+    "crypto/tls"
+    "fmt"
+    opensearch "github.com/opensearch-project/opensearch-go"
+    opensearchapi "github.com/opensearch-project/opensearch-go/opensearchapi"
+    "net/http"
+    "strings"
+)
+const IndexName = "go-test-index1"
+func main() {
+    // Initialize the client with SSL/TLS enabled.
+    client, err := opensearch.NewClient(opensearch.Config{
+        Transport: &http.Transport{
+            TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
+        },
+        Addresses: []string{"https://localhost:9200"},
+        Username:  "admin", // For testing only. Don't store credentials in code.
+        Password:  "admin",
+    })
+    if err != nil {
+        fmt.Println("cannot initialize", err)
+        os.Exit(1)
+    }
+
+    // Print OpenSearch version information on console.
+    fmt.Println(client.Info())
+
+    // Define index mapping.
+    mapping := strings.NewReader(`{
+     'settings': {
+       'index': {
+            'number_of_shards': 4
+            }
+          }
+     }`)
+
+    // Create an index with non-default settings.
+    res := opensearchapi.CreateRequest{
+        Index: IndexName,
+        Body:  mapping,
+    }
+    fmt.Println("creating index", res)
+
+    // Add a document to the index.
+    document := strings.NewReader(`{
+        "title": "Moneyball",
+        "director": "Bennett Miller",
+        "year": "2011"
+    }`)
+
+    docId := "1"
+    req := opensearchapi.IndexRequest{
+        Index:      IndexName,
+        DocumentID: docId,
+        Body:       document,
+    }
+    insertResponse, err := req.Do(context.Background(), client)
+    if err != nil {
+        fmt.Println("failed to insert document ", err)
+        os.Exit(1)
+    }
+    fmt.Println(insertResponse)
+
+    // Search for the document.
+    content := strings.NewReader(`{
+       "size": 5,
+       "query": {
+           "multi_match": {
+           "query": "miller",
+           "fields": ["title^2", "director"]
+           }
+      }
+    }`)
+
+    search := opensearchapi.SearchRequest{
+        Body: content,
+    }
+
+    searchResponse, err := search.Do(context.Background(), client)
+    if err != nil {
+        fmt.Println("failed to search document ", err)
+        os.Exit(1)
+    }
+    fmt.Println(searchResponse)
+
+    // Delete the document.
+    delete := opensearchapi.DeleteRequest{
+        Index:      IndexName,
+        DocumentID: docId,
+    }
+
+    deleteResponse, err := delete.Do(context.Background(), client)
+    if err != nil {
+        fmt.Println("failed to delete document ", err)
+        os.Exit(1)
+    }
+    fmt.Println("deleting document")
+    fmt.Println(deleteResponse)
+
+    // Delete previously created index.
+    deleteIndex := opensearchapi.IndicesDeleteRequest{
+        Index: []string{IndexName},
+    }
+
+    deleteIndexResponse, err := deleteIndex.Do(context.Background(), client)
+    if err != nil {
+        fmt.Println("failed to delete index ", err)
+        os.Exit(1)
+    }
+    fmt.Println("deleting index", deleteIndexResponse)
+}
+```

_clients/grafana.md

@@ -0,0 +1,10 @@
+---
+layout: default
+title: Grafana
+nav_order: 150
+has_children: false
+---
+
+# Grafana support
+
+Grafana has a data source plugin that lets you explore and visualize your OpenSearch data. For information on getting started with the plugin, see the [Grafana overview page](https://grafana.com/grafana/plugins/grafana-opensearch-datasource/).

_clients/index.md

@@ -0,0 +1,96 @@
+---
+layout: default
+title: Compatibility
+nav_order: 1
+has_children: false
+redirect_from:
+  - /clients/
+---
+
+# OpenSearch client compatibility
+
+OpenSearch provides clients for several popular programming languages, with more coming. In general, clients are compatible with clusters running the same major version of OpenSearch (`major.minor.patch`).
+
+For example, a 1.0.0 client works with an OpenSearch 1.1.0 cluster, but might not support any non-breaking API changes in OpenSearch 1.1.0. A 1.2.0 client works with the same cluster, but might allow you to pass unsupported options in certain functions. We recommend using the same version for both, but if your tests pass after a cluster upgrade, you don't necessarily need to upgrade your clients immediately.
+
+{% comment %}
+* [OpenSearch Java client]({{site.url}}{{site.baseurl}}/clients/java/)
+{% endcomment %}
+* [OpenSearch Python client]({{site.url}}{{site.baseurl}}/clients/python/)
+* [OpenSearch JavaScript (Node.js) client]({{site.url}}{{site.baseurl}}/clients/javascript/)
+* [OpenSearch Go client]({{site.url}}{{site.baseurl}}/clients/go/)
+
+
+## Legacy clients
+
+Most clients that work with Elasticsearch OSS 7.10.2 *should* work with OpenSearch, but the latest versions of those clients might include license or version checks that artificially break compatibility. This page includes recommendations around which versions of those clients to use for best compatibility with OpenSearch.
+
+Client | Recommended version
+:--- | :---
+[Java low-level REST client](https://search.maven.org/artifact/org.elasticsearch.client/elasticsearch-rest-client/7.13.4/jar) | 7.13.4
+[Java high-level REST client](https://search.maven.org/artifact/org.elasticsearch.client/elasticsearch-rest-high-level-client/7.13.4/jar) | 7.13.4
+[Python Elasticsearch client](https://pypi.org/project/elasticsearch/7.13.4/) | 7.13.4
+[Elasticsearch Node.js client](https://www.npmjs.com/package/@elastic/elasticsearch/v/7.13.0) | 7.13.0
+
+If you test a legacy client and verify that it works, please [submit a PR](https://github.com/opensearch-project/documentation-website/pulls) and add it to this table.
+
+
+{% comment %}
+## Python 3 test code
+
+This code indexes a single document and is equivalent to `PUT /python-test-index1/_doc/1`.
+
+```python
+from elasticsearch import Elasticsearch
+
+host = 'localhost'
+port = 9200
+# For testing only. Do not store credentials in code.
+auth = ('admin', 'admin')
+
+es = Elasticsearch(
+  hosts = [{'host': host, 'port': port}],
+  http_auth = auth,
+  use_ssl = True,
+  verify_certs = False
+)
+
+document = {
+  "title": "Moneyball",
+  "director": "Bennett Miller",
+  "year": "2011"
+}
+
+response = es.index(index='python-test-index1', id='1', body=document, refresh=True)
+
+print(response)
+```
+
+
+## Node.js test code
+
+This code is equivalent to `GET /`.
+
+```js
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  node: 'https://localhost:9200',
+  auth: {
+    // For testing only. Don't store credentials in code.
+    username: 'admin',
+    password: 'admin'
+  },
+  ssl: {
+    // ca: fs.readFileSync('./cacert.pem'),
+    rejectUnauthorized: false
+  }
+})
+
+async function run () {
+  const { body } = await client.info();
+  console.log(body);
+}
+
+run().catch(console.log)
+```
+{% endcomment %}

_clients/java-rest-high-level.md

@@ -0,0 +1,134 @@
+---
+layout: default
+title: OpenSearch Java high-level REST client
+nav_order: 60
+---
+
+# OpenSearch Java high-level REST client
+
+Although the OpenSearch Java high-level REST client is still usable, we recommend that you use the [OpenSearch Java client]({{site.url}}{{site.baseurl}}/clients/java/), which replaces the existing Java high-level REST client.
+{: .note}
+
+The OpenSearch Java high-level REST client lets you interact with your OpenSearch clusters and indices through Java methods and data structures rather than HTTP methods and JSON.
+
+## Setup
+
+To start using the OpenSearch Java high-level REST client, ensure that you have the following dependency in your project's `pom.xml` file:
+
+```
+<dependency>
+  <groupId>org.opensearch.client</groupId>
+  <artifactId>opensearch-rest-high-level-client</artifactId>
+  <version>{{site.opensearch_version}}</version>
+</dependency>
+```
+
+You can now start your OpenSearch cluster. The OpenSearch 1.x high-level REST client works with the 1.x versions of OpenSearch.
+
+## Sample code
+
+```java
+import org.apache.http.HttpHost;
+import org.apache.http.auth.AuthScope;
+import org.apache.http.auth.UsernamePasswordCredentials;
+import org.apache.http.client.CredentialsProvider;
+import org.apache.http.impl.client.BasicCredentialsProvider;
+import org.apache.http.impl.nio.client.HttpAsyncClientBuilder;
+import org.opensearch.action.admin.indices.delete.DeleteIndexRequest;
+import org.opensearch.action.delete.DeleteRequest;
+import org.opensearch.action.delete.DeleteResponse;
+import org.opensearch.action.get.GetRequest;
+import org.opensearch.action.get.GetResponse;
+import org.opensearch.action.index.IndexRequest;
+import org.opensearch.action.index.IndexResponse;
+import org.opensearch.action.support.master.AcknowledgedResponse;
+import org.opensearch.client.RequestOptions;
+import org.opensearch.client.RestClient;
+import org.opensearch.client.RestClientBuilder;
+import org.opensearch.client.RestHighLevelClient;
+import org.opensearch.client.indices.CreateIndexRequest;
+import org.opensearch.client.indices.CreateIndexResponse;
+import org.opensearch.common.settings.Settings;
+
+import java.io.IOException;
+import java.util.HashMap;
+
+public class RESTClientSample {
+
+  public static void main(String[] args) throws IOException {
+
+    //Point to keystore with appropriate certificates for security.
+    System.setProperty("javax.net.ssl.trustStore", "/full/path/to/keystore");
+    System.setProperty("javax.net.ssl.trustStorePassword", "password-to-keystore");
+
+    //Establish credentials to use basic authentication.
+    //Only for demo purposes. Do not specify your credentials in code.
+    final CredentialsProvider credentialsProvider = new BasicCredentialsProvider();
+
+    credentialsProvider.setCredentials(AuthScope.ANY,
+      new UsernamePasswordCredentials("admin", "admin"));
+
+    //Create a client.
+    RestClientBuilder builder = RestClient.builder(new HttpHost("localhost", 9200, "https"))
+      .setHttpClientConfigCallback(new RestClientBuilder.HttpClientConfigCallback() {
+        @Override
+        public HttpAsyncClientBuilder customizeHttpClient(HttpAsyncClientBuilder httpClientBuilder) {
+          return httpClientBuilder.setDefaultCredentialsProvider(credentialsProvider);
+            }
+          });
+    RestHighLevelClient client = new RestHighLevelClient(builder);
+
+    //Create a non-default index with custom settings and mappings.
+    CreateIndexRequest createIndexRequest = new CreateIndexRequest("custom-index");
+
+    createIndexRequest.settings(Settings.builder() //Specify in the settings how many shards you want in the index.
+      .put("index.number_of_shards", 4)
+      .put("index.number_of_replicas", 3)
+      );
+    //Create a set of maps for the index's mappings.
+    HashMap<String, String> typeMapping = new HashMap<String,String>();
+    typeMapping.put("type", "integer");
+    HashMap<String, Object> ageMapping = new HashMap<String, Object>();
+    ageMapping.put("age", typeMapping);
+    HashMap<String, Object> mapping = new HashMap<String, Object>();
+    mapping.put("properties", ageMapping);
+    createIndexRequest.mapping(mapping);
+    CreateIndexResponse createIndexResponse = client.indices().create(createIndexRequest, RequestOptions.DEFAULT);
+
+    //Adding data to the index.
+    IndexRequest request = new IndexRequest("custom-index"); //Add a document to the custom-index we created.
+    request.id("1"); //Assign an ID to the document.
+
+    HashMap<String, String> stringMapping = new HashMap<String, String>();
+    stringMapping.put("message:", "Testing Java REST client");
+    request.source(stringMapping); //Place your content into the index's source.
+    IndexResponse indexResponse = client.index(request, RequestOptions.DEFAULT);
+
+    //Getting back the document
+    GetRequest getRequest = new GetRequest("custom-index", "1");
+    GetResponse response = client.get(getRequest, RequestOptions.DEFAULT);
+
+    System.out.println(response.getSourceAsString());
+
+    //Delete the document
+    DeleteRequest deleteDocumentRequest = new DeleteRequest("custom-index", "1"); //Index name followed by the ID.
+    DeleteResponse deleteResponse = client.delete(deleteDocumentRequest, RequestOptions.DEFAULT);
+
+    //Delete the index
+    DeleteIndexRequest deleteIndexRequest = new DeleteIndexRequest("custom-index"); //Index name.
+    AcknowledgedResponse deleteIndexResponse = client.indices().delete(deleteIndexRequest, RequestOptions.DEFAULT);
+
+    client.close();
+  }
+}
+```
+
+## Elasticsearch OSS Java high-level REST client
+
+We recommend using the OpenSearch client to connect to OpenSearch clusters, but if you must use the Elasticsearch OSS Java high-level REST client, version 7.10.2 of the Elasticsearch OSS client also works with the 1.x versions of OpenSearch.
+
+### Migrating to the OpenSearch Java high-level REST client
+
+Migrating from the Elasticsearch OSS client to the OpenSearch high-level REST client is as simple as changing your Maven dependency to one that references [OpenSearch's dependency](#setup).
+
+Afterward, change all references of `org.elasticsearch` to `org.opensearch`, and you're ready to start submitting requests to your OpenSearch cluster.

_clients/java.md

@@ -0,0 +1,165 @@
+---
+layout: default
+title: OpenSearch Java client
+nav_order: 65
+---
+
+# Java client
+
+The OpenSearch Java client allows you to interact with your OpenSearch clusters through Java methods and data structures rather than HTTP methods and raw JSON.
+
+For example, you can submit requests to your cluster using objects to create indices, add data to documents, or complete some other operation using the client's built-in methods.
+
+## Setup
+
+To start using the OpenSearch Java client, ensure that you have the following dependency in your project's `pom.xml` file:
+
+```
+<dependency>
+  <groupId>org.opensearch.client</groupId>
+  <artifactId>opensearch-java</artifactId>
+  <version>0.1.0</version>
+</dependency>
+```
+
+If you're using Gradle, add the following dependencies to your project.
+
+```
+dependencies {
+    implementation 'org.opensearch.client:opensearch-rest-client: {{site.opensearch_version}}'
+    implementation 'org.opensearch.client:opensearch-java:0.1.0'
+}
+```
+
+You can now start your OpenSearch cluster.
+
+The following example uses credentials that come with the default OpenSearch configuration. If you're using the OpenSearch Java client with your own OpenSearch cluster, be sure to change the code to use your own credentials.
+
+## Sample code
+
+This section uses a class called `IndexData`, which is a simple Java class that stores basic data and methods. For your own OpenSearch cluster, you might find that you need a more robust class to store your data.
+
+### IndexData class
+
+```java
+static class IndexData {
+  private String firstName;
+  private String lastName;
+
+  public IndexData(String firstName, String lastName) {
+    this.firstName = firstName;
+    this.lastName = lastName;
+  }
+
+  public String getFirstName() {
+    return firstName;
+  }
+
+  public void setFirstName(String firstName) {
+    this.firstName = firstName;
+  }
+
+  public String getLastName() {
+    return lastName;
+  }
+
+  public void setLastName(String lastName) {
+    this.lastName = lastName;
+  }
+
+  @Override
+  public String toString() {
+    return String.format("IndexData{first name='%s', last name='%s'}", firstName, lastName);
+  }
+}
+```
+
+### OpenSearch client example
+
+```java
+import org.apache.http.HttpHost;
+import org.apache.http.auth.AuthScope;
+import org.apache.http.auth.UsernamePasswordCredentials;
+import org.apache.http.client.CredentialsProvider;
+import org.apache.http.impl.client.BasicCredentialsProvider;
+import org.apache.http.impl.nio.client.HttpAsyncClientBuilder;
+import org.opensearch.client.RestClient;
+import org.opensearch.client.RestClientBuilder;
+import org.opensearch.clients.base.RestClientTransport;
+import org.opensearch.clients.base.Transport;
+import org.opensearch.clients.json.jackson.JacksonJsonpMapper;
+import org.opensearch.clients.opensearch.OpenSearchClient;
+import org.opensearch.clients.opensearch._global.IndexRequest;
+import org.opensearch.clients.opensearch._global.IndexResponse;
+import org.opensearch.clients.opensearch._global.SearchResponse;
+import org.opensearch.clients.opensearch.indices.*;
+import org.opensearch.clients.opensearch.indices.put_settings.IndexSettingsBody;
+
+import java.io.IOException;
+
+public class OpenSearchClientExample {
+  public static void main(String[] args) {
+    try{
+    System.setProperty("javax.net.ssl.trustStore", "/full/path/to/keystore");
+    System.setProperty("javax.net.ssl.trustStorePassword", "password-to-keystore");
+
+    //Only for demo purposes. Don't specify your credentials in code.
+    final CredentialsProvider credentialsProvider = new BasicCredentialsProvider();
+    credentialsProvider.setCredentials(AuthScope.ANY,
+      new UsernamePasswordCredentials("admin", "admin"));
+
+    //Initialize the client with SSL and TLS enabled
+    RestClient restClient = RestClient.builder(new HttpHost("localhost", 9200, "https")).
+      setHttpClientConfigCallback(new RestClientBuilder.HttpClientConfigCallback() {
+        @Override
+        public HttpAsyncClientBuilder customizeHttpClient(HttpAsyncClientBuilder httpClientBuilder) {
+        return httpClientBuilder.setDefaultCredentialsProvider(credentialsProvider);
+        }
+      }).build();
+    Transport transport = new RestClientTransport(restClient, new JacksonJsonpMapper());
+    OpenSearchClient client = new OpenSearchClient(transport);
+
+    //Create the index
+    String index = "sample-index";
+    CreateRequest createIndexRequest = new CreateRequest.Builder().index(index).build();
+    client.indices().create(createIndexRequest);
+
+    //Add some settings to the index
+    IndexSettings indexSettings = new IndexSettings.Builder().autoExpandReplicas("0-all").build();
+    IndexSettingsBody settingsBody = new IndexSettingsBody.Builder().settings(indexSettings).build();
+    PutSettingsRequest putSettingsRequest = new PutSettingsRequest.Builder().index(index).value(settingsBody).build();
+    client.indices().putSettings(putSettingsRequest);
+
+    //Index some data
+    IndexData indexData = new IndexData("first_name", "Bruce");
+    IndexRequest<IndexData> indexRequest = new IndexRequest.Builder<IndexData>().index(index).id("1").value(indexData).build();
+    client.index(indexRequest);
+
+    //Search for the document
+    SearchResponse<IndexData> searchResponse = client.search(s -> s.index(index), IndexData.class);
+    for (int i = 0; i< searchResponse.hits().hits().size(); i++) {
+      System.out.println(searchResponse.hits().hits().get(i).source());
+    }
+
+    //Delete the document
+    client.delete(b -> b.index(index).id("1"));
+
+    // Delete the index
+    DeleteRequest deleteRequest = new DeleteRequest.Builder().index(index).build();
+    DeleteResponse deleteResponse = client.indices().delete(deleteRequest);
+
+    restClient.close();
+    } catch (IOException e){
+      System.out.println(e.toString());
+    } finally {
+			try {
+				if (client != null) {
+					client.close();
+				}
+			} catch (IOException e) {
+				System.out.println(e.toString());
+			}
+		}
+  }
+}
+```

_clients/javascript.md

@@ -0,0 +1,141 @@
+---
+layout: default
+title: JavaScript client
+nav_order: 90
+---
+
+# JavaScript client
+
+The OpenSearch JavaScript client provides a safer and easier way to interact with your OpenSearch cluster. Rather than using OpenSearch from the browser and potentially exposing your data to the public, you can build an OpenSearch client that takes care of sending requests to your cluster.
+
+The client contains a library of APIs that let you perform different operations on your cluster and return a standard response body. The example here demonstrates some basic operations like creating an index, adding documents, and searching your data.
+
+## Setup
+
+To add the client to your project, install it from [npm](https://www.npmjs.com):
+
+```bash
+npm install @opensearch-project/opensearch
+```
+
+To install a specific major version of the client, run the following command:
+
+```bash
+npm install @opensearch-project/opensearch@<version>
+```
+
+If you prefer to add the client manually or just want to examine the source code, see [opensearch-js](https://github.com/opensearch-project/opensearch-js) on GitHub.
+
+Then require the client:
+
+```javascript
+const { Client } = require("@opensearch-project/opensearch");
+```
+
+## Sample code
+
+```javascript
+"use strict";
+
+var host = "localhost";
+var protocol = "https";
+var port = 9200;
+var auth = "admin:admin"; // For testing only. Don't store credentials in code.
+var ca_certs_path = "/full/path/to/root-ca.pem";
+
+// Optional client certificates if you don't want to use HTTP basic authentication.
+// var client_cert_path = '/full/path/to/client.pem'
+// var client_key_path = '/full/path/to/client-key.pem'
+
+// Create a client with SSL/TLS enabled.
+var { Client } = require("@opensearch-project/opensearch");
+var fs = require("fs");
+var client = new Client({
+  node: protocol + "://" + auth + "@" + host + ":" + port,
+  ssl: {
+    ca: fs.readFileSync(ca_certs_path),
+    // You can turn off certificate verification (rejectUnauthorized: false) if you're using self-signed certificates with a hostname mismatch.
+    // cert: fs.readFileSync(client_cert_path),
+    // key: fs.readFileSync(client_key_path)
+  },
+});
+
+async function search() {
+  // Create an index with non-default settings.
+  var index_name = "books";
+  var settings = {
+    settings: {
+      index: {
+        number_of_shards: 4,
+        number_of_replicas: 3,
+      },
+    },
+  };
+
+  var response = await client.indices.create({
+    index: index_name,
+    body: settings,
+  });
+
+  console.log("Creating index:");
+  console.log(response.body);
+
+  // Add a document to the index.
+  var document = {
+    title: "The Outsider",
+    author: "Stephen King",
+    year: "2018",
+    genre: "Crime fiction",
+  };
+
+  var id = "1";
+
+  var response = await client.index({
+    id: id,
+    index: index_name,
+    body: document,
+    refresh: true,
+  });
+
+  console.log("Adding document:");
+  console.log(response.body);
+
+  // Search for the document.
+  var query = {
+    query: {
+      match: {
+        title: {
+          query: "The Outsider",
+        },
+      },
+    },
+  };
+
+  var response = await client.search({
+    index: index_name,
+    body: query,
+  });
+
+  console.log("Search results:");
+  console.log(response.body.hits);
+
+  // Delete the document.
+  var response = await client.delete({
+    index: index_name,
+    id: id,
+  });
+
+  console.log("Deleting document:");
+  console.log(response.body);
+
+  // Delete the index.
+  var response = await client.indices.delete({
+    index: index_name,
+  });
+
+  console.log("Deleting index:");
+  console.log(response.body);
+}
+
+search().catch(console.log);
+```

_clients/logstash/advanced-config.md

@@ -0,0 +1,246 @@
+---
+layout: default
+title: Advanced configurations
+parent: Logstash
+nav_order: 230
+---
+
+# Advanced configurations
+
+This section describes how to set up advanced configuration options, like referencing field values and conditional statements, for Logstash.
+
+## Referencing field values
+
+To get access to a field, use the `- field` syntax.
+You can also surround the field name by square brackets `- [field]` which makes it more explicit that you're referring to a field.
+
+
+For example, if you have the following event:
+
+```bash
+{
+  "request": "/products/view/123",
+  "verb": "GET",
+  "response": 200,
+  "headers": {
+  "request_path" => "/"
+  }
+}
+```
+
+To access the `request` field, use `- request` or `- [request]`.
+
+If you want to reference nested fields, use the square brackets syntax and specify the path to the field. With each level being enclosed within square brackets: `- [headers][request_path]`.
+
+You can reference fields using the `sprintf` format. This is also called string expansion. You need to add a % sign and then wrap the field reference within curly brackets.
+
+You need to reference field values when using conditional statements.
+
+For example, you can make the file name dynamic and contain the type of the processed events - either `access` or `error`. The `type` option is mainly used for conditionally applying filter plugins based on the type of events being processed.
+
+Let's add a `type` option and specify a value of `access`.
+
+
+```yml
+input {
+  file {
+    path => ""
+  start_position => "beginning"
+  type => "access"
+  }
+  http {
+    type => "access"
+  }
+}
+
+filter {
+  mutate {
+    remove_field => {"host"}
+  }
+}
+
+output {
+  stdout {
+    codec => rubydebug
+  }
+file {
+  path => "%{[type]}.log"
+  }
+}
+```
+
+Start Logstash and send an HTTP request. The processed event is output in the terminal. The event now includes a field named `type`.
+
+You'll see the `access.log` file created within the Logstash directory.
+
+## Conditional statements
+
+You can use conditional statements to control the flow of code execution based on some conditions.
+
+Syntax:
+
+```yml
+if EXPR {
+  ...
+} else if EXPR {
+  ...
+} else {
+  ...
+}
+```
+
+`EXPR` is any valid Logstash syntax that evaluates to a boolean value.
+For example, you can check if an event type is set to `access` or `error` and perform some action based on that:
+
+```yml
+if [type] == "access" {
+...
+} else if [type] == "error" {
+file { .. }
+} else {
+...
+}
+```
+
+You can compare a field value to some arbitrary value:
+
+```yml
+if [headers][content_length] >= 1000 {
+...
+}
+```
+
+You can regex:
+
+```yml
+if [some_field =~ /[0-9]+/ {
+  //some field only contains digits
+}
+```
+
+You can use arrays:
+
+```yml
+if [some_field] in ["one", "two", "three"] {
+  some field is either "one", "two", or "three"
+}
+```
+
+You can use boolean operators:
+
+```yml
+if [type] == "access" or [type] == "error" {
+  ...
+}
+```
+
+
+## Formatting dates
+
+You can use the `sprintf` format or string expansion to format dates.
+For example, you might want the current date to be part of the filename.
+
+To format the date, add a plus sign in curly brackets followed by the date format - `%{+yyyy-MM-dd}`.
+
+```yml
+file {
+  path => "%{[type]}_%{+yyyy_MM_dd}.log"
+}
+```
+
+This is the date stored within the @timestamp fields, which is the time and date of the event.
+Send a request to the pipeline and verify that a filename is outputted that contains the events date.
+
+You can embed the date in other outputs as well, for example into the index name in OpenSearch.
+
+## Sending time information
+
+You can set the time of events.
+
+Logstash already sets the time when the event is received by the input plugin within the @timestamp field.
+In some scenarios, you might need to use a different timestamp.
+For example, if you have an eCommerce store and you process the orders daily at midnight. When Logstash receives the events at midnight, it sets the timestamp to the current time.
+But you want it to be the time when the order is placed and not when Logstash received the event.
+
+Let's change the event timestamp to the date the request is received by the web server. You can do this using a filter plugin named `dates`.
+The `dates` filter passes a `date` or `datetime` value from a field and uses the results as the event timestamp.
+
+Add the `date` plugin at the bottom of the `filter` block:
+
+```yml
+date {
+  match => [ "timestamp", "dd/MMM/yyyy:HH:mm:ss Z" ]
+}
+```
+
+timestamp is the field that the `grok` pattern creates.
+`Z` is the timezone. i.e., UTC offsets.
+
+Start Logstash and send an HTTP request.
+
+You can see that the filename contains the date of the request instead of the present date.
+
+If the passing of the date fails, the `filter` plugin adds a tag named `_datepassfailure` to the text field.
+
+After you have set the @timestamp field to a new value, you don't really need the other `timestamp` field anymore. You can remove it with the `remove_field` option.
+
+```yml
+date {
+  match => [ "timestamp", "dd/MMM/yyyy:HH:mm:ss Z" ]
+  remove_field => [ "timestamp" ]
+}
+```
+
+## Parsing user agents
+
+The user agent is the last part of a log entry that consists of the name of the browser, the browser version, and the OS of the device.
+
+Users might be using a wide range of browsers, devices, and OS's. Doing this manually is hard.
+
+You can't use `grok` patterns because the `grok` pattern only matches the usage in the string as whole and doesn't figure out which browser the visitor used for instance.
+
+Logstash ships with a file containing regular expressions for this purpose. This makes it really easy to extract user agent information, which you could send to OpenSearch and run aggregations on.
+
+To do this, add a `source` option that contains the name of the field. In this case, that's the `agent` field.
+By default the user agent plugin, adds a number of fields at the top-level of the event.
+Since that can get pretty confusing, we can add an option named `target` with a value of `ua`, short for user agent. What this does is that it nests the fields within an object named `ua`, making things more organized.
+
+```yml
+useragent {
+  source => "agent"
+  target => "ua"
+}
+```
+
+Start Logstah and send an HTTP request.
+
+You can see a field named `ua` with a number of keys including the browser name and version, the OS, and the device.
+
+You could OpenSearch Dashboards to create a pie chart that shows how many visitors are from mobile devices and how many are desktop users. Or, you could get statistics on which browser versions are popular.
+
+## Enriching geographical data
+
+You can take an IP address and perform geographical lookup to resolve the geographical location of the user using the `geoip` filter.
+
+The `geoip` filter plugin ships with a database called `geolite 2`, which is provided by a company named MaxMind. `geolite 2` is a popular source of geographical data and it's available for free.
+Add the `geoip` plugin at the bottom of the `else` block.
+
+The value of the `source` option is the name of the field containing the IP address, in this case that's `clientip`. You can make this field available using the `grok` pattern.
+
+```yml
+geoip {
+  source => "clientip"
+}
+```
+
+Start Logstash and send an HTTP request.
+
+Within the terminal, you see a new field named `geoip` that contains information such as the timezone, country, continent, city, postal code, and the latitude / longitude pair.
+
+If you only need the country name for instance, include an option named `fields` with an array of the field names that you want the `geoip` plugin to return.
+
+Some of the fields are not always available such as city name and region because translating IP addresses into geographical locations is generally not that accurate. If the `geoip` plugin fails to look up the geographical location, it adds a tag named `geoip_lookup_failure`.
+
+You can use the `geoip` plugin with the OpenSearch output because `location` object within the `geoip` object, is a standard format for representing geospatial data in JSON. This is the same format as OpenSearch uses for its `geo_point` data type.
+
+You can use the powerful geospatial queries of OpenSearch for working with geographical data.

_clients/logstash/common-filters.md

@@ -0,0 +1,157 @@
+---
+layout: default
+title: Common filter plugins
+parent: Logstash
+nav_order: 220
+---
+
+# Common filter plugins
+
+This page contains a list of common filter plugins.
+
+## mutate
+
+You can use the `mutate` filter to change the data type of a field. For example, you can use the `mutate` filter if you're sending events to OpenSearch and you need to change the data type of a field to match any existing mappings.
+
+To convert the `quantity` field from a `string` type to an `integer` type:
+
+```yml
+input {
+  http {
+    host => "127.0.0.1"
+    port => 8080
+  }
+}
+
+filter {
+  mutate {
+   convert => {"quantity" => "integer"}
+  }
+}
+
+output {
+  file {
+    path => "output.txt"
+  }
+}
+```
+
+#### Sample output
+
+You can see that the type of the `quantity` field is changed from a `string` to an `integer`.
+
+```yml
+{
+  "quantity" => 3,
+  "host" => "127.0.0.1",
+  "@timestamp" => 2021-05-23T19:02:08.026Z,
+  "amount" => 10,
+  "@version" => "1",
+  "headers" => {
+    "request_path" => "/",
+    "connection" => "keep-alive",
+    "content_length" => "41",
+    "http_user_agent" => "PostmanRuntime/7.26.8",
+    "request_method" => "PUT",
+    "cache_control" => "no-cache",
+    "http_accept" => "*/*",
+    "content_type" => "application/json",
+    "http_version" => "HTTP/1.1",
+    "http_host" => "127.0.0.1:8080",
+    "accept_encoding" => "gzip, deflate, br",
+    "postman_token" => "ffd1cdcb-7a1d-4d63-90f8-0f2773069205"
+   }
+}
+```
+
+Other data types you can convert to are `float`, `string`, and `boolean` values. If you pass in an array, the `mutate` filter converts all the elements in the array. If you pass a `string` like "world" to cast to an `integer` type, the result is 0 and Logstash continues processing events.
+
+Logstash supports a few common options for all filter plugins:
+
+Option | Description
+:--- | :---
+`add_field` | Adds one or more fields to the event.
+`remove_field` | Removes one or more events from the field.
+`add_tag` | Adds one or more tags to the event. You can use tags to perform conditional processing on events depending on which tags they contain.
+`remove_tag` | Removes one or more tags from the event.
+
+For example, you can remove the `host` field from the event:
+
+```yml
+input {
+  http {
+    host => "127.0.0.1"
+    port => 8080
+  }
+}
+
+filter {
+  mutate {
+    remove_field => {"host"}
+  }
+}
+
+output {
+  file {
+    path => "output.txt"
+  }
+}
+```
+
+## grok
+
+With the `grok` filter, you can parse unstructured data and and structure it into fields. The `grok` filter uses text patterns to match text in your logs. You can think of text patterns as variables containing regular expressions.
+
+The format of a text pattern is as follows:
+
+```bash
+%{SYNTAX:SEMANTIC}
+```
+
+`SYNTAX` is the format a piece of text should be in for the pattern to match. You can enter any of `grok`'s predefined patterns. For example, you can use the email identifier to match an email address from a given piece of text.
+
+`SEMANTIC` is an arbitrary name for the matched text. For example, if you're using the email identifier syntax, you can name it “email.”
+
+The following request consists of the IP address of the visitor, name of the visitor, the timestamp of the request, the HTTP verb and URL, the HTTP status code, and the number of bytes:
+
+```bash
+184.252.108.229 - joe [20/Sep/2017:13:22:22 +0200] GET /products/view/123 200 12798
+```
+
+To split this request into different fields:
+
+```yml
+filter {
+  grok {
+   match => { "message" => " %{IP: ip_address} %{USER:identity}
+                             %{USER:auth} \[%{HTTPDATE:reg_ts}\]
+                             \"%{WORD:http_verb}
+                             %{URIPATHPARAM: req_path}
+                             \" %{INT:http_status:int}
+                             %{INT:num_bytes:int}"}
+  }
+}
+```
+
+where:
+
+- `IP`: matches the IP address field.
+- `USER`: matches the user name.
+- `WORD`: matches the HTTP verb.
+- `URIPATHPARAM`: matches the URI path.
+- `INT`: matches the HTTP status field.
+- `INT`: matches the number of bytes.
+
+This is what the event looks like after the `grok` filter breaks it down into individual fields:
+
+```yml
+ip_address: 184.252.108.229
+identity: joe
+reg_ts: 20/Sep/2017:13:22:22 +0200
+http_verb:GET
+req_path: /products/view/123
+http_status: 200
+num_bytes: 12798
+```
+
+For common log formats, you use the predefined patterns defined here⁠---[Logstash patterns](https://github.com/logstash-plugins/logstash-patterns-core/blob/master/patterns/ecs-v1). You can make any adjustments to the results with the `mutate` filter.

_clients/logstash/execution-model.md

@@ -0,0 +1,40 @@
+---
+layout: default
+title: Logstash execution model
+parent: Logstash
+nav_order: 210
+---
+
+# Logstash execution model
+
+Here's a brief introduction to how Logstash processes events internally.
+
+## Handling events concurrently
+
+You can configure Logstash to have a number of inputs listening for events. Each input runs in its own thread to avoid inputs blocking each other. If you have two incoming events at the same time, Logstash handles both events concurrently.
+
+After receiving an event and possibly applying an input codec, Logstash sends the event to a work queue. Pipeline workers or batchers perform the rest of the work involving filters and outputs along with any codec used at the output. Each pipeline worker also runs within its own thread meaning that Logstash processes multiple events simultaneously.
+
+## Processing events in batches
+
+A pipeline worker consumes events from the work queue in batches to optimize the throughput of the pipeline as a whole.
+
+One reason why Logstash works in batches is that some code needs to be executed regardless of how many events are processed at a time within the pipeline worker. Instead of executing that code 100 times for 100 events, it’s more efficient to execute it once for a batch of 100 events.
+
+Another reason is that a few output plugins group together events as batches. For example, if you send 100 requests to OpenSearch, the OpenSearch output plugin uses the bulk API to send a single request that groups together the 100 requests.
+
+Logstash determines the batch size by two configuration options⁠---a number representing the maximum batch size and the batch delay. The batch delay is how long Logstash waits before processing the unprocessed batch of events.
+If you set the maximum batch size to 50 and the batch delay to 100 ms, Logstash processes a batch if they're either 50 unprocessed events in the work queue or if one hundred milliseconds have elapsed.
+
+The reason that a batch is processed, even if the maximum batch size isn’t reached, is to reduce the delay in processing and to continue to process events in a timely manner. This works well for pipelines that process a low volume of events.
+
+Imagine that you’ve a pipeline that processes error logs from web servers and pushes them to OpenSearch. You’re using OpenSearch Dashboards to analyze the error logs. Because you’re possibly dealing with a fairly low number of events, it might take a long time to reach 50 events. Logstash processes the events before reaching this threshold because otherwise there would be a long delay before we see the errors appear in OpenSearch Dashboards.
+
+The default batch size and batch delay work for most cases. You don’t need to change the default values unless you need to minutely optimize the performance.
+
+## Optimizing based on CPU cores
+
+The number of pipeline workers are proportional to the number of CPU cores on the nodes.
+If you have 5 workers running on a server with 2 CPU cores, the 5 workers won't be able to process events concurrently. On the other hand, running 5 workers on a server running 10 CPU cores limits the throughput of a Logstash instance.
+
+Instead of running a fixed number of workers, which results in poor performance in some cases, Logstash examines the number of CPU cores of the instance and selects the number of pipeline workers to optimize its performance for the platform on which its running. For instance, your local development machine might not have the same processing power as a production server. So you don't need to manually configure Logstash for different machines.

_clients/logstash/index.md

@@ -0,0 +1,361 @@
+---
+layout: default
+title: Logstash
+nav_order: 200
+has_children: true
+has_toc: true
+redirect_from:
+  - /clients/logstash/
+---
+
+# Logstash
+
+Logstash is a real-time event processing engine. It's part of the OpenSearch stack which includes OpenSearch, Beats, and OpenSearch Dashboards.
+
+You can send events to Logstash from many different sources. Logstash processes the events and sends it one or more destinations. For example, you can send access logs from a web server to Logstash. Logstash extracts useful information from each log and sends it to a destination like OpenSearch.
+
+Sending events to Logstash lets you decouple event processing from your app. Your app only needs to send events to Logstash and doesn’t need to know anything about what happens to the events afterwards.
+
+The open-source community originally built Logstash for processing log data but now you can process any type of events, including events in XML or JSON format.
+
+## Structure of a pipeline
+
+The way that Logstash works is that you configure a pipeline that has three phases⁠---inputs, filters, and outputs.
+
+Each phase uses one or more plugins. Logstash has over 200 built-in plugins so chances are that you’ll find what you need. Apart from the built-in plugins, you can use plugins from the community or even write your own.
+
+The structure of a pipeline is as follows:
+
+```yml
+input {
+  input_plugin => {}
+}
+
+filter {
+  filter_plugin => {}
+}
+
+output {
+  output_plugin => {}
+}
+```
+
+where:
+
+* `input` receives events like logs from multiple sources simultaneously. Logstash supports a number of input plugins for TCP/UDP, files, syslog, Microsoft Windows EventLogs, stdin, HTTP, and so on. You can also use an open source collection of input tools called Beats to gather events. The input plugin sends the events to a filter.
+* `filter` parses and enriches the events in one way or the other. Logstash has a large collection of filter plugins that modify events and pass them on to an output. For example, a `grok` filter parses unstructured events into fields and a `mutate` filter changes fields. Filters are executed sequentially.
+* `output` ships the filtered events to one or more destinations. Logstash supports a wide range of output plugins for destinations like OpenSearch, TCP/UDP, emails, files, stdout, HTTP, Nagios, and so on.
+
+Both the input and output phases support codecs to process events as they enter or exit the pipeline.
+Some of the popular codecs are `json` and `multiline`. The `json` codec processes data that’s in JSON format and the `multiline` codec merges multiple line events into a single line.
+
+You can also write conditional statements within pipeline configurations to perform certain actions, if a certain criteria is met.
+
+## Install Logstash
+
+The OpenSearch Logstash plugin has two installation options at this time: Linux (ARM64/X64) and Docker (ARM64/X64).
+
+Make sure you have [Java Development Kit (JDK)](https://www.oracle.com/java/technologies/javase-downloads.html) version 8 or 11 installed.
+
+If you're migrating from an existing Logstash installation, you can install the [OpenSearch output plugin](https://rubygems.org/gems/logstash-output-opensearch/) manually and [update pipeline.conf](https://opensearch.org/docs/latest/clients/logstash/ship-to-opensearch/). We include this plugin by default in our tarball and Docker downloads.
+{: .note }
+
+### Tarball
+
+1. Download the Logstash tarball from [OpenSearch downloads](https://opensearch.org/downloads.html).
+
+2. Navigate to the downloaded folder in the terminal and extract the files:
+
+     ```bash
+     tar -zxvf logstash-oss-with-opensearch-output-plugin-7.13.2-linux-x64.tar.gz
+     ```
+
+3. Navigate to the `logstash-7.13.2` directory.
+- You can add your pipeline configurations to the `config` directory. Logstash saves any data from the plugins in the `data` directory. The `bin` directory contains the binaries for starting Logstash and managing plugins.
+
+### Docker
+
+1. Pull the Logstash oss package with the OpenSearch output plugin image:
+
+    ```
+    docker pull opensearchproject/logstash-oss-with-opensearch-output-plugin:7.13.2
+    ```
+
+1. Create a Docker network:
+
+    ```
+    docker network create test
+    ```
+
+1. Start OpenSearch with this network:
+
+    ```
+    docker run -p 9200:9200 -p 9600:9600 --name opensearch --net test -e "discovery.type=single-node" opensearchproject/opensearch:1.0.0
+    ```
+
+1. Start Logstash:
+
+    ```
+    docker run -it --rm --name logstash --net test opensearchproject/logstash-oss-with-opensearch-output-plugin:7.13.2 -e 'input { stdin { } } output {
+      opensearch {
+        hosts => ["https://opensearch:9200"]
+        index => "opensearch-logstash-docker-%{+YYYY.MM.dd}"
+        user => "admin"
+        password => "admin"
+        ssl => true
+        ssl_certificate_verification => false
+      }
+    }'
+    ```
+
+## Process text from the terminal
+
+You can define a pipeline that listens for events on `stdin` and outputs events on `stdout`. `stdin` and `stdout` refer to the terminal in which you’re running Logstash.
+
+To enter some text in the terminal and see the event data in the output:
+
+1. Use the `-e` argument to pass a pipeline configuration directly to the Logstash binary. In this case, `stdin` is the input plugin and `stdout` is the output plugin:
+
+    ```bash
+    bin/logstash -e "input { stdin { } } output { stdout { } }"
+    ```
+    Add the `—debug` flag to see a more detailed output.
+
+2. Enter "hello world" in your terminal. Logstash processes the text and outputs it back to the terminal:
+
+    ```yml
+    {
+     "message" => "hello world",
+     "host" => "a483e711a548.ant.amazon.com",
+     "@timestamp" => 2021-05-30T05:15:56.816Z,
+     "@version" => "1"
+    }
+    ```
+
+    The `message` field contains your raw input. The `host` field is an IP address when you don’t run Logstash locally. `@timestamp` shows the date and time for when the event is processed. Logstash uses the `@version` field for internal processing.
+
+3. Press `Ctrl + C` to shut down Logstash.
+
+### Troubleshooting
+
+If you already have a Logstash process running, you’ll get an error. To fix this issue:
+
+1. Delete the `.lock` file from the `data` directory:
+
+    ```bash
+    cd data
+    rm -rf .lock
+    ```
+
+2. Restart Logstash.
+
+## Process JSON or HTTP input and output it to a file
+
+To define a pipeline that handles JSON requests:
+
+1. Open the `config/pipeline.conf` file in any text editor you like. You can create a pipeline configuration file with any extension, the `.conf` extension is a Logstash convention. Add the `json` codec to accept JSON as the input and the `file` plugin to output the processed events to a `.txt` file:
+
+    ```yml
+    input {
+      stdin {
+        codec => json
+      }
+    }
+    output {
+      file {
+        path => "output.txt"
+      }
+    }
+    ```
+
+    To process inputs from a file, add an input file to the `events-data` directory and then pass its path to the `file` plugin at the input:
+
+    ```yml
+    input {
+      file {
+        path => "events-data/input_data.log"
+      }
+    }
+    ```
+
+2. Start Logstash:
+
+    ```bash
+    $ bin/logstash -f config/pipeline.conf
+    ```
+
+    `config/pipeline.conf` is a relative path to the `pipeline.conf` file. You can use an absolute path as well.
+
+3. Add a JSON object in the terminal:
+
+    ```json
+    { "amount": 10, "quantity": 2}
+    ```
+
+    The pipeline only handles a single line of input. If you paste some JSON that spans multiple lines, you’ll get an error.
+
+4. Check that the fields from the JSON object are added to the `output.txt` file:
+
+    ```json
+    $ cat output.txt
+
+    {
+      "@version": "1",
+      "@timestamp": "2021-05-30T05:52:52.421Z",
+      "host": "a483e711a548.ant.amazon.com",
+      "amount": 10,
+      "quantity": 2
+    }
+    ```
+
+    If you type in some invalid JSON as the input, you'll see a JSON parsing error. Logstash doesn't discard the invalid JSON because you still might want to do something with it. For example, you can trigger an email or send a notification to a Slack channel.
+
+To define a pipeline that handles HTTP requests:
+
+1. Use the `http` plugin to send events to Logstash through HTTP:
+
+    ```yml
+    input {
+      http {
+        host => "127.0.0.1"
+        port => 8080
+      }
+    }
+
+    output {
+      file {
+        path => "output.txt"
+      }
+    }
+    ```
+
+    If you don’t specify any options, the `http` plugin binds to `localhost` and listens on port 8080.
+
+2. Start Logstash:
+
+    ```bash
+    $ bin/logstash -f config/pipeline.conf
+    ```
+
+3. Use Postman to send an HTTP request. Set `Content-Type` to an HTTP header with a value of `application/json`:
+
+    ```json
+    PUT 127.0.0.1:8080
+
+    {
+      "amount": 10,
+      "quantity": 2
+    }
+    ```
+
+    Or, you can use the `curl` command:
+
+    ```bash
+    curl -XPUT -H "Content-Type: application/json" -d ' {"amount": 7, "quantity": 3 }' http://localhost:8080 (http://localhost:8080/)
+    ```
+
+    Even though we haven't added the `json` plugin to the input, the pipeline configuration still works because the HTTP plugin automatically applies the appropriate codec based on the `Content-Type` header.
+    If you specify a value of `applications/json`, Logstash parses the request body as JSON.
+
+    The `headers` field contains the HTTP headers that Logstash receives:
+
+    ```json
+    {
+      "host": "127.0.0.1",
+      "quantity": "3",
+      "amount": 10,
+      "@timestamp": "2021-05-30T06:05:48.135Z",
+      "headers": {
+        "http_version": "HTTP/1.1",
+        "request_method": "PUT",
+        "http_user_agent": "PostmanRuntime/7.26.8",
+        "connection": "keep-alive",
+        "postman_token": "c6cd29cf-1b37-4420-8db3-9faec66b9e7e",
+        "http_host": "127.0.0.1:8080",
+        "cache_control": "no-cache",
+        "request_path": "/",
+        "content_type": "application/json",
+        "http_accept": "*/*",
+        "content_length": "41",
+        "accept_encoding": "gzip, deflate, br"
+      },
+    "@version": "1"
+    }
+    ```
+
+
+## Automatically reload the pipeline configuration
+
+You can configure Logstash to detect any changes to the pipeline configuration file or the input log file and automatically reload the configuration.
+
+The `stdin` plugin doesn’t supporting automatic reloading.
+{: .note }
+
+1. Add an option named `start_position` with a value of `beginning` to the input plugin:
+
+    ```yml
+    input {
+      file {
+        path => "/Users/<user>/Desktop/logstash7-12.1/events-data/input_file.log"
+        start_position => "beginning"
+      }
+    }
+    ```
+
+    Logstash only processes any new events added to the input file and ignores the ones that it has already processed to avoid processing the same event more than once on restart.
+
+    Logstash records its progress in a file that's referred to as a `sinceDB` file. Logstash creates a `sinceDB` file for each file that it watches for changes.
+
+2. Open the `sinceDB` file to check how much of the input files are processed:
+
+    ```bash
+    cd data/plugins/inputs/file/
+    ls -al
+
+    -rw-r--r--  1 user  staff   0 Jun 13 10:50 .sincedb_9e484f2a9e6c0d1bdfe6f23ac107ffc5
+
+    cat .sincedb_9e484f2a9e6c0d1bdfe6f23ac107ffc5
+
+    51575938 1 4 7727
+    ```
+
+    The last number in the `sinceDB` file (7727) is the byte offset of the last known event processed.
+
+5. To process the input file from the beginning, delete the `sinceDB` file:
+
+    ```yml
+    rm .sincedb_*
+    ```
+
+2. Start Logstash with a `—-config.reload.automatic` argument:
+
+    ```bash
+    bin/logstash -f config/pipeline.conf --config.reload.automatic
+    ```
+
+    The `reload` option only reloads if you add a new line at the end of the pipeline configuration file.
+
+    Sample output:
+
+    ```yml
+    {
+       "message" => "216.243.171.38 - - [20/Sep/2017:19:11:52 +0200] \"GET /products/view/123 HTTP/1.1\" 200 12798 \"https://codingexplained.com/products\" \"Mozilla/5.0 (compatible; YandexBot/3.0; +http://yandex.com/bots)\"",
+       "@version" => "1",
+          "host" => "a483e711a548.ant.amazon.com",
+          "path" => "/Users/kumarjao/Desktop/odfe1/logstash-7.12.1/events-data/input_file.log",
+       "@timestamp" => 2021-06-13T18:03:30.423Z
+    }
+    {
+       "message" => "91.59.108.75 - - [20/Sep/2017:20:11:43 +0200] \"GET /js/main.js HTTP/1.1\" 200 588 \"https://codingexplained.com/products/view/863\" \"Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101 Firefox/45.0\"",
+      "@version" => "1",
+          "host" => "a483e711a548.ant.amazon.com",
+          "path" => "/Users/kumarjao/Desktop/odfe1/logstash-7.12.1/events-data/input_file.log",
+    "@timestamp" => 2021-06-13T18:03:30.424Z
+    }
+    ```
+
+7. Add a new line to the input file.
+    - Logstash immediately detects the change and processes the new line as an event.
+
+8. Make a change to the `pipeline.conf` file.
+    - Logstash immediately detects the change and reloads the modified pipeline.

_clients/logstash/ship-to-opensearch.md

@@ -0,0 +1,77 @@
+---
+layout: default
+title: Ship events to OpenSearch
+parent: Logstash
+nav_order: 220
+---
+
+# Ship events to OpenSearch
+
+You can Ship Logstash events to an OpenSearch cluster and then visualize your events with OpenSearch Dashboards.
+
+Make sure you have [Logstash]({{site.url}}{{site.baseurl}}/clients/logstash/index/#install-logstash), [OpenSearch]({{site.url}}{{site.baseurl}}/opensearch/install/index/), and [OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/install/index/).
+{: .note }
+
+## OpenSearch output plugin
+
+To run the OpenSearch output plugin, add the following configuration in your `pipeline.conf` file:
+
+```yml
+output {
+  opensearch {
+    hosts       => "https://localhost:9200"
+    user        => "admin"
+    password    => "admin"
+    index       => "logstash-logs-%{+YYYY.MM.dd}"
+    ssl_certificate_verification => false
+  }
+}
+```
+
+
+## Sample walkthrough
+
+1.  Open the `config/pipeline.conf` file and add in the following configuration:
+
+    ```yml
+    input {
+      stdin {
+        codec => json
+      }
+    }
+
+    output {
+      opensearch {
+        hosts       => "https://localhost:9200"
+        user        => "admin"
+        password    => "admin"
+        index       => "logstash-logs-%{+YYYY.MM.dd}"
+        ssl_certificate_verification => false
+      }
+    }
+    ```
+
+    This Logstash pipeline accepts JSON input through the terminal and ships the events to an OpenSearch cluster running locally. Logstash writes the events to an index with the `logstash-logs-%{+YYYY.MM.dd}` naming convention.
+
+2. Start Logstash:
+
+    ```bash
+    $ bin/logstash -f config/pipeline.conf --config.reload.automatic
+    ```
+
+    `config/pipeline.conf` is a relative path to the `pipeline.conf` file. You can use an absolute path as well.
+
+3. Add a JSON object in the terminal:
+
+    ```json
+    { "amount": 10, "quantity": 2}
+    ```
+
+4. Start OpenSearch Dashboards and choose **Dev Tools**:
+
+    ```json
+    GET _cat/indices?v
+
+    health | status | index | uuid | pri | rep | docs.count | docs.deleted | store.size | pri.store.size
+    green | open | logstash-logs-2021.07.01 | iuh648LYSnmQrkGf70pplA | 1 | 1 | 1 | 0 | 10.3kb | 5.1kb
+    ```

_clients/python.md

@@ -0,0 +1,128 @@
+---
+layout: default
+title: Python client
+nav_order: 70
+---
+
+# Python client
+
+The OpenSearch Python client provides a more natural syntax for interacting with your cluster. Rather than sending HTTP requests to a given URL, you can create an OpenSearch client for your cluster and call the client's built-in functions.
+
+{% comment %}
+`opensearch-py` is the lower-level of the two Python clients. If you want a general client for assorted operations, it's a great choice. If you want a higher-level client strictly for indexing and search operations, consider [opensearch-dsl-py]({{site.url}}{{site.baseurl}}/clients/python-dsl/).
+{% endcomment %}
+
+
+## Setup
+
+To add the client to your project, install it using [pip](https://pip.pypa.io/):
+
+```bash
+pip install opensearch-py
+```
+
+Then import it like any other module:
+
+```python
+from opensearchpy import OpenSearch
+```
+
+If you prefer to add the client manually or just want to examine the source code, see [opensearch-py on GitHub](https://github.com/opensearch-project/opensearch-py).
+
+
+## Sample code
+
+```python
+from opensearchpy import OpenSearch
+
+host = 'localhost'
+port = 9200
+auth = ('admin', 'admin') # For testing only. Don't store credentials in code.
+ca_certs_path = '/full/path/to/root-ca.pem' # Provide a CA bundle if you use intermediate CAs with your root CA.
+
+# Optional client certificates if you don't want to use HTTP basic authentication.
+# client_cert_path = '/full/path/to/client.pem'
+# client_key_path = '/full/path/to/client-key.pem'
+
+# Create the client with SSL/TLS enabled, but hostname verification disabled.
+client = OpenSearch(
+    hosts = [{'host': host, 'port': port}],
+    http_compress = True, # enables gzip compression for request bodies
+    http_auth = auth,
+    # client_cert = client_cert_path,
+    # client_key = client_key_path,
+    use_ssl = True,
+    verify_certs = True,
+    ssl_assert_hostname = False,
+    ssl_show_warn = False,
+    ca_certs = ca_certs_path
+)
+
+# Create an index with non-default settings.
+index_name = 'python-test-index'
+index_body = {
+  'settings': {
+    'index': {
+      'number_of_shards': 4
+    }
+  }
+}
+
+response = client.indices.create(index_name, body=index_body)
+print('\nCreating index:')
+print(response)
+
+# Add a document to the index.
+document = {
+  'title': 'Moneyball',
+  'director': 'Bennett Miller',
+  'year': '2011'
+}
+id = '1'
+
+response = client.index(
+    index = index_name,
+    body = document,
+    id = id,
+    refresh = True
+)
+
+print('\nAdding document:')
+print(response)
+
+# Search for the document.
+q = 'miller'
+query = {
+  'size': 5,
+  'query': {
+    'multi_match': {
+      'query': q,
+      'fields': ['title^2', 'director']
+    }
+  }
+}
+
+response = client.search(
+    body = query,
+    index = index_name
+)
+print('\nSearch results:')
+print(response)
+
+# Delete the document.
+response = client.delete(
+    index = index_name,
+    id = id
+)
+
+print('\nDeleting document:')
+print(response)
+
+# Delete the index.
+response = client.indices.delete(
+    index = index_name
+)
+
+print('\nDeleting index:')
+print(response)
+```

_config.yml

@@ -1,12 +1,13 @@
 title: OpenSearch documentation
 description: >- # this means to ignore newlines until "baseurl:"
   Documentation for OpenSearch, the Apache 2.0 search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more.
-baseurl: "" # the subpath of your site, e.g. /blog
-url: "https://docs-beta.opensearch.org" # the base hostname & protocol for your site, e.g. http://example.com
+baseurl: "/docs/latest" # the subpath of your site, e.g. /blog
+url: "https://opensearch.org" # the base hostname & protocol for your site, e.g. http://example.com
 permalink: /:path/
 
-opensearch_version: 1.0.0-rc1
-opensearch_major_minor_version: 1.0
+opensearch_version: 1.1.0
+opensearch_major_minor_version: 1.1
+lucene_version: 8_9_0
 
 # Build settings
 markdown: kramdown
@@ -20,8 +21,7 @@ logo: "/assets/images/logo.svg"
 
 # Aux links for the upper right navigation
 aux_links:
-  "Back to OpenSearch.org":
-    - "https://opensearch.org"
+
 color_scheme: opensearch
 
 # Define Jekyll collections
@@ -45,6 +45,9 @@ collections:
   im-plugin:
     permalink: /:collection/:path/
     output: true
+  replication-plugin:
+    permalink: /:collection/:path/
+    output: true
   monitoring-plugins:
     permalink: /:collection/:path/
     output: true
@@ -81,6 +84,9 @@ just_the_docs:
     im-plugin:
       name: Index management plugin
       nav_fold: true
+    replication-plugin:
+      name: Replication plugin
+      nav_fold: true
     monitoring-plugins:
       name: Monitoring plugins
       nav_fold: true
@@ -138,6 +144,7 @@ footer_content:
 plugins:
   - jekyll-remote-theme
   - jekyll-redirect-from
+  - jekyll-sitemap
 
 # Exclude from processing.
 # The following items will not be processed, by default. Create a custom list

_dashboards/dql.md

@@ -0,0 +1,142 @@
+---
+layout: default
+title: Dashboards query language
+nav_order: 99
+---
+
+# Dashboards Query Language
+
+Similar to the [Query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/index) that lets you use the HTTP request body to search for data, you can use the Dashbaords Query Language (DQL) in OpenSearch Dashboards to search for data and visualizations.
+
+For example, if you want to see all visualizations of visits to a host based in the US, enter `geo.dest:US` into the search field, and Dashboards refreshes to display all related data.
+
+Just like the query DSL, DQL has a handful of query types, so use whichever best fits your use case.
+
+This section uses the OpenSearch Dashboards sample web log data. To add sample data in Dashboards, log in to OpenSearch Dashboards, choose **Home**, **Add sample data**, and then **Add data**.
+
+---
+
+#### Table of contents
+1. TOC
+{:toc}
+
+---
+
+## Terms query
+
+The most basic query is to just specify the term you're searching for.
+
+```
+host:www.example.com
+```
+
+To access an object's nested field, list the complete path to the field separated by periods. For example, to retrieve the `lat` field in the `coordinates` object:
+
+```
+coordinates.lat:43.7102
+```
+
+DQL also supports leading and trailing wildcards, so you can search for any terms that match your pattern.
+
+```
+host.keyword:*.example.com/*
+```
+
+To check if a field exists or has any data, use a wildcard to see if Dashboards returns any results.
+
+```
+host.keyword:*
+```
+
+## Boolean query
+
+To mix and match, or even combine, multiple queries for more refined results, you can use the boolean operators `and`, `or`, and `not`. DQL is not case sensitive, so `AND` and `and` are the same.
+
+```
+host.keyword:www.example.com and response.keyword:200
+```
+
+The following example demonstrates how to use multiple operators in one query.
+
+```
+geo.dest:US or response.keyword:200 and host.keyword:www.example.com
+```
+
+Remember that boolean operators follow the logical precedence order of `not`, `and`, and `or`, so if you have an expression like the previous example, `response.keyword:200 and host.keyword:www.example.com` gets evaluated first, and then Dashboards uses that result to compare with `geo.dest:US`.
+
+To avoid confusion, we recommend using parentheses to dictate the order you want to evaluate in. If you want to evaluate `geo.dest:US or response.keyword:200` first, your expression becomes:
+
+```
+(geo.dest:US or response.keyword:200) and host.keyword:www.example.com
+```
+
+## Date and range queries
+
+DQL also supports inequalities if you're using numeric inequalities.
+
+```
+bytes >= 15 and memory < 15
+```
+
+Similarly, you can use the same method to find a date before or after your query. `>` indicates a search for a date after your specified date, and `<` returns dates before.
+
+```
+@timestamp > "2020-12-14T09:35:33"
+```
+
+## Nested field query
+
+If you have a document with nested fields, you have to specify which parts of the document you want to retrieve.
+
+Suppose that you have the following document:
+
+```json
+{
+  "superheroes":[
+    {
+      "hero-name": "Superman",
+      "real-identity": "Clark Kent",
+      "age": 28
+    },
+    {
+      "hero-name": "Batman",
+      "real-identity": "Bruce Wayne",
+      "age": 26
+    },
+    {
+      "hero-name": "Flash",
+      "real-identity": "Barry Allen",
+      "age": 28
+    },
+    {
+      "hero-name": "Robin",
+      "real-identity": "Dick Grayson",
+      "age": 15
+    }
+  ]
+}
+```
+
+The following example demonstrates how to use DQL to retrieve a specific field.
+
+```
+superheroes: {hero-name: Superman}
+```
+
+If you want to retrieve multiple objects from your document, just specify all of the fields you want to retrieve.
+
+```
+superheroes: {hero-name: Superman} and superheroes: {hero-name: Batman}
+```
+
+The previous boolean and range queries still work, so you can submit a more refined query.
+
+```
+superheroes: {hero-name: Superman and age < 50}
+```
+
+If your document has an object nested within another object, you can still retrieve data by specifying all of the levels.
+
+```
+justice-league.superheroes: {hero-name:Superman}
+```

_dashboards/index.md

@@ -6,10 +6,11 @@ has_children: false
 has_toc: false
 redirect_from:
   - /docs/opensearch-dashboards/
-  - /opensearch-dashboards/
   - /dashboards/
 ---
 
+{%- comment -%}The `/docs/opensearch-dashboards/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%}
+
 # OpenSearch Dashboards
 
 OpenSearch Dashboards is the default visualization tool for data in OpenSearch. It also serves as a user interface for many of the OpenSearch plugins, including security, alerting, Index State Management, SQL, and more.

_dashboards/install/helm.md

@@ -0,0 +1,135 @@
+---
+layout: default
+title: Helm
+parent: Install OpenSearch Dashboards
+nav_order: 35
+---
+
+# Run OpenSearch Dashboards using Helm
+
+Helm is a package manager that allows you to easily install and manage OpenSearch Dashboards in a Kubernetes cluster. You can define your OpenSearch configurations in a YAML file and use Helm to deploy your applications in a version-controlled and reproducible way.
+
+The Helm chart contains the resources described in the following table.
+
+Resource | Description
+:--- | :---
+`Chart.yaml` |  Information about the chart.
+`values.yaml` |  Default configuration values for the chart.
+`templates` |  Templates that combine with values to generate the Kubernetes manifest files.
+
+The specification in the default Helm chart supports many standard use cases and setups. You can modify the default chart to configure your desired specifications and set Transport Layer Security (TLS) and role-based access control (RBAC).
+
+For information about the default configuration, steps to configure security, and configurable parameters, see the
+[README](https://github.com/opensearch-project/helm-charts/tree/main/charts).
+
+The instructions here assume you have a Kubernetes cluster with Helm preinstalled. See the [Kubernetes documentation](https://kubernetes.io/docs/setup/) for steps to configure a Kubernetes cluster and the [Helm documentation](https://helm.sh/docs/intro/install/) to install Helm.
+{: .note }
+
+## Prerequisites
+
+Before you get started, you must first use [Helm to install OpenSearch]({{site.url}}{{site.baseurl}}/opensearch/install/helm/).
+
+Make sure that you can send requests to your OpenSearch pod:
+
+```json
+$ curl -XGET https://localhost:9200 -u 'admin:admin' --insecure
+{
+  "name" : "opensearch-cluster-master-1",
+  "cluster_name" : "opensearch-cluster",
+  "cluster_uuid" : "hP2gq5bPS3SLp8Z7wXm8YQ",
+  "version" : {
+    "distribution" : "opensearch",
+    "number" : "1.0.0",
+    "build_type" : "tar",
+    "build_hash" : "34550c5b17124ddc59458ef774f6b43a086522e3",
+    "build_date" : "2021-07-02T23:22:21.383695Z",
+    "build_snapshot" : false,
+    "lucene_version" : "8.8.2",
+    "minimum_wire_compatibility_version" : "6.8.0",
+    "minimum_index_compatibility_version" : "6.0.0-beta1"
+  },
+  "tagline" : "The OpenSearch Project: https://opensearch.org/"
+}
+```
+
+## Install OpenSearch Dashboards using Helm
+
+1. Change to the `opensearch-dashboards` directory:
+
+   ```bash
+   cd opensearch-dashboards
+   ```
+
+1. Package the Helm chart:
+
+   ```bash
+   helm package .
+   ```
+
+1. Deploy OpenSearch Dashboards:
+
+   ```bash
+   helm install --generate-name opensearch-dashboards-1.0.0.tgz
+   ```
+   The output shows you the specifications instantiated from the install.
+   To customize the deployment, pass in the values that you want to override with a custom YAML file:
+
+   ```bash
+   helm install --values=customvalues.yaml opensearch-dashboards-1.0.0.tgz
+   ```
+
+#### Sample output
+
+```yaml
+NAME: opensearch-dashboards-1-1629223356
+LAST DEPLOYED: Tue Aug 17 18:02:37 2021
+NAMESPACE: default
+STATUS: deployed
+REVISION: 1
+TEST SUITE: None
+NOTES:
+1. Get the application URL by running these commands:
+  export POD_NAME=$(kubectl get pods --namespace default -l "app.kubernetes.io/name=opensearch-dashboards,app.kubernetes.io/instance=op
+ensearch-dashboards-1-1629223356" -o jsonpath="{.items[0].metadata.name}")
+  export CONTAINER_PORT=$(kubectl get pod --namespace default $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl --namespace default port-forward $POD_NAME 8080:$CONTAINER_PORT
+```
+
+To make sure your OpenSearch Dashboards pod is up and running, run the following command:
+
+```bash
+$ kubectl get pods
+NAME                                                  READY   STATUS    RESTARTS   AGE
+opensearch-cluster-master-0                           1/1     Running   0          4m35s
+opensearch-cluster-master-1                           1/1     Running   0          4m35s
+opensearch-cluster-master-2                           1/1     Running   0          4m35s
+opensearch-dashboards-1-1629223356-758bd8747f-8www5   1/1     Running   0          66s
+```
+
+To set up port forwarding to access OpenSearch Dashboards, exit the OpenSearch shell and run the following command:
+
+```bash
+$ kubectl port-forward deployment/opensearch-dashboards-1-1629223356 5601
+```
+
+You can now access OpenSearch Dashboards from your browser at: http://localhost:5601.
+
+
+## Uninstall using Helm
+
+To identify the OpenSearch Dashboards deployment that you want to delete:
+
+```bash
+$ helm list
+NAME  NAMESPACE REVISION  UPDATED STATUS  CHART APP VERSION
+opensearch-1-1629223146 default 1 2021-08-17 17:59:07.664498239 +0000 UTCdeployedopensearch-1.0.0           1.0.0      
+opensearch-dashboards-1-1629223356 default  1 2021-08-17  18:02:37.600796946 +0000  UTCdepl
+oyedopensearch-dashboards-1.0.0 1.0.0        
+```
+
+To delete or uninstall a deployment, run the following command:
+
+```bash
+helm delete opensearch-dashboards-1-1629223356
+```

_dashboards/install/index.md

@@ -9,4 +9,4 @@ redirect_from:
 
 # Install and configure OpenSearch Dashboards
 
-OpenSearch Dashboards has two installation options at this time: Docker images and tarballs.
+OpenSearch Dashboards has three installation options at this time: Docker images, tarballs, and Helm charts.

_dashboards/install/plugins.md

@@ -29,32 +29,47 @@ If you don't want to use the all-in-one installation options, you can install th
   </thead>
   <tbody>
   <tr>
-    <td>1.0.0-rc1</td>
+    <td>1.1.0</td>
     <td>
-      <pre>alertingDashboards          1.0.0.0-rc1
-anomalyDetectionDashboards  1.0.0.0-rc1
-ganttChartDashboards        1.0.0.0-rc1
-indexManagementDashboards   1.0.0.0-rc1
-notebooksDashboards         1.0.0.0-rc1
-queryWorkbenchDashboards    1.0.0.0-rc1
-reportsDashboards           1.0.0.0-rc1
-securityDashboards          1.0.0.0-rc1
-traceAnalyticsDashboards    1.0.0.0-rc1
+      <pre>alertingDashboards          1.1.0.0
+anomalyDetectionDashboards  1.1.0.0
+ganttChartDashboards        1.1.0.0
+indexManagementDashboards   1.1.0.0
+notebooksDashboards         1.1.0.0
+queryWorkbenchDashboards    1.1.0.0
+reportsDashboards           1.1.0.0
+securityDashboards          1.1.0.0
+traceAnalyticsDashboards    1.1.0.0
 </pre>
     </td>
   </tr>
   <tr>
-    <td>1.0.0-beta1</td>
+    <td>1.0.1</td>
     <td>
-      <pre>alertingDashboards          1.0.0.0-beta1
-anomalyDetectionDashboards  1.0.0.0-beta1
-ganttChartDashboards        1.0.0.0-beta1
-indexManagementDashboards   1.0.0.0-beta1
-notebooksDashboards         1.0.0.0-beta1
-queryWorkbenchDashboards    1.0.0.0-beta1
-reportsDashboards           1.0.0.0-beta1
-securityDashboards          1.0.0.0-beta1
-traceAnalyticsDashboards    1.0.0.0-beta1
+      <pre>alertingDashboards          1.0.0.0
+anomalyDetectionDashboards  1.0.0.0
+ganttChartDashboards        1.0.0.0
+indexManagementDashboards   1.0.1.0
+notebooksDashboards         1.0.0.0
+queryWorkbenchDashboards    1.0.0.0
+reportsDashboards           1.0.1.0
+securityDashboards          1.0.1.0
+traceAnalyticsDashboards    1.0.0.0
+</pre>
+    </td>
+  </tr>
+  <tr>
+    <td>1.0.0</td>
+    <td>
+      <pre>alertingDashboards          1.0.0.0
+anomalyDetectionDashboards  1.0.0.0
+ganttChartDashboards        1.0.0.0
+indexManagementDashboards   1.0.0.0
+notebooksDashboards         1.0.0.0
+queryWorkbenchDashboards    1.0.0.0
+reportsDashboards           1.0.0.0
+securityDashboards          1.0.0.0
+traceAnalyticsDashboards    1.0.0.0
 </pre>
     </td>
   </tr>

_dashboards/install/tar.md

@@ -14,9 +14,10 @@ nav_order: 30
    ```bash
    # x64
    tar -zxf opensearch-dashboards-{{site.opensearch_version}}-linux-x64.tar.gz
-   cd opensearch-dashboards{% comment %}# ARM64
+   cd opensearch-dashboards
+   # ARM64
    tar -zxf opensearch-dashboards-{{site.opensearch_version}}-linux-arm64.tar.gz
-   cd opensearch-dashboards{% endcomment %}
+   cd opensearch-dashboards
    ```
 
 1. If desired, modify `config/opensearch_dashboards.yml`.
@@ -26,5 +27,3 @@ nav_order: 30
    ```bash
    ./bin/opensearch-dashboards
    ```
-
-1. See the [OpenSearch Dashboards documentation]({{site.url}}{{site.baseurl}}/opensearch-dashboards/).

_dashboards/install/tls.md

@@ -0,0 +1,41 @@
+---
+layout: default
+title: Configure TLS
+parent: Install OpenSearch Dashboards
+nav_order: 40
+---
+
+# Configure TLS for OpenSearch Dashboards
+
+By default, for ease of testing and getting started, OpenSearch Dashboards runs over HTTP. To enable TLS for HTTPS, update the following settings in `opensearch_dashboards.yml`.
+
+Setting | Description
+:--- | :---
+opensearch.ssl.verificationMode | This setting is for communications between OpenSearch and OpenSearch Dashboards. Valid values are `full`, `certificate`, or `none`. We recommend `full` if you enable TLS, which enables hostname verification. `certificate` just checks the certificate, not the hostname, and `none` performs no checks (suitable for HTTP). Default is `full`.
+opensearch.ssl.certificateAuthorities | If `opensearch.ssl.verificationMode` is `full` or `certificate`, specify the full path to one or more CA certificates that comprise a trusted chain for your OpenSearch cluster. For example, you might need to include a root CA _and_ an intermediate CA if you used the intermediate CA to issue your admin, client, and node certificates.
+server.ssl.enabled | This setting is for communications between OpenSearch Dashboards and the web browser. Set to true for HTTPS, false for HTTP.
+server.ssl.certificate | If `server.ssl.enabled` is true, specify the full path to a valid client certificate for your OpenSearch cluster. You can [generate your own]({{site.url}}{{site.baseurl}}/security-plugin/configuration/generate-certificates/) or get one from a certificate authority.
+server.ssl.key | If `server.ssl.enabled` is true, specify the full path (e.g. `/usr/share/opensearch-dashboards-1.0.0/config/my-client-cert-key.pem` to the key for your client certificate. You can [generate your own]({{site.url}}{{site.baseurl}}/security-plugin/configuration/generate-certificates/) or get one from a certificate authority.
+opensearch_security.cookie.secure | If you enable TLS for OpenSearch Dashboards, change this setting to `true`. For HTTP, set it to `false`.
+
+This `opensearch_dashboards.yml` configuration shows OpenSearch and OpenSearch Dashboards running on the same machine with the demo configuration:
+
+```yml
+opensearch.hosts: ["https://localhost:9200"]
+opensearch.ssl.verificationMode: full
+opensearch.username: "kibanaserver"
+opensearch.password: "kibanaserver"
+opensearch.requestHeadersWhitelist: [ authorization,securitytenant ]
+server.ssl.enabled: true
+server.ssl.certificate: /usr/share/opensearch-dashboards/config/client-cert.pem
+server.ssl.key: /usr/share/opensearch-dashboards/config/client-cert-key.pem
+opensearch.ssl.certificateAuthorities: [ "/usr/share/opensearch-dashboards/config/root-ca.pem", "/usr/share/opensearch-dashboards/config/intermediate-ca.pem" ]
+opensearch_security.multitenancy.enabled: true
+opensearch_security.multitenancy.tenants.preferred: ["Private", "Global"]
+opensearch_security.readonly_mode.roles: ["kibana_read_only"]
+opensearch_security.cookie.secure: true
+```
+
+If you use the Docker install, you can pass a custom `opensearch_dashboards.yml` to the container. To learn more, see the [Docker installation page]({{site.url}}{{site.baseurl}}/opensearch/install/docker/).
+
+After enabling these settings and starting OpenSearch Dashboards, you can connect to it at `https://localhost:5601`. You might have to acknowledge a browser warning if your certificates are self-signed. To avoid this sort of warning (or outright browser incompatibility), best practice is to use certificates from trusted certificate authority.

_dashboards/maptiles.md

@@ -2,8 +2,12 @@
 layout: default
 title: WMS map server
 nav_order: 5
+redirect_from:
+  - /docs/opensearch-dashboards/maptiles/
 ---
 
+{%- comment -%}The `/docs/opensearch-dashboards/maptiles/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%}
+
 # Configure WMS map server
 
 OpenSearch Dashboards includes default map tiles, but if you need more specialized maps, you can configure OpenSearch Dashboards to use a WMS map server:

_dashboards/notebooks.md

@@ -1,28 +1,30 @@
 ---
 layout: default
-title: Notebooks (experimental)
+title: Notebooks
 nav_order: 50
-redirect_from: /docs/notebooks/
+redirect_from: /notebooks/
 has_children: false
 ---
 
-# OpenSearch Dashboards notebooks (experimental)
+# Notebooks
 
-Notebooks have a known issue with [tenants]({{site.url}}{{site.baseurl}}/security-plugin/access-control/multi-tenancy/). If you open a notebook and can't see its visualizations, you might be under the wrong tenant, or you might not have access to the tenant at all.
-{: .warning }
-
-An OpenSearch Dashboards notebook is an interface that lets you easily combine live visualizations and narrative text in a single notebook interface.
+An OpenSearch Dashboards notebook is an interface that lets you easily combine code snippets, live visualizations, and narrative text in a single notebook interface.
 
 Notebooks let you interactively explore data by running different visualizations that you can share with team members to collaborate on a project.
 
-A notebook is a document composed of two elements: OpenSearch Dashboards visualizations and paragraphs (Markdown). Choose multiple timelines to compare and contrast visualizations.
+A notebook is a document composed of two elements: code blocks (Markdown/SQL/PPL) and visualizations. Choose multiple timelines to compare and contrast visualizations.
+
+You can also generate [reports]({{site.url}}{{site.baseurl}}/dashboards/reporting/) directly from your notebooks.
 
 Common use cases include creating postmortem reports, designing runbooks, building live infrastructure reports, and writing documentation.
 
+Tenants in OpenSearch Dashboards are spaces for saving notebooks and other OpenSearch Dashboards objects. For more information, see [OpenSearch Dashboards multi-tenancy]({{site.url}}{{site.baseurl}}/security-plugin/access-control/multi-tenancy/).
+{: .note }
 
-## Get Started with notebooks
 
-To get started, choose **OpenSearch Dashboards Notebooks** within OpenSearch Dashboards.
+## Get started with notebooks
+
+To get started, choose **Notebooks** within OpenSearch Dashboards.
 
 
 ### Step 1: Create a notebook
@@ -32,28 +34,59 @@ A notebook is an interface for creating reports.
 1. Choose **Create notebook** and enter a descriptive name.
 1. Choose **Create**.
 
-Choose **Notebook actions** to rename, duplicate, or delete a notebook.
+Choose **Actions** to rename, duplicate, or delete a notebook.
 
+![Create notebook]({{site.url}}{{site.baseurl}}/images/create_notebook.gif)
 
 ### Step 2: Add a paragraph
 
-Paragraphs combine text and visualizations for describing data.
+Paragraphs combine code blocks and visualizations for describing data.
+
+#### Add a code block
+
+Code blocks support markdown, SQL, and PPL languages.
+
+Specify the input language on the first line using `%[language type]` syntax.
+For example, type `%md` for markdown, `%sql` for SQL, and `%ppl` for PPL.
+
+##### Sample markdown block
+
+```
+%md
+Add in text formatted in markdown.
+```
+
+![Markdown paragraph]({{site.url}}{{site.baseurl}}/images/markdown_notebooks.gif)
+
+##### Sample SQL block
+
+```sql
+%sql
+Select * from opensearch_dashboards_sample_data_flights limit 20;
+```
+
+![SQL paragraph]({{site.url}}{{site.baseurl}}/images/sql_notebooks.gif)
+
+##### Sample PPL block
+
+```
+%ppl
+source=opensearch_dashboards_sample_data_logs | head 20
+```
+
+![PPL paragraph]({{site.url}}{{site.baseurl}}/images/ppl_notebooks.gif)
 
 
-#### Add a markdown paragraph
+#### Add a visualization
 
-1. To add text, choose **Add markdown paragraph**.
-1. Add rich text with markdown syntax.
-
-![Markdown paragraph]({{site.url}}{{site.baseurl}}/images/markdown-notebook.png)
-
-
-#### Add a visualization paragraph
-
-1. To add a visualization, choose **Add OpenSearch Dashboards visualization paragraph**.
+1. To add a visualization, choose **Add paragraph** and select **Visualization**.
 1. In **Title**, select your visualization and choose a date range. You can choose multiple timelines to compare and contrast visualizations.
 1. To run and save a paragraph, choose **Run**.
 
+![Visualization paragraph]({{site.url}}{{site.baseurl}}/images/visualization_notebooks.gif)
+
+## Paragraph actions
+
 You can perform the following actions on paragraphs:
 
 - Add a new paragraph to the top of a report.
@@ -61,4 +94,31 @@ You can perform the following actions on paragraphs:
 - Run all the paragraphs at the same time.
 - Clear the outputs of all paragraphs.
 - Delete all the paragraphs.
-- Move paragraphs up and down.
+
+![Sample notebooks]({{site.url}}{{site.baseurl}}/images/paragraphs_notebooks.gif)
+
+## Sample notebooks
+
+We prepared the following sample notebooks that showcase a variety of use cases:
+
+- Using SQL to query the OpenSearch Dashboards sample flight data.
+- Using PPL to query the OpenSearch Dashboards sample web logs data.
+- Using PPL and visualizations to perform sample root cause event analysis on the OpenSearch Dashboards sample web logs data.
+
+To add a sample notebook, choose **Actions** and select **Add sample notebooks**.
+
+![Sample notebooks]({{site.url}}{{site.baseurl}}/images/sample_notebooks.gif)
+
+## Create a report
+
+You can use notebooks to create PNG and PDF reports:
+
+1. From the top menu bar, choose **Reporting actions**.
+1. You can choose to **Download PDF** or **Download PNG**.
+
+   Reports generate asynchronously in the background and might take a few minutes, depending on the size of the report. A notification appears when your report is ready to download.
+
+1. To create a schedule-based report, choose **Create report definition**. For steps to create a report definition, see [Create reports using a definition]({{site.url}}{{site.baseurl}}/dashboards/reporting#create-reports-using-a-definition).
+1. To see all your reports, choose **View all reports**.
+
+![Report notebooks]({{site.url}}{{site.baseurl}}/images/report_notebooks.gif)

_dashboards/reporting.md

@@ -9,6 +9,9 @@ nav_order: 20
 
 You can use OpenSearch Dashboards to create PNG, PDF, and CSV reports. To create reports, you must have the correct permissions. For a summary of the predefined roles and the permissions they grant, see the [security plugin]({{site.url}}{{site.baseurl}}/security-plugin/access-control/users-roles#predefined-roles).
 
+CSV reports have a non-configurable 10,000 row limit. They have no explicit size limit (e.g. in MB), but extremely large documents could cause report generation to fail with an out of memory error from the V8 JavaScript engine.
+{: .tip }
+
 
 ## Create reports from Discovery, Visualize, or Dashboard
 

_data/alert.yml

@@ -0,0 +1 @@
+message: "🌡️ [OpenSearch 1.1.0 arrived October 5 with cross-cluster replication, bucket-level alerting, and much, much more. Grab it here!](/downloads.html)"

_data/footer.yml

@@ -0,0 +1,49 @@
+columns:
+  -
+    title: 'Get Involved'
+    links:
+      -
+        title: Code of Conduct
+        url: '/codeofconduct.html'
+      -
+        title: 'Forums'
+        url: 'https://discuss.opendistrocommunity.dev/'
+      -
+        title: 'Github'
+        url: 'https://github.com/opensearch-project'
+      -
+        title: 'Partners'
+        url: '/partners/'
+      -
+        title: 'Community Projects'
+        url: '/community_projects'
+  -
+    title: 'Resources'
+    links:
+      #- 
+      #  title: 'Documentation'
+      #  url: 'https://github.com/opensearch/documentation'
+      - 
+        title: FAQ
+        url: '/faq/'
+      -
+        title: 'Brand Guidelines'
+        url: '/brand.html'
+      -
+        title: 'Trademark Usage Policy'
+        url: '/trademark-usage.html'
+      - 
+        title: OpenSearch Disambiguation
+        url: '/disambiguation.html'
+  -
+    title: 'Connect'
+    links:
+      # -
+      #  title: 'Twitter'
+      #  url: 'https://twitter.com/opensearch_project'
+      #-
+      #  title: 'Facebook'
+      #  url: 'http://www.facebook.com/opensearch'
+      -
+        title: 'E-mail'
+        url: 'mailto:[email protected]'

_data/versions.json

@@ -0,0 +1,6 @@
+{
+  "current": "1.1",
+  "past": [
+    "1.0"
+  ]
+}

_external_links/developer-guide.md

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Dashboards developer guide
+nav_order: 2
+permalink: /dashboards-developer-guide/
+redirect_to: https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md
+---

_external_links/javadoc.md

@@ -3,5 +3,5 @@ layout: default
 title: Javadoc
 nav_order: 1
 permalink: /javadoc/
-redirect_to: https://opensearch.org/docs/javadocs/
+redirect_to: https://opensearch.org/javadocs/
 ---

_external_links/javadocs.md

@@ -0,0 +1,6 @@
+---
+layout: default
+nav_exclude: true
+permalink: /javadocs/
+redirect_to: https://opensearch.org/javadocs/
+---

_im-plugin/index-rollups/index.md

@@ -3,7 +3,7 @@ layout: default
 title: Index rollups
 nav_order: 35
 has_children: true
-redirect_from: /docs/ism/index-rollups/
+redirect_from: /im-plugin/index-rollups/
 has_toc: false
 ---
 

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

@@ -2,7 +2,6 @@
 layout: default
 title: Index rollups API
 parent: Index rollups
-redirect_from: /docs/ism/rollup-api/
 nav_order: 9
 ---
 
@@ -20,6 +19,8 @@ Use the index rollup operations to programmatically work with index rollup jobs.
 ---
 
 ## Create or update an index rollup job
+Introduced 1.0
+{: .label .label-purple }
 
 Creates or updates an index rollup job.
 You must provide the `seq_no` and `primary_term` parameters.
@@ -89,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
@@ -134,6 +135,8 @@ Options | Description | Type | Required
 
 
 ## Get an index rollup job
+Introduced 1.0
+{: .label .label-purple }
 
 Returns all information about an index rollup job based on the `rollup_id`.
 
@@ -159,6 +162,8 @@ GET _plugins/_rollup/jobs/<rollup_id>
 ---
 
 ## Delete an index rollup job
+Introduced 1.0
+{: .label .label-purple }
 
 Deletes an index rollup job based on the `rollup_id`.
 
@@ -178,6 +183,8 @@ DELETE _plugins/_rollup/jobs/<rollup_id>
 
 
 ## Start or stop an index rollup job
+Introduced 1.0
+{: .label .label-purple }
 
 Start or stop an index rollup job.
 
@@ -199,6 +206,8 @@ POST _plugins/_rollup/jobs/<rollup_id>/_stop
 ---
 
 ## Explain an index rollup job
+Introduced 1.0
+{: .label .label-purple }
 
 Returns detailed metadata information about the index rollup job and its current progress.
 

_im-plugin/index-transforms/index.md

@@ -3,7 +3,7 @@ layout: default
 title: Index transforms
 nav_order: 20
 has_children: true
-redirect_from: /docs/im/index-transforms/
+redirect_from: /im-plugin/index-transforms/
 has_toc: false
 ---
 
@@ -29,7 +29,7 @@ If you don't have any data in your cluster, you can use the sample flight data w
 ### Step 1: Choose indices
 
 1. In the **Job name and description** section, specify a name and an optional description for your job.
-2. In the **Indices** section, select the source and target index. You can either select an existing target index or create a new one by entering a name for your new index. If you want to transform just a subset of your source index, choose **Add Data Filter**, and use the OpenSearch query DSL to specify a subset of your source index. For more information about the OpenSearch query DSL, see [query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/).
+2. In the **Indices** section, select the source and target index. You can either select an existing target index or create a new one by entering a name for your new index. If you want to transform just a subset of your source index, choose **Edit data filter**, and use the OpenSearch query DSL to specify a subset of your source index. For more information about the OpenSearch query DSL, see [query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/).
 3. Choose **Next**.
 
 ### Step 2: Select fields to transform

_im-plugin/index-transforms/transforms-apis.md

@@ -15,6 +15,8 @@ Aside from using OpenSearch Dashboards, you can also use the REST API to create,
 {:toc}
 
 ## Create a transform job
+Introduced 1.0
+{: .label .label-purple }
 
 Creates a transform job.
 
@@ -139,6 +141,8 @@ source_field | String | The field(s) to transform | Yes
 aggregations | JSON | The aggregations to use in the transform job. Supported aggregations are: `sum`, `max`, `min`, `value_count`, `avg`, `scripted_metric`, and `percentiles`. For more information, see [Metric Aggregations]({{site.url}}{{site.baseurl}}/opensearch/metric-agg). | Yes if not using groups
 
 ## Update a transform job
+Introduced 1.0
+{: .label .label-purple }
 
 Updates a transform job if `transform_id` already exists.
 
@@ -254,6 +258,8 @@ Parameter | Description | Required
 `if_primary_term` | Only perform the transform operation if the last operation that changed the transform job has the specified sequence term. | No
 
 ## Get a transform job's details
+Introduced 1.0
+{: .label .label-purple }
 
 Returns a transform job's details.
 
@@ -520,6 +526,8 @@ GET _plugins/_transform?size=2&from=8
 ```
 
 ## Start a transform job
+Introduced 1.0
+{: .label .label-purple }
 
 Transform jobs created using the API are automatically enabled, but if you ever need to enable a job, you can use the `start` API operation.
 
@@ -538,6 +546,8 @@ POST _plugins/_transform/<transform_id>/_start
 ```
 
 ## Stop a transform job
+Introduced 1.0
+{: .label .label-purple }
 
 Stops/disables a transform job.
 
@@ -556,6 +566,8 @@ POST _plugins/_transform/<transform_id>/_stop
 ```
 
 ## Get the status of a transform job
+Introduced 1.0
+{: .label .label-purple }
 
 Returns the status and metadata of a transform job.
 
@@ -589,6 +601,8 @@ GET _plugins/_transform/<transform_id>/_explain
 ```
 
 ## Preview a transform job's results
+Introduced 1.0
+{: .label .label-purple }
 
 Returns a preview of what a transformed index would look like.
 
@@ -674,6 +688,8 @@ POST _plugins/_transform/_preview
 ```
 
 ## Delete a transform job
+Introduced 1.0
+{: .label .label-purple }
 
 Deletes a transform job. This operation does not delete the source or target indices.
 

_im-plugin/ism/api.md

@@ -2,8 +2,7 @@
 layout: default
 title: ISM API
 parent: Index State Management
-redirect_from: /docs/ism/api/
-nav_order: 5
+nav_order: 20
 ---
 
 # ISM API
@@ -21,6 +20,8 @@ Use the index state management operations to programmatically work with policies
 
 
 ## Create policy
+Introduced 1.0
+{: .label .label-purple }
 
 Creates a policy.
 
@@ -138,6 +139,8 @@ PUT _plugins/_ism/policies/policy_1
 ---
 
 ## Add policy
+Introduced 1.0
+{: .label .label-purple }
 
 Adds a policy to an index. This operation does not change the policy if the index already has one.
 
@@ -160,10 +163,16 @@ POST _plugins/_ism/add/index_1
 }
 ```
 
+If you use a wildcard `*` while adding a policy to an index, the ISM plugin interprets `*` as all indices, including system indices like `.opendistro-security`, which stores users, roles, and tenants. A delete action in your policy might accidentally delete all user roles and tenants in your cluster.
+Don't use the broad `*` wildcard, and instead add a prefix, such as `my-logs*`, when specifying indices with the `_ism/add` API.
+{: .warning }
+
 ---
 
 
 ## Update policy
+Introduced 1.0
+{: .label .label-purple }
 
 Updates a policy. Use the `seq_no` and `primary_term` parameters to update an existing policy. If these numbers don't match the existing policy or the policy doesn't exist, ISM throws an error.
 
@@ -281,6 +290,8 @@ PUT _plugins/_ism/policies/policy_1?if_seq_no=7&if_primary_term=1
 ---
 
 ## Get policy
+Introduced 1.0
+{: .label .label-purple }
 
 Gets the policy by `policy_id`.
 
@@ -351,6 +362,8 @@ GET _plugins/_ism/policies/policy_1
 ---
 
 ## Remove policy from index
+Introduced 1.0
+{: .label .label-purple }
 
 Removes any ISM policy from the index.
 
@@ -374,6 +387,8 @@ POST _plugins/_ism/remove/index_1
 ---
 
 ## Update managed index policy
+Introduced 1.0
+{: .label .label-purple }
 
 Updates the managed index policy to a new policy (or to a new version of the policy). You can use an index pattern to update multiple indices at once. When updating multiple indices, you might want to include a state filter to only affect certain managed indices. The change policy filters out all the existing managed indices and only applies the change to the ones in the state that you specify. You can also explicitly specify the state that the managed index transitions to after the change policy takes effect.
 
@@ -410,6 +425,8 @@ POST _plugins/_ism/change_policy/index_1
 ---
 
 ## Retry failed index
+Introduced 1.0
+{: .label .label-purple }
 
 Retries the failed action for an index. For the retry call to succeed, ISM must manage the index, and the index must be in a failed state. You can use index patterns (`*`) to retry multiple failed indices.
 
@@ -436,6 +453,8 @@ POST _plugins/_ism/retry/index_1
 ---
 
 ## Explain index
+Introduced 1.0
+{: .label .label-purple }
 
 Gets the current state of the index. You can use index patterns to get the status of multiple indices.
 
@@ -461,6 +480,8 @@ The `plugins.index_state_management.policy_id` setting is deprecated starting fr
 ---
 
 ## Delete policy
+Introduced 1.0
+{: .label .label-purple }
 
 Deletes the policy by `policy_id`.
 

_im-plugin/ism/index.md

@@ -4,8 +4,7 @@ title: Index State Management
 nav_order: 3
 has_children: true
 redirect_from:
-  - /docs/im/ism/
-  - /docs/ism/
+  - /im-plugin/ism/
 has_toc: false
 ---
 
@@ -32,14 +31,21 @@ To get started, choose **Index Management** in OpenSearch Dashboards.
 
 A policy is a set of rules that describes how an index should be managed. For information about creating a policy, see [Policies]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/).
 
+You can use the JSON editor or visual editor to create policies. Compared to the JSON editor, the visual editor offers a more structured way of defining policies by separating the process into creating error notifications, defining ISM templates, and adding states. We recommend using the visual editor if you want to see pre-defined fields, such as which actions you can assign to a state or under what conditions a state can transition into a destination state.
+
+#### JSON editor
+
 1. Choose the **Index Policies** tab.
 2. Choose **Create policy**.
-3. In the **Name policy** section, enter a policy ID.
-4. In the **Define policy** section, enter your policy.
-5. Choose **Create**.
+3. Choose **JSON editor**.
+4. In the **Name policy** section, enter a policy ID.
+5. In the **Define policy** section, enter your policy.
+6. Choose **Create**.
 
-After you create a policy, your next step is to attach this policy to an index or indices.
-You can set up an `ism_template` in the policy so when you create an index that matches the ISM template pattern, the index will have this policy attached to it:
+After you create a policy, your next step is to attach it to an index or indices.
+You can set up an `ism_template` in the policy so when an index that matches the ISM template pattern is created, the plugin automatically attaches the policy to the index.
+
+The following example demonstrates how to create a policy that automatically gets attached to all indices whose names start with `index_name-`.
 
 ```json
 PUT _plugins/_ism/policies/policy_id
@@ -56,6 +62,8 @@ PUT _plugins/_ism/policies/policy_id
 }
 ```
 
+If you have more than one template that matches an index pattern, ISM uses the priority value to determine which template to apply.
+
 For an example ISM template policy, see [Sample policy with ISM template]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies#sample-policy-with-ism-template).
 
 Older versions of the plugin include the `policy_id` in an index template, so when an index is created that matches the index template pattern, the index will have the policy attached to it:
@@ -90,7 +98,7 @@ Make sure that the alias that you enter already exists. For more information abo
 
 After you attach a policy to an index, ISM creates a job that runs every 5 minutes by default to perform policy actions, check conditions, and transition the index into different states. To change the default time interval for this job, see [Settings]({{site.url}}{{site.baseurl}}/im-plugin/ism/settings/).
 
-If you want to use an OpenSearch operation to create an index with a policy already attached to it, see [create index]({{site.url}}{{site.baseurl}}/im-plugin/ism/api#create-index).
+ISM does not run jobs if the cluster state is red.
 
 ### Step 3: Manage indices
 

_im-plugin/ism/managedindices.md

@@ -3,7 +3,6 @@ layout: default
 title: Managed Indices
 nav_order: 3
 parent: Index State Management
-redirect_from: /docs/ism/managedindices/
 has_children: false
 ---
 

_im-plugin/ism/policies.md

@@ -3,7 +3,6 @@ layout: default
 title: Policies
 nav_order: 1
 parent: Index State Management
-redirect_from: /docs/ism/policies/
 has_children: false
 ---
 
@@ -94,7 +93,7 @@ For a list of available unit types, see [Supported units]({{site.url}}{{site.bas
 
 ISM supports the following operations:
 
-- [force_merge](#forcemerge)
+- [force_merge](#force_merge)
 - [read_only](#read_only)
 - [read_write](#read_write)
 - [replica_count](#replica_count)
@@ -348,7 +347,7 @@ Parameter | Description | Type | Required | Default
 
 ### allocation
 
-Allocate the index to a node with a specific attribute.
+Allocate the index to a node with a specific attribute set [like this]({{site.url}}{{site.baseurl}}/opensearch/cluster/#advanced-step-7-set-up-a-hot-warm-architecture).
 For example, setting `require` to `warm` moves your data only to "warm" nodes.
 
 The `allocation` operation has the following parameters:
@@ -364,7 +363,7 @@ Parameter | Description | Type | Required
 "actions": [
   {
     "allocation": {
-      "require": { "box_type": "warm" }
+      "require": { "temp": "warm" }
     }
   }
 ]
@@ -559,9 +558,11 @@ The following sample template policy is for a rollover use case.
    PUT _index_template/ism_rollover
    {
      "index_patterns": ["log*"],
-     "settings": {
+     "template": {
+      "settings": {
        "plugins.index_state_management.rollover_alias": "log"
-     }
+      }
+    }
    }
    ```
 
@@ -587,6 +588,12 @@ The following sample template policy is for a rollover use case.
    }
    ```
 
+5. Verify if the policy is attached to the `log-000001` index:
+
+   ```json
+   GET _plugins/_ism/explain/log-000001?pretty
+   ```
+
 ## Example policy
 
 The following example policy implements a `hot`, `warm`, and `delete` workflow. You can use this policy as a template to prioritize resources to your indices based on their levels of activity.

_im-plugin/ism/settings.md

@@ -2,7 +2,6 @@
 layout: default
 title: Settings
 parent: Index State Management
-redirect_from: /docs/ism/settings/
 nav_order: 4
 ---
 

_im-plugin/refresh-analyzer/index.md

@@ -1,9 +1,9 @@
 ---
 layout: default
 title: Refresh search analyzer
-nav_order: 40
+nav_order: 50
 has_children: false
-redirect_from: /docs/ism/refresh-analyzer/
+redirect_from: /im-plugin/refresh-analyzer/
 has_toc: false
 ---
 

_im-plugin/security.md

@@ -0,0 +1,41 @@
+---
+layout: default
+title: Index management security
+nav_order: 40
+has_children: false
+---
+
+# Index management security
+
+Using the security plugin with index management lets you limit non-admin users to certain actions. For example, you might want to set up your security such that a group of users can only read ISM policies, while others can create, delete, or change policies.
+
+All index management data are protected as system indices, and only a super admin or an admin with a Transport Layer Security (TLS) certificate can access system indices. For more information, see [System indices]({{site.url}}{{site.baseurl}}/security-plugin/configuration/system-indices).
+
+## Basic permissions
+
+The security plugin comes with one role that offers full access to index management: `index_management_full_access`. For a description of the role's permissions, see [Predefined roles]({{site.url}}{{site.baseurl}}/security-plugin/access-control/users-roles#predefined-roles).
+
+With security enabled, users not only need the correct index management permissions, but they also need permissions to execute actions to involved indices. For example, if a user wants to use the REST API to attach a policy that executes a rollup job to an index named `system-logs`, they would need the permissions to attach a policy and execute a rollup job, as well as access to `system-logs`.
+
+Finally, with the exceptions of Create Policy, Get Policy, and Delete Policy, users also need the `indices:admin/opensearch/ism/managedindex` permission to execute [ISM APIs]({{site.url}}{{site.baseurl}}/im-plugin/ism/api).
+
+## (Advanced) Limit access by backend role
+
+You can use backend roles to configure fine-grained access to index management policies and actions. For example, users of different departments in an organization might view different policies depending on what roles and permissions they are assigned.
+
+First, ensure your users have the appropriate [backend roles]({{site.url}}{{site.baseurl}}/security-plugin/access-control/index/). Backend roles usually come from an [LDAP server]({{site.url}}{{site.baseurl}}/security-plugin/configuration/ldap/) or [SAML provider]({{site.url}}{{site.baseurl}}/security-plugin/configuration/saml/). However, if you use the internal user database, you can use the REST API to [add them manually]({{site.url}}{{site.baseurl}}/security-plugin/access-control/api#create-user).
+
+Use the REST API to enable the following setting:
+
+```json
+PUT _cluster/settings
+{
+  "transient": {
+    "plugins.index_management.filter_by_backend_roles": "true"
+  }
+}
+```
+
+With security enabled, only users who share at least one backend role can see and execute the policies and actions relevant to their roles.
+
+For example, consider a scenario with three users: `John` and `Jill`, who have the backend role `helpdesk_staff`, and `Jane`, who has the backend role `phone_operator`. `John` wants to create a policy that performs a rollup job on an index named `airline_data`, so `John` would need a backend role that has permissions to access that index, create relevant policies, and execute relevant actions, and `Jill` would be able to access the same index, policy, and job. However, `Jane` cannot access or edit those resources or actions.

_includes/footer.html

@@ -0,0 +1,45 @@
+
+<div role="contentinfo">
+  <div class="subfooter">
+    <div class="container">
+      <h1 class="visuallyhidden">OpenSearch Links</h1>
+    
+      {% for column in site.data.footer.columns %}
+        <div class="col {% if forloop.index > 2 %}last-child{% endif %}">
+        
+          <h2>{{ column.title }}</h2>
+          <ul>
+            {% for link in column.links %}
+            <li><a href="{{ link.url }}">{{ link.title}}</a></li>
+            {% endfor %}
+          </ul>
+        </div>
+      {% endfor %}
+
+    </div>
+  </div>
+
+  <div class="footer">
+    <div class="container">
+
+      <a href="{{ '/' | relative_url }}"><svg viewBox="0 0 64 64" fill="currentColor"  xmlns="http://www.w3.org/2000/svg">
+        <path d="M61.7374 23.5C60.4878 23.5 59.4748 24.513 59.4748 25.7626C59.4748 44.3813 44.3813 59.4748 25.7626 59.4748C24.513 59.4748 23.5 60.4878 23.5 61.7374C23.5 62.987 24.513 64 25.7626 64C46.8805 64 64 46.8805 64 25.7626C64 24.513 62.987 23.5 61.7374 23.5Z" fill="currentColor" />
+        <path d="M48.0814 38C50.2572 34.4505 52.3615 29.7178 51.9475 23.0921C51.0899 9.36725 38.6589 -1.04463 26.9206 0.0837327C22.3253 0.525465 17.6068 4.2712 18.026 10.9805C18.2082 13.8961 19.6352 15.6169 21.9544 16.9399C24.1618 18.1992 26.9978 18.9969 30.2128 19.9011C34.0962 20.9934 38.6009 22.2203 42.063 24.7717C46.2125 27.8295 49.0491 31.3743 48.0814 38Z" fill="currentColor" />
+        <path d="M3.91861 14C1.74276 17.5495 -0.361506 22.2822 0.0524931 28.9079C0.910072 42.6327 13.3411 53.0446 25.0794 51.9163C29.6747 51.4745 34.3932 47.7288 33.974 41.0195C33.7918 38.1039 32.3647 36.3831 30.0456 35.0601C27.8382 33.8008 25.0022 33.0031 21.7872 32.0989C17.9038 31.0066 13.3991 29.7797 9.93694 27.2283C5.78746 24.1704 2.95092 20.6257 3.91861 14Z" fill="currentColor" />
+        </svg></a>
+        
+      <p class="copyright">&copy; {{ 'now' | date: "%Y" }}
+        <a href="https://aws.amazon.com/"> Amazon Web Services</a> and individual contributors. OpenSearch is a
+        <a href="/trademark-usage.html">registered trademark</a> of Amazon Web Services.</a> <br /><br />
+
+        © 2005-2021
+          <a href="https://www.djangoproject.com/foundation/"> Django Software
+          Foundation</a> and individual contributors. Django is a
+          <a href="https://www.djangoproject.com/trademarks/">registered
+          trademark</a> of the Django Software Foundation.<br />
+        This website was forked from the BSD-licensed <a href="https://github.com/django/djangoproject.com/">djangoproject.com</a> originally designed by <a href="https://www.threespot.com">Threespot</a> <span class="ampersand">&amp;</span> <a  href="http://andrevv.com/">andrevv</a>.<br /> We ♡ Django and the Django community. If you need a <a href="https://www.djangoproject.com/">high-level Python framework</a>, check it out. 
+      </p>
+    </div>
+  </div>
+
+</div>

_includes/head_custom.html

@@ -6,3 +6,9 @@
   <script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
   <script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/[email protected]/es5/tex-mml-chtml.js"></script>
 {% endif %}
+
+{% if jekyll.environment == "development" %}
+  <script src="{{ '/assets/js/version-selector.js' | relative_url }}"></script>
+{% else %}
+  <script src="{{ '/docs/latest/assets/js/version-selector.js' }}"></script>
+{% endif %}

_includes/header.html

@@ -0,0 +1,41 @@
+{% assign url_full = site.baseurl | append: page.url %}
+{% assign url_parts = url_full | split: "/" %}
+{%if page.alert %}
+<div role="banner" class="banner-alert">
+  <div class="container">
+    {{page.alert | markdownify}}
+  </div>
+</div>
+{%endif%}
+{%if site.data.alert.message %}
+<div role="banner" class="banner-alert">
+  <div class="container">
+  {{site.data.alert.message | markdownify}}
+  </div>
+</div>
+{%endif%}
+<div role="banner" id="top">
+  <div class="container">
+    <a class="logo" href="/">
+      OpenSearch
+      <svg viewBox="0 0 372 72" fill="none" xmlns="http://www.w3.org/2000/svg">
+        <path d="M61.7374 26.5C60.4878 26.5 59.4748 27.513 59.4748 28.7626C59.4748 47.3814 44.3814 62.4748 25.7626 62.4748C24.513 62.4748 23.5 63.4878 23.5 64.7374C23.5 65.987 24.513 67 25.7626 67C46.8805 67 64 49.8805 64 28.7626C64 27.513 62.987 26.5 61.7374 26.5Z" fill="#00A3E0"/>
+        <path d="M48.0814 41C50.2572 37.4505 52.3615 32.7178 51.9475 26.0921C51.0899 12.3673 38.6589 1.95537 26.9206 3.08373C22.3253 3.52547 17.6068 7.2712 18.026 13.9805C18.2082 16.8961 19.6352 18.6169 21.9544 19.9399C24.1618 21.1992 26.9978 21.9969 30.2128 22.9011C34.0962 23.9934 38.6009 25.2203 42.0631 27.7717C46.2125 30.8296 49.0491 34.3743 48.0814 41Z" fill="#B9D9EB"/>
+        <path d="M3.91861 17C1.74276 20.5495 -0.361506 25.2822 0.0524931 31.9079C0.910072 45.6327 13.3411 56.0446 25.0794 54.9163C29.6747 54.4745 34.3932 50.7288 33.974 44.0195C33.7918 41.1039 32.3647 39.3831 30.0456 38.0601C27.8382 36.8008 25.0022 36.0031 21.7872 35.0989C17.9038 34.0066 13.3991 32.7797 9.93695 30.2283C5.78747 27.1704 2.95092 23.6257 3.91861 17Z" fill="#00A3E0"/>
+        <path fill-rule="evenodd" clip-rule="evenodd" d="M362.5 31V54H371.5V29C371.5 24.3927 370.6 20.9121 368.799 18.5511C366.998 16.1672 364.282 15 360.75 15C356.918 15 353.847 17.2408 352 21H351.5C351.636 19.0591 351.76 17.9472 351.85 17.1353C351.943 16.298 352 15.7797 352 15V0.5H343V54H352.5V35.5C352.5 31.3511 352.639 28.2815 353.493 26.081C354.347 23.8575 355.836 22.7458 357.96 22.7458C360.799 22.7458 362.5 25.3841 362.5 31ZM231.852 51.2289C234.284 48.7148 235.5 45.0936 235.5 40.3653C235.5 37.4129 234.834 34.7835 233.501 32.477C232.191 30.1705 229.865 27.9102 226.521 25.6959C224.042 24.0814 222.3 22.6398 221.294 21.3713C220.312 20.1027 219.821 18.615 219.821 16.9082C219.821 15.1783 220.23 13.8175 221.049 12.8257C221.891 11.8108 223.083 11.3034 224.627 11.3034C226.03 11.3034 227.339 11.5571 228.555 12.0645C229.794 12.572 230.975 13.1486 232.098 13.7944L235.254 6.25216C231.63 4.08405 227.854 3 223.925 3C219.809 3 216.524 4.26857 214.069 6.80572C211.637 9.34287 210.421 12.7796 210.421 17.1158C210.421 19.3761 210.725 21.3597 211.333 23.0665C211.964 24.7733 212.841 26.3187 213.964 27.7026C215.109 29.0634 216.781 30.4935 218.979 31.9927C221.505 33.6995 223.317 35.2564 224.416 36.6633C225.515 38.0472 226.065 39.5811 226.065 41.2648C226.065 42.9716 225.597 44.3209 224.662 45.3127C223.75 46.3045 222.382 46.8004 220.558 46.8004C217.354 46.8004 213.835 45.5664 210 43.0985V52.4052C213.133 54.1351 216.933 55 221.4 55C225.959 55 229.444 53.743 231.852 51.2289ZM241.674 49.8745C244.48 53.2915 248.306 55 253.152 55C257.303 55 260.862 54.1111 263.83 52.3333V44.7489C260.677 46.619 257.593 47.5541 254.578 47.5541C252.213 47.5541 250.358 46.7229 249.013 45.0606C247.668 43.3752 247.07 40.9401 247 37.5H265.5V32.4545C265.5 26.9365 264.283 22.6537 261.848 19.6061C259.413 16.5354 256.086 15 251.865 15C247.343 15 243.819 16.7893 241.291 20.368C238.764 23.9466 237.5 28.9221 237.5 35.2944C237.5 41.5743 238.891 46.4343 241.674 49.8745ZM248.526 24.2121C249.384 22.8038 250.474 22.0996 251.796 22.0996C253.21 22.0996 254.323 22.8268 255.135 24.2814C255.946 25.7359 256.454 28.1833 256.5 31H247C247.139 28.0678 247.668 25.5974 248.526 24.2121ZM288 54L286.5 49H286C284.622 51.2587 283.295 52.868 281.824 53.7208C280.352 54.5736 278.494 55 276.252 55C273.378 55 271.112 53.9398 269.453 51.8194C267.818 49.6989 267 46.7488 267 42.9689C267 38.9124 268.121 35.9046 270.364 33.9455C272.63 31.9634 276.006 30.8686 280.492 30.6612L285.678 30.4538V27.688C285.678 24.0925 284.101 22.2947 280.947 22.2947C278.611 22.2947 275.924 23.1936 272.887 24.9914L269.663 18.6301C273.541 16.21 277.694 15 282.25 15C286.385 15 289.592 16.1755 291.741 18.5264C293.914 20.8542 295 24.1616 295 28.4486V54H288ZM280.071 47.809C281.777 47.809 283.132 47.0599 284.136 45.5618C285.164 44.0406 285.678 42.0239 285.678 39.5117V36.2619L282.805 36.4002C280.679 36.5154 279.113 37.1147 278.109 38.1979C277.128 39.2812 276.637 40.8946 276.637 43.038C276.637 46.2187 277.782 47.809 280.071 47.809ZM318 15.75C316.93 15.405 315.337 15 314.222 15C312.651 15 311.273 15.5174 310.089 16.5523C308.905 17.5872 308.002 18.5853 307 21H306.5L305 16H298V54H307.463V34C307.463 30.6424 307.676 28.4763 308.86 26.7285C310.044 24.9577 311.74 24.0723 313.948 24.0723C314.973 24.0723 315.863 24.27 316.5 24.5L318 15.75ZM332 55C327.443 55 323.954 53.478 321.573 50.1302C319.191 46.7824 318 41.8647 318 35.377C318 28.5891 319.122 23.5213 321.366 20.1735C323.634 16.8257 327.017 15 331.735 15C333.154 15 334.752 15.3596 336.309 15.7752C337.866 16.1908 339.763 16.715 341 17.5L337.889 24.7449C335.989 23.6136 334.305 23.048 332.84 23.048C330.893 23.048 329.485 24.0754 328.614 26.1302C327.767 28.162 327.344 31.2211 327.344 35.3077C327.344 39.3019 327.767 42.2918 328.614 44.2774C329.462 46.2399 330.847 47.2211 332.771 47.2211C335.061 47.2211 337.454 46.413 339.95 44.7969V52.9008C337.546 54.4015 334.908 55 332 55Z" fill="#B9D9EB"/>
+        <path fill-rule="evenodd" clip-rule="evenodd" d="M107.777 48.2625C110.926 43.7708 112.5 37.3442 112.5 28.9827C112.5 20.6213 110.937 14.2062 107.812 9.73754C104.686 5.24585 100.194 3 94.3368 3C88.4098 3 83.8719 5.23433 80.7231 9.70299C77.5744 14.1486 76 20.5522 76 28.9136C76 37.3442 77.5744 43.8053 80.7231 48.297C83.8719 52.7657 88.3866 55 94.2674 55C100.125 55 104.628 52.7542 107.777 48.2625ZM87.8425 42.1468C86.3839 39.1293 85.6546 34.7413 85.6546 28.9827C85.6546 23.2011 86.3839 18.8131 87.8425 15.8186C89.3011 12.8011 91.4659 11.2924 94.3368 11.2924C99.986 11.2924 102.811 17.1891 102.811 28.9827C102.811 40.7763 99.9629 46.6731 94.2674 46.6731C91.4428 46.6731 89.3011 45.1643 87.8425 42.1468ZM128.186 53.9979C129.469 54.7387 130.85 55 132.5 55C136.03 55 138.9 53.3265 140.94 49.7612C142.98 46.196 144 41.2764 144 35.0025C144 28.6359 143.014 23.7164 141.043 20.2437C139.072 16.7479 136.345 15 132.861 15C129.24 15 126.402 17.1569 124.5 21H124L122.5 16H115.5V71.5H124.5V55C124.5 54.3518 124.367 52.1485 124 49H124.5C125.25 51.25 126.925 53.2339 128.186 53.9979ZM125.882 25.3832C126.685 23.6932 127.979 22.8482 129.767 22.8482C131.44 22.8482 132.666 23.8437 133.446 25.8347C134.248 27.8257 134.649 30.8353 134.649 34.8636C134.649 43.059 133.045 47.1567 129.836 47.1567C127.979 47.1567 126.65 46.1844 125.848 44.2397C125.046 42.295 124.645 39.1928 124.645 34.933V33.7176C124.691 29.8282 125.103 27.0501 125.882 25.3832ZM161.652 55C156.806 55 152.98 53.2915 150.174 49.8745C147.391 46.4343 146 41.5743 146 35.2944C146 28.9221 147.264 23.9466 149.791 20.368C152.319 16.7893 155.843 15 160.365 15C164.585 15 167.913 16.5354 170.348 19.6061C172.783 22.6537 174 26.9365 174 32.4545V37.5H155.5C155.57 40.9401 156.168 43.3752 157.513 45.0606C158.858 46.7229 160.713 47.5541 163.078 47.5541C166.093 47.5541 169.177 46.619 172.33 44.7489V52.3333C169.362 54.1111 165.803 55 161.652 55ZM160.296 22.0996C158.974 22.0996 157.884 22.8038 157.026 24.2121C156.168 25.5974 155.639 28.0678 155.5 31H165C164.954 28.1833 164.446 25.7359 163.635 24.2814C162.823 22.8268 161.71 22.0996 160.296 22.0996ZM196.5 31V54H205.5V29.1991C205.5 24.5589 204.623 21.0323 202.868 18.6194C201.137 16.2065 198.516 15 195.007 15C192.93 15 191.117 15.5104 189.57 16.5313C188.024 17.5289 186.831 19.2135 186 21H185.5L184.25 16H177V54H186.5V35.75C186.5 31.0402 186.673 27.8302 187.597 25.8582C188.52 23.8628 189.974 22.8652 191.96 22.8652C193.46 22.8652 194.546 23.5844 195.215 25.0229C195.885 26.4614 196.5 28.1927 196.5 31Z" fill="#00A3E0"/>
+        </svg>            
+    </a>
+
+    <div class="menu-button"><i class="icon icon-reorder"></i><span>Menu</span></div>
+    <div class="nav-menu-on" role="navigation">
+      <ul class="small-nav">
+        {%- include nav_item.html text="News" href="/blog" url_full="/blog/" url_fragment="blog" -%}
+        {%- include nav_item.html text="Source" href="/source.html" url_full="/source.html" url_fragment="source" -%}
+        {%- include nav_item.html text="Documentation" href="/docs" url_full="/docs/" url_fragment="docs" -%}
+        {%- include nav_item.html text="Events" href="/events" url_full="/events/" url_fragment="events" -%}
+        {%- include nav_item.html text="Get Started" href="/downloads.html" url_full="/downloads.html" url_fragment="downloads" -%}
+      </ul>
+    </div>
+  </div>
+</div>

_includes/nav_item.html

@@ -0,0 +1,7 @@
+<li>
+  {% if url_full == include.url_full %} {{ include.text }} {% else %}
+    <a href="{{ include.href }}" {% if url_parts[1] == {{include.url_fragment}} %} class="in-category" {% endif %}>
+      {{ include.text }}
+    </a>
+  {% endif %}
+</li>

_layouts/default.html

@@ -38,61 +38,74 @@ layout: table_wrappers
         <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline>
       </svg>
     </symbol>
+    <symbol id="svg-grid" viewBox="0 0 24 24">
+      <title>Documentation Menu</title>
+      <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather feather-grid">
+        <rect x="3" y="3" width="7" height="7"></rect><rect x="14" y="3" width="7" height="7"></rect><rect x="14" y="14" width="7" height="7"></rect><rect x="3" y="14" width="7" height="7"></rect>
+      </svg>
+    </symbol>
   </svg>
 
-  <div class="side-bar">
-    <div class="site-header">
-      <a href="{{ '/' | absolute_url }}" class="site-title lh-tight">{% include title.html %}</a>
-      <a href="#" id="menu-button" class="site-button">
-        <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-menu"></use></svg>
-      </a>
-    </div>
-    <nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
-      {% assign pages_top_size = site.html_pages
-          | where_exp:"item", "item.title != nil"
-          | where_exp:"item", "item.parent == nil"
-          | where_exp:"item", "item.nav_exclude != true"
-          | size %}
-      {% if pages_top_size > 0 %}
-        {% include nav.html pages=site.html_pages key=nil %}
-      {% endif %}
-      {% if site.just_the_docs.collections %}
-        {% assign collections_size = site.just_the_docs.collections | size %}
-        {% for collection_entry in site.just_the_docs.collections %}
-          {% assign collection_key = collection_entry[0] %}
-          {% assign collection_value = collection_entry[1] %}
-          {% assign collection = site[collection_key] %}
-          {% if collection_value.nav_exclude != true %}
-            {% if collections_size > 1 or pages_top_size > 0 %}
-              {% if collection_value.nav_fold == true %}
-                <ul class="nav-list nav-category-list">
-                  <li class="nav-list-item{% if page.collection == collection_key %} active{% endif %}">
-                    {%- if collection.size > 0 -%}
-                    <a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
-                    {%- endif -%}
-                    <div class="nav-category">{{ collection_value.name }}</div>
-                    {% include nav.html pages=collection key=collection_key %}
-                  </li>
-                </ul>
+  {% include header.html %}
+
+  <main>
+    <div id="main-header"></div>
+    <div class="side-bar">
+      <div class="site-header">
+        <a href="#" id="menu-button" class="site-button">
+          Documentation <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-grid"></use></svg>
+        </a>
+      </div>
+      <nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
+        {% assign past_versions = site.data.versions.past | join: ";" %}
+        <div class="version-wrapper">
+          <version-selector selected="{{ site.data.versions.current }}"></version-selector>
+        </div>
+        {% assign pages_top_size = site.html_pages
+            | where_exp:"item", "item.title != nil"
+            | where_exp:"item", "item.parent == nil"
+            | where_exp:"item", "item.nav_exclude != true"
+            | size %}
+        {% if pages_top_size > 0 %}
+          {% include nav.html pages=site.html_pages key=nil %}
+        {% endif %}
+        {% if site.just_the_docs.collections %}
+          {% assign collections_size = site.just_the_docs.collections | size %}
+          {% for collection_entry in site.just_the_docs.collections %}
+            {% assign collection_key = collection_entry[0] %}
+            {% assign collection_value = collection_entry[1] %}
+            {% assign collection = site[collection_key] %}
+            {% if collection_value.nav_exclude != true %}
+              {% if collections_size > 1 or pages_top_size > 0 %}
+                {% if collection_value.nav_fold == true %}
+                  <ul class="nav-list nav-category-list">
+                    <li class="nav-list-item{% if page.collection == collection_key %} active{% endif %}">
+                      {%- if collection.size > 0 -%}
+                      <a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
+                      {%- endif -%}
+                      <div class="nav-category">{{ collection_value.name }}</div>
+                      {% include nav.html pages=collection key=collection_key %}
+                    </li>
+                  </ul>
+                {% else %}
+                  <div class="nav-category">{{ collection_value.name }}</div>
+                  {% include nav.html pages=collection key=collection_key %}
+                {% endif %}
               {% else %}
-                <div class="nav-category">{{ collection_value.name }}</div>
                 {% include nav.html pages=collection key=collection_key %}
               {% endif %}
-            {% else %}
-              {% include nav.html pages=collection key=collection_key %}
             {% endif %}
-          {% endif %}
-        {% endfor %}
-      {% endif %}
-    </nav>
-    <footer class="site-footer">
-      <p class="text-small text-grey-dk-100">See a problem? Submit <a href="https://github.com/opensearch-project/documentation-website/issues">issues</a> or <a href="https://github.com/opensearch-project/documentation-website/edit/main/{{ page.path }}">edit this page</a> on <a href="https://github.com/opensearch-project/documentation-website/">GitHub</a>.</p>
-      <p class="text-small text-grey-dk-100 mb-0">© 2021 OpenSearch contributors. This documentation is under the Apache License 2.0.</p>
-    </footer>
-  </div>
-  <div class="main" id="top">
-    <div id="main-header" class="main-header">
-      {% if site.search_enabled != false %}
+          {% endfor %}
+        {% endif %}
+      </nav>
+      <div class="site-footer">
+        <p class="text-small text-grey-dk-100">See a problem? Submit <a href="https://github.com/opensearch-project/documentation-website/issues">issues</a> or <a href="https://github.com/opensearch-project/documentation-website/edit/main/{{ page.path }}">edit this page</a> on <a href="https://github.com/opensearch-project/documentation-website/">GitHub</a>.</p>
+      </div>
+    </div>
+    <div class="copy-banner">
+      <div class="container">
+        <h1><a href="#">Documentation</a></h1>
+        {% if site.search_enabled != false %}
         <div class="search">
           <div class="search-input-wrap">
             <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search..." aria-label="Search {{ site.title }}" autocomplete="off">
@@ -100,117 +113,105 @@ layout: table_wrappers
           </div>
           <div id="search-results" class="search-results"></div>
         </div>
-      {% endif %}
-      {% include header_custom.html %}
-      {% if site.aux_links %}
-        <nav aria-label="Auxiliary" class="aux-nav">
-          <ul class="aux-nav-list">
-            {% for link in site.aux_links %}
-              <li class="aux-nav-list-item">
-                <a href="{{ link.last }}" class="site-button"
-                  {% if site.aux_links_new_tab %}
-                  target="_blank" rel="noopener noreferrer"
-                  {% endif %}
-                >
-                  {{ link.first }}
-                </a>
-              </li>
-            {% endfor %}
-          </ul>
-        </nav>
-      {% endif %}
-    </div>
-    <div id="main-content-wrap" class="main-content-wrap">
-      {% unless page.url == "/" %}
-        {% if page.parent %}
-          <nav aria-label="Breadcrumb" class="breadcrumb-nav">
-            <ol class="breadcrumb-nav-list">
-              {% if page.grand_parent %}
-                <li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.grand_parent }}</a></li>
-                <li class="breadcrumb-nav-list-item"><a href="{{ second_level_url }}">{{ page.parent }}</a></li>
-              {% else %}
-                <li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.parent }}</a></li>
-              {% endif %}
-              <li class="breadcrumb-nav-list-item"><span>{{ page.title }}</span></li>
-            </ol>
-          </nav>
         {% endif %}
-      {% endunless %}
-      <div id="main-content" class="main-content" role="main">
-        {% if site.heading_anchors != false %}
-          {% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#svg-link\"></use></svg>" anchorClass="anchor-heading" anchorAttrs="aria-labelledby=\"%html_id%\"" %}
-        {% else %}
-          <p class="warning" style="margin-top: 0">This documentation remains in a beta state. It has content gaps and might contain bugs.</p>
-          {{ content }}
-        {% endif %}
-
-        {% if page.has_children == true and page.has_toc != false %}
-          <hr>
-          <h2 class="text-delta">Table of contents</h2>
-          <ul>
-            {% for child in toc_list %}
-              <li>
-                <a href="{{ child.url | absolute_url }}">{{ child.title }}</a>{% if child.summary %} - {{ child.summary }}{% endif %}
-              </li>
-            {% endfor %}
-          </ul>
-        {% endif %}
-
-        {% capture footer_custom %}
-          {%- include footer_custom.html -%}
-        {% endcapture %}
-        {% if footer_custom != "" or site.last_edit_timestamp or site.gh_edit_link %}
-          <hr>
-          <footer>
-            {% if site.back_to_top %}
-              <p><a href="#top" id="back-to-top">{{ site.back_to_top_text }}</a></p>
-            {% endif %}
-
-            {{ footer_custom }}
-
-            {% if site.last_edit_timestamp or site.gh_edit_link %}
-              <div class="d-flex mt-2">
-                {% if site.last_edit_timestamp and site.last_edit_time_format and page.last_modified_date %}
-                  <p class="text-small text-grey-dk-000 mb-0 mr-2">
-                    Page last modified: <span class="d-inline-block">{{ page.last_modified_date | date: site.last_edit_time_format }}</span>.
-                  </p>
-                {% endif %}
-                {% if
-                  site.gh_edit_link and
-                  site.gh_edit_link_text and
-                  site.gh_edit_repository and
-                  site.gh_edit_branch and
-                  site.gh_edit_view_mode
-                %}
-                  <p class="text-small text-grey-dk-000 mb-0">
-                    <a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}{% if site.gh_edit_source %}/{{ site.gh_edit_source }}{% endif %}/{{ page.path }}" id="edit-this-page">{{ site.gh_edit_link_text }}</a>
-                  </p>
-                {% endif %}
-              </div>
-            {% endif %}
-          </footer>
-        {% endif %}
-
       </div>
-    </div>
-    <div class="toc">
-      {% include toc.html html=content h_min=2 h_max=2 class="toc-list" item_class="toc-item" sanitize=true %}
-    </div>
-    {% if site.search_enabled != false %}
-      {% if site.search.button %}
-        <a href="#" id="search-button" class="search-button">
-          <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-search"></use></svg>
-        </a>
-      {% endif %}
-
       <div class="search-overlay"></div>
-    {% endif %}
-  </div>
+    </div>
+    <div class="main" id="top">
+      <div id="main-content-wrap" class="main-content-wrap">
+        {% unless page.url == "/" %}
+          {% if page.parent %}
+            <nav aria-label="Breadcrumb" class="breadcrumb-nav">
+              <ol class="breadcrumb-nav-list">
+                {% if page.grand_parent %}
+                  <li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.grand_parent }}</a></li>
+                  <li class="breadcrumb-nav-list-item"><a href="{{ second_level_url }}">{{ page.parent }}</a></li>
+                {% else %}
+                  <li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.parent }}</a></li>
+                {% endif %}
+                <li class="breadcrumb-nav-list-item"><span>{{ page.title }}</span></li>
+              </ol>
+            </nav>
+          {% endif %}
+        {% endunless %}
+        <div id="main-content" class="main-content" role="main">
+          {% if site.heading_anchors != false %}
+            {% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#svg-link\"></use></svg>" anchorClass="anchor-heading" anchorAttrs="aria-labelledby=\"%html_id%\"" %}
+          {% else %}
+            {{ content }}
+          {% endif %}
+
+          {% if page.has_children == true and page.has_toc != false %}
+            <hr>
+            <h2 class="text-delta">Table of contents</h2>
+            <ul>
+              {% for child in toc_list %}
+                <li>
+                  <a href="{{ child.url | absolute_url }}">{{ child.title }}</a>{% if child.summary %} - {{ child.summary }}{% endif %}
+                </li>
+              {% endfor %}
+            </ul>
+          {% endif %}
+
+          {% capture footer_custom %}
+            {%- include footer_custom.html -%}
+          {% endcapture %}
+          {% if footer_custom != "" or site.last_edit_timestamp or site.gh_edit_link %}
+            <hr>
+            <footer>
+              {% if site.back_to_top %}
+                <p><a href="#top" id="back-to-top">{{ site.back_to_top_text }}</a></p>
+              {% endif %}
+
+              {{ footer_custom }}
+
+              {% if site.last_edit_timestamp or site.gh_edit_link %}
+                <div class="d-flex mt-2">
+                  {% if site.last_edit_timestamp and site.last_edit_time_format and page.last_modified_date %}
+                    <p class="text-small text-grey-dk-000 mb-0 mr-2">
+                      Page last modified: <span class="d-inline-block">{{ page.last_modified_date | date: site.last_edit_time_format }}</span>.
+                    </p>
+                  {% endif %}
+                  {% if
+                    site.gh_edit_link and
+                    site.gh_edit_link_text and
+                    site.gh_edit_repository and
+                    site.gh_edit_branch and
+                    site.gh_edit_view_mode
+                  %}
+                    <p class="text-small text-grey-dk-000 mb-0">
+                      <a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}{% if site.gh_edit_source %}/{{ site.gh_edit_source }}{% endif %}/{{ page.path }}" id="edit-this-page">{{ site.gh_edit_link_text }}</a>
+                    </p>
+                  {% endif %}
+                </div>
+              {% endif %}
+            </footer>
+          {% endif %}
+
+        </div>
+      </div>
+      <div class="toc-wrap">
+        <div class="toc">
+          {% include toc.html html=content h_min=2 h_max=2 class="toc-list" item_class="toc-item" sanitize=true %}
+        </div>
+      </div>
+      {% if site.search_enabled != false %}
+        {% if site.search.button %}
+          <a href="#" id="search-button" class="search-button">
+            <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-search"></use></svg>
+          </a>
+        {% endif %}
+      {% endif %}
+    </div>
+  </main>
+
+  {% include footer.html %}
 
   {% if site.anchor_links != nil %}
     <script>
-      anchors.add();
+      anchors.add().remove('.subfooter h1, .subfooter h2');
     </script>
   {% endif %}
+  <script src="{{ '/assets/js/header-nav.js' | relative_url }}"></script>
 </body>
 </html>

_monitoring-plugins/ad/index.md

@@ -13,28 +13,23 @@ An anomaly in OpenSearch is any unusual behavior change in your time-series data
 
 It can be challenging to discover anomalies using conventional methods such as creating visualizations and dashboards. You could configure an alert based on a static threshold, but this requires prior domain knowledge and isn't adaptive to data that exhibits organic growth or seasonal behavior.
 
-Anomaly detection  automatically detects anomalies in your OpenSearch data in near real-time using the Random Cut Forest (RCF) algorithm. RCF is an unsupervised machine learning algorithm that models a sketch of your incoming data stream to compute an `anomaly grade` and `confidence score` value for each incoming data point. These values are used to differentiate an anomaly from normal variations. For more information about how RCF works, see [Random Cut Forests](https://pdfs.semanticscholar.org/8bba/52e9797f2e2cc9a823dbd12514d02f29c8b9.pdf?_ga=2.56302955.1913766445.1574109076-1059151610.1574109076).
+Anomaly detection  automatically detects anomalies in your OpenSearch data in near real-time using the Random Cut Forest (RCF) algorithm. RCF is an unsupervised machine learning algorithm that models a sketch of your incoming data stream to compute an `anomaly grade` and `confidence score` value for each incoming data point. These values are used to differentiate an anomaly from normal variations. For more information about how RCF works, see [Random Cut Forests](https://api.semanticscholar.org/CorpusID:927435).
 
 You can pair the anomaly detection plugin with the [alerting plugin]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/) to notify you as soon as an anomaly is detected.
 
-To use the anomaly detection plugin, your computer needs to have more than one CPU core.
-{: .note }
-
-## Get started with Anomaly Detection
-
 To get started, choose **Anomaly Detection** in OpenSearch Dashboards.
-To first test with sample streaming data, choose **Sample Detectors** and try out one of the preconfigured detectors.
+To first test with sample streaming data, you can try out one of the preconfigured detectors with one of the sample datasets.
 
-### Step 1: Create a detector
+## Step 1: Define a detector
 
-A detector is an individual anomaly detection task. You can create multiple detectors, and all the detectors can run simultaneously, with each analyzing data from different sources.
+A detector is an individual anomaly detection task. You can define multiple detectors, and all the detectors can run simultaneously, with each analyzing data from different sources.
 
-1. Choose **Create Detector**.
+1. Choose **Create detector**.
 1. Enter a name and brief description. Make sure the name is unique and descriptive enough to help you to identify the purpose of the detector.
 1. For **Data source**, choose the index you want to use as the data source. You can optionally use index patterns to choose multiple indices.
+1. (Optional) For **Data filter**, filter the index you chose as the data source. From the **Data filter** menu, choose **Add data filter**, and then design your filter query by selecting **Field**, **Operator**, and **Value**, or choose **Use query DSL** and add your own JSON filter query.
 1. Select the **Timestamp field** in your index.
-1. (Optional) For **Data filter**, filter the index you chose as the data source. From the **Filter type** menu, choose  **Visual filter**, and then design your filter query by selecting **Fields**, **Operator**, and **Value**, or choose **Custom Expression** and add your own JSON filter query.
-1. For **Detector operation settings**, define the **Detector interval**, which is the time interval at which the detector collects data.
+1. For **Operation settings**, define the **Detector interval**, which is the time interval at which the detector collects data.
 - The detector aggregates the data in this interval, then feeds the aggregated result into the anomaly detection model.
 The shorter you set this interval, the fewer data points the detector aggregates.
 The anomaly detection model uses a shingling process, a technique that uses consecutive data points to create a sample for the model. This process needs a certain number of aggregated data points from contiguous intervals.
@@ -44,48 +39,53 @@ Set the window delay to shift the detector interval to account for this delay.
 - For example, say the detector interval is 10 minutes and data is ingested into your cluster with a general delay of 1 minute.
 Assume the detector runs at 2:00. The detector attempts to get the last 10 minutes of data from 1:50 to 2:00, but because of the 1-minute delay, it only gets 9 minutes of data and misses the data from 1:59 to 2:00.
 Setting the window delay to 1 minute shifts the interval window to 1:49 - 1:59, so the detector accounts for all 10 minutes of the detector interval time.
-1. Choose **Create**.
+1. Choose **Next**.
 
-After you create the detector, the next step is to add features to it.
+After you define the detector, the next step is to configure the model.
 
-### Step 2: Add features to your detector
+## Step 2: Configure the model
+
+#### Add features to your detector
 
 A feature is the field in your index that you want to check for anomalies. A detector can discover anomalies across one or more features. You must choose an aggregation method for each feature: `average()`, `count()`, `sum()`, `min()`, or `max()`. The aggregation method determines what constitutes an anomaly.
 
 For example, if you choose `min()`, the detector focuses on finding anomalies based on the minimum values of your feature. If you choose `average()`, the detector finds anomalies based on the average values of your feature.
 
-A multi-feature model correlates anomalies across all its features. The [curse of dimensionality](https://en.wikipedia.org/wiki/Curse_of_dimensionality) makes it less likely for multi-feature models to identify smaller anomalies as compared to a single-feature model. Adding more features might negatively impact the [precision and recall](https://en.wikipedia.org/wiki/Precision_and_recall) of a model. A higher proportion of noise in your data might further amplify this negative impact. Selecting the optimal feature set is usually an iterative process. We recommend experimenting with a historical detector with different feature sets and checking the precision before moving on to real-time detectors. By default, the maximum number of features for a detector is 5. You can adjust this limit with the `plugins.anomaly_detection.max_anomaly_features` setting.
+A multi-feature model correlates anomalies across all its features. The [curse of dimensionality](https://en.wikipedia.org/wiki/Curse_of_dimensionality) makes it less likely for multi-feature models to identify smaller anomalies as compared to a single-feature model. Adding more features might negatively impact the [precision and recall](https://en.wikipedia.org/wiki/Precision_and_recall) of a model. A higher proportion of noise in your data might further amplify this negative impact. Selecting the optimal feature set is usually an iterative process. By default, the maximum number of features for a detector is 5. You can adjust this limit with the `plugins.anomaly_detection.max_anomaly_features` setting.
 {: .note }
 
-1. On the **Model configuration** page, enter the **Feature name**.
-1. For **Find anomalies based on**, choose the method to find anomalies. For **Field Value** menu, choose the **field** and the **aggregation method**. Or choose **Custom expression**, and add your own JSON aggregation query.
+1. On the **Configure Model** page, enter the **Feature name** and check **Enable feature**.
+1. For **Find anomalies based on**, choose the method to find anomalies. For **Field Value**, choose the **aggregation method**. Or choose **Custom expression**, and add your own JSON aggregation query.
+1. Select a field.
 
-#### (Optional) Set a category field for high cardinality
+#### (Optional) Set category fields for high cardinality
 
 You can categorize anomalies based on a keyword or IP field type.
 
 The category field categorizes or slices the source time series with a dimension like IP addresses, product IDs, country codes, and so on. This helps to see a granular view of anomalies within each entity of the category field to isolate and debug issues.
 
-To set a category field, choose **Enable a category field** and select a field.
+To set a category field, choose **Enable a category field** and select a field. You can’t change the category fields after you create the detector.
 
 Only a certain number of unique entities are supported in the category field. Use the following equation to calculate the recommended total number of entities supported in a cluster:
 
 ```
-(data nodes * heap size * anomaly detection maximum memory percentage) / (entity size of a detector)
+(data nodes * heap size * anomaly detection maximum memory percentage) / (entity model size of a detector)
 ```
 
+To get the entity model size of a detector, use the [profile detector API]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/api/#profile-detector). You can adjust the maximum memory percentage with the `plugins.anomaly_detection.model_max_size_percent` setting.
+
 This formula provides a good starting point, but make sure to test with a representative workload.
 {: .note }
 
-For example, for a cluster with 3 data nodes, each with 8G of JVM heap size, a maximum memory percentage of 10% (default), and the entity size of the detector as 1MB: the total number of unique entities supported is (8.096 * 10^9 * 0.1 / 1M ) * 3 = 2429.
+For example, for a cluster with three data nodes, each with 8 GB of JVM heap size, a maximum memory percentage of 10% (default), and the entity model size of the detector as 1MB: the total number of unique entities supported is (8.096 * 10^9 * 0.1 / 1 MB ) * 3 = 2429.
 
-#### Set a window size
+If the actual total number of unique entities higher than this number that you calculate (in this case: 2429), the anomaly detector makes its best effort to model the extra entities. The detector prioritizes entities that occur more often and are more recent.
 
-Set the number of aggregation intervals from your data stream to consider in a detection window. It's best to choose this value based on your actual data to see which one leads to the best results for your use case.
+#### (Advanced settings) Set a shingle size
 
-Based on experiments performed on a wide variety of one-dimensional data streams, we recommend using a window size between 1 and 16. The default window size is 8. If you set the category field for high cardinality, the default window size is 1.
+Set the number of aggregation intervals from your data stream to consider in a detection window. It’s best to choose this value based on your actual data to see which one leads to the best results for your use case.
 
-If you expect missing values in your data or if you want to base the anomalies on the current interval, choose 1. If your data is continuously ingested and you want to base the anomalies on multiple intervals, choose a larger window size.
+The anomaly detector expects the shingle size to be in the range of 1 and 60. The default shingle size is 8. We recommend that you don't choose 1 unless you have two or more features. Smaller values might increase [recall](https://en.wikipedia.org/wiki/Precision_and_recall) but also false positives. Larger values might be useful for ignoring noise in a signal.
 
 #### Preview sample anomalies
 
@@ -94,12 +94,27 @@ For sample previews, the anomaly detection plugin selects a small number of data
 
 Examine the sample preview and use it to fine-tune your feature configurations (for example, enable or disable features) to get more accurate results.
 
-1. Choose **Save and start detector**.
-1. Choose between automatically starting the detector (recommended) or manually starting the detector at a later time.
+1. Choose **Preview sample anomalies**.
+    - If you don't see any sample anomaly result, check the detector interval and make sure you have more than 400 data points for some entities during the preview date range.
+1. Choose **Next**.
 
-### Step 3: Observe the results
+## Step 3: Set up detector jobs
 
-Choose the **Anomaly results** tab. You need to wait for some time to see the anomaly results. If the detector interval is 10 minutes, the detector might take more than an hour to start, as it's waiting for sufficient data to generate anomalies.
+To start a real-time detector to find anomalies in your data in near real-time, check **Start real-time detector automatically (recommended)**.
+
+Alternatively, if you want to perform historical analysis and find patterns in long historical data windows (weeks or months), check **Run historical analysis detection** and select a date range (at least 128 detection intervals).
+
+Analyzing historical data helps you get familiar with the anomaly detection plugin. You can also evaluate the performance of a detector with historical data to further fine-tune it.
+
+We recommend experimenting with historical analysis with different feature sets and checking the precision before moving on to real-time detectors.
+
+## Step 4: Review and create
+
+Review your model configuration and select **Create detector**.
+
+## Step 5: Observe the results
+
+Choose the **Real-time results** or **Historical analysis** tab. For real-time results, you need to wait for some time to see the anomaly results. If the detector interval is 10 minutes, the detector might take more than an hour to start, as it's waiting for sufficient data to generate anomalies.
 
 A shorter interval means the model passes the shingle process more quickly and starts to generate the anomaly results sooner.
 Use the [profile detector]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/api#profile-detector) operation to make sure you have sufficient data points.
@@ -108,12 +123,12 @@ If you see the detector pending in "initialization" for longer than a day, aggre
 
 ![Anomaly detection results]({{site.url}}{{site.baseurl}}/images/ad.png)
 
-Analize anomalies with the following visualizations:
+Analyze anomalies with the following visualizations:
 
 - **Live anomalies** - displays live anomaly results for the last 60 intervals. For example, if the interval is 10, it shows results for the last 600 minutes. The chart refreshes every 30 seconds.
-- **Anomaly history** - plots the anomaly grade with the corresponding measure of confidence.
-- **Feature breakdown** - plots the features based on the aggregation method. You can vary the date-time range of the detector.
+- **Anomaly history** (for historical analysis) / **Anomaly overview** (for real-time results) - plots the anomaly grade with the corresponding measure of confidence.
 - **Anomaly occurrence** - shows the `Start time`, `End time`, `Data confidence`, and `Anomaly grade` for each detected anomaly.
+- **Feature breakdown** - plots the features based on the aggregation method. You can vary the date-time range of the detector.
 
 `Anomaly grade` is a number between 0 and 1 that indicates how anomalous a data point is. An anomaly grade of 0 represents “not an anomaly,” and a non-zero value represents the relative severity of the anomaly.
 
@@ -121,47 +136,26 @@ Analize anomalies with the following visualizations:
 
 If you set the category field, you see an additional **Heat map** chart. The heat map correlates results for anomalous entities. This chart is empty until you select an anomalous entity. You also see the anomaly and feature line chart for the time period of the anomaly (`anomaly_grade` > 0).
 
-Choose a filled rectangle to see a more detailed view of the anomaly.
+Choose and drag over the anomaly line chart to zoom in and see a more detailed view of an anomaly.
 {: .note }
 
-### Step 4: Set up alerts
+## Step 6: Set up alerts
 
-Choose **Set up alerts** and configure a monitor to notify you when anomalies are detected. For steps to create a monitor and set up notifications based on your anomaly detector, see [Monitors]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/monitors/).
+Under **Real-time results**, choose **Set up alerts** and configure a monitor to notify you when anomalies are detected. For steps to create a monitor and set up notifications based on your anomaly detector, see [Monitors]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/monitors/).
 
 If you stop or delete a detector, make sure to delete any monitors associated with it.
 
-### Step 5: Adjust the model
+## Step 7: Adjust the model
 
 To see all the configuration settings for a detector, choose the **Detector configuration** tab.
 
 1. To make any changes to the detector configuration, or fine tune the time interval to minimize any false positives, go to the **Detector configuration** section and choose **Edit**.
-- You need to stop the detector to change its configuration. Confirm that you want to stop the detector and proceed.
+- You need to stop real-time and historical analysis to change its configuration. Confirm that you want to stop the detector and proceed.
 1. To enable or disable features, in the **Features** section, choose **Edit** and adjust the feature settings as needed. After you make your changes, choose **Save and start detector**.
-- Choose between automatically starting the detector (recommended) or manually starting the detector at a later time.
 
-### Step 6: Analyze historical data
+## Step 8: Manage your detectors
 
-Analyzing historical data helps you get familiar with the anomaly detection plugin. You can also evaluate the performance of a detector with historical data to further fine-tune it.
+To start, stop, or delete a detector, go to the **Detectors** page.
 
-To use a historical detector, you need to specify a date range that has data present in at least 1,000 detection intervals.
-{: .note }
-
-1. Choose **Historical detectors** and **Create historical detector**.
-1. Enter the **Name** of the detector and a brief **Description**.
-1. For **Data source**, choose the index to use as the data source. You can optionally use index patterns to choose multiple indices.
-1. For **Time range**, select a time range for historical analysis.
-1. For **Detector settings**, choose to use the settings of an existing detector. Or choose the **Timestamp field** in your index, add individual features to the detector, and set the detector interval.
-1. (Optional) Choose to run the historical detector automatically after creating it.
-1. Choose **Create**.
-   - You can stop the historical detector even before it completes.
-
-### Step 7: Manage your detectors
-
-To change or delete a detector, go to the **Detector details** page.
-
-1. To make changes to your detector, choose the detector name.
-1. Choose **Actions** and **Edit detector**.
-   - You need to stop the detector to change its configuration. Confirm that you want to stop the detector and proceed.
-1. Make your changes and choose **Save changes**.
-
-To delete your detector, choose **Actions** and **Delete detector**. In the pop-up box, type `delete` to confirm and choose **Delete**.
+1. Choose the detector name.
+2. Choose **Actions** and select **Start real-time detectors**, **Stop real-time detectors**, or **Delete detectors**.

_monitoring-plugins/ad/settings.md

@@ -24,19 +24,24 @@ PUT _cluster/settings
 
 Setting | Default | Description
 :--- | :--- | :---
-`plugins.anomaly_detection.enabled` | True | Whether the anomaly detection plugin is enabled or not. If disabled, all detectors immediately stop running.
-`plugins.anomaly_detection.max_anomaly_detectors` | 1,000 | The maximum number of non-high cardinality detectors (no category field) users can create.
-`plugins.anomaly_detection.max_multi_entity_anomaly_detectors` | 10 | The maximum number of high cardinality detectors (with category field) in a cluster.
-`plugins.anomaly_detection.max_anomaly_features` | 5 | The maximum number of features for a detector.
-`plugins.anomaly_detection.ad_result_history_rollover_period` | 12h | How often the rollover condition is checked. If `true`, the plugin rolls over the result index to a new index.
-`plugins.anomaly_detection.ad_result_history_max_docs` | 250000000 | The maximum number of documents in one result index. The plugin only counts refreshed documents in the primary shards.
-`plugins.anomaly_detection.ad_result_history_retention_period` | 30d | The maximum age of the result index.  If its age exceeds the threshold, the plugin deletes the rolled over result index. If the cluster has only one result index, the plugin keeps the index even if it's older than its configured retention period.
-`plugins.anomaly_detection.max_entities_per_query` | 1,000 | The maximum unique values per detection interval for high cardinality detectors. By default, if the category field has more than 1,000 unique values in a detector interval, the plugin selects the top 1,000 values and orders them by `doc_count`.
-`plugins.anomaly_detection.max_entities_for_preview` | 30 | The maximum unique category field values displayed with the preview operation for high cardinality detectors. If the category field has more than 30 unique values, the plugin selects the top 30 values and orders them by `doc_count`.
-`plugins.anomaly_detection.max_primary_shards` | 10 | The maximum number of primary shards an anomaly detection index can have.
-`plugins.anomaly_detection.filter_by_backend_roles` | False | When you enable the security plugin and set this to `true`, the plugin filters results based on the user's backend role(s).
-`plugins.anomaly_detection.max_cache_miss_handling_per_second` | 100 | High cardinality detectors use a cache to store active models. In the event of a cache miss, the cache gets the models from the model checkpoint index. Use this setting to limit the rate of fetching models. Because the thread pool for a GET operation has a queue of 1,000, we recommend setting this value below 1,000.
-`plugins.anomaly_detection.max_batch_task_per_node` | 2 | Starting a historical detector triggers a batch task. This setting is the number of batch tasks that you can run per data node. You can tune this setting from 1 to 1000. If the data nodes can't support all batch tasks and you're not sure if the data nodes are capable of running more historical detectors, add more data nodes instead of changing this setting to a higher value.
-`plugins.anomaly_detection.max_old_ad_task_docs_per_detector` | 10 | You can run the same historical detector many times. For each run, the anomaly detection plugin creates a new task. This setting is the number of previous tasks the plugin keeps. Set this value to at least 1 to track its last run. You can keep a maximum of 1,000 old tasks to avoid overwhelming the cluster.
-`plugins.anomaly_detection.batch_task_piece_size` | 1000 | The date range for a historical task is split into smaller pieces and the anomaly detection plugin runs the task piece by piece. Each piece contains 1,000 detection intervals by default. For example, if detector interval is 1 minute and one piece is 1000 minutes, the feature data is queried every 1,000 minutes. You can change this setting from 1 to 10,000.
-`plugins.anomaly_detection.batch_task_piece_interval_seconds` | 5 | Add a time interval between historical detector tasks. This interval prevents the task from consuming too much of the available resources and starving other operations like search and bulk index. You can change this setting from 1 to 600 seconds.
+plugins.anomaly_detection.enabled | True | Whether the anomaly detection plugin is enabled or not. If disabled, all detectors immediately stop running.
+plugins.anomaly_detection.max_anomaly_detectors | 1,000 | The maximum number of non-high cardinality detectors (no category field) users can create.
+plugins.anomaly_detection.max_multi_entity_anomaly_detectors | 10 | The maximum number of high cardinality detectors (with category field) in a cluster.
+plugins.anomaly_detection.max_anomaly_features | 5 | The maximum number of features for a detector.
+plugins.anomaly_detection.ad_result_history_rollover_period | 12h | How often the rollover condition is checked. If `true`, the anomaly detection plugin rolls over the result index to a new index.
+plugins.anomaly_detection.ad_result_history_max_docs_per_shard | 1,350,000,000 | The maximum number of documents in a single shard of the result index. The anomaly detection plugin only counts the refreshed documents in the primary shards.
+plugins.anomaly_detection.max_entities_per_query | 1,000,000 | The maximum unique values per detection interval for high cardinality detectors. By default, if the category field(s) have more than the configured unique values in a detector interval, the anomaly detection plugin orders them by the natural ordering of categorical values (for example, entity `ab` comes before `bc`) and then selects the top values.
+plugins.anomaly_detection.max_entities_for_preview | 5 | The maximum unique category field values displayed with the preview operation for high cardinality detectors. By default, if the category field(s) have more than the configured unique values in a detector interval, the anomaly detection plugin orders them by the natural ordering of categorical values (for example, entity `ab` comes before `bc`) and then selects the top values.
+plugins.anomaly_detection.max_primary_shards | 10 | The maximum number of primary shards an anomaly detection index can have.
+plugins.anomaly_detection.filter_by_backend_roles | False | When you enable the security plugin and set this to `true`, the anomaly detection plugin filters results based on the user's backend role(s).
+plugins.anomaly_detection.max_batch_task_per_node | 10 | Starting a historical analysis triggers a batch task. This setting is the number of batch tasks that you can run per data node. You can tune this setting from 1 to 1,000. If the data nodes can’t support all batch tasks and you’re not sure if the data nodes are capable of running more historical analysis, add more data nodes instead of changing this setting to a higher value. Increasing this value might bring more load on each data node.
+plugins.anomaly_detection.max_old_ad_task_docs_per_detector | 1 | You can run historical analysis for the same detector many times. For each run, the anomaly detection plugin creates a new task. This setting is the number of previous tasks the plugin keeps. Set this value to at least 1 to track its last run. You can keep a maximum of 1,000 old tasks to avoid overwhelming the cluster.
+plugins.anomaly_detection.batch_task_piece_size | 1,000 | The date range for a historical task is split into smaller pieces and the anomaly detection plugin runs the task piece by piece. Each piece contains 1,000 detection intervals by default. For example, if detector interval is 1 minute and one piece is 1,000 minutes, the feature data is queried every 1,000 minutes. You can change this setting from 1 to 10,000.
+plugins.anomaly_detection.batch_task_piece_interval_seconds | 5 | Add a time interval between two pieces of the same historical analysis task. This interval prevents the task from consuming too much of the available resources and starving other operations like search and bulk index. You can change this setting from 1 to 600 seconds.
+plugins.anomaly_detection.max_top_entities_for_historical_analysis | 1,000 | The maximum number of top entities that you run for a high cardinality detector historical analysis. The range is from 1 to 10,000.
+plugins.anomaly_detection.max_running_entities_per_detector_for_historical_analysis | 10 | The number of entity tasks that you can run in parallel for a high cardinality detector analysis. The task slots available on your cluster also impact how many entities run in parallel. If a cluster has 3 data nodes, each data node has 10 task slots by default. Say you already have two high cardinality detectors and each of them run 10 entities. If you start a single-entity detector that takes 1 task slot, the number of task slots available is 10 * 3 - 10 * 2 - 1 = 9. If you now start a new high cardinality detector, the detector can only run 9 entities in parallel and not 10. You can tune this value from 1 to 1,000 based on your cluster's capability. If you set a higher value, the anomaly detection plugin runs historical analysis faster but also consumes more resources.
+plugins.anomaly_detection.max_cached_deleted_tasks | 1,000 | You can rerun historical analysis for a single detector as many times as you like. The anomaly detection plugin only keeps a limited number of old tasks, by default 1 old task. If you run historical analysis three times for a detector, the oldest task is deleted. Because historical analysis generates a number of anomaly results in a short span of time, it's necessary to clean up anomaly results for a deleted task. With this field, you can configure how many deleted tasks you can cache at most. The plugin cleans up a task's results when it's deleted. If the plugin fails to do this cleanup, it adds the task's results into a cache and an hourly cron job performs the cleanup. You can use this setting to limit how many old tasks are put into cache to avoid a DDoS attack. After an hour, if still you find an old task result in the cache, use the [delete detector results API]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/api/#delete-detector-results) to delete the task result manually. You can tune this setting from 1 to 10,000.
+plugins.anomaly_detection.delete_anomaly_result_when_delete_detector | False | Whether the anomaly detection plugin deletes the anomaly result when you delete a detector. If you want to save some disk space, especially if you've high cardinality detectors generating a lot of results, set this field to true. Alternatively, you can use the [delete detector results API]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/api/#delete-detector-results) to manually delete the results.
+plugins.anomaly_detection.dedicated_cache_size | 10 | If the real-time analysis of a high cardinality detector starts successfully, the anomaly detection plugin guarantees keeping 10 (dynamically adjustable via this setting) entities' models in memory per node. If the number of entities exceeds this limit, the plugin puts the extra entities' models in a memory space shared by all detectors. The actual number of entities varies based on the memory that you've available and the frequencies of the entities. If you'd like the plugin to guarantee keeping more entities' models in memory and if you're cluster has sufficient memory, you can increase this setting value.
+plugins.anomaly_detection.max_concurrent_preview | 2 | The maximum number of concurrent previews. You can use this setting to limit resource usage.
+plugins.anomaly_detection.model_max_size_percent | 0.1 | The upper bound of the memory percentage for a model.

_monitoring-plugins/alerting/api.md

@@ -19,7 +19,11 @@ Use the alerting API to programmatically manage monitors and alerts.
 
 ---
 
-## Create monitor
+## Create query-level monitor
+Introduced 1.0
+{: .label .label-purple }
+
+Query-level monitors run the query and check whether the results should trigger any alerts. As such, query-level monitors can only trigger one alert at a time. For more information about query-level monitors versus bucket-level monitors, see [Create monitors]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/monitors/#create-monitors).
 
 #### Request
 
@@ -28,6 +32,7 @@ POST _plugins/_alerting/monitors
 {
   "type": "monitor",
   "name": "test-monitor",
+  "monitor_type": "query_level_monitor",
   "enabled": true,
   "schedule": {
     "period": {
@@ -164,7 +169,7 @@ If you use a custom webhook for your destination and need to embed JSON in the m
         },
         "throttle_enabled": false,
         "subject_template": {
-          "source": "TheSubject",
+          "source": "Subject",
           "lang": "mustache"
         }
       }]
@@ -184,6 +189,7 @@ The following example creates a monitor that runs at 12:10 PM Pacific Time on th
 {
   "type": "monitor",
   "name": "test-monitor",
+  "monitor_type": "query_level_monitor",
   "enabled": true,
   "schedule": {
     "cron" : {
@@ -226,7 +232,7 @@ The following example creates a monitor that runs at 12:10 PM Pacific Time on th
       "name": "test-action",
       "destination_id": "ld7912sBlQ5JUWWFThoW",
       "message_template": {
-        "source": "This is my message body."
+        "source": "This is a message body."
       },
       "throttle_enabled": true,
       "throttle": {
@@ -234,7 +240,7 @@ The following example creates a monitor that runs at 12:10 PM Pacific Time on th
         "unit": "MINUTES"
       },
       "subject_template": {
-        "source": "TheSubject"
+        "source": "Subject"
       }
     }]
   }]
@@ -245,7 +251,268 @@ For a full list of timezone names, refer to [Wikipedia](https://en.wikipedia.org
 
 ---
 
+## Create bucket-level monitor
+
+Bucket-level monitors categorize results into buckets separated by fields. The monitor then runs your script with each bucket's results and evaluates whether to trigger an alert. For more information about bucket-level monitors versus query-level monitors, see [Create monitors]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/monitors/#create-monitors).
+
+```json
+POST _plugins/_alerting/monitors
+{
+  "type": "monitor",
+  "name": "test-bucket-level-monitor",
+  "monitor_type": "bucket_level_monitor",
+  "enabled": true,
+  "schedule": {
+    "period": {
+      "interval": 1,
+      "unit": "MINUTES"
+    }
+  },
+  "inputs": [
+    {
+      "search": {
+        "indices": [
+          "movies"
+        ],
+        "query": {
+          "size": 0,
+          "query": {
+            "bool": {
+              "filter": [
+                {
+                  "range": {
+                    "order_date": {
+                      "from": "{{period_end}}||-1h",
+                      "to": "{{period_end}}",
+                      "include_lower": true,
+                      "include_upper": true,
+                      "format": "epoch_millis"
+                    }
+                  }
+                }
+              ]
+            }
+          },
+          "aggregations": {
+            "composite_agg": {
+              "composite": {
+                "sources": [
+                  {
+                    "user": {
+                      "terms": {
+                        "field": "user"
+                      }
+                    }
+                  }
+                ]
+              },
+              "aggregations": {
+                "avg_products_base_price": {
+                  "avg": {
+                    "field": "products.base_price"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  ],
+  "triggers": [
+    {
+      "bucket_level_trigger": {
+        "name": "test-trigger",
+        "severity": "1",
+        "condition": {
+          "buckets_path": {
+            "_count": "_count",
+            "avg_products_base_price": "avg_products_base_price"
+          },
+          "parent_bucket_path": "composite_agg",
+          "script": {
+            "source": "params._count > 50 || params.avg_products_base_price < 35",
+            "lang": "painless"
+          }
+        },
+        "actions": [
+          {
+            "name": "test-action",
+            "destination_id": "E4o5hnsB6KjPKmHtpfCA",
+            "message_template": {
+              "source": """Monitor {{ctx.monitor.name}} just entered alert status. Please investigate the issue.   - Trigger: {{ctx.trigger.name}}   - Severity: {{ctx.trigger.severity}}   - Period start: {{ctx.periodStart}}   - Period end: {{ctx.periodEnd}}    - Deduped Alerts:   {{ctx.dedupedAlerts}}     * {{id}} : {{bucket_keys}}   {{ctx.dedupedAlerts}}    - New Alerts:   {{ctx.newAlerts}}     * {{id}} : {{bucket_keys}}   {{ctx.newAlerts}}    - Completed Alerts:   {{ctx.completedAlerts}}     * {{id}} : {{bucket_keys}}   {{ctx.completedAlerts}}""",
+              "lang": "mustache"
+            },
+            "throttle_enabled": false,
+            "throttle": {
+              "value": 10,
+              "unit": "MINUTES"
+            },
+            "action_execution_policy": {
+              "action_execution_scope": {
+                "per_alert": {
+                  "actionable_alerts": [
+                    "DEDUPED",
+                    "NEW"
+                  ]
+                }
+              }
+            },
+            "subject_template": {
+              "source": "The Subject",
+              "lang": "mustache"
+            }
+          }
+        ]
+      }
+    }
+  ]
+}
+```
+
+#### Sample response
+```json
+{
+  "_id" : "Dfxr63sBwex6DxEhHV5N",
+  "_version" : 1,
+  "_seq_no" : 3,
+  "_primary_term" : 1,
+  "monitor" : {
+    "type" : "monitor",
+    "schema_version" : 4,
+    "name" : "test-bucket-level-monitor",
+    "monitor_type" : "bucket_level_monitor",
+    "user" : {
+      "name" : "",
+      "backend_roles" : [ ],
+      "roles" : [ ],
+      "custom_attribute_names" : [ ],
+      "user_requested_tenant" : null
+    },
+    "enabled" : true,
+    "enabled_time" : 1631742270785,
+    "schedule" : {
+      "period" : {
+        "interval" : 1,
+        "unit" : "MINUTES"
+      }
+    },
+    "inputs" : [
+      {
+        "search" : {
+          "indices" : [
+            "opensearch_dashboards_sample_data_flights"
+          ],
+          "query" : {
+            "size" : 0,
+            "query" : {
+              "bool" : {
+                "filter" : [
+                  {
+                    "range" : {
+                      "order_date" : {
+                        "from" : "{{period_end}}||-1h",
+                        "to" : "{{period_end}}",
+                        "include_lower" : true,
+                        "include_upper" : true,
+                        "format" : "epoch_millis",
+                        "boost" : 1.0
+                      }
+                    }
+                  }
+                ],
+                "adjust_pure_negative" : true,
+                "boost" : 1.0
+              }
+            },
+            "aggregations" : {
+              "composite_agg" : {
+                "composite" : {
+                  "size" : 10,
+                  "sources" : [
+                    {
+                      "user" : {
+                        "terms" : {
+                          "field" : "user",
+                          "missing_bucket" : false,
+                          "order" : "asc"
+                        }
+                      }
+                    }
+                  ]
+                },
+                "aggregations" : {
+                  "avg_products_base_price" : {
+                    "avg" : {
+                      "field" : "products.base_price"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    ],
+    "triggers" : [
+      {
+        "bucket_level_trigger" : {
+          "id" : "C_xr63sBwex6DxEhHV5B",
+          "name" : "test-trigger",
+          "severity" : "1",
+          "condition" : {
+            "buckets_path" : {
+              "_count" : "_count",
+              "avg_products_base_price" : "avg_products_base_price"
+            },
+            "parent_bucket_path" : "composite_agg",
+            "script" : {
+              "source" : "params._count > 50 || params.avg_products_base_price < 35",
+              "lang" : "painless"
+            },
+            "gap_policy" : "skip"
+          },
+          "actions" : [
+            {
+              "id" : "DPxr63sBwex6DxEhHV5B",
+              "name" : "test-action",
+              "destination_id" : "E4o5hnsB6KjPKmHtpfCA",
+              "message_template" : {
+                "source" : "Monitor {{ctx.monitor.name}} just entered alert status. Please investigate the issue.   - Trigger: {{ctx.trigger.name}}   - Severity: {{ctx.trigger.severity}}   - Period start: {{ctx.periodStart}}   - Period end: {{ctx.periodEnd}}    - Deduped Alerts:   {{ctx.dedupedAlerts}}     * {{id}} : {{bucket_keys}}   {{ctx.dedupedAlerts}}    - New Alerts:   {{ctx.newAlerts}}     * {{id}} : {{bucket_keys}}   {{ctx.newAlerts}}    - Completed Alerts:   {{ctx.completedAlerts}}     * {{id}} : {{bucket_keys}}   {{ctx.completedAlerts}}",
+                "lang" : "mustache"
+              },
+              "throttle_enabled" : false,
+              "subject_template" : {
+                "source" : "The Subject",
+                "lang" : "mustache"
+              },
+              "throttle" : {
+                "value" : 10,
+                "unit" : "MINUTES"
+              },
+              "action_execution_policy" : {
+                "action_execution_scope" : {
+                  "per_alert" : {
+                    "actionable_alerts" : [
+                      "DEDUPED",
+                      "NEW"
+                    ]
+                  }
+                }
+              }
+            }
+          ]
+        }
+      }
+    ],
+    "last_update_time" : 1631742270785
+  }
+}
+```
+
 ## Update monitor
+Introduced 1.0
+{: .label .label-purple }
 
 When you update a monitor, include the current version number as a parameter. OpenSearch increments the version number automatically (see the sample response).
 
@@ -368,6 +635,8 @@ PUT _plugins/_alerting/monitors/<monitor_id>
 ---
 
 ## Get monitor
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 
@@ -438,6 +707,8 @@ GET _plugins/_alerting/monitors/<monitor_id>
 ---
 
 ## Monitor stats
+Introduced 1.0
+{: .label .label-purple }
 
 Returns statistics about the alerting feature. Use `_plugins/_alerting/stats` to find node IDs and metrics. Then you can drill down using those values.
 
@@ -627,6 +898,8 @@ GET _plugins/_alerting/<node-id>/stats/<metric>
 ---
 
 ## Delete monitor
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 
@@ -658,6 +931,8 @@ DELETE _plugins/_alerting/monitors/<monitor_id>
 ---
 
 ## Search monitors
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 
@@ -755,6 +1030,8 @@ GET _plugins/_alerting/monitors/_search
 ---
 
 ## Run monitor
+Introduced 1.0
+{: .label .label-purple }
 
 You can add the optional `?dryrun=true` parameter to the URL to show the results of a run without actions sending any message.
 
@@ -787,6 +1064,8 @@ POST _plugins/_alerting/monitors/<monitor_id>/_execute
 ---
 
 ## Get alerts
+Introduced 1.0
+{: .label .label-purple }
 
 Returns an array of all alerts.
 
@@ -855,8 +1134,10 @@ GET _plugins/_alerting/monitors/alerts
 ---
 
 ## Acknowledge alert
+Introduced 1.0
+{: .label .label-purple }
 
-[After getting your alerts](#get-alerts/), you can acknowledge any number of active alerts in one call. If the alert is already in an ERROR, COMPLETED, or ACKNOWLEDGED state, it appears in the `failed` array.
+[After getting your alerts](#get-alerts), you can acknowledge any number of active alerts in one call. If the alert is already in an ERROR, COMPLETED, or ACKNOWLEDGED state, it appears in the `failed` array.
 
 
 #### Request
@@ -882,6 +1163,8 @@ POST _plugins/_alerting/monitors/<monitor-id>/_acknowledge/alerts
 ---
 
 ## Create destination
+Introduced 1.0
+{: .label .label-purple }
 
 #### Requests
 
@@ -956,6 +1239,8 @@ POST _plugins/_alerting/destinations
 ---
 
 ## Update destination
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 
@@ -991,6 +1276,8 @@ PUT _plugins/_alerting/destinations/<destination-id>
 ---
 
 ## Get destination
+Introduced 1.0
+{: .label .label-purple }
 
 Retrieve one destination.
 
@@ -1036,6 +1323,8 @@ GET _plugins/_alerting/destinations/<destination-id>
 ---
 
 ## Get destinations
+Introduced 1.0
+{: .label .label-purple }
 
 Retrieve all destinations.
 
@@ -1081,6 +1370,8 @@ GET _plugins/_alerting/destinations
 ---
 
 ## Delete destination
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 
@@ -1110,6 +1401,8 @@ DELETE _plugins/_alerting/destinations/<destination-id>
 ---
 
 ## Create email account
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 ```json
@@ -1142,6 +1435,8 @@ POST _plugins/_alerting/destinations/email_accounts
 ```
 
 ## Update email account
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 ```json
@@ -1173,6 +1468,8 @@ PUT _plugins/_alerting/destinations/email_accounts/<email_account_id>
 ```
 
 ## Get email account
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 ```json
@@ -1204,6 +1501,8 @@ GET _plugins/_alerting/destinations/email_accounts/<email_account_id>
 ```
 
 ## Delete email account
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 ```
@@ -1230,6 +1529,8 @@ DELETE _plugins/_alerting/destinations/email_accounts/<email_account_id>
 ```
 
 ## Search email account
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 
@@ -1296,6 +1597,8 @@ POST _plugins/_alerting/destinations/email_accounts/_search
 ---
 
 ## Create email group
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 
@@ -1330,6 +1633,8 @@ POST _plugins/_alerting/destinations/email_groups
 ```
 
 ## Update email group
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 
@@ -1363,6 +1668,8 @@ PUT _plugins/_alerting/destinations/email_groups/<email_group_id>
 ```
 
 ## Get email group
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 ```json
@@ -1395,6 +1702,8 @@ GET _plugins/_alerting/destinations/email_groups/<email_group_id>
 ```
 
 ## Delete email group
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 ```
@@ -1421,6 +1730,8 @@ DELETE _plugins/_alerting/destinations/email_groups/<email_group_id>
 ```
 
 ## Search email group
+Introduced 1.0
+{: .label .label-purple }
 
 #### Request
 

_monitoring-plugins/alerting/cron.md

@@ -4,9 +4,6 @@ title: Cron
 nav_order: 20
 parent: Alerting
 has_children: false
-redirect_from:
-  - /alerting/cron/
-  - /docs/alerting/cron/
 ---
 
 # Cron expression reference

_monitoring-plugins/alerting/monitors.md

@@ -19,11 +19,11 @@ has_children: false
 
 Term | Definition
 :--- | :---
-Monitor | A job that runs on a defined schedule and queries OpenSearch. The results of these queries are then used as input for one or more *triggers*.
+Monitor | A job that runs on a defined schedule and queries OpenSearch indices. The results of these queries are then used as input for one or more *triggers*.
 Trigger | Conditions that, if met, generate *alerts*.
 Alert | An event associated with a trigger. When an alert is created, the trigger performs *actions*, which can include sending a notification.
 Action | The information that you want the monitor to send out after being triggered. Actions have a *destination*, a message subject, and a message body.
-Destination | A reusable location for an action, such as Amazon Chime, Slack, or a webhook URL.
+Destination | A reusable location for an action. Supported locations are Amazon Chime, Email, Slack, or custom webhook.
 
 
 ---
@@ -34,9 +34,9 @@ Destination | A reusable location for an action, such as Amazon Chime, Slack, or
 1. Specify a name for the destination so that you can identify it later.
 1. For **Type**, choose Slack, Amazon Chime, custom webhook, or [email](#email-as-a-destination).
 
-For Email type, refer to [Email as a destination](#email-as-a-destination) section below. For all other types, specify the webhook URL. For more information about webhooks, see the documentation for [Slack](https://api.slack.com/incoming-webhooks) and [Chime](https://docs.aws.amazon.com/chime/latest/ug/webhooks.html).
+For Email, refer to the [Email as a destination](#email-as-a-destination) section below. For all other types, specify the webhook URL. See the documentation for [Slack](https://api.slack.com/incoming-webhooks) and [Amazon Chime](https://docs.aws.amazon.com/chime/latest/ug/webhooks.html) to learn more about webhooks.
 
-For custom webhooks, you must specify more information: parameters and headers. For example, if your endpoint requires basic authentication, you might need to add a header with a key of `Authorization` and a value of `Basic <Base64-encoded-credential-string>`. You might also need to change `Content-Type` to whatever your webhook requires. Popular values are `application/json`, `application/xml`, and `text/plain`.
+If you're using custom webhooks, you must specify more information: parameters and headers. For example, if your endpoint requires basic authentication, you might need to add a header with a key of `Authorization` and a value of `Basic <Base64-encoded-credential-string>`. You might also need to change `Content-Type` to whatever your webhook requires. Popular values are `application/json`, `application/xml`, and `text/plain`.
 
 This information is stored in plain text in the OpenSearch cluster. We will improve this design in the future, but for now, the encoded credentials (which are neither encrypted nor hashed) might be visible to other OpenSearch users.
 
@@ -55,7 +55,7 @@ To configure a sender email, do the following:
 1. After you choose **Email** as the destination type, choose **Manage senders**.
 1. Choose **Add sender**, **New sender** and enter a unique name.
 1. Enter the email address, SMTP host (e.g. `smtp.gmail.com` for a Gmail account), and the port.
-1. Choose an encryption method, or use the default value of **None**. However, most email providers require SSL or TLS, which requires a username and password in OpenSearch keystore. Refer to [Authenticate sender account](#authenticate-sender-account) to learn more.
+1. Choose an encryption method, or use the default value of **None**. However, most email providers require SSL or TLS, which require a username and password in OpenSearch keystore. Refer to [Authenticate sender account](#authenticate-sender-account) to learn more.
 1. Choose **Save** to save the configuration and create the sender. You can create a sender even before you add your credentials to the OpenSearch keystore. However, you must [authenticate each sender account](#authenticate-sender-account) before you use the destination to send your alert.
 
 You can reuse senders across many different destinations, but each destination only supports one sender.
@@ -82,7 +82,7 @@ If your email provider requires SSL or TLS, you must authenticate each sender ac
 ./bin/opensearch-keystore add plugins.alerting.destination.email.<sender_name>.password
 ```
 
-**Note**: Keystore settings are node-specific. You must run these commands on each node.
+Note: Keystore settings are node-specific. You must run these commands on each node.
 {: .note}
 
 To change or update your credentials (after you've added them to the keystore on every node), call the reload API to automatically update those credentials without restarting OpenSearch:
@@ -101,20 +101,9 @@ POST _nodes/reload_secure_settings
 
 1. Choose **Alerting**, **Monitors**, **Create monitor**.
 1. Specify a name for the monitor.
+1. Choose either **Per query monitor** or **Per bucket monitor**.
 
-The anomaly detection option is for pairing with the anomaly detection plugin. See [Anomaly Detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/).
-For anomaly detector, choose an appropriate schedule for the monitor based on the detector interval. Otherwise, the alerting monitor might miss reading the results.
-
-For example, assume you set the monitor interval and the detector interval as 5 minutes, and you start the detector at 12:00. If an anomaly is detected at 12:05, it might be available at 12:06 because of the delay between writing the anomaly and it being available for queries. The monitor reads the anomaly results between 12:00 and 12:05, so it does not get the anomaly results available at 12:06.
-
-To avoid this issue, make sure the alerting monitor is at least twice the detector interval.
-When you create a monitor using OpenSearch Dashboards, the anomaly detector plugin generates a default monitor schedule that's twice the detector interval.
-
-Whenever you update a detector’s interval, make sure to update the associated monitor interval as well, as the anomaly detection plugin does not do this automatically.
-
-1. Choose one or more indices. You can also use `*` as a wildcard to specify an index pattern.
-
-   If you use the security plugin, you can only choose indices that you have permission to access. For details, see [Alerting security]({{site.url}}{{site.baseurl}}/security-plugin/).
+Whereas query-level monitors run your specified query and then check whether the query's results triggers any alerts, bucket-level monitors let you select fields to create buckets and categorize your results into those buckets. The alerting plugin runs each bucket's unique results against a script you define later, so you have finer control over which results should trigger alerts. Each of those buckets can trigger an alert, but query-level monitors can only trigger one alert at a time.
 
 1. Define the monitor in one of three ways: visually, using a query, or using an anomaly detector.
 
@@ -167,39 +156,57 @@ Whenever you update a detector’s interval, make sure to update the associated
      }
      ```
 
-     "Start" and "end" refer to the interval at which the monitor runs. See [Available variables](#available-variables).
+    "Start" and "end" refer to the interval at which the monitor runs. See [Available variables](#available-variables).
 
+    To define a monitor visually, choose **Visual editor**. Then choose a source index, a timeframe, an aggregation (for example, `count()` or `average()`), a data filter if you want to monitor a subset of your source index, and a group-by field if you want to include an aggregation field in your query. At least one group-by field is required if you're defining a bucket-level monitor. Visual definition works well for most monitors.
 
-1. To define a monitor visually, choose **Define using visual graph**. Then choose an aggregation (for example, `count()` or `average()`), a set of documents, and a timeframe. Visual definition works well for most monitors.
+    If you use the security plugin, you can only choose indices that you have permission to access. For details, see [Alerting security]({{site.url}}{{site.baseurl}}/security-plugin/).
 
-   To use a query, choose **Define using extraction query**, add your query (using [the OpenSearch query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/full-text/)), and test it using the **Run** button.
+    To use a query, choose **Extraction query editor**, add your query (using [the OpenSearch query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/full-text/)), and test it using the **Run** button.
 
-   The monitor makes this query to OpenSearch as often as the schedule dictates; check the **Query Performance** section and make sure you're comfortable with the performance implications.
+    The monitor makes this query to OpenSearch as often as the schedule dictates; check the **Query Performance** section and make sure you're comfortable with the performance implications.
+
+    To use an anomaly detector, choose **Anomaly detector** and select your **Detector**.
+
+    The anomaly detection option is for pairing with the anomaly detection plugin. See [Anomaly Detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/).
+    For anomaly detector, choose an appropriate schedule for the monitor based on the detector interval. Otherwise, the alerting monitor might miss reading the results.
+
+    For example, assume you set the monitor interval and the detector interval as 5 minutes, and you start the detector at 12:00. If an anomaly is detected at 12:05, it might be available at 12:06 because of the delay between writing the anomaly and it being available for queries. The monitor reads the anomaly results between 12:00 and 12:05, so it does not get the anomaly results available at 12:06.
+
+    To avoid this issue, make sure the alerting monitor is at least twice the detector interval.
+    When you create a monitor using OpenSearch Dashboards, the anomaly detector plugin generates a default monitor schedule that's twice the detector interval.
+
+    Whenever you update a detector’s interval, make sure to update the associated monitor interval as well, as the anomaly detection plugin does not do this automatically.
+
+    **Note**: Anomaly detection is available only if you are defining a per query monitor.
+    {: .note}
 
-   To use an anomaly detector, choose **Define using Anomaly detector** and select your **Detector**.
 1. Choose a frequency and timezone for your monitor. Note that you can only pick a timezone if you choose Daily, Weekly, Monthly, or [custom cron expression]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/cron/) for frequency.
-1. Choose **Create**.
 
+1. Add a trigger to your monitor.
 
 ---
 
 ## Create triggers
 
-The next step in creating a monitor is to create a trigger. These steps differ depending on whether you chose **Define using visual graph** or **Define using extraction query** or **Define using Anomaly detector** when you created the monitor.
+Steps to create a trigger differ depending on whether you chose **Visual editor**, **Extraction query editor**, or **Anomaly detector** when you created the monitor.
 
-Either way, you begin by specifying a name and severity level for the trigger. Severity levels help you manage alerts. A trigger with a high severity level (e.g. 1) might page a specific individual, whereas a trigger with a low severity level might message a chat room.
+You begin by specifying a name and severity level for the trigger. Severity levels help you manage alerts. A trigger with a high severity level (e.g. 1) might page a specific individual, whereas a trigger with a low severity level might message a chat room.
 
+Remember that query-level monitors run your trigger's script just once against the query's results, but bucket-level monitors execute your trigger's script on each bucket, so you should create a trigger that best fits the monitor you chose. If you want to execute multiple scripts, you must create multiple triggers.
 
-### Visual graph
+### Visual editor
 
-For **Trigger condition**, specify a threshold for the aggregation and timeframe you chose earlier, such as "is below 1,000" or "is exactly 10."
+For a query-level monitor's **Trigger condition**, specify a threshold for the aggregation and timeframe you chose earlier, such as "is below 1,000" or "is exactly 10."
 
 The line moves up and down as you increase and decrease the threshold. Once this line is crossed, the trigger evaluates to true.
 
+Bucket-level monitors also require you to specify a threshold and value for your aggregation and timeframe, but you can use a maximum of five conditions to better refine your trigger. Optionally, you can also use a keyword filter to filter for a specific field in your index.
+
 
 ### Extraction query
 
-For **Trigger condition**, specify a Painless script that returns true or false. Painless is the default OpenSearch scripting language and has a syntax similar to Groovy.
+If you're using a query-level monitor, specify a Painless script that returns true or false. Painless is the default OpenSearch scripting language and has a syntax similar to Groovy.
 
 Trigger condition scripts revolve around the `ctx.results[0]` variable, which corresponds to the extraction query response. For example, your script might reference `ctx.results[0].hits.total.value` or `ctx.results[0].hits.hits[i]._source.error_code`.
 
@@ -208,6 +215,27 @@ A return value of true means the trigger condition has been met, and the trigger
 The **Info** link next to **Trigger condition** contains a useful summary of the variables and results available to your query.
 {: .tip }
 
+Bucket-level monitors require you to specify more information in your trigger condition. At a minimum, you must have the following fields:
+
+- `buckets_path`, which maps variable names to metrics to use in your script.
+- `parent_bucket_path`, which is a path to a multi-bucket aggregation. The path can include single-bucket aggregations, but the last aggregation must be multi-bucket. For example, if you have a pipeline such as `agg1>agg2>agg3`, `agg1` and `agg2` are single-bucket aggregations, but `agg3` must be a multi-bucket aggregation.
+- `script`, which is the script that OpenSearch runs to evaluate whether to trigger any alerts.
+
+For example, you might have a script that looks like the following:
+
+```json
+{
+  "buckets_path": {
+    "count_var": "_count"
+  },
+  "parent_bucket_path": "composite_agg",
+  "script": {
+    "source": "params.count_var > 5"
+  }
+}
+```
+
+After mapping the `count_var` variable to the `_count` metric, you can use `count_var` in your script and reference `_count` data. Finally, `composite_agg` is a path to a multi-bucket aggregation.
 
 ### Anomaly detector
 
@@ -264,11 +292,11 @@ Below are some variables you can include in your message using Mustache template
 
 Variable | Data Type | Description
 :--- | :--- | :---
-`ctx.monitor` | JSON | Includes `ctx.monitor.name`, `ctx.monitor.type`, `ctx.monitor.enabled`, `ctx.monitor.enabled_time`, `ctx.monitor.schedule`, `ctx.monitor.inputs`, `triggers` and `ctx.monitor.last_update_time`.
-`ctx.monitor.user` | JSON | Includes information about the user who created the monitor. Includes `ctx.monitor.user.backend_roles` and `ctx.monitor.user.roles`, which are arrays that contain the backend roles and roles assigned to the user. See [alerting security]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/security/) for more information.
+`ctx.monitor` | Object | Includes `ctx.monitor.name`, `ctx.monitor.type`, `ctx.monitor.enabled`, `ctx.monitor.enabled_time`, `ctx.monitor.schedule`, `ctx.monitor.inputs`, `triggers` and `ctx.monitor.last_update_time`.
+`ctx.monitor.user` | Object | Includes information about the user who created the monitor. Includes `ctx.monitor.user.backend_roles` and `ctx.monitor.user.roles`, which are arrays that contain the backend roles and roles assigned to the user. See [alerting security]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/security/) for more information.
 `ctx.monitor.enabled` | Boolean | Whether the monitor is enabled.
 `ctx.monitor.enabled_time` | Milliseconds | Unix epoch time of when the monitor was last enabled.
-`ctx.monitor.schedule` | JSON | Contains a schedule of how often or when the monitor should run.
+`ctx.monitor.schedule` | Object | Contains a schedule of how often or when the monitor should run.
 `ctx.monitor.schedule.period.interval` | Integer | The interval at which the monitor runs.
 `ctx.monitor.schedule.period.unit` | String | The interval's unit of time.
 `ctx.monitor.inputs` | Array | An array that contains the indices and definition used to create the monitor.
@@ -282,7 +310,7 @@ Variable | Data Type | Description
 `ctx.trigger.id` | String | The trigger's ID.
 `ctx.trigger.name` | String | The trigger's name.
 `ctx.trigger.severity` | String | The trigger's severity.
-`ctx.trigger.condition`| JSON | Contains the Painless script used when creating the monitor.
+`ctx.trigger.condition`| Object | Contains the Painless script used when creating the monitor.
 `ctx.trigger.condition.script.source` | String | The language used to define the script. Must be painless.
 `ctx.trigger.condition.script.lang` | String | The script used to define the trigger.
 `ctx.trigger.actions`| Array | An array with one element that contains information about the action the monitor needs to trigger.
@@ -296,7 +324,7 @@ Variable | Data Type | Description
 `ctx.trigger.actions.destination_id`| String | The alert destination's ID.
 `ctx.trigger.actions.message_template.source` | String | The message to send in the alert.
 `ctx.trigger.actions.message_template.lang` | String | The scripting language used to define the message. Must be Mustache.
-`ctx.trigger.actions.throttle_enabled` | Boolean | Whether throttling is enabled for this trigger. See [adding actions](#add-actions/) for more information about throttling.
+`ctx.trigger.actions.throttle_enabled` | Boolean | Whether throttling is enabled for this trigger. See [adding actions](#add-actions) for more information about throttling.
 `ctx.trigger.actions.subject_template.source` | String | The message's subject in the alert.
 `ctx.trigger.actions.subject_template.lang` | String | The scripting language used to define the subject. Must be mustache.
 
@@ -309,7 +337,13 @@ Variable | Data Type | Description
 `ctx.periodStart` | String | Unix timestamp for the beginning of the period during which the alert triggered. For example, if a monitor runs every ten minutes, a period might begin at 10:40 and end at 10:50.
 `ctx.periodEnd` | String | The end of the period during which the alert triggered.
 `ctx.error` | String | The error message if the trigger was unable to retrieve results or unable to evaluate the trigger, typically due to a compile error or null pointer exception. Null otherwise.
-`ctx.alert` | JSON | The current, active alert (if it exists). Includes `ctx.alert.id`, `ctx.alert.version`, and `ctx.alert.isAcknowledged`. Null if no alert is active.
+`ctx.alert` | Object | The current, active alert (if it exists). Includes `ctx.alert.id`, `ctx.alert.version`, and `ctx.alert.isAcknowledged`. Null if no alert is active. Only available with query-level monitors.
+`ctx.dedupedAlerts` | Object | Alerts that have already been triggered. OpenSearch keeps the existing alert to prevent the plugin from creating endless amounts of the same alerts. Only available with bucket-level monitors.
+`ctx.newAlerts` | Object | Newly created alerts. Only available with bucket-level monitors.
+`ctx.completedAlerts` | Object | Alerts that are no longer ongoing. Only available with bucket-level monitors.
+`bucket_keys` | String | Comma-separated list of the monitor's bucket key values. Available only for `ctx.dedupedAlerts`, `ctx.newAlerts`, and `ctx.completedAlerts`. Accessed through `ctx.dedupedAlerts[0].bucket_keys`.
+`parent_bucket_path` | String | The parent bucket path of the bucket that triggered the alert. Accessed through `ctx.dedupedAlerts[0].parent_bucket_path`.
+
 
 
 ---
@@ -334,6 +368,7 @@ If you don't want to receive notifications for alerts, you don't have to add act
    ```
 
    In this case, the message content must conform to the `Content-Type` header in the [custom webhook](#create-destinations).
+1. If you're using a bucket-level monitor, you can choose whether the monitor should perform an action for each execution or for each alert.
 
 1. (Optional) Use action throttling to limit the number of notifications you receive within a given span of time.
 

_monitoring-plugins/pa/api.md

@@ -6,6 +6,8 @@ nav_order: 1
 ---
 
 # Performance Analyzer API
+Introduced 1.0
+{: .label .label-purple }
 
 Performance Analyzer uses a single HTTP method and URI for most requests:
 

_monitoring-plugins/pa/dashboards.md

@@ -1,6 +1,6 @@
 ---
 layout: default
-title: Create Dashboards
+title: Create PerfTop Dashboards
 parent: Performance Analyzer
 nav_order: 2
 ---

_monitoring-plugins/pa/index.md

@@ -48,11 +48,11 @@ Otherwise, just specify the OpenSearch endpoint:
 ./opensearch-perf-top-macos --dashboard dashboards/<dashboard>.json --endpoint my-cluster.my-domain.com
 ```
 
-PerfTop has four pre-built dashboards in the `dashboards` directory, but you can also [create your own]({{site.url}}{{site.baseurl}}/dashboards/).
+PerfTop has four pre-built dashboards in the `dashboards` directory, but you can also [create your own]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/dashboards/).
 
 You can also load the pre-built dashboards (ClusterOverview, ClusterNetworkMemoryAnalysis, ClusterThreadAnalysis, or NodeAnalysis) without the JSON files, such as `--dashboard ClusterThreadAnalysis`.
 
-PerfTop has no interactivity. Start the application, monitor the dashboard, and press esc, q, or Ctrl + C to quit.
+PerfTop has no interactivity. Start the application, monitor the dashboard, and press Esc, Q, or Ctrl + C to quit.
 {: .note }
 
 

_monitoring-plugins/trace/data-prepper-reference.md

@@ -40,9 +40,19 @@ Source for the OpenTelemetry Collector.
 
 Option | Required | Description
 :--- | :--- | :---
-ssl | No | Boolean, whether to connect to the OpenTelemetry Collector over SSL.
-sslKeyCertChainFile | No | String, path to the security certificate (e.g. `"config/demo-data-prepper.crt"`.
-sslKeyFile | No | String, path to the security certificate key (e.g. `"config/demo-data-prepper.key"`).
+port | No | Integer, the port OTel trace source is running on. Default is `21890`.
+request_timeout | No | Integer, the request timeout in millis. Default is `10_000`.
+health_check_service | No | Boolean, enables a gRPC health check service under `grpc.health.v1/Health/Check`. Default is `false`.
+proto_reflection_service | No | Boolean, enables a reflection service for Protobuf services (see [gRPC reflection](https://github.com/grpc/grpc/blob/master/doc/server-reflection.md) and [gRPC Server Reflection Tutorial](https://github.com/grpc/grpc-java/blob/master/documentation/server-reflection-tutorial.md) docs). Default is `false`.
+unframed_requests | No | Boolean, enable requests not framed using the gRPC wire protocol.
+thread_count | No | Integer, the number of threads to keep in the ScheduledThreadPool. Default is `200`.
+max_connection_count | No | Integer, the maximum allowed number of open connections. Default is `500`.
+ssl | No | Boolean, enables connections to the OTel source port over TLS/SSL. Defaults to `true`.
+sslKeyCertChainFile | Conditionally | String, file-system path or AWS S3 path to the security certificate (e.g. `"config/demo-data-prepper.crt"` or `"s3://my-secrets-bucket/demo-data-prepper.crt"`). Required if ssl is set to `true`.
+sslKeyFile | Conditionally | String, file-system path or AWS S3 path to the security key (e.g. `"config/demo-data-prepper.key"` or `"s3://my-secrets-bucket/demo-data-prepper.key"`). Required if ssl is set to `true`.
+useAcmCertForSSL | No | Boolean, enables TLS/SSL using certificate and private key from AWS Certificate Manager (ACM). Default is `false`.
+acmCertificateArn | Conditionally | String, represents the ACM certificate ARN. ACM certificate take preference over S3 or local file system certificate. Required if `useAcmCertForSSL` is set to `true`.
+awsRegion | Conditionally | String, represents the AWS region to use ACM or S3. Required if `useAcmCertForSSL` is set to `true` or `sslKeyCertChainFile` and `sslKeyFile` are AWS S3 paths.
 
 
 ### file
@@ -114,11 +124,17 @@ Option | Required | Description
 :--- | :--- | :---
 time_out | No | Integer, forwarded request timeout in seconds. Defaults to 3 seconds.
 span_agg_count | No | Integer, batch size for number of spans per request. Defaults to 48.
-discovery_mode | No | String, peer discovery mode to be used. Allowable values are `static` and `dns`. Defaults to `static`.
+target_port | No | Integer, the destination port to forward requests to. Defaults to `21890`.
+discovery_mode | No | String, peer discovery mode to be used. Allowable values are `static`, `dns`, and `aws_cloud_map`. Defaults to `static`.
 static_endpoints | No | List, containing string endpoints of all Data Prepper instances.
 domain_name | No | String, single domain name to query DNS against. Typically used by creating multiple DNS A Records for the same domain.
 ssl | No | Boolean, indicating whether TLS should be used. Default is true.
-sslKeyCertChainFile | No | String, path to the security certificate
+awsCloudMapNamespaceName | Conditionally | String, name of your CloudMap Namespace. Required if `discovery_mode` is set to `aws_cloud_map`.
+awsCloudMapServiceName | Conditionally | String, service name within your CloudMap Namespace. Required if `discovery_mode` is set to `aws_cloud_map`.
+sslKeyCertChainFile | Conditionally | String, represents the SSL certificate chain file path or AWS S3 path. S3 path example `s3://<bucketName>/<path>`. Required if `ssl` is set to `true`.
+useAcmCertForSSL | No | Boolean, enables TLS/SSL using certificate and private key from AWS Certificate Manager (ACM). Default is `false`.
+awsRegion | Conditionally | String, represents the AWS region to use ACM, S3, or CloudMap. Required if `useAcmCertForSSL` is set to `true` or `sslKeyCertChainFile` and `sslKeyFile` are AWS S3 paths.
+acmCertificateArn | Conditionally | String represents the ACM certificate ARN. ACM certificate take preference over S3 or local file system certificate. Required if `useAcmCertForSSL` is set to `true`.
 
 ### string_converter
 
@@ -144,8 +160,9 @@ hosts | Yes | List of OpenSearch hosts to write to (e.g. `["https://localhost:92
 cert | No | String, path to the security certificate (e.g. `"config/root-ca.pem"`) if the cluster uses the OpenSearch security plugin.
 username | No | String, username for HTTP basic authentication.
 password | No | String, password for HTTP basic authentication.
-aws_sigv4 | No | Boolean, whether to use IAM signing to connect to an Amazon ES cluster. For your access key, secret key, and optional session token, Data Prepper uses the default credential chain (environment variables, Java system properties, `~/.aws/credential`, etc.).
-aws_region | No | String, AWS region for the cluster (e.g. `"us-east-1"`) if you are connecting to Amazon ES.
+aws_sigv4 | No | Boolean, whether to use IAM signing to connect to an Amazon OpenSearch Service domain. For your access key, secret key, and optional session token, Data Prepper uses the default credential chain (environment variables, Java system properties, `~/.aws/credential`, etc.).
+aws_region | No | String, AWS region (e.g. `"us-east-1"`) for the domain if you are connecting to Amazon OpenSearch Service.
+aws_sts_role | No | String, IAM role which the sink plugin will assume to sign request to Amazon OpenSearch Service. If not provided the plugin will use the default credentials.
 trace_analytics_raw | No | Boolean, default false. Whether to export as trace data to the `otel-v1-apm-span-*` index pattern (alias `otel-v1-apm-span`) for use with the Trace Analytics OpenSearch Dashboards plugin.
 trace_analytics_service_map | No | Boolean, default false. Whether to export as trace data to the `otel-v1-apm-service-map` index for use with the service map component of the Trace Analytics OpenSearch Dashboards plugin.
 index | No | String, name of the index to export to. Only required if you don't use the `trace_analytics_raw` or `trace_analytics_service_map` presets.

_opensearch/aggregations.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Aggregations
-nav_order: 13
+nav_order: 14
 has_children: true
 ---
 

_opensearch/bucket-agg.md

@@ -660,7 +660,7 @@ GET opensearch_dashboards_sample_data_logs/_search
 ```
 
 The `ip_range` aggregation is for IP addresses.
-It works on `ip` type fields. You can define the IP ranges and masks in the [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation.
+It works on `ip` type fields. You can define the IP ranges and masks in the [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation.
 
 ```json
 GET opensearch_dashboards_sample_data_logs/_search
@@ -1026,7 +1026,7 @@ GET opensearch_dashboards_sample_data_logs/_search
 
 The `geohash_grid` aggregation buckets documents for geographical analysis. It organizes a geographical region into a grid of smaller regions of different sizes or precisions. Lower values of precision represent larger geographical areas and higher values represent smaller, more precise geographical areas.
 
-The number of results returned by a query might be far too many to display each geo point individually on a map. The `geohash_grid` aggregation buckets nearby geo points together by calculating the Geohash for each point, at the level of precision that you define (between 1 to 12; the default is 5). To learn more about Geohash, see [Wikipedia](http://en.wikipedia.org/wiki/Geohash).
+The number of results returned by a query might be far too many to display each geo point individually on a map. The `geohash_grid` aggregation buckets nearby geo points together by calculating the Geohash for each point, at the level of precision that you define (between 1 to 12; the default is 5). To learn more about Geohash, see [Wikipedia](https://en.wikipedia.org/wiki/Geohash).
 
 The web logs example data is spread over a large geographical area, so you can use a lower precision value. You can zoom in on this map by increasing the precision value:
 

_opensearch/cluster.md

@@ -329,10 +329,4 @@ You can then use the [Index State Management (ISM)]({{site.url}}{{site.baseurl}}
 
 ## Next steps
 
-If you are using the security plugin, the previous request to `_cat/nodes?v` might have failed with an initialization error. To initialize the plugin, run `opensearch/plugins/opensearch-security/tools/securityadmin.sh`. A sample command that uses the demo certificates might look like this:
-
-```bash
-sudo ./securityadmin.sh -cd {{site.url}}{{site.baseurl}}/securityconfig/ -icl -nhnv -cacert /etc/opensearch/root-ca.pem -cert /etc/opensearch/kirk.pem -key /etc/opensearch/kirk-key.pem -h <private-ip>
-```
-
-For full guidance around configuration options, see [Security configuration]({{site.url}}{{site.baseurl}}/security-plugin/configuration/index/).
+If you are using the security plugin, the previous request to `_cat/nodes?v` might have failed with an initialization error. For full guidance around using the security plugin, see [Security configuration]({{site.url}}{{site.baseurl}}/security-plugin/configuration/index/).

_opensearch/configuration.md

@@ -65,4 +65,16 @@ PUT _cluster/settings
 
 You can find `opensearch.yml` in `/usr/share/opensearch/config/opensearch.yml` (Docker) or `/etc/opensearch/opensearch.yml` (most Linux distributions) on each node.
 
+You can edit the `OPENSEARCH_PATH_CONF=/etc/opensearch` to change the config directory location. This variable is sourced from `/etc/default/opensearch`(Debian package) and `/etc/sysconfig/opensearch`(RPM package).
+
+If you set your customized `OPENSEARCH_PATH_CONF` variable, be aware that other default environment variables will not be loaded.
+
+You don't mark settings in `opensearch.yml` as persistent or transient, and settings use the flat form:
+
+```yml
+cluster.name: my-application
+action.auto_create_index: true
+compatibility.override_main_response_version: true
+```
+
 The demo configuration includes a number of settings for the security plugin that you should modify before using OpenSearch for a production workload. To learn more, see [Security]({{site.url}}{{site.baseurl}}/security-plugin/).

_opensearch/data-streams.md

@@ -0,0 +1,265 @@
+---
+layout: default
+title: Data streams
+nav_order: 13
+---
+
+# Data streams
+
+If you're ingesting continuously generated time-series data such as logs, events, and metrics into OpenSearch, you're likely in a scenario where the number of documents grows rapidly and you don't need to update older documents.
+
+A typical workflow to manage time-series data involves multiple steps, such as creating a rollover index alias, defining a write index, and defining common mappings and settings for the backing indices.
+
+Data streams simplify this process and enforce a setup that best suits time-series data, such as being designed primarily for append-only data and ensuring that each document has a timestamp field.
+
+A data stream is internally composed of multiple backing indices. Search requests are routed to all the backing indices, while indexing requests are routed to the latest write index. [ISM]({{site.url}}{{site.baseurl}}/im-plugin/ism/index/) policies let you automatically handle index rollovers or deletions.
+
+
+## Get started with data streams
+
+### Step 1: Create an index template
+
+To create a data stream, you first need to create an index template that configures a set of indices as a data stream. The `data_stream` object indicates that it’s a data stream and not a regular index template. The index pattern matches with the name of the data stream:
+
+```json
+PUT _index_template/logs-template
+{
+  "index_patterns": [
+    "my-data-stream",
+    "logs-*"
+  ],
+  "data_stream": {},
+  "priority": 100
+}
+```
+
+In this case, each ingested document must have an `@timestamp` field.
+You also have the ability to define your own custom timestamp field as a property in the `data_stream` object. You can also add index mappings and other settings here, just as you would for a regular index template.
+
+```json
+PUT _index_template/logs-template-nginx
+{
+  "index_patterns": "logs-nginx",
+  "data_stream": {
+    "timestamp_field": {
+      "name": "request_time"
+    }
+  },
+  "priority": 200,
+  "template": {
+    "settings": {
+      "number_of_shards": 1,
+      "number_of_replicas": 0
+    }
+  }
+}
+```
+
+In this case, `logs-nginx` index matches both the `logs-template` and `logs-template-nginx` templates. When you have a tie, OpenSearch selects the matching index template with the higher priority value.
+
+### Step 2: Create a data stream
+
+After you create an index template, you can create a data stream.
+You can use the data stream API to explicitly create a data stream. The data stream API initializes the first backing index:
+
+```json
+PUT _data_stream/logs-redis
+PUT _data_stream/logs-nginx
+```
+
+You can also directly start ingesting data without creating a data stream.
+
+Because we have a matching index template with a data_stream object, OpenSearch automatically creates the data stream:
+
+```json
+POST logs-staging/_doc
+{
+  "message": "login attempt failed",
+  "@timestamp": "2013-03-01T00:00:00"
+}
+```
+
+To see information about a specific data stream:
+
+```json
+GET _data_stream/logs-nginx
+```
+
+#### Sample response
+
+```json
+{
+  "data_streams" : [
+    {
+      "name" : "logs-nginx",
+      "timestamp_field" : {
+        "name" : "request_time"
+      },
+      "indices" : [
+        {
+          "index_name" : ".ds-logs-nginx-000001",
+          "index_uuid" : "-VhmuhrQQ6ipYCmBhn6vLw"
+        }
+      ],
+      "generation" : 1,
+      "status" : "GREEN",
+      "template" : "logs-template-nginx"
+    }
+  ]
+}
+```
+
+You can see the name of the timestamp field, the list of the backing indices, and the template that's used to create the data stream. You can also see the health of the data stream, which represents the lowest status of all its backing indices.
+
+To see more insights about the data stream, use the `_stats` endpoint:
+
+```json
+GET _data_stream/logs-nginx/_stats
+```
+
+#### Sample response
+
+```json
+{
+  "_shards" : {
+    "total" : 1,
+    "successful" : 1,
+    "failed" : 0
+  },
+  "data_stream_count" : 1,
+  "backing_indices" : 1,
+  "total_store_size_bytes" : 208,
+  "data_streams" : [
+    {
+      "data_stream" : "logs-nginx",
+      "backing_indices" : 1,
+      "store_size_bytes" : 208,
+      "maximum_timestamp" : 0
+    }
+  ]
+}
+```
+
+### Step 3: Ingest data into the data stream
+
+To ingest data into a data stream, you can use the regular indexing APIs. Make sure every document that you index has a timestamp field. If you try to ingest a document that doesn't have a timestamp field, you get an error.
+
+```json
+POST logs-redis/_doc
+{
+  "message": "login attempt",
+  "@timestamp": "2013-03-01T00:00:00"
+}
+```
+
+### Step 4: Searching a data stream
+
+You can search a data stream just like you search a regular index or an index alias.
+The search operation applies to all of the backing indices (all data present in the stream).
+
+```json
+GET logs-redis/_search
+{
+  "query": {
+    "match": {
+      "message": "login"
+    }
+  }
+}
+```
+
+#### Sample response
+
+```json
+{
+  "took" : 514,
+  "timed_out" : false,
+  "_shards" : {
+    "total" : 5,
+    "successful" : 5,
+    "skipped" : 0,
+    "failed" : 0
+  },
+  "hits" : {
+    "total" : {
+      "value" : 1,
+      "relation" : "eq"
+    },
+    "max_score" : 0.2876821,
+    "hits" : [
+      {
+        "_index" : ".ds-logs-redis-000001",
+        "_type" : "_doc",
+        "_id" : "-rhVmXoBL6BAVWH3mMpC",
+        "_score" : 0.2876821,
+        "_source" : {
+          "message" : "login attempt",
+          "@timestamp" : "2013-03-01T00:00:00"
+        }
+      }
+    ]
+  }
+}
+```
+
+### Step 5: Rollover a data stream
+
+A rollover operation creates a new backing index that becomes the data stream’s new write index.
+
+To perform manual rollover operation on the data stream:
+
+```json
+POST logs-redis/_rollover
+```
+
+#### Sample response
+
+```json
+{
+  "acknowledged" : true,
+  "shards_acknowledged" : true,
+  "old_index" : ".ds-logs-redis-000001",
+  "new_index" : ".ds-logs-redis-000002",
+  "rolled_over" : true,
+  "dry_run" : false,
+  "conditions" : { }
+}
+```
+
+If you now perform a `GET` operation on the `logs-redis` data stream, you see that the generation ID is incremented from 1 to 2.
+
+You can also set up an [Index State Management (ISM) policy]({{site.url}}{{site.baseurl}}/im-plugin/ism/policies/) to automate the rollover process for the data stream.  
+The ISM policy is applied to the backing indices at the time of their creation. When you associate a policy to a data stream, it only affects the future backing indices of that data stream.
+
+You also don’t need to provide the `rollover_alias` setting, because the ISM policy infers this information from the backing index.
+
+### Step 6: Manage data streams in OpenSearch Dashboards
+
+To manage data streams from OpenSearch Dashboards, open **OpenSearch Dashboards**, choose **Index Management**, select **Indices** or **Policy managed indices**.
+
+You see a toggle switch for data streams that you can use to show or hide indices belonging to a data stream.
+
+When you enable this switch, you see a data stream multi-select dropdown menu that you can use for filtering data streams.
+You also see a data stream column that shows you the name of the data stream the index is contained in.
+
+![data stream toggle]({{site.url}}{{site.baseurl}}/images/data_streams_toggle.png)
+
+You can select one or more data streams and apply an ISM policy on them. You can also apply a policy on any individual backing index.
+
+You can performing visualizations on a data stream just like you would on a regular index or index alias.
+
+### Step 7: Delete a data stream
+
+The delete operation first deletes the backing indices of a data stream and then deletes the data stream itself.
+
+To delete a data stream and all of its hidden backing indices:
+
+```json
+DELETE _data_stream/<name_of_data_stream>
+```
+
+You can use wildcards to delete more than one data stream.
+
+We recommend deleting data from a data stream using an ISM policy.
+
+You can also use [asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/index/) and [SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/index/) and [PPL]({{site.url}}{{site.baseurl}}/search-plugins/ppl/index/) to query your data stream directly. You can also use the security plugin to define granular permissions on the data stream name.

_opensearch/index-templates.md

@@ -1,23 +1,14 @@
 ---
 layout: default
 title: Index templates
-nav_order: 14
+nav_order: 15
 ---
 
 # Index templates
 
 Index templates let you initialize new indices with predefined mappings and settings. For example, if you continuously index log data, you can define an index template so that all of these indices have the same number of shards and replicas.
 
----
-
-#### Table of contents
-1. TOC
-{:toc}
-
-
----
-
-## Create a template
+### Create a template
 
 To create an index template, use a POST request:
 
@@ -106,7 +97,7 @@ GET logs-2020-01-01
 
 Any additional indices that match this pattern---`logs-2020-01-02`, `logs-2020-01-03`, and so on---will inherit the same mappings and settings.
 
-## Retrieve a template
+### Retrieve a template
 
 To list all index templates:
 
@@ -138,7 +129,7 @@ To check if a specific template exists:
 HEAD _index_template/<name>
 ```
 
-## Configure multiple templates
+### Configure multiple templates
 
 You can create multiple index templates for your indices. If the index name matches more than one template, OpenSearch merges all mappings and settings from all matching templates and applies them to the index.
 
@@ -184,7 +175,7 @@ PUT _index_template/template-02
 
 Because `template-02` has a higher `priority` value, it takes precedence over `template-01` . The `logs-2020-01-02` index would have the `number_of_shards` value as 3.
 
-## Delete a template
+### Delete a template
 
 You can delete an index template using its name:
 
@@ -192,11 +183,160 @@ You can delete an index template using its name:
 DELETE _index_template/daily_logs
 ```
 
+## Composable index templates
+
+Managing multiple index templates has the following challenges:
+
+- If you have duplication between index templates, storing these index templates results in a bigger cluster state.
+- If you want to make a change across all your index templates, you have to manually make the change for each template.
+- If an index matches multiple templates, OpenSearch might merge the templates in an unexpected way that you discover only after an index is created.
+
+You can use composable index templates to overcome these challenges. Composable index templates let you abstract common settings, mappings, and aliases into a reusable building block called a component template.
+
+You can combine component templates to compose an index template.
+
+Settings and mappings that you specify directly in the [create index]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/) request override any settings or mappings specified in an index template and its component templates.
+{: .note }
+
+### Create a component template
+
+Let's define two component templates⁠---`component_template_1` and `component_template_2`:
+
+#### Component template 1
+
+```json
+PUT _component_template/component_template_1
+{
+  "template": {
+    "mappings": {
+      "properties": {
+        "@timestamp": {
+          "type": "date"
+        }
+      }
+    }
+  }
+}
+```
+
+#### Component template 2
+
+```json
+PUT _component_template/component_template_2
+{
+  "template": {
+    "mappings": {
+      "properties": {
+        "ip_address": {
+          "type": "ip"
+        }
+      }
+    }
+  }
+}
+```
+
+### Use component templates to create an index template
+
+When creating index templates, you need to include the component templates in a `composed_of` list.
+
+OpenSearch applies the component templates in the order in which you specify them within the index template. The settings, mappings, and aliases that you specify inside the index template are applied last.
+
+```json
+PUT _index_template/daily_logs
+{
+  "index_patterns": [
+    "logs-2020-01-*"
+  ],
+  "template": {
+    "aliases": {
+      "my_logs": {}
+    },
+    "settings": {
+      "number_of_shards": 2,
+      "number_of_replicas": 1
+    },
+    "mappings": {
+      "properties": {
+        "timestamp": {
+          "type": "date",
+          "format": "yyyy-MM-dd HH:mm:ss||yyyy-MM-dd||epoch_millis"
+        },
+        "value": {
+          "type": "double"
+        }
+      }
+    }
+  },
+  "priority": 200,
+  "composed_of": [
+    "component_template_1",
+    "component_template_2"
+  ],
+  "version": 3,
+  "_meta": {
+    "description": "using component templates"
+  }
+}
+```
+
+If you create an index named `logs-2020-01-01`, you can see that it derives its mappings and settings from both the component templates:
+
+```json
+PUT logs-2020-01-01
+GET logs-2020-01-01
+```
+
+#### Sample response
+
+```json
+{
+  "logs-2020-01-01": {
+    "aliases": {
+      "my_logs": {}
+    },
+    "mappings": {
+      "properties": {
+        "@timestamp": {
+          "type": "date"
+        },
+        "ip_address": {
+          "type": "ip"
+        },
+        "timestamp": {
+          "type": "date",
+          "format": "yyyy-MM-dd HH:mm:ss||yyyy-MM-dd||epoch_millis"
+        },
+        "value": {
+          "type": "double"
+        }
+      }
+    },
+    "settings": {
+      "index": {
+        "creation_date": "1625382479459",
+        "number_of_shards": "2",
+        "number_of_replicas": "1",
+        "uuid": "rYUlpOXDSUSuZifQLPfa5A",
+        "version": {
+          "created": "7100299"
+        },
+        "provided_name": "logs-2020-01-01"
+      }
+    }
+  }
+}
+```
+
+
 ## Index template options
 
 You can specify the following template options:
 
 Option | Type | Description | Required
 :--- | :--- | :--- | :---
-`priority` | `Number` | The priority of the index template.  | No
-`create` | `Boolean` | Whether this index template should replace an existing one. | No
+`template` | `Object` |  Specify index settings, mappings, and aliases. | No
+`priority` | `Integer` | The priority of the index template.  | No
+`composed_of` | `String array` |  The names of component templates applied on a new index together with the current template.  | No
+`version` | `Integer` | Specify a version number to simplify template management. Default is `null`. | No
+`_meta ` | `Object` | Specify meta information about the template. | No

_opensearch/index.md

@@ -5,9 +5,12 @@ nav_order: 1
 has_children: false
 has_toc: false
 redirect_from:
+  - /docs/opensearch/
   - /opensearch/
 ---
 
+{%- comment -%}The `/docs/opensearch/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%}
+
 # Introduction to OpenSearch
 
 OpenSearch is a distributed search and analytics engine based on [Apache Lucene](https://lucene.apache.org/). After adding your data to OpenSearch, you can perform full-text searches on it with all of the features you might expect: search by field, search multiple indices, boost fields, rank results by score, sort results by field, and aggregate results.

_opensearch/install/compatibility.md

@@ -0,0 +1,19 @@
+---
+layout: default
+title: Compatibility
+parent: Install OpenSearch
+nav_order: 2
+---
+
+# Operating system and JVM compatibility
+
+- We recommend installing OpenSearch on RHEL- or Debian-based Linux distributions that use [systemd](https://en.wikipedia.org/wiki/Systemd), such as CentOS, Amazon Linux 2, and Ubuntu (LTS). OpenSearch should work on many Linux distributions, but we only test a handful.
+- The OpenSearch tarball ships with a compatible version of Java in the `jdk` directory. To find its version, run `./jdk/bin/java -version`. For example, the OpenSearch 1.0.0 tarball ships with Java 15 (non-LTS).
+
+{% comment %}`./jdk/bin/java -version` doesn't work on macOS with zsh at the moment, and I have no idea why. Maybe we need a macOS artifact. Regardless, the command works on Amazon Linux 2 with bash and presumably other distros. - aetter{% endcomment %}
+
+  To use a different Java installation, set the `OPENSEARCH_JAVA_HOME` environment variable to the Java install location. We recommend Java 11 (LTS), but OpenSearch also works with Java 8.
+
+OpenSearch version | Compatible Java versions | Recommended operating systems
+:--- | :--- | :---
+1.x | 8, 11 | Red Hat Enterprise Linux 7, 8; CentOS 7, 8; Amazon Linux 2; Ubuntu 16.04, 18.04, 20.04

_opensearch/install/docker-security.md

@@ -129,8 +129,8 @@ plugins.security.enable_snapshot_restore_privilege: true
 plugins.security.check_snapshot_restore_write_privileges: true
 plugins.security.restapi.roles_enabled: ["all_access", "security_rest_api_access"]
 cluster.routing.allocation.disk.threshold_enabled: false
-plugins.security.audit.config.disabled_rest_categories: NONE
-plugins.security.audit.config.disabled_transport_categories: NONE
+opendistro_security.audit.config.disabled_rest_categories: NONE
+opendistro_security.audit.config.disabled_transport_categories: NONE
 ```
 
 Use this same override process to specify new [authentication settings]({{site.url}}{{site.baseurl}}/security-plugin/configuration/configuration/) in `/usr/share/opensearch/plugins/opensearch-security/securityconfig/config.yml`, as well as new default [internal users, roles, mappings, action groups, and tenants]({{site.url}}{{site.baseurl}}/security-plugin/configuration/yaml/).

_opensearch/install/docker.md

@@ -2,7 +2,7 @@
 layout: default
 title: Docker
 parent: Install OpenSearch
-nav_order: 1
+nav_order: 3
 ---
 
 # Docker image
@@ -16,7 +16,7 @@ docker pull opensearchproject/opensearch-dashboards:{{site.opensearch_version}}
 
 To check available versions, see [Docker Hub](https://hub.docker.com/u/opensearchproject).
 
-OpenSearch images use `centos:7` as the base image. If you run Docker locally, we recommend allowing Docker to use at least 4 GB of RAM in **Preferences** > **Resources**.
+OpenSearch images use `amazonlinux:2` as the base image. If you run Docker locally, set Docker to use at least 4 GB of RAM in **Preferences** > **Resources**.
 
 
 ---

_opensearch/install/helm.md

@@ -0,0 +1,159 @@
+---
+layout: default
+title: Helm
+parent: Install OpenSearch
+nav_order: 6
+---
+
+# Run OpenSearch using Helm
+
+Helm is a package manager that allows you to easily install and manage OpenSearch in a Kubernetes cluster. You can define your OpenSearch configurations in a YAML file and use Helm to deploy your applications in a version-controlled and reproducible way.
+
+The Helm chart contains the resources described in the following table.
+
+Resource | Description
+:--- | :---
+`Chart.yaml` |  Information about the chart.
+`values.yaml` |  Default configuration values for the chart.
+`templates` |  Templates that combine with values to generate the Kubernetes manifest files.
+
+The specification in the default Helm chart supports many standard use cases and setups. You can modify the default chart to configure your desired specifications and set Transport Layer Security (TLS) and role-based access control (RBAC).
+
+For information about the default configuration, steps to configure security, and configurable parameters, see the
+[README](https://github.com/opensearch-project/helm-charts/tree/main/charts).
+
+The instructions here assume you have a Kubernetes cluster with Helm preinstalled. See the [Kubernetes documentation](https://kubernetes.io/docs/setup/) for steps to configure a Kubernetes cluster and the [Helm documentation](https://helm.sh/docs/intro/install/) to install Helm.
+{: .note }
+
+## Prerequisites
+
+The default Helm chart deploys a three-node cluster. We recommend that you have at least 8 GiB of memory available for this deployment. You can expect the deployment to fail if, say, you have less than 4 GiB of memory available.
+
+## Install OpenSearch using Helm
+
+1. Add `opensearch` [helm-charts](https://github.com/opensearch-project/helm-charts) repository to Helm:
+
+   ```bash
+   helm repo add opensearch https://opensearch-project.github.io/helm-charts/
+   ```
+
+1. Update the available charts locally from charts repositories:
+
+   ```bash
+   helm repo update
+   ```
+
+1. To search for the OpenSearch-related Helm charts:
+
+   ```bash
+   helm search repo opensearch
+   ```
+
+   ```bash
+   NAME                            	CHART VERSION	APP VERSION	DESCRIPTION                           
+   opensearch/opensearch           	1.0.7        	1.0.0      	A Helm chart for OpenSearch           
+   opensearch/opensearch-dashboards	1.0.4        	1.0.0      	A Helm chart for OpenSearch Dashboards
+   ```
+
+1. Deploy OpenSearch:
+
+   ```bash
+   helm install my-deployment opensearch/opensearch
+   ```
+
+You can also build the `opensearch-1.0.0.tgz` file manually:
+
+1. Change to the `opensearch` directory:
+
+   ```bash
+   cd charts/opensearch
+   ```
+
+1. Package the Helm chart:
+
+   ```bash
+   helm package .
+   ```
+
+1. Deploy OpenSearch:
+
+   ```bash
+   helm install --generate-name opensearch-1.0.0.tgz
+   ```
+   The output shows you the specifications instantiated from the install.
+   To customize the deployment, pass in the values that you want to override with a custom YAML file:
+
+   ```bash
+   helm install --values=customvalues.yaml opensearch-1.0.0.tgz
+   ```
+
+#### Sample output
+
+  ```yaml
+  NAME: opensearch-1-1629223146
+  LAST DEPLOYED: Tue Aug 17 17:59:07 2021
+  NAMESPACE: default
+  STATUS: deployed
+  REVISION: 1
+  TEST SUITE: None
+  NOTES:
+  Watch all cluster members come up.
+    $ kubectl get pods --namespace=default -l app=opensearch-cluster-master -w
+  ```
+
+To make sure your OpenSearch pod is up and running, run the following command:
+
+```bash
+$ kubectl get pods
+NAME                                                  READY   STATUS    RESTARTS   AGE
+opensearch-cluster-master-0                           1/1     Running   0          3m56s
+opensearch-cluster-master-1                           1/1     Running   0          3m56s
+opensearch-cluster-master-2                           1/1     Running   0          3m56s
+```
+
+To access the OpenSearch shell:
+
+```bash
+$ kubectl exec -it opensearch-cluster-master-0 -- /bin/bash
+```
+
+You can send requests to the pod to verify that OpenSearch is up and running:
+
+```json
+$ curl -XGET https://localhost:9200 -u 'admin:admin' --insecure
+{
+  "name" : "opensearch-cluster-master-1",
+  "cluster_name" : "opensearch-cluster",
+  "cluster_uuid" : "hP2gq5bPS3SLp8Z7wXm8YQ",
+  "version" : {
+    "distribution" : "opensearch",
+    "number" : "1.0.0",
+    "build_type" : "tar",
+    "build_hash" : "34550c5b17124ddc59458ef774f6b43a086522e3",
+    "build_date" : "2021-07-02T23:22:21.383695Z",
+    "build_snapshot" : false,
+    "lucene_version" : "8.8.2",
+    "minimum_wire_compatibility_version" : "6.8.0",
+    "minimum_index_compatibility_version" : "6.0.0-beta1"
+  },
+  "tagline" : "The OpenSearch Project: https://opensearch.org/"
+}
+```
+
+## Uninstall using Helm
+
+To identify the OpenSearch deployment that you want to delete:
+
+```bash
+$ helm list
+NAME  NAMESPACEREVISIONUPDATED  STATUS  CHART APP VERSION
+opensearch-1-1629223146 default 1 2021-08-17 17:59:07.664498239 +0000 UTCdeployedopensearch-1.0.0    1.0.0       
+```
+
+To delete or uninstall a deployment, run the following command:
+
+```bash
+helm delete opensearch-1-1629223146
+```
+
+For steps to install OpenSearch Dashboards, see [Helm to install OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/install/helm/).

_opensearch/install/important-settings.md

@@ -7,13 +7,13 @@ nav_order: 70
 
 # Important settings
 
-For production workloads, make sure the [Linux setting](https://www.kernel.org/doc/Documentation/sysctl/vm.txt) `vm.max_map_count` is set to at least 262144. On the OpenSearch Docker image, this setting is the default. To check, start a Bash session in the container and run:
+For production workloads, make sure the [Linux setting](https://www.kernel.org/doc/Documentation/sysctl/vm.txt) `vm.max_map_count` is set to at least 262144. Even if you use the Docker image, set this value on the *host machine*. To check the current value, run this command:
 
 ```bash
 cat /proc/sys/vm/max_map_count
 ```
 
-To increase this value, you have to modify the Docker image. For other install types, add this setting to the host machine's `/etc/sysctl.conf` file with the following line:
+To increase the value, add the following line to `/etc/sysctl.conf`:
 
 ```
 vm.max_map_count=262144

_opensearch/install/index.md

@@ -3,7 +3,6 @@ layout: default
 title: Install OpenSearch
 nav_order: 2
 redirect_from:
-  - /docs/install/
   - /opensearch/install/
 has_children: true
 ---

_opensearch/install/plugins.md

@@ -30,35 +30,54 @@ If you don't want to use the all-in-one OpenSearch installation options, you can
   </thead>
   <tbody>
   <tr>
-    <td>1.0.0-rc1</td>
+    <td>1.1.0</td>
     <td>
-      <pre>opensearch-alerting             1.0.0.0-rc1
-opensearch-anomaly-detection    1.0.0.0-rc1
-opensearch-asynchronous-search  1.0.0.0-rc1
-opensearch-index-management     1.0.0.0-rc1
-opensearch-job-scheduler        1.0.0.0-rc1
-opensearch-knn                  1.0.0.0-rc1
-opensearch-notebooks            1.0.0.0-rc1
-opensearch-performance-analyzer 1.0.0.0-rc1
-opensearch-reports-scheduler    1.0.0.0-rc1
-opensearch-security             1.0.0.0-rc1
-opensearch-sql                  1.0.0.0-rc1
+      <pre>opensearch-alerting                  1.1.0.0
+opensearch-anomaly-detection         1.1.0.0
+opensearch-asynchronous-search       1.1.0.0
+opensearch-cross-cluster-replication 1.1.0.0
+opensearch-index-management          1.1.0.0
+opensearch-job-scheduler             1.1.0.0
+opensearch-knn                       1.1.0.0
+opensearch-notebooks                 1.1.0.0
+opensearch-performance-analyzer      1.1.0.0
+opensearch-reports-scheduler         1.1.0.0
+opensearch-security                  1.1.0.0
+opensearch-sql                       1.1.0.0
 </pre>
     </td>
   </tr>
   <tr>
-    <td>1.0.0-beta1</td>
+    <td>1.0.1</td>
     <td>
-      <pre>opensearch-alerting             1.0.0.0-beta1
-opensearch-anomaly-detection    1.0.0.0-beta1
-opensearch-asynchronous-search  1.0.0.0-beta1
-opensearch-index-management     1.0.0.0-beta1
-opensearch-job-scheduler        1.0.0.0-beta1
-opensearch-knn                  1.0.0.0-beta1
-opensearch-performance-analyzer 1.0.0.0-beta1
-opensearch-reports-scheduler    1.0.0.0-beta1
-opensearch-security             1.0.0.0-beta1
-opensearch-sql                  1.0.0.0-beta1
+      <pre>opensearch-alerting             1.0.0.0
+opensearch-anomaly-detection    1.0.0.0
+opensearch-asynchronous-search  1.0.0.0
+opensearch-index-management     1.0.1.0
+opensearch-job-scheduler        1.0.0.0
+opensearch-knn                  1.0.0.0
+opensearch-notebooks            1.0.0.0
+opensearch-performance-analyzer 1.0.1.0
+opensearch-reports-scheduler    1.0.0.0
+opensearch-security             1.0.1.0
+opensearch-sql                  1.0.0.0
+</pre>
+    </td>
+  </tr>
+  <tr>
+    <td>1.0.0</td>
+    <td>
+      <pre>opensearch-alerting             1.0.0.0
+opensearch-anomaly-detection    1.0.0.0
+opensearch-asynchronous-search  1.0.0.0
+opensearch-index-management     1.0.0.0
+opensearch-job-scheduler        1.0.0.0
+opensearch-knn                  1.0.0.0
+opensearch-notebooks            1.0.0.0
+opensearch-performance-analyzer 1.0.0.0
+opensearch-reports-scheduler    1.0.0.0
+opensearch-security             1.0.0.0
+opensearch-sql                  1.0.0.0
 </pre>
     </td>
   </tr>

_opensearch/install/tar.md

@@ -18,17 +18,20 @@ The tarball supports most Linux distributions, including CentOS 7, Amazon Linux
    ```bash
    # x64
    tar -zxf opensearch-{{site.opensearch_version}}-linux-x64.tar.gz
-   cd opensearch-{{site.opensearch_version}}{% comment %}# ARM64
+   cd opensearch-{{site.opensearch_version}}
+   # ARM64
    tar -zxf opensearch-{{site.opensearch_version}}-linux-arm64.tar.gz
-   cd opensearch-{{site.opensearch_version}}{% endcomment %}
+   cd opensearch-{{site.opensearch_version}}
    ```
 
-1. Run OpenSearch:
+1. Run OpenSearch with the demo security configuration:
 
    ```bash
    ./opensearch-tar-install.sh
    ```
 
+   If you configure the security plugin for production use (or disable it), you can run OpenSearch using `./bin/opensearch`.
+
 1. Open a second terminal session, and send requests to the server to verify that OpenSearch is up and running:
 
    ```bash
@@ -111,7 +114,7 @@ In a tarball installation, Performance Analyzer collects data when it is enabled
 1. Launch the agent CLI:
 
    ```bash
-   ES_HOME="$PWD" ./bin/performance-analyzer-agent-cli
+   OPENSEARCH_HOME="$PWD" ./bin/performance-analyzer-agent-cli
    ```
 
 1. In a separate window, enable the Performance Analyzer plugin:

_opensearch/logs.md

@@ -11,7 +11,7 @@ The OpenSearch logs include valuable information for monitoring cluster operatio
 - On Docker, OpenSearch writes most logs to the console and stores the remainder in `opensearch/logs/`. The tarball installation also uses `opensearch/logs/`.
 - On most Linux installations, OpenSearch writes logs to `/var/log/opensearch/`.
 
-Logs are available as `.log` (plain text) and `.json` files.
+Logs are available as `.log` (plain text) and `.json` files. Permissions for the OpenSearch logs are `-rw-r--r--` by default, meaning that any user account on the node can read them. You can change this behavior _for each log type_ in `log4j2.properties` using the `filePermissions` option. For example, you might add `appender.rolling.filePermissions = rw-r-----` to change permissions for the JSON server log. For details, see the [Log4j 2 documentation](https://logging.apache.org/log4j/2.x/manual/appenders.html#RollingFileAppender).
 
 
 ## Application logs

_opensearch/metric-agg.md

@@ -88,8 +88,8 @@ GET opensearch_dashboards_sample_data_ecommerce/_search
 }
 ```
 
-The cardinality count is approximate.
-If you had tens of thousands of products in your store, an accurate cardinality calculation requires loading all the values into a hash set and returning its size. This approach doesn't scale well because it requires more memory and causes high latency.
+Cardinality count is approximate.
+If you have tens of thousands of products in your hypothetical store, an accurate cardinality calculation requires loading all the values into a hash set and returning its size. This approach doesn't scale well; it requires huge amounts of memory and can cause high latencies.
 
 You can control the trade-off between memory and accuracy with the `precision_threshold` setting. This setting defines the threshold below which counts are expected to be close to accurate. Above this value, counts might become a bit less accurate. The default value of `precision_threshold` is 3,000. The maximum supported value is 40,000.
 

_opensearch/query-dsl/bool.md

@@ -3,7 +3,6 @@ layout: default
 title: Boolean queries
 parent: Query DSL
 nav_order: 45
-redirect_from: /docs/opensearch/bool/
 ---
 
 # Boolean queries

_opensearch/query-dsl/full-text.md

@@ -3,9 +3,6 @@ layout: default
 title: Full-text queries
 parent: Query DSL
 nav_order: 40
-redirect_from:
-  - /docs/opensearch/full-text/
-  - /opensearch/full-text/
 ---
 
 # Full-text queries
@@ -24,7 +21,7 @@ This page lists all full-text query types and common options. Given the sheer nu
 
 ## Match
 
-Creates a [boolean query](https://lucene.apache.org/core/8_4_0/core/org/apache/lucene/search/BooleanQuery.html) that returns results if the search term is present in the field.
+Creates a [boolean query](https://lucene.apache.org/core/{{site.lucene_version}}/core/org/apache/lucene/search/BooleanQuery.html) that returns results if the search term is present in the field.
 
 The most basic form of the query provides only a field (`title`) and a term (`wind`):
 
@@ -129,7 +126,7 @@ GET _search
 
 ## Match boolean prefix
 
-Similar to [match](#match), but creates a [prefix query](https://lucene.apache.org/core/8_4_0/core/org/apache/lucene/search/PrefixQuery.html) out of the last term in the query string.
+Similar to [match](#match), but creates a [prefix query](https://lucene.apache.org/core/{{site.lucene_version}}/core/org/apache/lucene/search/PrefixQuery.html) out of the last term in the query string.
 
 ```json
 GET _search
@@ -167,7 +164,7 @@ GET _search
 
 ## Match phrase
 
-Creates a [phrase query](https://lucene.apache.org/core/8_4_0/core/org/apache/lucene/search/PhraseQuery.html) that matches a sequence of terms.
+Creates a [phrase query](https://lucene.apache.org/core/{{site.lucene_version}}/core/org/apache/lucene/search/PhraseQuery.html) that matches a sequence of terms.
 
 ```json
 GET _search
@@ -201,7 +198,7 @@ GET _search
 
 ## Match phrase prefix
 
-Similar to [match phrase](#match-phrase), but creates a [prefix query](https://lucene.apache.org/core/8_4_0/core/org/apache/lucene/search/PrefixQuery.html) out of the last term in the query string.
+Similar to [match phrase](#match-phrase), but creates a [prefix query](https://lucene.apache.org/core/{{site.lucene_version}}/core/org/apache/lucene/search/PrefixQuery.html) out of the last term in the query string.
 
 ```json
 GET _search
@@ -413,7 +410,7 @@ Option | Valid values | Description
 `allow_leading_wildcard` | Boolean | Whether `*` and `?` are allowed as the first character of a search term. The default is true.
 `analyze_wildcard` | Boolean | Whether OpenSearch should attempt to analyze wildcard terms. Some analyzers do a poor job at this task, so the default is false.
 `analyzer` | `standard, simple, whitespace, stop, keyword, pattern, <language>, fingerprint` | The analyzer you want to use for the query. Different analyzers have different character filters, tokenizers, and token filters. The `stop` analyzer, for example, removes stop words (e.g. "an," "but," "this") from the query string.
-`auto_generate_synonyms_phrase_query` | Boolean | A value of true (default) automatically generates [phrase queries](https://lucene.apache.org/core/8_4_0/core/org/apache/lucene/search/PhraseQuery.html) for multi-term synonyms. For example, if you have the synonym `"ba, batting average"` and search for "ba," OpenSearch searches for `ba OR "batting average"` (if this option is true) or `ba OR (batting AND average)` (if this option is false).
+`auto_generate_synonyms_phrase_query` | Boolean | A value of true (default) automatically generates [phrase queries](https://lucene.apache.org/core/{{site.lucene_version}}/core/org/apache/lucene/search/PhraseQuery.html) for multi-term synonyms. For example, if you have the synonym `"ba, batting average"` and search for "ba," OpenSearch searches for `ba OR "batting average"` (if this option is true) or `ba OR (batting AND average)` (if this option is false).
 `boost` | Floating-point | Boosts the clause by the given multiplier. Useful for weighing clauses in compound queries. The default is 1.0.
 `cutoff_frequency` | Between `0.0` and `1.0` or a positive integer | This value lets you define high and low frequency terms based on number of occurrences in the index. Numbers between 0 and 1 are treated as a percentage. For example, 0.10 is 10%. This value means that if a word occurs within the search field in more than 10% of the documents on the shard, OpenSearch considers the word "high frequency" and deemphasizes it when calculating search score.<br /><br />Because this setting is *per shard*, testing its impact on search results can be challenging unless a cluster has many documents.
 `enable_position_increments` | Boolean | When true, result queries are aware of position increments. This setting is useful when the removal of stop words leaves an unwanted "gap" between terms. The default is true.
@@ -423,7 +420,7 @@ Option | Valid values | Description
 `fuzzy_transpositions` | Boolean | Setting `fuzzy_transpositions` to true (default) adds swaps of adjacent characters to the insert, delete, and substitute operations of the `fuzziness` option. For example, the distance between `wind` and `wnid` is 1 if `fuzzy_transpositions` is true (swap "n" and "i") and 2 if it is false (delete "n", insert "n"). <br /><br />If `fuzzy_transpositions` is false, `rewind` and `wnid` have the same distance (2) from `wind`, despite the more human-centric opinion that `wnid` is an obvious typo. The default is a good choice for most use cases.
 `lenient` | Boolean | Setting `lenient` to true lets you ignore data type mismatches between the query and the document field. For example, a query string of "8.2" could match a field of type `float`. The default is false.
 `low_freq_operator` | `and, or` | The operator for low-frequency terms. The default is `or`. See [Common terms](#common-terms) queries and `operator` in this table.
-`max_determinized_states` | Positive integer | The maximum number of "[states](https://lucene.apache.org/core/8_4_0/core/org/apache/lucene/util/automaton/Operations.html#DEFAULT_MAX_DETERMINIZED_STATES)" (a measure of complexity) that Lucene can create for query strings that contain regular expressions (e.g. `"query": "/wind.+?/"`). Larger numbers allow for queries that use more memory. The default is 10,000.
+`max_determinized_states` | Positive integer | The maximum number of "[states](https://lucene.apache.org/core/{{site.lucene_version}}/core/org/apache/lucene/util/automaton/Operations.html#DEFAULT_MAX_DETERMINIZED_STATES)" (a measure of complexity) that Lucene can create for query strings that contain regular expressions (e.g. `"query": "/wind.+?/"`). Larger numbers allow for queries that use more memory. The default is 10,000.
 `max_expansions` | Positive integer | Fuzzy queries "expand to" a number of matching terms that are within the distance specified in `fuzziness`. Then OpenSearch tries to match those terms against its indices. `max_expansions` specifies the maximum number of terms that the fuzzy query expands to. The default is 50.
 `minimum_should_match` | Positive or negative integer, positive or negative percentage, combination | If the query string contains multiple search terms and you used the `or` operator, the number of terms that need to match for the document to be considered a match. For example, if `minimum_should_match` is 2, "wind often rising" does not match "The Wind Rises." If `minimum_should_match` is 1, it matches. This option also has `low_freq` and `high_freq` properties for [Common terms](#common-terms) queries.
 `operator` | `or, and` | If the query string contains multiple search terms, whether all terms need to match (`and`) or only one term needs to match (`or`) for a document to be considered a match.
@@ -431,7 +428,7 @@ Option | Valid values | Description
 `prefix_length` | `0` (default) or a positive integer | The number of leading characters that are not considered in fuzziness.
 `quote_field_suffix` | String | This option lets you search different fields depending on whether terms are wrapped in quotes. For example, if `quote_field_suffix` is `".exact"` and you search for `"lightly"` (in quotes) in the `title` field, OpenSearch searches the `title.exact` field. This second field might use a different type (e.g. `keyword` rather than `text`) or a different analyzer. The default is null.
 `rewrite` | `constant_score, scoring_boolean, constant_score_boolean, top_terms_N, top_terms_boost_N, top_terms_blended_freqs_N` | Determines how OpenSearch rewrites and scores multi-term queries. The default is `constant_score`.
-`slop` | `0` (default) or a positive integer | Controls the degree to which words in a query can be misordered and still be considered a match. From the [Lucene documentation](https://lucene.apache.org/core/8_4_0/core/org/apache/lucene/search/PhraseQuery.html#getSlop--): "The number of other words permitted between words in query phrase. For example, to switch the order of two words requires two moves (the first move places the words atop one another), so to permit re-orderings of phrases, the slop must be at least two. A value of zero requires an exact match."
+`slop` | `0` (default) or a positive integer | Controls the degree to which words in a query can be misordered and still be considered a match. From the [Lucene documentation](https://lucene.apache.org/core/{{site.lucene_version}}/core/org/apache/lucene/search/PhraseQuery.html#getSlop--): "The number of other words permitted between words in query phrase. For example, to switch the order of two words requires two moves (the first move places the words atop one another), so to permit re-orderings of phrases, the slop must be at least two. A value of zero requires an exact match."
 `tie_breaker` | `0.0` (default) to `1.0` | Changes the way OpenSearch scores searches. For example, a `type` of `best_fields` typically uses the highest score from any one field. If you specify a `tie_breaker` value between 0.0 and 1.0, the score changes to highest score + `tie_breaker` * score for all other matching fields. If you specify a value of 1.0, OpenSearch adds together the scores for all matching fields (effectively defeating the purpose of `best_fields`).
 `time_zone` | UTC offset | The time zone to use (e.g. `-08:00`) if the query string contains a date range (e.g. `"query": "wind rises release_date[2012-01-01 TO 2014-01-01]"`). The default is `UTC`.
 `type` | `best_fields, most_fields, cross-fields, phrase, phrase_prefix` | Determines how OpenSearch executes the query and scores the results. The default is `best_fields`.

_opensearch/query-dsl/index.md

@@ -5,8 +5,11 @@ nav_order: 27
 has_children: true
 redirect_from:
   - /opensearch/query-dsl/
+  - /docs/opensearch/query-dsl/
 ---
 
+{%- comment -%}The `/docs/opensearch/query-dsl/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%}
+
 # Query DSL
 
 While you can use HTTP request parameters to perform simple searches, you can also use the OpenSearch query domain-specific language (DSL), which provides a wider range of search options. The query DSL uses the HTTP request body, so you can more easily customize your queries to get the exact results that you want.

_opensearch/query-dsl/term.md

@@ -3,7 +3,6 @@ layout: default
 title: Term-level queries
 parent: Query DSL
 nav_order: 30
-redirect_from: /docs/opensearch/term/
 ---
 
 # Term-level queries
@@ -145,7 +144,7 @@ The search query “To be, or not to be” is analyzed and tokenized into an arr
 ...
 ```
 
-For a list of all full-text queries, see [Full-text queries]({{site.url}}{{site.baseurl}}/opensearch/full-text/).
+For a list of all full-text queries, see [Full-text queries]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/full-text/).
 
 If you want to query for an exact term like “HAMLET” in the speaker field and don't need the results to be sorted by relevance scores, a term-level query is more efficient:
 
@@ -431,7 +430,7 @@ Wildcard queries tend to be slow because they need to iterate over a lot of term
 
 ## Regex
 
-Use the `regex` query to search for terms that match a regular expression.
+Use the `regexp` query to search for terms that match a regular expression.
 
 This regular expression matches any single uppercase or lowercase letter:
 
@@ -440,12 +439,14 @@ GET shakespeare/_search
 {
   "query": {
     "regexp": {
-      "play_name": "H[a-zA-Z]+mlet"
+      "play_name": "[a-zA-Z]amlet"
     }
   }
 }
 ```
 
-Regular expressions are applied to the terms in the field and not the entire value of the field.
+A few important notes:
 
-The efficiency of your regular expression depends a lot on the patterns you write. Make sure that you write `regex` queries with either a prefix or suffix to improve performance.
+- Regular expressions are applied to the terms in the field (i.e. tokens), not the entire field.
+- Regular expressions use the Lucene syntax, which differs from more standardized implementations. Test thoroughly to ensure that you receive the results you expect. To learn more, see [the Lucene documentation](https://lucene.apache.org/core/{{site.lucene_version}}/core/index.html).
+- `regexp` queries can be expensive operations and require the `search.allow_expensive_queries` setting to be set to `true`. Before making frequent `regexp` queries, test their impact on cluster performance and examine alternative queries for achieving similar results.

_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/alias.md

@@ -0,0 +1,81 @@
+---
+layout: default
+title: Alias
+parent: REST API reference
+nav_order: 5
+---
+
+# Alias
+Introduced 1.0
+{: .label .label-purple }
+
+An alias is a virtual pointer that you can use to reference one or more indices. Creating and updating aliases are atomic operations, so you can reindex your data and point an alias at it without any downtime.
+
+
+## Example
+
+```json
+POST _aliases
+{
+  "actions": [
+    {
+      "add": {
+        "index": "movies",
+        "alias": "movies-alias1"
+      }
+    },
+    {
+      "remove": {
+        "index": "old-index",
+        "alias": "old-index-alias"
+      }
+    }
+
+  ]
+}
+```
+
+## Path and HTTP methods
+
+```
+POST _aliases
+```
+
+## URL parameters
+
+All alias parameters are optional.
+
+Parameter | Data Type | Description
+:--- | :--- | :---
+master_timeout | Time | The amount of time to wait for a response from the master node. Default is `30s`.
+timeout | Time | The amount of time to wait for a response from the cluster. Default is `30s`.
+
+## Request body
+
+In your request body, you need to specify what action to take, the alias name, and the index you want to associate with the alias. Other fields are optional.
+
+Field | Data Type | Description | Required
+:--- | :--- | :--- | :---
+actions | Array | Set of actions you want to perform on the index. Valid options are: `add`, `remove`, and `remove_index`. You must have at least one action in the array. | Yes
+add | N/A | Adds an alias to the specified index. | No
+remove | N/A | Removes an alias from the specified index. | No
+remove_index | N/A | Deletes an index. | No
+index | String | Name of the index you want to associate with the alias. Supports wildcard expressions. | Yes if you don't supply an `indices` field in the body.
+indices | Array | Array of index names you want to associate with the alias. | Yes if you don't supply an `index` field in the body.
+alias | String | The name of the alias. | Yes if you don't supply an `aliases` field in the body.
+aliases | Array | Array of alias names. | Yes if you don't supply an `alias` field in the body.
+filter | Object | A filter to use with the alias, so the alias points to a filtered part of the index. | No
+is_hidden | Boolean | Specifies whether the alias should be hidden from results that include wildcard expressions | No
+must_exist | Boolean | Specifies whether the alias to remove must exist. | No
+is_write_index | Boolean | Specifies whether the index should be a write index. An alias can only have one write index at a time. | No
+routing | String | Used to assign a custom value to a shard for specific operations. | No
+index_routing | String | Assigns a custom value to a shard only for index operations. | No
+search_routing | String | Assigns a custom value to a shard only for search operations. | No
+
+## Response
+
+```json
+{
+    "acknowledged": true
+}
+```

_opensearch/rest-api/cat/cat-aliases.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat aliases
+Introduced 1.0
+{: .label .label-purple }
 
 The cat aliases operation lists the mapping of aliases to indices, plus routing and filtering information.
 

_opensearch/rest-api/cat/cat-allocation.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat allocation
+Introduced 1.0
+{: .label .label-purple }
 
 The cat allocation operation lists the allocation of disk space for indices and the number of shards on each node.
 

_opensearch/rest-api/cat/cat-count.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat count
+Introduced 1.0
+{: .label .label-purple }
 
 The cat count operation lists the number of documents in your cluster.
 

_opensearch/rest-api/cat/cat-field-data.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat fielddata
+Introduced 1.0
+{: .label .label-purple }
 
 The cat fielddata operation lists the memory size used by each field per node.
 

_opensearch/rest-api/cat/cat-health.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat health
+Introduced 1.0
+{: .label .label-purple }
 
 The cat health operation lists the status of the cluster, how long the cluster has been up, the number of nodes, and other useful information that helps you analyze the health of your cluster.
 

_opensearch/rest-api/cat/cat-indices.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat indices
+Introduced 1.0
+{: .label .label-purple }
 
 The cat indices operation lists information related to indices⁠—how much disk space they are using, how many shards they have, their health status, and so on.
 

_opensearch/rest-api/cat/cat-master.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat master
+Introduced 1.0
+{: .label .label-purple }
 
 The cat master operation lists information that helps identify the elected master node.
 

_opensearch/rest-api/cat/cat-nodeattrs.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat nodeattrs
+Introduced 1.0
+{: .label .label-purple }
 
 The cat nodeattrs operation lists the attributes of custom nodes.
 

_opensearch/rest-api/cat/cat-nodes.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat nodes
+Introduced 1.0
+{: .label .label-purple }
 
 The cat nodes operation lists node-level information, including node roles and load metrics.
 

_opensearch/rest-api/cat/cat-pending-tasks.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat pending tasks
+Introduced 1.0
+{: .label .label-purple }
 
 The cat pending tasks operation lists the progress of all pending tasks, including task priority and time in queue.
 

_opensearch/rest-api/cat/cat-plugins.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat plugins
+Introduced 1.0
+{: .label .label-purple }
 
 The cat plugins operation lists the names, components, and versions of the installed plugins.
 

_opensearch/rest-api/cat/cat-recovery.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat recovery
+Introduced 1.0
+{: .label .label-purple }
 
 The cat recovery operation lists all completed and ongoing index and shard recoveries.
 

_opensearch/rest-api/cat/cat-repositories.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat repositories
+Introduced 1.0
+{: .label .label-purple }
 
 The cat repositories operation lists all completed and ongoing index and shard recoveries.
 

_opensearch/rest-api/cat/cat-segments.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat segments
+Introduced 1.0
+{: .label .label-purple }
 
 The cat segments operation lists Lucene segment-level information for each index.
 

_opensearch/rest-api/cat/cat-shards.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat shards
+Introduced 1.0
+{: .label .label-purple }
 
 The cat shards operation lists the state of all primary and replica shards and how they are distributed.
 

_opensearch/rest-api/cat/cat-snapshots.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # cat snapshots
+Introduced 1.0
+{: .label .label-purple }
 
 The cat snapshots operation lists all snapshots for a repository.