Merge branch 'main' into add-bucket-aggregations

_analyzers/index-analyzers.md

@@ -2,6 +2,7 @@
 layout: default
 title: Index analyzers
 nav_order: 20
+parent: Analyzers
 ---
 
 # Index analyzers

_analyzers/index.md

@@ -45,20 +45,9 @@ An analyzer must contain exactly one tokenizer and may contain zero or more char
 
 There is also a special type of analyzer called a ***normalizer***. A normalizer is similar to an analyzer except that it does not contain a tokenizer and can only include specific types of character filters and token filters. These filters can perform only character-level operations, such as character or pattern replacement, and cannot perform operations on the token as a whole. This means that replacing a token with a synonym or stemming is not supported. See [Normalizers]({{site.url}}{{site.baseurl}}/analyzers/normalizers/) for further details.
 
-## Built-in analyzers
+## Supported analyzers
 
-The following table lists the built-in analyzers that OpenSearch provides. The last column of the table contains the result of applying the analyzer to the string `It’s fun to contribute a brand-new PR or 2 to OpenSearch!`.
-
-Analyzer | Analysis performed | Analyzer output 
-:--- | :--- | :---
-**Standard** (default) | - Parses strings into tokens at word boundaries <br> - Removes most punctuation <br> - Converts tokens to lowercase | [`it’s`, `fun`, `to`, `contribute`, `a`,`brand`, `new`, `pr`, `or`, `2`, `to`, `opensearch`]
-**Simple** | - Parses strings into tokens on any non-letter character <br> - Removes non-letter characters <br> - Converts tokens to lowercase  | [`it`, `s`, `fun`, `to`, `contribute`, `a`,`brand`, `new`, `pr`, `or`, `to`, `opensearch`]
-**Whitespace** | - Parses strings into tokens on white space | [`It’s`, `fun`, `to`, `contribute`, `a`,`brand-new`, `PR`, `or`, `2`, `to`, `OpenSearch!`]
-**Stop** | - Parses strings into tokens on any non-letter character <br> - Removes non-letter characters <br> - Removes stop words <br> - Converts tokens to lowercase | [`s`, `fun`, `contribute`, `brand`, `new`, `pr`, `opensearch`]
-**Keyword** (no-op) | - Outputs the entire string unchanged | [`It’s fun to contribute a brand-new PR or 2 to OpenSearch!`]
-**Pattern** | - Parses strings into tokens using regular expressions <br> - Supports converting strings to lowercase <br> - Supports removing stop words | [`it`, `s`, `fun`, `to`, `contribute`, `a`,`brand`, `new`, `pr`, `or`, `2`, `to`, `opensearch`]
-[**Language**]({{site.url}}{{site.baseurl}}/analyzers/language-analyzers/) | Performs analysis specific to a certain language (for example, `english`). | [`fun`, `contribut`, `brand`, `new`, `pr`, `2`, `opensearch`]
-**Fingerprint** | - Parses strings on any non-letter character <br> - Normalizes characters by converting them to ASCII <br> - Converts tokens to lowercase <br> - Sorts, deduplicates, and concatenates tokens into a single token <br> - Supports removing stop words | [`2 a brand contribute fun it's new opensearch or pr to`] <br> Note that the apostrophe was converted to its ASCII counterpart.
+For a list of supported analyzers, see [Analyzers]({{site.url}}{{site.baseurl}}/analyzers/supported-analyzers/index/).
 
 ## Custom analyzers
 
@@ -195,3 +184,4 @@ Normalization ensures that searches are not limited to exact term matches, allow
 ## Next steps
 
 - Learn more about specifying [index analyzers]({{site.url}}{{site.baseurl}}/analyzers/index-analyzers/) and [search analyzers]({{site.url}}{{site.baseurl}}/analyzers/search-analyzers/).
+- See the list of [supported analyzers]({{site.url}}{{site.baseurl}}/analyzers/supported-analyzers/index/).

_analyzers/language-analyzers.md

@@ -1,7 +1,8 @@
 ---
 layout: default
 title: Language analyzers
-nav_order: 10
+nav_order: 100
+parent: Analyzers
 redirect_from:
   - /query-dsl/analyzers/language-analyzers/
 ---

_analyzers/search-analyzers.md

@@ -2,6 +2,7 @@
 layout: default
 title: Search analyzers
 nav_order: 30
+parent: Analyzers
 ---
 
 # Search analyzers
