Comment out Java for now

Merge branch 'main' into python-client
Update links
2021-09-30 13:48:32 -07:00 · 2021-09-21 16:40:46 -07:00 · 2021-09-21 13:56:25 -07:00 · 2021-09-21 13:40:38 -07:00 · 2021-09-21 12:34:59 -07:00 · 2021-09-21 11:34:44 -07:00
422 changed files with 10902 additions and 2114 deletions
@@ -4,3 +4,4 @@ _site
 .DS_Store
 Gemfile.lock
 .idea
+.jekyll-cache
@@ -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]
@@ -1 +1 @@
-Copyright 2021 OpenSearch contributors.
+Copyright OpenSearch contributors.
@@ -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. For example, the Markdown file for [this page](https://docs-beta.opensearch.org/docs/opensearch/) is [here](https://github.com/opensearch-project/documentation-website/blob/master/docs/opensearch/index.md).
+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,7 +196,7 @@ 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` and `opensearch_major_minor_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`.

@@ -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.
@@ -0,0 +1,87 @@
+---
+layout: default
+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 compatibility solution, OpenSearch has a setting that instructs the cluster to return version 7.10.2 rather than its actual version.
+
+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
+
+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).
+
+- [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)
+- [Heartbeat OSS 7.12.1](https://elastic.co/downloads/past-releases/heartbeat-oss-7-12-1)
+- [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
+
+*Italicized* cells are untested, but indicate what a value theoretically should be based on existing information.
+
+
+### 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 |
+| :---| :--- | :--- | :--- | :--- |
+| 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 | Yes via version setting | *No* | *Yes* |
+
+\* Most current compatible version with Elasticsearch OSS.
+
+
+### Compatibility Matrix for Beats
+
+| | Beats OSS 7.x to 7.11.x\*\* | Beats OSS 7.12.x\* | Beats 7.13.x |
+| :--- | :--- | :--- | :--- |
+| 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 | 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* |
+
+\* Most current compatible version with Elasticsearch OSS.
+
+\*\* Beats OSS includes all Apache 2.0 Beats agents (i.e. Filebeat, Metricbeat, Auditbeat, Heartbeat, Winlogbeat, Packetbeat).
@@ -9,7 +9,7 @@ has_children: false

 The OpenSearch CLI command line interface (opensearch-cli) lets you manage your OpenSearch cluster from the command line and automate tasks.

-Currently, opensearch-cli supports the [Anomaly Detection](../ad/) and [k-NN](../knn/) plugins, along with arbitrary REST API paths. Among other things, you can use opensearch-cli to create and delete detectors, start and stop them, and check k-NN statistics.
+Currently, opensearch-cli supports the [Anomaly Detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/) and [k-NN]({{site.url}}{{site.baseurl}}/search-plugins/knn/) plugins, along with arbitrary REST API paths. Among other things, you can use opensearch-cli to create and delete detectors, start and stop them, and check k-NN statistics.

 Profiles let you easily access different clusters or sign requests with different credentials. opensearch-cli supports unauthenticated requests, HTTP basic signing, and IAM signing for Amazon Web Services.

@@ -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 %}
@@ -0,0 +1,124 @@
+---
+layout: default
+title: Java high-level REST client
+nav_order: 60
+---
+
+# Java high-level REST client
+
+The Elasticsearch OSS Java high-level REST client allows you to interact with your OpenSearch clusters and indices through Java methods and data structures rather than HTTP methods and JSON.
+
+You submit requests to your cluster using request objects, which allows you to create indices, add data to documents, or complete other operations with your cluster. In return, you get back response objects that have all of the available information, such as the associated index or ID, from your cluster.
+
+## Setup
+
+To start using the Elasticsearch OSS Java high-level REST client, ensure that you have the following dependency in your project's `pom.xml` file:
+
+```
+<dependency>
+  <groupId>org.elasticsearch.client</groupId>
+  <artifactId>elasticsearch-rest-high-level-client</artifactId>
+  <version>7.10.2</version>
+</dependency>
+```
+
+You can now start your OpenSearch cluster. The 7.10.2 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.elasticsearch.action.admin.indices.delete.DeleteIndexRequest;
+import org.elasticsearch.action.delete.DeleteRequest;
+import org.elasticsearch.action.delete.DeleteResponse;
+import org.elasticsearch.action.get.GetRequest;
+import org.elasticsearch.action.get.GetResponse;
+import org.elasticsearch.action.index.IndexRequest;
+import org.elasticsearch.action.index.IndexResponse;
+import org.elasticsearch.action.support.master.AcknowledgedResponse;
+import org.elasticsearch.client.RequestOptions;
+import org.elasticsearch.client.RestClient;
+import org.elasticsearch.client.RestClientBuilder;
+import org.elasticsearch.client.RestHighLevelClient;
+import org.elasticsearch.client.indices.CreateIndexRequest;
+import org.elasticsearch.client.indices.CreateIndexResponse;
+import org.elasticsearch.common.settings.Settings;
+import org.elasticsearch.common.xcontent.XContentType;
+
+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();
+  }
+}
+```
@@ -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.
@@ -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.
@@ -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.
@@ -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
+    ```
@@ -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)
+```
@@ -1,27 +1,13 @@
-# Welcome to Jekyll!
-#
-# This config file is meant for settings that affect your whole blog, values
-# which you are expected to set up once and rarely edit after that. If you find
-# yourself editing this file very often, consider using Jekyll's data files
-# feature for the data you need to update frequently.
-#
-# For technical reasons, this file is *NOT* reloaded automatically when you use
-# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
-
-# Site settings
-# These are used to personalize your new site. If you look in the HTML files,
-# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
-# You can create any custom variable you would like, and they will be accessible
-# in the templates via {{ site.myvariable }}.
 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
-permalink: pretty
+baseurl: "/docs" # 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-beta1
+opensearch_version: 1.0.1
 opensearch_major_minor_version: 1.0
+lucene_version: 8_8_2

 # Build settings
 markdown: kramdown
@@ -35,10 +21,79 @@ 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
+collections:
+  # Define a collection named "tests", its documents reside in the "_tests" directory
+  upgrade-to:
+    permalink: /:collection/:path/
+    output: true
+  opensearch:
+    permalink: /:collection/:path/
+    output: true
+  dashboards:
+    permalink: /:collection/:path/
+    output: true
+  security-plugin:
+    permalink: /:collection/:path/
+    output: true
+  search-plugins:
+    permalink: /:collection/:path/
+    output: true
+  im-plugin:
+    permalink: /:collection/:path/
+    output: true
+  monitoring-plugins:
+    permalink: /:collection/:path/
+    output: true
+  clients:
+    permalink: /:collection/:path/
+    output: true
+  troubleshoot:
+    permalink: /:collection/:path/
+    output: true
+  external_links:
+    permalink: /:collection/:path/
+    output: true
+
+just_the_docs:
+  # Define the collections used in the theme
+  collections:
+    upgrade-to:
+      name: Upgrade to OpenSearch
+      # nav_exclude: true
+      nav_fold: true
+      # search_exclude: true
+    opensearch:
+      name: OpenSearch
+      nav_fold: true
+    dashboards:
+      name: OpenSearch Dashboards
+      nav_fold: true
+    security-plugin:
+      name: Security plugin
+      nav_fold: true
+    search-plugins:
+      name: Search plugins
+      nav_fold: true
+    im-plugin:
+      name: Index management plugin
+      nav_fold: true
+    monitoring-plugins:
+      name: Monitoring plugins
+      nav_fold: true
+    clients:
+      name: Clients and tools
+      nav_fold: true
+    troubleshoot:
+      name: Troubleshooting
+      nav_fold: true
+    external_links:
+      name: External links
+
+
 # Enable or disable the site search
 # Supports true (default) or false
 search_enabled: true
@@ -83,6 +138,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
@@ -1,7 +1,6 @@
 ---
 layout: default
 title: Gantt charts
-parent: OpenSearch Dashboards
 nav_order: 10
 ---

@@ -21,6 +20,6 @@ To create a Gantt chart, perform the following steps:
 1. Choose **Panel settings** to adjust axis labels, time format, and colors.
 1. Choose **Update**.

-![Gantt Chart](../../images/gantt-chart.png)
+![Gantt Chart]({{site.url}}{{site.baseurl}}/images/gantt-chart.png)

 This Gantt chart displays the ID of each log on the y-axis. Each bar is a unique event that spans some amount of time. Hover over a bar to see the duration of that event.
@@ -1,11 +1,16 @@
 ---
 layout: default
-title: OpenSearch Dashboards
-nav_order: 11
-has_children: true
+title: About Dashboards
+nav_order: 1
+has_children: false
 has_toc: false
+redirect_from:
+  - /docs/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.
@@ -2,7 +2,6 @@
 layout: default
 title: Docker
 parent: Install OpenSearch Dashboards
-grand_parent: OpenSearch Dashboards
 nav_order: 1
 ---

@@ -12,13 +11,13 @@ You *can* start OpenSearch Dashboards using `docker run` after [creating a Docke

 1. Run `docker pull opensearchproject/opensearch-dashboards:{{site.opensearch_version}}`.

-1. Create a [`docker-compose.yml`](https://docs.docker.com/compose/compose-file/) file appropriate for your environment. A sample file that includes OpenSearch Dashboards is available on the OpenSearch [Docker installation page](../opensearch/docker/#sample-docker-compose-file).
+1. Create a [`docker-compose.yml`](https://docs.docker.com/compose/compose-file/) file appropriate for your environment. A sample file that includes OpenSearch Dashboards is available on the OpenSearch [Docker installation page]({{site.url}}{{site.baseurl}}/opensearch/install/docker#sample-docker-compose-file).

   Just like `opensearch.yml`, you can pass a custom `opensearch_dashboards.yml` to the container in the Docker Compose file.
   {: .tip }

 1. Run `docker-compose up`.

-   Wait for the containers to start. Then see the [OpenSearch Dashboards documentation](../../../opensearch-dashboards/).
+   Wait for the containers to start. Then see the [OpenSearch Dashboards documentation]({{site.url}}{{site.baseurl}}/).

 1. When finished, run `docker-compose down`.
@@ -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/opensearch-devops/blob/main/Helm/README.md).
+
+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
+```
@@ -0,0 +1,12 @@
+---
+layout: default
+title: Install OpenSearch Dashboards
+nav_order: 1
+has_children: true
+redirect_from:
+  - /dashboards/install/
+---
+
+# Install and configure OpenSearch Dashboards
+
+OpenSearch Dashboards has three installation options at this time: Docker images, tarballs, and Helm charts.
@@ -2,7 +2,6 @@
 layout: default
 title: OpenSearch Dashboards plugins
 parent: Install OpenSearch Dashboards
-grand_parent: OpenSearch Dashboards
 nav_order: 50
 ---

@@ -30,18 +29,32 @@ If you don't want to use the all-in-one installation options, you can install th
  </thead>
  <tbody>
  <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>
@@ -52,14 +65,15 @@ traceAnalyticsDashboards    1.0.0.0-beta1
 ## Prerequisites

 - A compatible OpenSearch cluster
- The corresponding OpenSearch plugins [installed on that cluster](../../install/plugins)
- The corresponding version of [OpenSearch Dashboards](../) (e.g. OpenSearch Dashboards 1.0.0 works with OpenSearch 1.0.0)
+- The corresponding OpenSearch plugins [installed on that cluster]({{site.url}}{{site.baseurl}}/opensearch/install/plugins/)
+- The corresponding version of [OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/) (e.g. OpenSearch Dashboards 1.0.0 works with OpenSearch 1.0.0)


 ## Install

 Navigate to the OpenSearch Dashboards home directory (likely `/usr/share/opensearch-dashboards`) and run the install command for each plugin.

+{% comment %}

 #### Security OpenSearch Dashboards

@@ -146,6 +160,7 @@ sudo bin/opensearch-dashboards-plugin install https://d3g5vo6xdbdb9a.cloudfront.

 This plugin adds a new Gantt chart visualization.

+{% endcomment %}

 ## List installed plugins

@@ -164,6 +179,8 @@ To remove a plugin:
 sudo bin/opensearch-dashboards-plugin remove <plugin-name>
 ```

+Then remove all associated entries from `opensearch_dashboards.yml`.
+
 For certain plugins, you must also remove the "optimze" bundle. This is a sample command for the Anomaly Detection plugin:

 ```bash
@@ -2,7 +2,6 @@
 layout: default
 title: Tarball
 parent: Install OpenSearch Dashboards
-grand_parent: OpenSearch Dashboards
 nav_order: 30
 ---

@@ -28,4 +27,4 @@ nav_order: 30
   ./bin/opensearch-dashboards
   ```

-1. See the [OpenSearch Dashboards documentation](../../opensearch-dashboards/).
+1. See the [OpenSearch Dashboards documentation]({{site.url}}{{site.baseurl}}/dashboards/index/).
@@ -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.
@@ -1,10 +1,13 @@
 ---
 layout: default
 title: WMS map server
-parent: OpenSearch Dashboards
 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:
@@ -0,0 +1,124 @@
+---
+layout: default
+title: Notebooks
+nav_order: 50
+redirect_from: /notebooks/
+has_children: false
+---
+
+# Notebooks
+
+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: 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 **Notebooks** within OpenSearch Dashboards.
+
+
+### Step 1: Create a notebook
+
+A notebook is an interface for creating reports.
+
+1. Choose **Create notebook** and enter a descriptive name.
+1. Choose **Create**.
+
+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 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 visualization
+
+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.
+- Add a new paragraph to the bottom of a report.
+- Run all the paragraphs at the same time.
+- Clear the outputs of all paragraphs.
+- Delete all the paragraphs.
+
+![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)
@@ -1,14 +1,16 @@
 ---
 layout: default
 title: Reporting
-parent: OpenSearch Dashboards
 nav_order: 20
 ---


 # Reporting

-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](../../security/access-control/users-roles/#predefined-roles).
+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
@@ -36,7 +38,7 @@ Definitions let you generate reports on a periodic schedule.
 1. (Optional) Add a header or footer to the report. Headers and footers are only available for dashboard or visualization reports.
 1. Under **Report trigger**, choose either **On-demand** or **Schedule**.

-   For scheduled reports, select either **Recurring** or **Cron based**. You can receive reports daily or at some other time interval. Cron expressions give you even more flexiblity. See [Cron expression reference](../../alerting/cron/) for more information.
+   For scheduled reports, select either **Recurring** or **Cron based**. You can receive reports daily or at some other time interval. Cron expressions give you even more flexiblity. See [Cron expression reference]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/cron/) for more information.

 1. Choose **Create**.

@@ -46,7 +48,7 @@ Definitions let you generate reports on a periodic schedule.

 While creating a report for dashboards or visualizations, you might see a the following error:

-![OpenSearch Dashboards reporting pop-up error message](../../images/reporting-error.png)
+![OpenSearch Dashboards reporting pop-up error message]({{site.url}}{{site.baseurl}}/images/reporting-error.png)

 This problem can occur for two reasons:

@@ -0,0 +1 @@
+message: "🔥 [OpenSearch 1.0 released on July 12th! Get it now!](/downloads.html)"
@@ -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]'
@@ -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
+---
--- a/Show More
+++ b/Show More
				`@@ -0,0 +1 @@`
				`message: "🔥 [OpenSearch 1.0 released on July 12th! Get it now!](/downloads.html)"`