Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More redirect updates #4077

Merged
merged 3 commits into from
May 15, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-indices.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ GET _cat/indices/<index>?v
```
{% include copy-curl.html %}

If you want to get information for more than one index, separate the indices with commas:
If you want to get information for more than one index, separate the indexes with commas:

```json
GET _cat/indices/index1,index2,index3
Expand All @@ -51,12 +51,12 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe
Parameter | Type | Description
:--- | :--- | :---
bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
health | String | Limit indices based on their health status. Supported values are `green`, `yellow`, and `red`.
health | String | Limit indexes based on their health status. Supported values are `green`, `yellow`, and `red`.
include_unloaded_segments | Boolean | Whether to include information from segments not loaded into memory. Default is false.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
pri | Boolean | Whether to return information only from the primary shards. Default is false.
time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
expand_wildcards | Enum | Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`.
expand_wildcards | Enum | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`.


## Response
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ GET _cat/recovery/<index>?v
```
{% include copy-curl.html %}

If you want to get information for more than one index, separate the indices with commas:
If you want to get information for more than one index, separate the indexes with commas:

```json
GET _cat/recovery/index1,index2,index3
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-segments.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ GET _cat/segments/<index>?v
```
{% include copy-curl.html %}

If you want to get information for more than one index, separate the indices with commas:
If you want to get information for more than one index, separate the indexes with commas:

```
GET _cat/segments/index1,index2,index3
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-shards.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ GET _cat/shards/<index>?v
```
{% include copy-curl.html %}

If you want to get information for more than one index, separate the indices with commas:
If you want to get information for more than one index, separate the indexes with commas:

```
GET _cat/shards/index1,index2,index3
Expand Down
2 changes: 2 additions & 0 deletions _api-reference/explain.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Explain
nav_order: 30
redirect_from:
- /opensearch/rest-api/explain/
---

# Explain
Expand Down
5 changes: 3 additions & 2 deletions _api-reference/index-apis/create-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@ parent: Index APIs
nav_order: 1
redirect_from:
- /opensearch/rest-api/index-apis/create-index/
- opensearch/rest-api/create-index/
---

# Create index
Introduced 1.0
{: .label .label-purple }

While you can create an index by using a document as a base, you can also create an empty index for use later.
While you can create an index by using a document as a base, you can also create an empty index for later use.

## Example

Expand Down Expand Up @@ -85,7 +86,7 @@ index.codec | The compression type to use to compress stored data. Available val
index.routing_partition_size | The number of shards a custom routing value can go to. Routing helps an imbalanced cluster by relocating values to a subset of shards rather than just a single shard. To enable, set this value to greater than 1 but less than `index.number_of_shards`. Default is 1.
index.soft_deletes.retention_lease.period | The maximum amount of time to retain a shard's history of operations. Default is `12h`.
index.load_fixed_bitset_filters_eagerly | Whether OpenSearch should pre-load cached filters. Available options are `true` and `false`. Default is `true`.
index.hidden | Whether the index should be hidden. Hidden indices are not returned as part of queries that have wildcards. Available options are `true` and `false`. Default is `false`.
index.hidden | Whether the index should be hidden. Hidden indexes are not returned as part of queries that have wildcards. Available options are `true` and `false`. Default is `false`.

#### Dynamic index Settings

Expand Down
16 changes: 9 additions & 7 deletions _api-reference/multi-search.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Multi-search
nav_order: 45
redirect_from:
- /opensearch/rest-api/multi-search/
---

# Multi-search
Expand Down Expand Up @@ -46,7 +48,7 @@ Query\n