@@ -42,7 +43,7 @@ GET shakespeare/_search
 ```
 {% include copy-curl.html %}
 
-Valid values for [built-in analyzers]({{site.url}}{{site.baseurl}}/analyzers/index#built-in-analyzers) are `standard`, `simple`, `whitespace`, `stop`, `keyword`, `pattern`, `fingerprint`, or any supported [language analyzer]({{site.url}}{{site.baseurl}}/analyzers/language-analyzers/).
+For more information about supported analyzers, see [Analyzers]({{site.url}}{{site.baseurl}}/analyzers/supported-analyzers/index/).
 
 ## Specifying a search analyzer for a field
 

_analyzers/supported-analyzers/index.md

@@ -0,0 +1,32 @@
+---
+layout: default
+title: Analyzers
+nav_order: 40
+has_children: true
+has_toc: false
+redirect_from:
+    - /analyzers/supported-analyzers/index/
+---
+
+# Analyzers
+
+The following sections list all analyzers that OpenSearch supports.
+
+## Built-in analyzers
+
+The following table lists the built-in analyzers that OpenSearch provides. The last column of the table contains the result of applying the analyzer to the string `It’s fun to contribute a brand-new PR or 2 to OpenSearch!`.
+
+Analyzer | Analysis performed | Analyzer output 
+:--- | :--- | :---
+**Standard** (default) | - Parses strings into tokens at word boundaries <br> - Removes most punctuation <br> - Converts tokens to lowercase | [`it’s`, `fun`, `to`, `contribute`, `a`,`brand`, `new`, `pr`, `or`, `2`, `to`, `opensearch`]
+**Simple** | - Parses strings into tokens on any non-letter character <br> - Removes non-letter characters <br> - Converts tokens to lowercase  | [`it`, `s`, `fun`, `to`, `contribute`, `a`,`brand`, `new`, `pr`, `or`, `to`, `opensearch`]
+**Whitespace** | - Parses strings into tokens on white space | [`It’s`, `fun`, `to`, `contribute`, `a`,`brand-new`, `PR`, `or`, `2`, `to`, `OpenSearch!`]
+**Stop** | - Parses strings into tokens on any non-letter character <br> - Removes non-letter characters <br> - Removes stop words <br> - Converts tokens to lowercase | [`s`, `fun`, `contribute`, `brand`, `new`, `pr`, `opensearch`]
+**Keyword** (no-op) | - Outputs the entire string unchanged | [`It’s fun to contribute a brand-new PR or 2 to OpenSearch!`]
+**Pattern** | - Parses strings into tokens using regular expressions <br> - Supports converting strings to lowercase <br> - Supports removing stop words | [`it`, `s`, `fun`, `to`, `contribute`, `a`,`brand`, `new`, `pr`, `or`, `2`, `to`, `opensearch`]
+[**Language**]({{site.url}}{{site.baseurl}}/analyzers/language-analyzers/) | Performs analysis specific to a certain language (for example, `english`). | [`fun`, `contribut`, `brand`, `new`, `pr`, `2`, `opensearch`]
+**Fingerprint** | - Parses strings on any non-letter character <br> - Normalizes characters by converting them to ASCII <br> - Converts tokens to lowercase <br> - Sorts, deduplicates, and concatenates tokens into a single token <br> - Supports removing stop words | [`2 a brand contribute fun it's new opensearch or pr to`] <br> Note that the apostrophe was converted to its ASCII counterpart.
+
+## Language analyzers
+
+OpenSearch supports analyzers for various languages. For more information, see [Language analyzers]({{site.url}}{{site.baseurl}}/analyzers/language-analyzers/).

_analyzers/token-filters/index.md

@@ -4,6 +4,8 @@ title: Token filters
 nav_order: 70
 has_children: true
 has_toc: false
+redirect_from:
+    - /analyzers/token-filters/index/
 ---
 
 # Token filters

_analyzers/tokenizers/index.md

@@ -4,6 +4,8 @@ title: Tokenizers
 nav_order: 60
 has_children: false
 has_toc: false
+redirect_from:
+    - /analyzers/tokenizers/index/
 ---
 
 # Tokenizers

_api-reference/snapshots/cleanup-snapshot-repository.md

