Skip to content

Commit

Permalink
Merge branch 'opensearch-project:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
stephen-crawford authored Nov 1, 2023
2 parents 7210c0a + 88d06e1 commit 2b55e85
Show file tree
Hide file tree
Showing 297 changed files with 8,487 additions and 2,453 deletions.
1 change: 1 addition & 0 deletions .github/vale/styles/OpenSearch/AcronymParentheses.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ exceptions:
- BM25
- CSV
- CPU
- CRUD
- DNS
- DOS
- FAQ
Expand Down
1 change: 1 addition & 0 deletions .github/vale/styles/OpenSearch/SubstitutionsError.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,5 @@ swap:
'U.S.': US
'web page': webpage
'web site': website
'whitespace': white space
'user interface \(UI\)': UI
2 changes: 2 additions & 0 deletions .github/vale/styles/Vocab/OpenSearch/Words/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[Bb]ackporting
[Bb]ackpressure
[Bb]asemap
[Bb]enchmarked
[Bb]igram
Boolean
[Cc]allout
Expand Down Expand Up @@ -64,6 +65,7 @@ Levenshtein
[Mm]isorder
[Mm]ultifield
[Mm]ultiline
[Mm]ultimodal
[Mm]ultipoint
[Mm]ultipolygon
[Mm]ultithreaded
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ The following resources provide important guidance regarding contributions to th

If you encounter problems or have questions when contributing to the documentation, these people can help:

