[Bug] Fix broken cross-ref links in the docs (#1253)
* to fix broken cross-ref links Signed-off-by: alicejw <alicejw@amazon.com> * replace removed link Signed-off-by: alicejw <alicejw@amazon.com> Signed-off-by: alicejw <alicejw@amazon.com>
This commit is contained in:
parent
1b2121ef67
commit
282a26ebfe
|
@ -21,7 +21,7 @@ npm install -g @aws/opensearch-perftop
|
|||
|
||||
![PerfTop screenshot]({{site.url}}{{site.baseurl}}/images/perftop.png)
|
||||
|
||||
For enabling Performance Analyzer with tarball installations of OpenSearch, see [Configure Performance Analyzer for Tarball Installation](#configure-performance-analyzer-for-tarball-installation).
|
||||
For enabling Performance Analyzer with tarball installations of OpenSearch, see [Configure Performance Analyzer for Tarball Installation](#configure-performance-analyzer-for-tarball-installations).
|
||||
|
||||
## Get started with PerfTop
|
||||
|
||||
|
|
|
@ -11,5 +11,5 @@ has_children: true
|
|||
|
||||
OpenSearch has two installation options at this time: Docker images and tarballs.
|
||||
|
||||
OpenSearch does not support direct version downgrades. If your environment must be downgraded, we recommend [using snapshots to create a restore point](https://opensearch.org/docs/latest/opensearch/snapshot-restore/), then restoring the snapshot to a cluster built with the target version.
|
||||
OpenSearch does not support direct version downgrades. If your environment must be downgraded, we recommend using snapshots to create a restore point, then restoring the snapshot to a cluster built with the target version. To learn more about restore points, see [Restore snapshots]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore#restore-snapshots).
|
||||
{: .note }
|
|
@ -75,7 +75,7 @@ Before proceeding you should test your installation of OpenSearch. Otherwise, it
|
|||
1. **(Security enabled)** Apply a generic configuration using the demo security script included in the tar archive.
|
||||
1. **(Security disabled)** Manually disable the security plugin and test the instance before applying your own custom security settings.
|
||||
|
||||
The demo security script will apply a generic configuration to your instance of OpenSearch. This configuration defines some environment variables and also applies self-signed TLS certificates. If you would like to configure these yourself, see [Set up OpenSearch in your environment](#setup-opensearch-in-your-environment).
|
||||
The demo security script will apply a generic configuration to your instance of OpenSearch. This configuration defines some environment variables and also applies self-signed TLS certificates. If you would like to configure these yourself, see [Step 4: Set up OpenSearch in your environment](#step-4-set-up-opensearch-in-your-environment).
|
||||
|
||||
If you only want to verify that the service is properly configured and you intend to configure security settings yourself, then you may want to disable the security plugin and launch the service without encryption or authentication.
|
||||
|
||||
|
@ -455,7 +455,7 @@ $ curl https://your.host.address:9200 -u admin:yournewpassword -k
|
|||
## Related links
|
||||
|
||||
- [OpenSearch configuration]({{site.url}}{{site.baseurl}}/opensearch/configuration/)
|
||||
- [Configure Performance Analyzer for Tarball Installation]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/index/#configure-performance-analyzer-for-tarball-installation)
|
||||
- [Configure Performance Analyzer for Tarball Installation]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/index/#configure-performance-analyzer-for-tarball-installations)
|
||||
- [Install and configure OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/install/index/)
|
||||
- [OpenSearch plugin installation]({{site.url}}{{site.baseurl}}/opensearch/install/plugins/)
|
||||
- [About the security plugin]({{site.url}}{{site.baseurl}}/security-plugin/index/)
|
|
@ -473,10 +473,10 @@ Option | Valid values | Description
|
|||
`fields` | String array | The list of fields to search (e.g. `"fields": ["title^4", "description"]`). If unspecified, defaults to the `index.query.default_field` setting, which defaults to `["*"]`.
|
||||
`flags` | String | A `|`-delimited string of [flags](#simple-query-string) to enable (e.g., `AND|OR|NOT`). The default is `ALL`. You can explicitly set the value for `default_field`. For example, to return all titles, set it to `"default_field": "title"`.
|
||||
`lenient` | Boolean | Setting `lenient` to true lets you ignore data type mismatches between the query and the document field. For example, a query string of "8.2" could match a field of type `float`. The default is false.
|
||||
`low_freq_operator` | `and, or` | The operator for low-frequency terms. The default is `or`. See [Common terms](#common-terms) queries and `operator` in this table.
|
||||
`low_freq_operator` | `and, or` | The operator for low-frequency terms. The default is `or`. See also `operator` in this table.
|
||||
`max_determinized_states` | Positive integer | The maximum number of "[states](https://lucene.apache.org/core/8_9_0/core/org/apache/lucene/util/automaton/Operations.html#DEFAULT_MAX_DETERMINIZED_STATES)" (a measure of complexity) that Lucene can create for query strings that contain regular expressions (e.g. `"query": "/wind.+?/"`). Larger numbers allow for queries that use more memory. The default is 10,000.
|
||||
`max_expansions` | Positive integer | `max_expansions` specifies the maximum number of terms to which the query can expand. The default is 50.
|
||||
`minimum_should_match` | Positive or negative integer, positive or negative percentage, combination | If the query string contains multiple search terms and you used the `or` operator, the number of terms that need to match for the document to be considered a match. For example, if `minimum_should_match` is 2, "wind often rising" does not match "The Wind Rises." If `minimum_should_match` is 1, it matches. This option also has `low_freq` and `high_freq` properties for [Common terms](#common-terms) queries.
|
||||
`minimum_should_match` | Positive or negative integer, positive or negative percentage, combination | If the query string contains multiple search terms and you used the `or` operator, the number of terms that need to match for the document to be considered a match. For example, if `minimum_should_match` is 2, "wind often rising" does not match "The Wind Rises." If `minimum_should_match` is 1, it matches.
|
||||
`operator` | `or, and` | If the query string contains multiple search terms, whether all terms need to match (`and`) or only one term needs to match (`or`) for a document to be considered a match.
|
||||
`phrase_slop` | `0` (default) or a positive integer | See `slop`.
|
||||
`prefix_length` | `0` (default) or a positive integer | The number of leading characters that are not considered in fuzziness.
|
||||
|
|
|
@ -14,7 +14,7 @@ For additonal information about Painless scripting, see:
|
|||
|
||||
* [k-NN Painless Scripting extensions]({{site.url}}{{site.baseurl}}/search-plugins/knn/painless-functions/).
|
||||
|
||||
* [k-NN]({{site.url}}{{site.baseurl}}/search-plugins/knn/inswz/).
|
||||
* [k-NN]({{site.url}}{{site.baseurl}}/search-plugins/knn/index/).
|
||||
|
||||
|
||||
### Path parameters
|
||||
|
|
|
@ -12,7 +12,7 @@ Retrieves information about a snapshot repository.
|
|||
|
||||
To learn more about repositories, see [Register repository]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore#register-repository).
|
||||
|
||||
You can also get details about a snapshot during and after snapshot creation. See [Get snapshot status]({{site.url}}{{site.baseurl}}/opensearch/snapshots/get-snapshot-status).
|
||||
You can also get details about a snapshot during and after snapshot creation. See [Get snapshot status]({{site.url}}{{site.baseurl}}/opensearch/rest-api/snapshots/get-snapshot-status/).
|
||||
{: .note}
|
||||
|
||||
### Path parameters
|
||||
|
|
|
@ -14,9 +14,8 @@ Restores a snapshot of a cluster or specified data streams and indices.
|
|||
|
||||
* For information about data streams, see [Data streams]({{site.url}}{{site.baseurl}}/opensearch/data-streams).
|
||||
|
||||
If open indices with the same name that you want to restore already exist in the cluster, you must close, delete, or rename the indices. See [Sample Request](#sample-request-1) for information about renaming an index. See [Close index]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/close-index) for information about closing an index.
|
||||
If open indices with the same name that you want to restore already exist in the cluster, you must close, delete, or rename the indices. See [Sample Request](#sample-request) for information about renaming an index. See [Close index]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/close-index) for information about closing an index.
|
||||
{: .note}
|
||||
|
||||
### Path parameters
|
||||
|
||||
| Parameter | Data Type | Description |
|
||||
|
|
|
@ -87,7 +87,7 @@ Setting | Description
|
|||
sudo ./bin/opensearch-plugin install repository-s3
|
||||
```
|
||||
|
||||
If you're using the Docker installation, see [Customize the Docker image]({{site.url}}{{site.baseurl}}/opensearch/install/docker#customize-the-docker-image). Your `Dockerfile` should look something like this:
|
||||
If you're using the Docker installation, see [Install, configure or remove plugins]({{site.url}}{{site.baseurl}}/opensearch/install/docker#install-configure-or-remove-plugins). Your `Dockerfile` should look something like this:
|
||||
|
||||
```
|
||||
FROM opensearchproject/opensearch:{{site.opensearch_version}}
|
||||
|
|
|
@ -39,7 +39,7 @@ These methods are described in the following sections.
|
|||
Prefix matching finds documents that matches the last term in the query string.
|
||||
|
||||
For example, assume that the user types “qui” into a search UI. To autocomplete this phrase, use the `match_phrase_prefix` query to search all `text_entry` fields that begin with the prefix "qui."
|
||||
To make the word order and relative positions flexible, specify a `slop` value. To learn about the `slop` option, see [Options]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/full-text#options).
|
||||
To make the word order and relative positions flexible, specify a `slop` value. To learn about the `slop` option, see [Other optional query fields]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/full-text#other-optional-query-fields).
|
||||
|
||||
#### Sample Request
|
||||
|
||||
|
|
|
@ -48,7 +48,7 @@ Querqy is currently only compatible with OpenSearch 1.3.1
|
|||
/path/to/file/querqy-opensearch-main/build/distributions/opensearch-querqy-1.3.1.0.zip`
|
||||
```
|
||||
|
||||
1. The compiled Querqy plugin is installed the same as [any OpenSearch plugin](https://opensearch.org/docs/latest/opensearch/install/plugins/#install-a-plugin):
|
||||
1. The compiled Querqy plugin is installed the same as [any OpenSearch plugin](https://opensearch.org/docs/latest/opensearch/install/plugins/#install):
|
||||
|
||||
```bash
|
||||
/path/to/opensearch/bin/opensearch-plugin install file:///path/to/file/opensearch-querqy-1.3.1.0.zip
|
||||
|
|
|
@ -18,7 +18,7 @@ A more permanent option is to remove the security plugin entirely:
|
|||
1. Delete the `plugins/opensearch-security` folder on all nodes.
|
||||
1. Delete all `plugins.security.*` configuration entries from `opensearch.yml`.
|
||||
|
||||
To perform these steps on the Docker image, see [Customize the Docker image]({{site.url}}{{site.baseurl}}/opensearch/install/docker#customize-the-docker-image).
|
||||
To perform these steps on the Docker image, see [Install, configure or remove plugins]({{site.url}}{{site.baseurl}}/opensearch/install/docker#install-configure-or-remove-plugins).
|
||||
|
||||
Disabling or removing the plugin exposes the configuration index for the security plugin. If the index contains sensitive information, be sure to protect it through some other means. If you no longer need the index, delete it.
|
||||
{: .warning }
|
||||
|
|
Loading…
Reference in New Issue