@@ -0,0 +1,64 @@
+---
+layout: default
+title: Cleanup Snapshot Repository
+parent: Snapshot APIs
+nav_order: 11
+---
+
+# Cleanup Snapshot Repository 
+Introduced 1.0
+{: .label .label-purple }
+
+The Cleanup Snapshot Repository API clears a snapshot repository of data no longer referenced by any existing snapshot.
+
+## Path and HTTP methods
+
+```json
+POST /_snapshot/<repository>/_cleanup
+```
+{% include copy.html %}
+
+
+## Path parameters
+
+| Parameter | Data type | Description |
+| :--- | :--- | :--- |
+| `repository` | String | The name of the snapshot repository. |
+
+## Query parameters
+
+The following table lists the available query parameters. All query parameters are optional.
+
+| Parameter |  Data type | Description |
+| :--- | :--- | :--- |
+| `cluster_manager_timeout` | Time | The amount of time to wait for a response from the cluster manager node. Formerly called `master_timeout`. Optional. Default is 30 seconds. |
+| `timeout` | Time | The amount of time to wait for the operation to complete. Optional.|
+
+## Example request
+
+The following request removes all stale data from the repository `my_backup`:
+
+```json
+POST /_snapshot/my_backup/_cleanup
+```
+{% include copy-curl.html %}
+
+
+## Example response
+
+```json
+{
+	"results":{
+		"deleted_bytes":40,
+		"deleted_blobs":8
+	}
+}
+```
+
+## Response body fields
+
+| Field | Data type | Description |
+| :--- | :--- | :--- |
+| `deleted_bytes` | Integer | The number of bytes made available in the snapshot after data deletion. |
+| `deleted_blobs` | Integer | The number of binary large objects (BLOBs) cleared from the repository by the request. |
+

_benchmark/glossary.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Glossary
-nav_order: 10
+nav_order: 100
 ---
 
 # OpenSearch Benchmark glossary

_benchmark/user-guide/configuring-benchmark.md → _benchmark/user-guide/install-and-configure/configuring-benchmark.md

@@ -1,10 +1,12 @@
 ---
 layout: default
-title: Configuring OpenSearch Benchmark
+title: Configuring
 nav_order: 7
-parent: User guide
+grand_parent: User guide
+parent: Install and configure
 redirect_from:
   - /benchmark/configuring-benchmark/
+  - /benchmark/user-guide/configuring-benchmark/
 ---
 
 # Configuring OpenSearch Benchmark

_benchmark/user-guide/install-and-configure/index.md

@@ -0,0 +1,12 @@
+---
+layout: default
+title: Install and configure
+nav_order: 5
+parent: User guide
+has_children: true
+---
+
+# Installing and configuring OpenSearch Benchmark 
+
+This section details how to install and configure OpenSearch Benchmark.
+

_benchmark/user-guide/installing-benchmark.md → _benchmark/user-guide/install-and-configure/installing-benchmark.md

@@ -1,10 +1,12 @@
 ---
 layout: default
-title: Installing OpenSearch Benchmark
+title: Installing
 nav_order: 5
-parent: User guide
+grand_parent: User guide
+parent: Install and configure
 redirect_from:
   - /benchmark/installing-benchmark/
+  - /benchmark/user-guide/installing-benchmark/
 ---
 
 # Installing OpenSearch Benchmark

_benchmark/user-guide/distributed-load.md → _benchmark/user-guide/optimizing-benchmarks/distributed-load.md

@@ -2,12 +2,12 @@
 layout: default
 title: Running distributed loads
 nav_order: 15
-parent: User guide
+parent: Optimizing benchmarks
+grand_parent: User guide
 ---
 
 # Running distributed loads 
 
-
 OpenSearch Benchmark loads always run on the same machine on which the benchmark was started. However, you can use multiple load drivers to generate additional benchmark testing loads, particularly for large clusters on multiple machines. This tutorial describes how to distribute benchmark loads across multiple machines in a single cluster.
 
 ## System architecture 

_benchmark/user-guide/optimizing-benchmarks/index.md

@@ -0,0 +1,11 @@
+---
+layout: default
+title: Optimizing benchmarks
+nav_order: 25
+parent: User guide
+has_children: true
+---
+
+# Optimizing benchmarks
+
+This section details different ways you can optimize the benchmark tools for your cluster.

_benchmark/user-guide/target-throughput.md → _benchmark/user-guide/optimizing-benchmarks/target-throughput.md

@@ -2,7 +2,10 @@
 layout: default
 title: Target throughput
 nav_order: 150
-parent: User guide
+parent: Optimizing benchmarks
+grand_parent: User guide
+redirect_from: 
+  - /benchmark/user-guide/target-throughput/
 ---
 
 # Target throughput

_benchmark/user-guide/understanding-results/index.md

@@ -0,0 +1,12 @@
+---
+layout: default
+title: Understanding results
+nav_order: 20
+parent: User guide
+has_children: true
+---
+
+After a [running a workload]({{site.url}}{{site.baseurl}}/benchmark/user-guide/working-with-workloads/running-workloads/), OpenSearch Benchmark produces a series of metrics. The following pages details:
+
+- [How metrics are reported]({{site.url}}{{site.baseurl}}/benchmark/user-guide/understanding-results/summary-reports/)
+- [How to visualize metrics]({{site.url}}{{site.baseurl}}/benchmark/user-guide/understanding-results/telemetry/)