- [cwillum](https://github.com/cwillum)
- [hdhalter](https://github.com/hdhalter)
- [kolchfa-aws](https://github.com/kolchfa-aws)
- [Naarcha-AWS](https://github.com/Naarcha-AWS)
Expand Down
1 change: 1 addition & 0 deletions STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ The following table lists acronyms that you don't need to spell out.
| BASIC | Beginner's All-Purpose Symbolic Instruction Code |
| BM25 | Best Match 25 |
| CPU | central processing unit |
| CRUD | create, read, update, and delete |
| CSV | comma-separated values |
| DNS | Domain Name System |
| DOS | disk operating system |
Expand Down
8 changes: 8 additions & 0 deletions TERMS.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,8 @@ Use data is, not data are. Don’t use datas. Use pieces of data or equivalent t

**dataset**

**data source**

**data store, datastore**

Two words when used generically, but one word when referring to the VMware product.
Expand Down Expand Up @@ -391,6 +393,8 @@ Use *just* in the sense of *just now* (as in "the resources that you just create

## K

**key store**

**kill**

Do not use. Replace with *stop*, *end*, *clear*, *remove*, or *cancel*.
Expand Down Expand Up @@ -704,6 +708,8 @@ Data that's provided as part of a metric. The time value is assumed to be when t

Avoid using as a verb to refer to an action that precipitates a subsequent action. It is OK to use when referring to a feature name, such as a *trigger function* or *time-triggered architecture*. As a verb, use an alternative, such as *initiate*, *invoke*, *launch*, or *start*.

**trust store**

**turn on, turn off**

Use *turn on* and *turn off* in reference to a toggle to describe switching a setting or mode on or off.
Expand Down Expand Up @@ -768,6 +774,8 @@ Do not use. Use *open day* instead.

Do not use. Use *allow list* instead.

**white space**

**wish, want, desire, need**

_Wish_ and _desire_ are indirect and nuanced versions of _want_. Don’t use them. Be direct.
Expand Down
4 changes: 2 additions & 2 deletions _analyzers/token-filters/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Token filter | Underlying Lucene token filter| Description
`fingerprint` | [FingerprintFilter](https://lucene.apache.org/core/8_7_0/analyzers-common/org/apache/lucene/analysis/miscellaneous/FingerprintFilter.html) | Sorts and deduplicates the token list and concatenates tokens into a single token.
`flatten_graph` | [FlattenGraphFilter](https://lucene.apache.org/core/8_7_0/analyzers-common/org/apache/lucene/analysis/core/FlattenGraphFilter.html) | Flattens a token graph produced by a graph token filter, such as `synonym_graph` or `word_delimiter_graph`, making the graph suitable for indexing.
`hunspell` | [HunspellStemFilter](https://lucene.apache.org/core/8_7_0/analyzers-common/org/apache/lucene/analysis/hunspell/HunspellStemFilter.html) | Uses [Hunspell](https://en.wikipedia.org/wiki/Hunspell) rules to stem tokens. Because Hunspell supports a word having multiple stems, this filter can emit multiple tokens for each consumed token. Requires you to configure one or more language-specific Hunspell dictionaries.
`hyphenation_decompounder` | [HyphenationCompoundWordTokenFilter](https://lucene.apache.org/core/8_7_0/analyzers-common/org/apache/lucene/analysis/compound/HyphenationCompoundWordTokenFilter.html) | Uses XML-based hyphenation patterns to find potential subwords in compound words and checks the subwords against the specified word list. The token output contains only the subwords found in the word list.
`hyphenation_decompounder` | [HyphenationCompoundWordTokenFilter](https://lucene.apache.org/core/9_8_0/analysis/common/org/apache/lucene/analysis/compound/HyphenationCompoundWordTokenFilter.html) | Uses XML-based hyphenation patterns to find potential subwords in compound words and checks the subwords against the specified word list. The token output contains only the subwords found in the word list.
`keep_types` | [TypeTokenFilter](https://lucene.apache.org/core/8_7_0/analyzers-common/org/apache/lucene/analysis/core/TypeTokenFilter.html) | Keeps or removes tokens of a specific type.
`keep_word` | [KeepWordFilter](https://lucene.apache.org/core/8_7_0/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeepWordFilter.html) | Checks the tokens against the specified word list and keeps only those that are in the list.
`keyword_marker` | [KeywordMarkerFilter](https://lucene.apache.org/core/8_7_0/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordMarkerFilter.html) | Marks specified tokens as keywords, preventing them from being stemmed.
Expand Down Expand Up @@ -61,4 +61,4 @@ Normalization | `arabic_normalization`: [ArabicNormalizer](https://lucene.apache
`unique` | N/A | Ensures each token is unique by removing duplicate tokens from a stream.
`uppercase` | [UpperCaseFilter](https://lucene.apache.org/core/8_7_0/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html) | Converts tokens to uppercase.
`word_delimiter` | [WordDelimiterFilter](https://lucene.apache.org/core/8_7_0/analyzers-common/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.html) | Splits tokens at non-alphanumeric characters and performs normalization based on the specified rules.
`word_delimiter_graph` | [WordDelimiterGraphFilter](https://lucene.apache.org/core/8_7_0/analyzers-common/org/apache/lucene/analysis/miscellaneous/WordDelimiterGraphFilter.html) | Splits tokens at non-alphanumeric characters and performs normalization based on the specified rules. Assigns multi-position tokens a `positionLength` attribute.
`word_delimiter_graph` | [WordDelimiterGraphFilter](https://lucene.apache.org/core/8_7_0/analyzers-common/org/apache/lucene/analysis/miscellaneous/WordDelimiterGraphFilter.html) | Splits tokens at non-alphanumeric characters and performs normalization based on the specified rules. Assigns multi-position tokens a `positionLength` attribute.
2 changes: 2 additions & 0 deletions _api-reference/analyze-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ redirect_from:
---

# Analyze API
**Introduced 1.0**
{: .label .label-purple }

The Analyze API allows you to perform [text analysis]({{site.url}}{{site.baseurl}}/api-reference/analyze-apis/), which is the process of converting unstructured text into individual tokens (usually words) that are optimized for search.

Expand Down
4 changes: 2 additions & 2 deletions _api-reference/cat/cat-aliases.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ has_children: false
---

# CAT aliases
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT aliases operation lists the mapping of aliases to indexes, plus routing and filtering information.
Expand Down Expand Up @@ -53,7 +53,7 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe
Parameter | Type | Description
:--- | :--- | :---
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
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-allocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ has_children: false
---

# CAT allocation
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT allocation operation lists the allocation of disk space for indexes and the number of shards on each node.
Expand Down
3 changes: 2 additions & 1 deletion _api-reference/cat/cat-cluster_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ has_children: false
---

# CAT cluster_manager
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT cluster manager operation lists information that helps identify the elected cluster manager node.
Expand All @@ -36,6 +36,7 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe
Parameter | Type | Description
:--- | :--- | :---
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.

## Response

```json
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-count.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ redirect_from:
---

# CAT count
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT count operation lists the number of documents in your cluster.
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-field-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ redirect_from:
---

# CAT fielddata
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT fielddata operation lists the memory size used by each field per node.
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-health.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ redirect_from:
---

# CAT health
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT health operation lists the status of the cluster, how long the cluster has been up, the number of nodes, and other useful information that helps you analyze the health of your cluster.
Expand Down
6 changes: 3 additions & 3 deletions _api-reference/cat/cat-indices.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ redirect_from:
---

# CAT indices
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT indices operation lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.
The CAT indexes operation lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.

## Example

Expand Down Expand Up @@ -44,7 +44,7 @@ GET _cat/indices

## URL parameters

All CAT indices URL parameters are optional.
All CAT indexes URL parameters are optional.

In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:

Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-nodeattrs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ redirect_from:
---

# CAT nodeattrs
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT nodeattrs operation lists the attributes of custom nodes.
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ redirect_from:
---

# CAT nodes
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT nodes operation lists node-level information, including node roles and load metrics.
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-pending-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ redirect_from:
---

# CAT pending tasks
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT pending tasks operation lists the progress of all pending tasks, including task priority and time in queue.
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ redirect_from:
---

# CAT plugins
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT plugins operation lists the names, components, and versions of the installed plugins.
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 @@ -10,7 +10,7 @@ redirect_from:
---

# CAT recovery
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT recovery operation lists all completed and ongoing index and shard recoveries.
Expand Down
4 changes: 2 additions & 2 deletions _api-reference/cat/cat-repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ redirect_from:
---

# CAT repositories
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT repositories operation lists all completed and ongoing index and shard recoveries.
The CAT repositories operation lists all snapshot repositories for a cluster.

## Example

Expand Down
4 changes: 2 additions & 2 deletions _api-reference/cat/cat-segment-replication.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ has_children: false
---

# CAT segment replication
Introduced 2.7
**Introduced 2.7**
{: .label .label-purple }

The CAT segment replication operation returns information about active and last completed [segment replication]({{site.url}}{{site.baseurl}}/opensearch/segment-replication/index) events on each replica shard, including related shard-level metrics. These metrics provide information about how far behind the primary shard the replicas are lagging.
Expand Down Expand Up @@ -47,7 +47,7 @@ Parameter | Data type | Description
`v` | Boolean | If `true`, the response includes column headings. Defaults to `false`.
`s` | String | Specifies to sort the results. For example, `s=shardId:desc` sorts by shardId in descending order.

## Examples
## Example

The following examples illustrate various segment replication responses.

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 @@ -10,7 +10,7 @@ redirect_from:
---

# CAT segments
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The cat segments operation lists Lucene segment-level information for each index.
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 @@ -10,7 +10,7 @@ redirect_from:
---

# CAT shards
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT shards operation lists the state of all primary and replica shards and how they are distributed.
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ redirect_from:
---

# CAT snapshots
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT snapshots operation lists all snapshots for a repository.
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ redirect_from:
---

# CAT tasks
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT tasks operation lists the progress of all tasks currently running on your cluster.
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ redirect_from:
---

# CAT templates
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT templates operation lists the names, patterns, order numbers, and version numbers of index templates.
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cat/cat-thread-pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ redirect_from:
---

# CAT thread pool
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The CAT thread pool operation lists the active, queued, and rejected threads of different thread pools on each node.
Expand Down
3 changes: 2 additions & 1 deletion _api-reference/cat/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ redirect_from:
---

# CAT API

**Introduced 1.0**
{: .label .label-purple }
You can get essential statistics about your cluster in an easy-to-understand, tabular format using the compact and aligned text (CAT) API. The CAT API is a human-readable interface that returns plain text instead of traditional JSON.

Using the CAT API, you can answer questions like which node is the elected master, what state is the cluster in, how many documents are in each index, and so on.
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/cluster-api/cluster-allocation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ redirect_from:
---

# Cluster allocation explain
Introduced 1.0
**Introduced 1.0**
{: .label .label-purple }

The most basic cluster allocation explain request finds an unassigned shard and explains why it can't be allocated to a node.
Expand Down
Loading

0 comments on commit 2b55e85

Please sign in to comment.