diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md index 2508fce675..152584dd57 100644 --- a/_api-reference/cat/cat-cluster_manager.md +++ b/_api-reference/cat/cat-cluster_manager.md @@ -2,7 +2,8 @@ layout: default title: CAT cluster manager parent: CAT API - +redirect_from: + - /opensearch/rest-api/cat/cat-master/ nav_order: 30 has_children: false --- diff --git a/_api-reference/document-apis/index-document.md b/_api-reference/document-apis/index-document.md index 90247c4dd8..5d44122430 100644 --- a/_api-reference/document-apis/index-document.md +++ b/_api-reference/document-apis/index-document.md @@ -4,7 +4,7 @@ title: Index document parent: Document APIs nav_order: 1 redirect_from: - - /opensearch/rest-api/document-apis/index-document + - /opensearch/rest-api/document-apis/index-document/ --- # Index document diff --git a/_api-reference/document-apis/multi-get.md b/_api-reference/document-apis/multi-get.md index cde566d7c7..5ca557c661 100644 --- a/_api-reference/document-apis/multi-get.md +++ b/_api-reference/document-apis/multi-get.md @@ -4,14 +4,14 @@ title: Multi-get document parent: Document APIs nav_order: 30 redirect_from: - - /opensearch/rest-api/document-apis/mulit-get/ + - /opensearch/rest-api/document-apis/multi-get/ --- # Multi-get documents Introduced 1.0 {: .label .label-purple } -The multi-get operation allows you to execute multiple GET operations in one request, so you can get back all documents that match your criteria. +The multi-get operation allows you to run multiple GET operations in one request, so you can get back all documents that match your criteria. ## Example without specifying index in URL diff --git a/_api-reference/document-apis/reindex.md b/_api-reference/document-apis/reindex.md index 29735c05e9..845042f3f6 100644 --- a/_api-reference/document-apis/reindex.md +++ b/_api-reference/document-apis/reindex.md @@ -4,7 +4,8 @@ title: Reindex document parent: Document APIs nav_order: 60 redirect_from: - - /opensearch/reindex-data/ + - /opensearch/reindex-data/ + - /opensearch/rest-api/document-apis/reindex/ --- # Reindex document diff --git a/_api-reference/index-apis/put-mapping.md b/_api-reference/index-apis/put-mapping.md index 55ba0f80d8..2ce82d6b14 100644 --- a/_api-reference/index-apis/put-mapping.md +++ b/_api-reference/index-apis/put-mapping.md @@ -5,6 +5,7 @@ parent: Index APIs nav_order: 27 redirect_from: - /opensearch/rest-api/index-apis/update-mapping/ + - /opensearch/rest-api/update-mapping/ --- # Create or update mappings diff --git a/_im-plugin/ism/managedindexes.md b/_im-plugin/ism/managedindexes.md index 91fcca3c74..8de7a3e981 100644 --- a/_im-plugin/ism/managedindexes.md +++ b/_im-plugin/ism/managedindexes.md @@ -4,6 +4,8 @@ title: Managed indexes nav_order: 3 parent: Index State Management has_children: false +redirect_from: + - /im-plugin/ism/managedindices/ --- # Managed indexes diff --git a/_install-and-configure/configuration.md b/_install-and-configure/configuration.md index 1c4bbf151c..3ec7caafd0 100755 --- a/_install-and-configure/configuration.md +++ b/_install-and-configure/configuration.md @@ -4,6 +4,7 @@ title: Configuring OpenSearch nav_order: 10 redirect_from: - /install-and-configure/configuration/ + - /opensearch/configuration/ --- # Configuring OpenSearch diff --git a/_install-and-configure/install-dashboards/plugins.md b/_install-and-configure/install-dashboards/plugins.md index e128609eb5..f937940cb2 100644 --- a/_install-and-configure/install-dashboards/plugins.md +++ b/_install-and-configure/install-dashboards/plugins.md @@ -3,7 +3,7 @@ layout: default title: Managing OpenSearch Dashboards plugins nav_order: 100 redirect_from: - - /dashboards/install/plugins + - /dashboards/install/plugins/ - /install-and-configure/install-dashboards/plugins/ --- @@ -149,7 +149,7 @@ sudo bin/opensearch-dashboards-plugin remove 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: +For certain plugins, you must also remove the "optimize" bundle. This is a sample command for the Anomaly Detection plugin: ```bash sudo rm /usr/share/opensearch-dashboards/optimize/bundles/opensearch-anomaly-detection-opensearch-dashboards.* @@ -181,7 +181,7 @@ OpenSearch Dashboards doesn’t update plugins. Instead, you have to remove the 1. Restart OpenSearch Dashboards. -For example, to remove and reinstall the anomaly detection plugin: +For example, to remove and reinstall the Anomaly Detection plugin: ```bash sudo bin/opensearch-plugin remove opensearch-anomaly-detection diff --git a/_observing-your-data/notebooks.md b/_observing-your-data/notebooks.md index 8d4c059c9c..a6b824706d 100644 --- a/_observing-your-data/notebooks.md +++ b/_observing-your-data/notebooks.md @@ -3,7 +3,7 @@ layout: default title: Notebooks nav_order: 50 redirect_from: - - /notebooks/ + - /dashboards/notebooks/ - /observability-plugin/notebooks/ has_children: false --- diff --git a/_observing-your-data/trace/getting-started.md b/_observing-your-data/trace/getting-started.md index 4fb0bec42c..55ffc1ddc7 100644 --- a/_observing-your-data/trace/getting-started.md +++ b/_observing-your-data/trace/getting-started.md @@ -5,6 +5,7 @@ parent: Trace Analytics nav_order: 1 redirect_from: - /observability-plugin/trace/get-started/ + - /monitoring-plugins/trace/get-started/ --- # Getting started with Trace Analytics diff --git a/_observing-your-data/trace/index.md b/_observing-your-data/trace/index.md index c966eb7312..e6077a0083 100644 --- a/_observing-your-data/trace/index.md +++ b/_observing-your-data/trace/index.md @@ -6,6 +6,7 @@ has_children: true has_toc: false redirect_from: - /observability-plugin/trace/index/ + - /monitoring-plugins/trace/index/ --- # Trace Analytics diff --git a/_observing-your-data/trace/ta-dashboards.md b/_observing-your-data/trace/ta-dashboards.md index d4b3ee5812..3186093bcc 100644 --- a/_observing-your-data/trace/ta-dashboards.md +++ b/_observing-your-data/trace/ta-dashboards.md @@ -5,6 +5,7 @@ parent: Trace Analytics nav_order: 50 redirect_from: - /observability-plugin/trace/ta-dashboards/ + - /monitoring-plugins/trace/ta-dashboards/ --- # Trace Analytics OpenSearch Dashboards plugin @@ -15,7 +16,7 @@ The **Dashboard** view groups traces together by HTTP method and path so that yo ![Dashboard view]({{site.url}}{{site.baseurl}}/images/ta-dashboard.png) -To drill down on the traces that make up a trace group, choose the number of traces in righthand column. Then choose an individual trace for a detailed summary. +To drill down on the traces that make up a trace group, choose the number of traces in the column on the right. Then choose an individual trace for a detailed summary. ![Detailed trace view]({{site.url}}{{site.baseurl}}/images/ta-trace.png) diff --git a/_query-dsl/aggregations/pipeline-agg.md b/_query-dsl/aggregations/pipeline-agg.md index ed3c7e097e..1803b8d647 100644 --- a/_query-dsl/aggregations/pipeline-agg.md +++ b/_query-dsl/aggregations/pipeline-agg.md @@ -5,6 +5,8 @@ parent: Aggregations nav_order: 5 permalink: /aggregations/pipeline-agg/ has_children: false +redirect_from: + - /opensearch/pipeline-agg/ --- # Pipeline aggregations diff --git a/_search-plugins/index.md b/_search-plugins/index.md index f98b0f7243..4294ff707b 100644 --- a/_search-plugins/index.md +++ b/_search-plugins/index.md @@ -11,7 +11,7 @@ nav_exclude: true OpenSearch provides several features for customizing your search use cases and improving search relevance. In OpenSearch, you can: -- Use [SQL and Piped Processing Language (PPL)]({{site.url}}{{site.baseurl}}/search-plugins/sql/) as alternatives to [query domain-specific language (DSL)]({{site.url}}{{site.baseurl}}/query-dsl/) to search data. +- Use [SQL and Piped Processing Language (PPL)]({{site.url}}{{site.baseurl}}/search-plugins/sql/index/) as alternatives to [query domain-specific language (DSL)]({{site.url}}{{site.baseurl}}/query-dsl/) to search data. - Run resource-intensive queries asynchronously with [asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/). @@ -25,6 +25,6 @@ OpenSearch provides several features for customizing your search use cases and i - Use a dataset that is fixed in time to paginate results with [Point in Time]({{site.url}}{{site.baseurl}}/search-plugins/point-in-time/). -- [Paginate]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/paginate) and [sort]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/sort/) search results, [highlight]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/highlight/) search terms, and use the [autocomplete]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/autocomplete/) and [did-you-mean]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/did-you-mean/) functionality. +- [Paginate]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/paginate/) and [sort]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/sort/) search results, [highlight]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/highlight/) search terms, and use the [autocomplete]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/autocomplete/) and [did-you-mean]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/did-you-mean/) functionality. -- Rewrite queries with [Querqy]({{site.url}}{{site.baseurl}}/search-plugins/querqy). +- Rewrite queries with [Querqy]({{site.url}}{{site.baseurl}}/search-plugins/querqy/). diff --git a/_search-plugins/knn/jni-libraries.md b/_search-plugins/knn/jni-libraries.md index 25d1556908..01cdb89041 100644 --- a/_search-plugins/knn/jni-libraries.md +++ b/_search-plugins/knn/jni-libraries.md @@ -4,6 +4,8 @@ title: JNI libraries nav_order: 35 parent: k-NN has_children: false +redirect_from: + - /search-plugins/knn/jni-library/ --- # JNI libraries diff --git a/_search-plugins/sql/cli.md b/_search-plugins/sql/cli.md index f4f8e52a3d..8534e5640e 100644 --- a/_search-plugins/sql/cli.md +++ b/_search-plugins/sql/cli.md @@ -3,6 +3,8 @@ layout: default title: SQL and PPL CLI parent: SQL and PPL nav_order: 3 +redirect_from: + - /search-plugins/sql/cli/ --- # SQL and PPL CLI diff --git a/_search-plugins/sql/index.md b/_search-plugins/sql/index.md index 852ab65578..2d4c98f00d 100644 --- a/_search-plugins/sql/index.md +++ b/_search-plugins/sql/index.md @@ -5,7 +5,7 @@ nav_order: 38 has_children: true has_toc: false redirect_from: - - /search-plugins/sql/ + - /search-plugins/sql/index/ --- # SQL and PPL diff --git a/_search-plugins/sql/ppl/index.md b/_search-plugins/sql/ppl/index.md index 87a43454a6..a0a45414a0 100644 --- a/_search-plugins/sql/ppl/index.md +++ b/_search-plugins/sql/ppl/index.md @@ -10,6 +10,8 @@ redirect_from: - /search-plugins/ppl/ - /observability-plugin/ppl/ - /search-plugins/ppl/index/ + - /search-plugins/ppl/endpoint/ + - /search-plugins/ppl/protocol/ --- # PPL – Piped Processing Language diff --git a/_search-plugins/sql/settings.md b/_search-plugins/sql/settings.md index 6954e74406..73f5e42a59 100644 --- a/_search-plugins/sql/settings.md +++ b/_search-plugins/sql/settings.md @@ -7,7 +7,7 @@ redirect_from: - /search-plugins/sql/settings/ --- -# Settings +# SQL settings The SQL plugin adds a few settings to the standard OpenSearch cluster settings. Most are dynamic, so you can change the default behavior of the plugin without restarting your cluster. @@ -75,6 +75,6 @@ Setting | Default | Description `plugins.sql.enabled` | True | Change to `false` to disable the `SQL` support in the plugin. `plugins.ppl.enabled` | True | Change to `false` to disable the `PPL` support in the plugin. `plugins.sql.slowlog` | 2 seconds | Configures the time limit (in seconds) for slow queries. The plugin logs slow queries as `Slow query: elapsed=xxx (ms)` in `opensearch.log`. -`plugins.sql.cursor.keep_alive` | 1 minute | Configures how long the cursor context is kept open. Cursor contexts are resource resource intensive, so we recommend a low value. +`plugins.sql.cursor.keep_alive` | 1 minute | Configures how long the cursor context is kept open. Cursor contexts are resource-intensive, so we recommend a low value. `plugins.query.memory_limit` | 85% | Configures the heap memory usage limit for the circuit breaker of the query engine. `plugins.query.size_limit` | 200 | Sets the default size of index that the query engine fetches from OpenSearch. diff --git a/_security/access-control/cross-cluster-search.md b/_security/access-control/cross-cluster-search.md index c2159d5c1f..182803da5d 100644 --- a/_security/access-control/cross-cluster-search.md +++ b/_security/access-control/cross-cluster-search.md @@ -5,6 +5,7 @@ parent: Access control nav_order: 105 redirect_from: - /security/access-control/cross-cluster-search/ + - /security-plugin/access-control/cross-cluster-search/ --- # Cross-cluster search diff --git a/_security/access-control/default-action-groups.md b/_security/access-control/default-action-groups.md index 89c17a678a..79dd39baa1 100644 --- a/_security/access-control/default-action-groups.md +++ b/_security/access-control/default-action-groups.md @@ -5,6 +5,7 @@ parent: Access control nav_order: 115 redirect_from: - /security/access-control/default-action-groups/ + - /security-plugin/access-control/default-action-groups/ --- # Default action groups diff --git a/_security/access-control/document-level-security.md b/_security/access-control/document-level-security.md index e768f7be5e..edfb52bf39 100644 --- a/_security/access-control/document-level-security.md +++ b/_security/access-control/document-level-security.md @@ -5,6 +5,7 @@ parent: Access control nav_order: 85 redirect_from: - /security/access-control/document-level-security/ + - /security-plugin/access-control/document-level-security/ --- # Document-level security (DLS) diff --git a/_security/access-control/field-level-security.md b/_security/access-control/field-level-security.md index 3a685d9072..24b1f3744f 100644 --- a/_security/access-control/field-level-security.md +++ b/_security/access-control/field-level-security.md @@ -5,6 +5,7 @@ parent: Access control nav_order: 90 redirect_from: - /security/access-control/field-level-security/ + - /security-plugin/access-control/field-level-security/ --- # Field-level security diff --git a/_security/access-control/field-masking.md b/_security/access-control/field-masking.md index b9f938f9f8..0fc4213806 100644 --- a/_security/access-control/field-masking.md +++ b/_security/access-control/field-masking.md @@ -5,6 +5,7 @@ parent: Access control nav_order: 95 redirect_from: - /security/access-control/field-masking/ + - /security-plugin/access-control/field-masking/ --- # Field masking diff --git a/_security/access-control/impersonation.md b/_security/access-control/impersonation.md index eb8840b7dd..3333e9824e 100644 --- a/_security/access-control/impersonation.md +++ b/_security/access-control/impersonation.md @@ -5,6 +5,7 @@ parent: Access control nav_order: 100 redirect_from: - /security/access-control/impersonation/ + - /security-plugin/access-control/impersonation/ --- # User impersonation diff --git a/_security/access-control/users-roles.md b/_security/access-control/users-roles.md index 5c75345dda..8b5015575b 100644 --- a/_security/access-control/users-roles.md +++ b/_security/access-control/users-roles.md @@ -5,6 +5,7 @@ parent: Access control nav_order: 80 redirect_from: - /security/access-control/users-roles/ + - /security-plugin/access-control/users-roles/ --- # Users and roles diff --git a/_security/audit-logs/field-reference.md b/_security/audit-logs/field-reference.md index e2c4c55d37..dee0baf4d5 100644 --- a/_security/audit-logs/field-reference.md +++ b/_security/audit-logs/field-reference.md @@ -5,6 +5,7 @@ parent: Audit logs nav_order: 130 redirect_from: - /security/audit-logs/field-reference/ + - /security-plugin/audit-logs/field-reference/ --- # Audit log field reference diff --git a/_security/audit-logs/index.md b/_security/audit-logs/index.md index c42a7edc78..aea8015a06 100644 --- a/_security/audit-logs/index.md +++ b/_security/audit-logs/index.md @@ -6,6 +6,7 @@ has_children: true has_toc: false redirect_from: - /security/audit-logs/index/ + - /security-plugin/audit-logs/index/ --- # Audit logs diff --git a/_security/audit-logs/storage-types.md b/_security/audit-logs/storage-types.md index 084217850a..7fa4f549bd 100644 --- a/_security/audit-logs/storage-types.md +++ b/_security/audit-logs/storage-types.md @@ -5,6 +5,7 @@ parent: Audit logs nav_order: 135 redirect_from: - /security/audit-logs/storage-types/ + - /security-plugin/audit-logs/storage-types/ --- # Audit log storage types diff --git a/_security/configuration/configuration.md b/_security/configuration/configuration.md index 69fb1ca1b6..e77f142604 100755 --- a/_security/configuration/configuration.md +++ b/_security/configuration/configuration.md @@ -3,6 +3,8 @@ layout: default title: Configuring the Security backend parent: Configuration nav_order: 5 +redirect_from: + - /security-plugin/configuration/configuration/ --- # Configuring the Security backend diff --git a/_security/configuration/system-indices.md b/_security/configuration/system-indices.md index 4e4bad6107..49183be5cd 100644 --- a/_security/configuration/system-indices.md +++ b/_security/configuration/system-indices.md @@ -3,6 +3,8 @@ layout: default title: System indexes parent: Configuration nav_order: 4 +redirect_from: + - /security-plugin/configuration/system-indices/ --- # System indexes diff --git a/_tools/logstash/advanced-config.md b/_tools/logstash/advanced-config.md index e3c8714e4a..1016211ae7 100644 --- a/_tools/logstash/advanced-config.md +++ b/_tools/logstash/advanced-config.md @@ -3,6 +3,8 @@ layout: default title: Advanced configurations parent: Logstash nav_order: 230 +redirect_from: + - /clients/logstash/advanced-config/ --- # Advanced configurations @@ -89,7 +91,7 @@ if EXPR { } ``` -`EXPR` is any valid Logstash syntax that evaluates to a boolean value. +`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 @@ -126,7 +128,7 @@ if [some_field] in ["one", "two", "three"] { } ``` -You can use boolean operators: +You can use Boolean operators: ```yml if [type] == "access" or [type] == "error" { @@ -235,7 +237,7 @@ geoip { Start Logstash and send an HTTP request. -Within the terminal, you see a new field named `geoip` that contains information such as the time zone, country, continent, city, postal code, and the latitude / longitude pair. +Within the terminal, you see a new field named `geoip` that contains information such as the time zone, 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. diff --git a/_tools/logstash/common-filters.md b/_tools/logstash/common-filters.md index 193c97633d..4cfc2b6703 100644 --- a/_tools/logstash/common-filters.md +++ b/_tools/logstash/common-filters.md @@ -3,6 +3,8 @@ layout: default title: Common filter plugins parent: Logstash nav_order: 220 +redirect_from: + - /clients/logstash/common-filters/ --- # Common filter plugins diff --git a/_tools/logstash/execution-model.md b/_tools/logstash/execution-model.md index d206a475ac..f3d4a89928 100644 --- a/_tools/logstash/execution-model.md +++ b/_tools/logstash/execution-model.md @@ -3,6 +3,8 @@ layout: default title: Logstash execution model parent: Logstash nav_order: 210 +redirect_from: + - /clients/logstash/execution-model/ --- # Logstash execution model @@ -19,7 +21,7 @@ After receiving an event and possibly applying an input codec, Logstash sends th 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. +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 run 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. diff --git a/_tools/logstash/read-from-opensearch.md b/_tools/logstash/read-from-opensearch.md index 883a1e87ee..4b0d322200 100644 --- a/_tools/logstash/read-from-opensearch.md +++ b/_tools/logstash/read-from-opensearch.md @@ -3,6 +3,8 @@ layout: default title: Read from OpenSearch parent: Logstash nav_order: 220 +redirect_from: + - /clients/logstash/ship-to-opensearch/ --- # Read from OpenSearch diff --git a/_tools/logstash/ship-to-opensearch.md b/_tools/logstash/ship-to-opensearch.md index 2728ee98dd..e56163c288 100644 --- a/_tools/logstash/ship-to-opensearch.md +++ b/_tools/logstash/ship-to-opensearch.md @@ -3,6 +3,8 @@ layout: default title: Ship events to OpenSearch parent: Logstash nav_order: 220 +redirect_from: + - /clients/logstash/ship-to-opensearch/ --- # Ship events to OpenSearch diff --git a/index.md b/index.md index 6091e8c7ea..0f4b0560c8 100755 --- a/index.md +++ b/index.md @@ -49,7 +49,7 @@ OpenSearch has several features and plugins to help index, secure, monitor, and - [Anomaly detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/) - Identify atypical data and receive automatic notifications - [KNN]({{site.url}}{{site.baseurl}}/search-plugins/knn/) - Find “nearest neighbors” in your vector data - [Performance Analyzer]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/) - Monitor and optimize your cluster -- [SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/) - Use SQL or a piped processing language to query your data +- [SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/index/) - Use SQL or a piped processing language to query your data - [Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/) - Automate index operations - [ML Commons plugin]({{site.url}}{{site.baseurl}}/ml-commons-plugin/index/) - Train and execute machine-learning models - [Asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/) - Run search requests in the background