```

- Metadata lines include options, such as which indices to search and the type of search.
- Metadata lines include options, such as which indexes to search and the type of search.
- Query lines use the [query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/).

Just like the [bulk]({{site.url}}{{site.baseurl}}/api-reference/document-apis/bulk/) operation, the JSON doesn't need to be minified---spaces are fine---but it does need to be on a single line. OpenSearch uses newline characters to parse multi-search requests and requires that the request body end with a newline character.
Expand All @@ -58,11 +60,11 @@ All multi-search URL parameters are optional. Some can also be applied per-searc

Parameter | Type | Description | Supported in metadata line
:--- | :--- | :---
allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indices. Default is `true`. | Yes
allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indexes. Default is `true`. | Yes
cancel_after_time_interval | Time | The time after which the search request will be canceled. Supported at both parent and child request levels. The order of precedence is:<br> 1. Child-level parameter<br> 2. Parent-level parameter<br> 3. [Cluster setting]({{site.url}}{{site.baseurl}}/api-reference/cluster-settings).<br>Default is -1. | Yes
css_minimize_roundtrips | Boolean | Whether OpenSearch should try to minimize the number of network round trips between the coordinating node and remote clusters (only applicable to cross-cluster search requests). Default is `true`. | No
expand_wildcards | Enum | Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`. | Yes
ignore_unavailable | Boolean | If an index from the indices list doesn’t exist, whether to ignore it rather than fail the query. Default is `false`. | Yes
expand_wildcards | Enum | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`. | Yes
ignore_unavailable | Boolean | If an index from the indexes list doesn’t exist, whether to ignore it rather than fail the query. Default is `false`. | Yes
max_concurrent_searches | Integer | The maximum number of concurrent searches. The default depends on your node count and search thread pool size. Higher values can improve performance, but risk overloading the cluster. | No
max_concurrent_shard_requests | Integer | Maximum number of concurrent shard requests that each search executes per node. Default is 5. Higher values can improve performance, but risk overloading the cluster. | No
pre_filter_shard_size | Integer | Default is 128. | No
Expand All @@ -81,10 +83,10 @@ Some options can't be applied as URL parameters to the entire request. Instead,

Option | Type | Description
:--- | :--- | :---
index | String, string array | If you don't specify an index or multiple indices as part of the URL (or want to override the URL value for an individual search), you can include it here. Examples include `"logs-*"` and `["my-store", "sample_data_ecommerce"]`.
index | String, string array | If you don't specify an index or multiple indexes as part of the URL (or want to override the URL value for an individual search), you can include it here. Examples include `"logs-*"` and `["my-store", "sample_data_ecommerce"]`.
preference | String | The nodes or shards that you'd like to perform the search. This setting can be useful for testing, but in most situations, the default behavior provides the best search latencies. Options include `_local`, `_only_local`, `_prefer_nodes`, `_only_nodes`, and `_shards`. These last three options accept a list of nodes or shards. Examples include `"_only_nodes:data-node1,data-node2"` and `"_shards:0,1`.
request_cache | Boolean | Whether to cache results, which can improve latency for repeat searches. Default is to use the `index.requests.cache.enable` setting for the index (which defaults to `true` for new indices).
routing | String | Comma-separated custom routing values (e.g. `"routing": "value1,value2,value3"`.
request_cache | Boolean | Whether to cache results, which can improve latency for repeat searches. Default is to use the `index.requests.cache.enable` setting for the index (which defaults to `true` for new indexes).
routing | String | Comma-separated custom routing values, for example, `"routing": "value1,value2,value3"`.


## Response
Expand Down
2 changes: 2 additions & 0 deletions _api-reference/remote-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Remote cluster information
nav_order: 67
redirect_from:
- /opensearch/rest-api/remote-info/
---

# Remote cluster information
Expand Down
9 changes: 3 additions & 6 deletions _install-and-configure/install-dashboards/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,14 @@ title: Installing OpenSearch Dashboards
nav_order: 3
has_children: true
redirect_from:
- /dashboards/install/
- /dashboards/install/index/
- /dashboards/compatibility/
- /install-and-configure/install-dashboards/index/
---

# Installing OpenSearch Dashboards

This section details how to install and configure OpenSearch Dashboards.

## Installation options

OpenSearch Dashboards has the following installation options:
OpenSearch Dashboards provides a fully integrated solution for visually exploring, discovering, and querying your observability data. You can install OpenSearch Dashboards with any of the following options:

- [Docker]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/docker/)
- [Tarball]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/tar/)
Expand Down
4 changes: 3 additions & 1 deletion _tools/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ nav_order: 50
has_children: false
nav_exclude: true
redirect_from:
- /clients/agents-and-ingestion-tools/
- /clients/agents-and-ingestion-tools/index/
---

# OpenSearch tools
Expand All @@ -16,6 +16,8 @@ This section provides documentation for OpenSearch-supported tools, including:
- [OpenSearch CLI](#opensearch-cli)
- [OpenSearch Kubernetes operator](#opensearch-kubernetes-operator)

For information about Data Prepper, the server-side data collector for filtering, enriching, transforming, normalizing, and aggregating data for downstream analytics and visualization, see [Data Prepper]({{site.url}}{{site.baseurl}}/ddata-prepper/index/).
hdhalter marked this conversation as resolved.
Show resolved Hide resolved

## 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.
Expand Down
2 changes: 1 addition & 1 deletion _upgrade-to/upgrade-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ If you are migrating an Open Distro for Elasticsearch cluster, we recommend firs

1. Port your settings from `elasticsearch.yml` to `opensearch.yml`. Most settings use the same names. At a minimum, specify `cluster.name`, `node.name`, `discovery.seed_hosts`, and `cluster.initial_cluster_manager_nodes`.

1. (Optional) If you're actively connecting to the cluster with legacy clients that check for a particular version number, such as Logstash OSS, add a [compatibility setting]({{site.url}}{{site.baseurl}}/clients/agents-and-ingestion-tools/) to `opensearch.yml`:
1. (Optional) If you're actively connecting to the cluster with legacy clients that check for a particular version number, such as Logstash OSS, add a [compatibility setting]({{site.url}}{{site.baseurl}}/https://opensearch.org/docs/2.7/tools/index/#compatibility-matrices/) to `opensearch.yml`:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link doesn't work for me. I built local to try it. (But the 404 page works!)

Copy link
Contributor Author

@hdhalter hdhalter May 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works for me locally. @Naarcha-AWS or @kolchfa-aws - do you mind testing this link? Thank you! **Never mind - it is broken. I'll fix!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the first prefix from the link (starting with https)


```yml
compatibility.override_main_response_version: true
Expand Down