_benchmark/user-guide/understanding-results.md → _benchmark/user-guide/understanding-results/summary-reports.md

@@ -1,10 +1,14 @@
 ---
 layout: default
-title: Understanding benchmark results
+title: Summary reports
 nav_order: 22
-parent: User guide
+grand_parent: User guide
+parent: Understanding results
+redirect_from: 
+  - /benchmark/user-guide/understanding-results/
 ---
 
+# Understanding the summary report
 
 At the end of each test run, OpenSearch Benchmark creates a summary of test result metrics like service time, throughput, latency, and more. These metrics provide insights into how the selected workload performed on a benchmarked OpenSearch cluster.
 

_benchmark/user-guide/understanding-results/telemetry.md

@@ -0,0 +1,21 @@
+---
+layout: default
+title: Enabling telemetry devices
+nav_order: 30
+grand_parent: User guide
+parent: Understanding results
+redirect_from: 
+  - /benchmark/user-guide/telemetry
+---
+
+# Enabling telemetry devices
+
+Telemetry results will not appear in the summary report. To visualize telemetry results, ingest the data into OpenSearch and visualize the data in OpenSearch Dashboards. 
+
+To view a list of the available telemetry devices, use the command `opensearch-benchmark list telemetry`. After you've selected a [supported telemetry device]({{site.url}}{{site.baseurl}}/benchmark/reference/telemetry/), you can activate the device when running a tests with the `--telemetry` command flag. For example, if you want to use the `jfr` device with the `geonames` workload, enter the following command:
+
+```json
+opensearch-benchmark workload --workload=geonames --telemetry=jfr
+```
+{% include copy-curl.html %}
+

_benchmark/user-guide/understanding-workloads/index.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Understanding workloads
-nav_order: 7
+nav_order: 10
 parent: User guide
 has_children: true
 ---

_benchmark/user-guide/contributing-workloads.md → _benchmark/user-guide/working-with-workloads/contributing-workloads.md

@@ -2,7 +2,10 @@
 layout: default
 title: Sharing custom workloads
 nav_order: 11
-parent: User guide
+grand_parent: User guide
+parent: Working with workloads
+redirect_from: 
+  - /benchmark/user-guide/contributing-workloads/
 ---
 
 # Sharing custom workloads

_benchmark/user-guide/creating-custom-workloads.md → _benchmark/user-guide/working-with-workloads/creating-custom-workloads.md

@@ -2,7 +2,8 @@
 layout: default
 title: Creating custom workloads
 nav_order: 10
-parent: User guide
+grand_parent: User guide
+parent: Working with workloads
 redirect_from: 
   - /benchmark/user-guide/creating-custom-workloads/
   - /benchmark/creating-custom-workloads/

_benchmark/user-guide/finetine-workloads.md → _benchmark/user-guide/working-with-workloads/finetune-workloads.md

@@ -2,7 +2,10 @@
 layout: default
 title: Fine-tuning custom workloads
 nav_order: 12
-parent: User guide
+grand_parent: User guide
+parent: Working with workloads
+redirect_from: 
+  - /benchmark/user-guide/finetine-workloads/
 ---
 
 # Fine-tuning custom workloads

_benchmark/user-guide/working-with-workloads/index.md

@@ -0,0 +1,16 @@
+---
+layout: default
+title: Working with workloads
+nav_order: 15
+parent: User guide
+has_children: true
+---
+
+# Working with workloads
+
+Once you [understand workloads]({{site.url}}{{site.baseurl}}/benchmark/user-guide/understanding-workloads/index/) and have [chosen a workload]({{site.url}}{{site.baseurl}}/benchmark/user-guide/understanding-workloads/choosing-a-workload/) to run your benchmarks with, you can begin working with workloads.
+
+- [Running workloads]({{site.url}}{{site.baseurl}}/benchmark/user-guide/working-with-workloads/running-workloads/): Learn how to run an OpenSearch Benchmark workload.
+- [Creating custom workloads]({{site.url}}{{site.baseurl}}/benchmark/user-guide/working-with-workloads/creating-custom-workloads/): Create a custom workload with your own datasets.
+- [Fine-tuning workloads]({{site.url}}{{site.baseurl}}/benchmark/user-guide/working-with-workloads/finetune-workloads/): Fine-tune your custom workload according to the needs of your cluster.
+- [Contributing workloads]({{site.url}}{{site.baseurl}}/benchmark/user-guide/working-with-workloads/contributing-workloads/): Contribute your custom workload for the OpenSearch community to use.