From e119a9379810cedfe7fa65bc4ef256ca0d3f9cc2 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Wed, 8 Mar 2023 09:53:21 -0600 Subject: [PATCH] Index and OpenSearch TOC changes (#2946) * Add new Query DSL section Signed-off-by: Naarcha-AWS * Change config settings Signed-off-by: Naarcha-AWS * Fix links Signed-off-by: Naarcha-AWS * Add Query DSL back to Search Signed-off-by: Naarcha-AWS * Fix remaining links Signed-off-by: Naarcha-AWS * Last reorder Signed-off-by: Naarcha-AWS * Add Heather's feedback Signed-off-by: Naarcha-AWS * Add Query DSL section. Delete Index Data page Signed-off-by: Naarcha-AWS * Fix index title Signed-off-by: Naarcha-AWS * Add correct title to managing indexes Signed-off-by: Naarcha-AWS * Change config yml Signed-off-by: Naarcha-AWS * Add permalinks for each page in query DSL section Signed-off-by: Naarcha-AWS * :wq --------- Signed-off-by: Naarcha-AWS --- .../common-parameters.md | 2 + .../popular-api.md | 2 + {_opensearch => _api-reference}/units.md | 2 + _config.yml | 32 +- _dashboards/im-dashboards/datastream.md | 1 + _dashboards/im-dashboards/forcemerge.md | 2 +- _external_links/developer-guide.md | 7 - _external_links/javadoc.md | 7 - _external_links/javadocs.md | 6 - .../alias.md | 2 + .../autocomplete.md | 2 + .../binary.md | 2 + .../boolean.md | 2 + .../completion.md | 2 + .../date.md | 2 + .../geo-point.md | 2 + .../geo-shape.md | 2 + .../geographic.md | 2 + .../index.md | 1 + .../ip.md | 2 + .../join.md | 2 + .../keyword.md | 2 + {_opensearch => _field-types}/mappings.md | 2 + .../nested.md | 2 + .../numeric.md | 2 + .../object-fields.md | 0 .../object.md | 2 + .../percolator.md | 2 + .../range.md | 2 + .../rank.md | 2 + .../search-as-you-type.md | 2 + .../string.md | 2 + .../text.md | 2 + .../token-count.md | 2 + .../xy-point.md | 2 + .../xy-shape.md | 2 + .../xy.md | 2 + {_opensearch => _im-plugin}/data-streams.md | 0 {_opensearch => _im-plugin}/index-alias.md | 4 +- _im-plugin/index-rollups/index.md | 4 +- .../index-templates.md | 4 +- _im-plugin/index.md | 277 +++++++++++++++++- _im-plugin/ism/error-prevention/index.md | 3 +- _im-plugin/ism/index.md | 2 +- {_opensearch => _im-plugin}/reindex-data.md | 4 +- .../logs.md | 0 _opensearch/index-data.md | 271 ----------------- .../segment-replication/configuration.md | 83 ------ _opensearch/segment-replication/index.md | 25 -- .../aggregations}/aggregations.md | 5 +- .../aggregations}/bucket-agg.md | 6 +- .../aggregations}/geohexgrid-agg.md | 2 +- .../aggregations}/metric-agg.md | 6 +- .../aggregations}/pipeline-agg.md | 3 +- _query-dsl/analyzers/language-analyzers.md | 43 +++ .../analyzers/refresh-analyzer.md | 6 +- .../analyzers}/text-analyzers.md | 46 +-- .../query-dsl/compound/bool.md | 3 + .../query-dsl/compound/index.md | 3 + .../query-dsl/full-text/index.md | 2 + .../query-dsl/full-text/query-string.md | 3 + .../query-dsl/geo-and-xy/geo-bounding-box.md | 3 + .../query-dsl/geo-and-xy/index.md | 3 + .../query-dsl/geo-and-xy/xy.md | 3 + .../query-dsl/index.md | 4 +- .../query-dsl/query-filter-context.md | 1 + .../query-dsl/span-query.md | 3 + .../query-dsl/term-vs-full-text.md | 1 + {_opensearch => _query-dsl}/query-dsl/term.md | 3 + .../neural-search.md | 4 +- .../point-in-time-api.md | 4 +- .../point-in-time.md | 2 + _search-plugins/querqy/index.md | 2 +- .../search-template.md | 2 + .../searching-data}/autocomplete.md | 2 + .../searching-data}/did-you-mean.md | 0 .../searching-data}/highlight.md | 2 + .../searching-data}/index.md | 2 +- .../searching-data}/paginate.md | 2 + .../searching-data}/sort.md | 2 + _troubleshoot/security-admin.md | 3 +- .../snapshots/snapshot-restore.md | 1 + _upgrade-to/upgrade-to.md | 5 +- 83 files changed, 484 insertions(+), 489 deletions(-) rename {_opensearch => _api-reference}/common-parameters.md (98%) rename {_opensearch => _api-reference}/popular-api.md (98%) rename {_opensearch => _api-reference}/units.md (97%) delete mode 100644 _external_links/developer-guide.md delete mode 100644 _external_links/javadoc.md delete mode 100644 _external_links/javadocs.md rename {_opensearch/supported-field-types => _field-types}/alias.md (97%) rename {_opensearch/supported-field-types => _field-types}/autocomplete.md (91%) rename {_opensearch/supported-field-types => _field-types}/binary.md (95%) rename {_opensearch/supported-field-types => _field-types}/boolean.md (98%) rename {_opensearch/supported-field-types => _field-types}/completion.md (99%) rename {_opensearch/supported-field-types => _field-types}/date.md (99%) rename {_opensearch/supported-field-types => _field-types}/geo-point.md (97%) rename {_opensearch/supported-field-types => _field-types}/geo-shape.md (99%) rename {_opensearch/supported-field-types => _field-types}/geographic.md (90%) rename {_opensearch/supported-field-types => _field-types}/index.md (99%) rename {_opensearch/supported-field-types => _field-types}/ip.md (98%) rename {_opensearch/supported-field-types => _field-types}/join.md (99%) rename {_opensearch/supported-field-types => _field-types}/keyword.md (98%) rename {_opensearch => _field-types}/mappings.md (99%) rename {_opensearch/supported-field-types => _field-types}/nested.md (98%) rename {_opensearch/supported-field-types => _field-types}/numeric.md (98%) rename {_opensearch/supported-field-types => _field-types}/object-fields.md (100%) rename {_opensearch/supported-field-types => _field-types}/object.md (98%) rename {_opensearch/supported-field-types => _field-types}/percolator.md (97%) rename {_opensearch/supported-field-types => _field-types}/range.md (98%) rename {_opensearch/supported-field-types => _field-types}/rank.md (99%) rename {_opensearch/supported-field-types => _field-types}/search-as-you-type.md (98%) rename {_opensearch/supported-field-types => _field-types}/string.md (91%) rename {_opensearch/supported-field-types => _field-types}/text.md (99%) rename {_opensearch/supported-field-types => _field-types}/token-count.md (98%) rename {_opensearch/supported-field-types => _field-types}/xy-point.md (97%) rename {_opensearch/supported-field-types => _field-types}/xy-shape.md (99%) rename {_opensearch/supported-field-types => _field-types}/xy.md (97%) rename {_opensearch => _im-plugin}/data-streams.md (100%) rename {_opensearch => _im-plugin}/index-alias.md (98%) rename {_opensearch => _im-plugin}/index-templates.md (99%) rename {_opensearch => _im-plugin}/reindex-data.md (99%) rename {_opensearch => _monitoring-your-cluster}/logs.md (100%) delete mode 100644 _opensearch/index-data.md delete mode 100644 _opensearch/segment-replication/configuration.md delete mode 100644 _opensearch/segment-replication/index.md rename {_opensearch => _query-dsl/aggregations}/aggregations.md (98%) rename {_opensearch => _query-dsl/aggregations}/bucket-agg.md (99%) rename {_opensearch => _query-dsl/aggregations}/geohexgrid-agg.md (99%) rename {_opensearch => _query-dsl/aggregations}/metric-agg.md (99%) rename {_opensearch => _query-dsl/aggregations}/pipeline-agg.md (99%) create mode 100644 _query-dsl/analyzers/language-analyzers.md rename _im-plugin/refresh-analyzer/index.md => _query-dsl/analyzers/refresh-analyzer.md (87%) rename {_opensearch/query-dsl => _query-dsl/analyzers}/text-analyzers.md (73%) rename {_opensearch => _query-dsl}/query-dsl/compound/bool.md (98%) rename {_opensearch => _query-dsl}/query-dsl/compound/index.md (93%) rename {_opensearch => _query-dsl}/query-dsl/full-text/index.md (99%) rename {_opensearch => _query-dsl}/query-dsl/full-text/query-string.md (98%) rename {_opensearch => _query-dsl}/query-dsl/geo-and-xy/geo-bounding-box.md (98%) rename {_opensearch => _query-dsl}/query-dsl/geo-and-xy/index.md (96%) rename {_opensearch => _query-dsl}/query-dsl/geo-and-xy/xy.md (99%) rename {_opensearch => _query-dsl}/query-dsl/index.md (98%) rename {_opensearch => _query-dsl}/query-dsl/query-filter-context.md (98%) rename {_opensearch => _query-dsl}/query-dsl/span-query.md (94%) rename {_opensearch => _query-dsl}/query-dsl/term-vs-full-text.md (99%) rename {_opensearch => _query-dsl}/query-dsl/term.md (99%) rename _neural-search-plugin/index.md => _search-plugins/neural-search.md (99%) rename {_opensearch => _search-plugins}/point-in-time-api.md (99%) rename {_opensearch => _search-plugins}/point-in-time.md (99%) rename {_opensearch => _search-plugins}/search-template.md (99%) rename {_opensearch/search => _search-plugins/searching-data}/autocomplete.md (99%) rename {_opensearch/search => _search-plugins/searching-data}/did-you-mean.md (100%) rename {_opensearch/search => _search-plugins/searching-data}/highlight.md (99%) rename {_opensearch/search => _search-plugins/searching-data}/index.md (98%) rename {_opensearch/search => _search-plugins/searching-data}/paginate.md (99%) rename {_opensearch/search => _search-plugins/searching-data}/sort.md (99%) diff --git a/_opensearch/common-parameters.md b/_api-reference/common-parameters.md similarity index 98% rename from _opensearch/common-parameters.md rename to _api-reference/common-parameters.md index b96bd95a..eb0fae8c 100644 --- a/_opensearch/common-parameters.md +++ b/_api-reference/common-parameters.md @@ -2,6 +2,8 @@ layout: default title: Common REST Parameters nav_order: 93 +redirect_from: + - /opensearch/common-parameters/ --- # Common REST parameters diff --git a/_opensearch/popular-api.md b/_api-reference/popular-api.md similarity index 98% rename from _opensearch/popular-api.md rename to _api-reference/popular-api.md index 00b4e3eb..181a64a2 100644 --- a/_opensearch/popular-api.md +++ b/_api-reference/popular-api.md @@ -2,6 +2,8 @@ layout: default title: Popular APIs nav_order: 96 +redirect_from: + - /opensearch/popular-api/ --- # Popular APIs diff --git a/_opensearch/units.md b/_api-reference/units.md similarity index 97% rename from _opensearch/units.md rename to _api-reference/units.md index 0e098cfe..1b9a3d07 100644 --- a/_opensearch/units.md +++ b/_api-reference/units.md @@ -2,6 +2,8 @@ layout: default title: Supported units nav_order: 90 +redirect_from: + - /opensearch/units/ --- # Supported units diff --git a/_config.yml b/_config.yml index 6406e674..44e006f7 100644 --- a/_config.yml +++ b/_config.yml @@ -34,9 +34,6 @@ collections: upgrade-to: permalink: /:collection/:path/ output: true - opensearch: - permalink: /:collection/:path/ - output: true im-plugin: permalink: /:collection/:path/ output: true @@ -54,13 +51,10 @@ collections: output: true search-plugins: permalink: /:collection/:path/ - output: true + output: true ml-commons-plugin: permalink: /:collection/:path/ - output: true - neural-search-plugin: - permalink: /:collection/:path/ - output: true + output: true tuning-your-cluster: permalink: /:collection/:path/ output: true @@ -70,10 +64,10 @@ collections: observing-your-data: permalink: /:collection/:path/ output: true - ml-commons-plugin: + query-dsl: permalink: /:collection/:path/ - output: true - neural-search-plugin: + output: true + field-types: permalink: /:collection/:path/ output: true clients: @@ -106,9 +100,6 @@ just_the_docs: # nav_exclude: true nav_fold: true # search_exclude: true - opensearch: - name: OpenSearch - nav_fold: true im-plugin: name: Managing Indexes nav_fold: true @@ -122,7 +113,7 @@ just_the_docs: name: Security in OpenSearch nav_fold: true security-analytics: - name: Security analytics plugin + name: Security analytics nav_fold: true search-plugins: name: Search @@ -130,9 +121,6 @@ just_the_docs: ml-commons-plugin: name: Machine learning nav_fold: true - neural-search-plugin: - name: Neural Search - nav_fold: true tuning-your-cluster: name: Tuning your cluster nav_fold: true @@ -142,6 +130,12 @@ just_the_docs: observing-your-data: name: Observability nav_fold: true + query-dsl: + name: Query DSL, Aggregations, and Analyzers + nav_fold: true + field-types: + name: Mappings and field types + nav_fold: true clients: name: Clients nav_fold: true @@ -157,8 +151,6 @@ just_the_docs: troubleshoot: name: Troubleshooting nav_fold: true - external_links: - name: External links # Enable or disable the site search diff --git a/_dashboards/im-dashboards/datastream.md b/_dashboards/im-dashboards/datastream.md index 60adfad3..27ea6755 100644 --- a/_dashboards/im-dashboards/datastream.md +++ b/_dashboards/im-dashboards/datastream.md @@ -5,6 +5,7 @@ parent: Index management in Dashboards nav_order: 20 redirect_from: - /dashboards/admin-ui-index/datastream/ + - /opensearch/data-streams/ --- # Data streams diff --git a/_dashboards/im-dashboards/forcemerge.md b/_dashboards/im-dashboards/forcemerge.md index 7e5554e4..34903740 100644 --- a/_dashboards/im-dashboards/forcemerge.md +++ b/_dashboards/im-dashboards/forcemerge.md @@ -11,7 +11,7 @@ redirect_from: Introduced 2.6 {: .label .label-purple } -OpenSearch Dashboards allows you to perform a [force merge]({{site.url}}{{site.baseurl}}/im-plugin/ism/error-prevention/index/#force_merge) operation on two or more indexes with **Index Management**. +OpenSearch Dashboards allows you to perform a [force merge]({{site.url}}{{site.baseurl}}/im-plugin/ism/error-prevention/index#force_merge) operation on two or more indexes with **Index Management**. ## Force merging indexes diff --git a/_external_links/developer-guide.md b/_external_links/developer-guide.md deleted file mode 100644 index 5f07b6ae..00000000 --- a/_external_links/developer-guide.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -layout: default -title: Dashboards developer guide -nav_order: 2 -permalink: /dashboards-developer-guide/ -redirect_to: https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md ---- diff --git a/_external_links/javadoc.md b/_external_links/javadoc.md deleted file mode 100644 index 8c937391..00000000 --- a/_external_links/javadoc.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -layout: default -title: Javadoc -nav_order: 1 -permalink: /javadoc/ -redirect_to: https://opensearch.org/javadocs/ ---- diff --git a/_external_links/javadocs.md b/_external_links/javadocs.md deleted file mode 100644 index bdaf076d..00000000 --- a/_external_links/javadocs.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -layout: default -nav_exclude: true -permalink: /javadocs/ -redirect_to: https://opensearch.org/javadocs/ ---- diff --git a/_opensearch/supported-field-types/alias.md b/_field-types/alias.md similarity index 97% rename from _opensearch/supported-field-types/alias.md rename to _field-types/alias.md index f128ef65..8cb4e6d2 100644 --- a/_opensearch/supported-field-types/alias.md +++ b/_field-types/alias.md @@ -4,6 +4,8 @@ title: Alias nav_order: 10 has_children: false parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/alias/ --- # Alias field type diff --git a/_opensearch/supported-field-types/autocomplete.md b/_field-types/autocomplete.md similarity index 91% rename from _opensearch/supported-field-types/autocomplete.md rename to _field-types/autocomplete.md index 4fc7ad39..006f0786 100644 --- a/_opensearch/supported-field-types/autocomplete.md +++ b/_field-types/autocomplete.md @@ -5,6 +5,8 @@ nav_order: 50 has_children: true has_toc: false parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/autocomplete/ --- # Autocomplete field types diff --git a/_opensearch/supported-field-types/binary.md b/_field-types/binary.md similarity index 95% rename from _opensearch/supported-field-types/binary.md rename to _field-types/binary.md index 2bc95c31..7786785b 100644 --- a/_opensearch/supported-field-types/binary.md +++ b/_field-types/binary.md @@ -4,6 +4,8 @@ title: Binary parent: Supported field types nav_order: 12 has_children: false +redirect_from: + - /opensearch/supported-field-types/binary/ --- # Binary field type diff --git a/_opensearch/supported-field-types/boolean.md b/_field-types/boolean.md similarity index 98% rename from _opensearch/supported-field-types/boolean.md rename to _field-types/boolean.md index 40affbde..4e5e795f 100644 --- a/_opensearch/supported-field-types/boolean.md +++ b/_field-types/boolean.md @@ -4,6 +4,8 @@ title: Boolean nav_order: 20 has_children: false parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/boolean/ --- # Boolean field type diff --git a/_opensearch/supported-field-types/completion.md b/_field-types/completion.md similarity index 99% rename from _opensearch/supported-field-types/completion.md rename to _field-types/completion.md index 2f3123af..05fcbaa5 100644 --- a/_opensearch/supported-field-types/completion.md +++ b/_field-types/completion.md @@ -5,6 +5,8 @@ nav_order: 51 has_children: false parent: Autocomplete field types grand_parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/completion/ --- # Completion field type diff --git a/_opensearch/supported-field-types/date.md b/_field-types/date.md similarity index 99% rename from _opensearch/supported-field-types/date.md rename to _field-types/date.md index 714c6b31..075eed36 100644 --- a/_opensearch/supported-field-types/date.md +++ b/_field-types/date.md @@ -4,6 +4,8 @@ title: Date nav_order: 25 has_children: false parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/date/ --- # Date field type diff --git a/_opensearch/supported-field-types/geo-point.md b/_field-types/geo-point.md similarity index 97% rename from _opensearch/supported-field-types/geo-point.md rename to _field-types/geo-point.md index c686907f..ee40a133 100644 --- a/_opensearch/supported-field-types/geo-point.md +++ b/_field-types/geo-point.md @@ -5,6 +5,8 @@ nav_order: 56 has_children: false parent: Geographic field types grand_parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/geo-point/ --- # Geopoint field type diff --git a/_opensearch/supported-field-types/geo-shape.md b/_field-types/geo-shape.md similarity index 99% rename from _opensearch/supported-field-types/geo-shape.md rename to _field-types/geo-shape.md index e66dfed8..cf0506de 100644 --- a/_opensearch/supported-field-types/geo-shape.md +++ b/_field-types/geo-shape.md @@ -5,6 +5,8 @@ nav_order: 57 has_children: false parent: Geographic field types grand_parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/geo-shape/ --- # Geoshape field type diff --git a/_opensearch/supported-field-types/geographic.md b/_field-types/geographic.md similarity index 90% rename from _opensearch/supported-field-types/geographic.md rename to _field-types/geographic.md index 9dbe6c29..34d1a54f 100644 --- a/_opensearch/supported-field-types/geographic.md +++ b/_field-types/geographic.md @@ -5,6 +5,8 @@ nav_order: 55 has_children: true has_toc: false parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/geographic/ --- # Geographic field types diff --git a/_opensearch/supported-field-types/index.md b/_field-types/index.md similarity index 99% rename from _opensearch/supported-field-types/index.md rename to _field-types/index.md index f13c3140..cca833a5 100644 --- a/_opensearch/supported-field-types/index.md +++ b/_field-types/index.md @@ -6,6 +6,7 @@ has_children: true has_toc: false redirect_from: - /opensearch/supported-field-types/ + - //opensearch/supported-field-types/index/ --- # Supported field types diff --git a/_opensearch/supported-field-types/ip.md b/_field-types/ip.md similarity index 98% rename from _opensearch/supported-field-types/ip.md rename to _field-types/ip.md index 250e2da6..a3e1277b 100644 --- a/_opensearch/supported-field-types/ip.md +++ b/_field-types/ip.md @@ -4,6 +4,8 @@ title: IP address nav_order: 30 has_children: false parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/ip/ --- # IP address field type diff --git a/_opensearch/supported-field-types/join.md b/_field-types/join.md similarity index 99% rename from _opensearch/supported-field-types/join.md rename to _field-types/join.md index 18a25637..bd14f250 100644 --- a/_opensearch/supported-field-types/join.md +++ b/_field-types/join.md @@ -5,6 +5,8 @@ nav_order: 43 has_children: false parent: Object field types grand_parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/join/ --- # Join field type diff --git a/_opensearch/supported-field-types/keyword.md b/_field-types/keyword.md similarity index 98% rename from _opensearch/supported-field-types/keyword.md rename to _field-types/keyword.md index cfa522f5..4624ebb8 100644 --- a/_opensearch/supported-field-types/keyword.md +++ b/_field-types/keyword.md @@ -5,6 +5,8 @@ nav_order: 46 has_children: false parent: String field types grand_parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/keyword/ --- # Keyword field type diff --git a/_opensearch/mappings.md b/_field-types/mappings.md similarity index 99% rename from _opensearch/mappings.md rename to _field-types/mappings.md index d00d2ec6..6ad58c07 100644 --- a/_opensearch/mappings.md +++ b/_field-types/mappings.md @@ -2,6 +2,8 @@ layout: default title: Mapping nav_order: 13 +redirect_from: + - /opensearch/mappings/ --- # Mapping diff --git a/_opensearch/supported-field-types/nested.md b/_field-types/nested.md similarity index 98% rename from _opensearch/supported-field-types/nested.md rename to _field-types/nested.md index bb27cd28..a075d238 100644 --- a/_opensearch/supported-field-types/nested.md +++ b/_field-types/nested.md @@ -5,6 +5,8 @@ nav_order: 42 has_children: false parent: Object field types grand_parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/nested/ --- # Nested field type diff --git a/_opensearch/supported-field-types/numeric.md b/_field-types/numeric.md similarity index 98% rename from _opensearch/supported-field-types/numeric.md rename to _field-types/numeric.md index c12326e1..e76b64ff 100644 --- a/_opensearch/supported-field-types/numeric.md +++ b/_field-types/numeric.md @@ -4,6 +4,8 @@ title: Numeric field types parent: Supported field types nav_order: 15 has_children: false +redirect_from: + - /opensearch/supported-field-types/numeric/ --- # Numeric field types diff --git a/_opensearch/supported-field-types/object-fields.md b/_field-types/object-fields.md similarity index 100% rename from _opensearch/supported-field-types/object-fields.md rename to _field-types/object-fields.md diff --git a/_opensearch/supported-field-types/object.md b/_field-types/object.md similarity index 98% rename from _opensearch/supported-field-types/object.md rename to _field-types/object.md index 68cb15cb..7bb446e1 100644 --- a/_opensearch/supported-field-types/object.md +++ b/_field-types/object.md @@ -5,6 +5,8 @@ nav_order: 41 has_children: false parent: Object field types grand_parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/object/ --- # Object field type diff --git a/_opensearch/supported-field-types/percolator.md b/_field-types/percolator.md similarity index 97% rename from _opensearch/supported-field-types/percolator.md rename to _field-types/percolator.md index 393c9e0a..e39f1cad 100644 --- a/_opensearch/supported-field-types/percolator.md +++ b/_field-types/percolator.md @@ -4,6 +4,8 @@ title: Percolator nav_order: 65 has_children: false parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/percolator/ --- # Percolator field type diff --git a/_opensearch/supported-field-types/range.md b/_field-types/range.md similarity index 98% rename from _opensearch/supported-field-types/range.md rename to _field-types/range.md index 8bce485d..3815053f 100644 --- a/_opensearch/supported-field-types/range.md +++ b/_field-types/range.md @@ -4,6 +4,8 @@ title: Range field types nav_order: 35 has_children: false parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/range/ --- # Range field types diff --git a/_opensearch/supported-field-types/rank.md b/_field-types/rank.md similarity index 99% rename from _opensearch/supported-field-types/rank.md rename to _field-types/rank.md index 50aab1bc..691fbbb7 100644 --- a/_opensearch/supported-field-types/rank.md +++ b/_field-types/rank.md @@ -4,6 +4,8 @@ title: Rank field types nav_order: 60 has_children: false parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/rank/ --- # Rank field types diff --git a/_opensearch/supported-field-types/search-as-you-type.md b/_field-types/search-as-you-type.md similarity index 98% rename from _opensearch/supported-field-types/search-as-you-type.md rename to _field-types/search-as-you-type.md index eb4d863e..fdef9c0c 100644 --- a/_opensearch/supported-field-types/search-as-you-type.md +++ b/_field-types/search-as-you-type.md @@ -5,6 +5,8 @@ nav_order: 53 has_children: false parent: Autocomplete field types grand_parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/search-as-you-type/ --- # Search-as-you-type field type diff --git a/_opensearch/supported-field-types/string.md b/_field-types/string.md similarity index 91% rename from _opensearch/supported-field-types/string.md rename to _field-types/string.md index 7848d2ab..304fd434 100644 --- a/_opensearch/supported-field-types/string.md +++ b/_field-types/string.md @@ -5,6 +5,8 @@ nav_order: 45 has_children: true has_toc: false parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/string/ --- # String field types diff --git a/_opensearch/supported-field-types/text.md b/_field-types/text.md similarity index 99% rename from _opensearch/supported-field-types/text.md rename to _field-types/text.md index 37f3a6c0..c68f678f 100644 --- a/_opensearch/supported-field-types/text.md +++ b/_field-types/text.md @@ -5,6 +5,8 @@ nav_order: 47 has_children: false parent: String field types grand_parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/text/ --- # Text field type diff --git a/_opensearch/supported-field-types/token-count.md b/_field-types/token-count.md similarity index 98% rename from _opensearch/supported-field-types/token-count.md rename to _field-types/token-count.md index c1795af3..adc5b725 100644 --- a/_opensearch/supported-field-types/token-count.md +++ b/_field-types/token-count.md @@ -5,6 +5,8 @@ nav_order: 48 has_children: false parent: String field types grand_parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/token-count/ --- # Token count field type diff --git a/_opensearch/supported-field-types/xy-point.md b/_field-types/xy-point.md similarity index 97% rename from _opensearch/supported-field-types/xy-point.md rename to _field-types/xy-point.md index 8909c43b..b9edabab 100644 --- a/_opensearch/supported-field-types/xy-point.md +++ b/_field-types/xy-point.md @@ -5,6 +5,8 @@ nav_order: 58 has_children: false parent: Cartesian field types grand_parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/xy-point/ --- # xy point field type diff --git a/_opensearch/supported-field-types/xy-shape.md b/_field-types/xy-shape.md similarity index 99% rename from _opensearch/supported-field-types/xy-shape.md rename to _field-types/xy-shape.md index 07cc8586..e6f95b73 100644 --- a/_opensearch/supported-field-types/xy-shape.md +++ b/_field-types/xy-shape.md @@ -5,6 +5,8 @@ nav_order: 59 has_children: false parent: Cartesian field types grand_parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/xy-shape/ --- # xy shape field type diff --git a/_opensearch/supported-field-types/xy.md b/_field-types/xy.md similarity index 97% rename from _opensearch/supported-field-types/xy.md rename to _field-types/xy.md index cd600538..2ab07be5 100644 --- a/_opensearch/supported-field-types/xy.md +++ b/_field-types/xy.md @@ -5,6 +5,8 @@ nav_order: 57 has_children: true has_toc: false parent: Supported field types +redirect_from: + - /opensearch/supported-field-types/xy/ --- # Cartesian field types diff --git a/_opensearch/data-streams.md b/_im-plugin/data-streams.md similarity index 100% rename from _opensearch/data-streams.md rename to _im-plugin/data-streams.md diff --git a/_opensearch/index-alias.md b/_im-plugin/index-alias.md similarity index 98% rename from _opensearch/index-alias.md rename to _im-plugin/index-alias.md index 3227d304..85a3c79f 100644 --- a/_opensearch/index-alias.md +++ b/_im-plugin/index-alias.md @@ -1,7 +1,9 @@ --- layout: default title: Index aliases -nav_order: 12 +nav_order: 11 +redirect_from: + - /opensearch/index-alias/ --- # Index aliases diff --git a/_im-plugin/index-rollups/index.md b/_im-plugin/index-rollups/index.md index ae10a109..e2cac729 100644 --- a/_im-plugin/index-rollups/index.md +++ b/_im-plugin/index-rollups/index.md @@ -3,8 +3,8 @@ layout: default title: Index rollups nav_order: 35 has_children: true -redirect_from: /im-plugin/index-rollups/ -has_toc: false +redirect_from: + - /im-plugin/index-rollups/ --- # Index rollups diff --git a/_opensearch/index-templates.md b/_im-plugin/index-templates.md similarity index 99% rename from _opensearch/index-templates.md rename to _im-plugin/index-templates.md index b979b3e3..015c9908 100644 --- a/_opensearch/index-templates.md +++ b/_im-plugin/index-templates.md @@ -1,7 +1,9 @@ --- layout: default title: Index templates -nav_order: 15 +nav_order: 6 +redirect_from: + - /opensearch/index-templates/ --- # Index templates diff --git a/_im-plugin/index.md b/_im-plugin/index.md index 809d4775..f7cd370e 100644 --- a/_im-plugin/index.md +++ b/_im-plugin/index.md @@ -1,14 +1,285 @@ --- layout: default -title: About Index Management +title: Managing indexes nav_order: 1 has_children: false redirect_from: - /im-plugin/ + - /opensearch/index-data/ --- -# About Index Management +# Managing indexes OpenSearch Dashboards {: .label .label-yellow :} -The Index Management (IM) plugin lets you automate recurring index management activities and reduce storage costs. +You index data using the OpenSearch REST API. Two APIs exist: the index API and the `_bulk` API. + +For situations in which new data arrives incrementally (for example, customer orders from a small business), you might use the index API to add documents individually as they arrive. For situations in which the flow of data is less frequent (for example, weekly updates to a marketing website), you might prefer to generate a file and send it to the `_bulk` API. For large numbers of documents, lumping requests together and using the `_bulk` API offers superior performance. If your documents are enormous, however, you might need to index them individually. + + +## Introduction to indexing + +Before you can search data, you must *index* it. Indexing is the method by which search engines organize data for fast retrieval. The resulting structure is called, fittingly, an index. + +In OpenSearch, the basic unit of data is a JSON *document*. Within an index, OpenSearch identifies each document using a unique ID. + +A request to the index API looks like this: + +```json +PUT /_doc/ +{ "A JSON": "document" } +``` + +A request to the `_bulk` API looks a little different, because you specify the index and ID in the bulk data: + +```json +POST _bulk +{ "index": { "_index": "", "_id": "" } } +{ "A JSON": "document" } +``` + +Bulk data must conform to a specific format, which requires a newline character (`\n`) at the end of every line, including the last line. This is the basic format: + +``` +Action and metadata\n +Optional document\n +Action and metadata\n +Optional document\n +``` + +The document is optional, because `delete` actions don't require a document. The other actions (`index`, `create`, and `update`) all require a document. If you specifically want the action to fail if the document already exists, use the `create` action instead of the `index` action. +{: .note } + +To index bulk data using the `curl` command, navigate to the folder where you have your file saved and run the following command: + +```json +curl -H "Content-Type: application/x-ndjson" -POST https://localhost:9200/data/_bulk -u 'admin:admin' --insecure --data-binary "@data.json" +``` + +If any one of the actions in the `_bulk` API fail, OpenSearch continues to execute the other actions. Examine the `items` array in the response to figure out what went wrong. The entries in the `items` array are in the same order as the actions specified in the request. + +OpenSearch automatically creates an index when you add a document to an index that doesn't already exist. It also automatically generates an ID if you don't specify an ID in the request. This simple example automatically creates the movies index, indexes the document, and assigns it a unique ID: + +```json +POST movies/_doc +{ "title": "Spirited Away" } +``` + +Automatic ID generation has a clear downside: because the indexing request didn't specify a document ID, you can't easily update the document at a later time. Also, if you run this request 10 times, OpenSearch indexes this document as 10 different documents with unique IDs. To specify an ID of 1, use the following request (note the use of PUT instead of POST): + +```json +PUT movies/_doc/1 +{ "title": "Spirited Away" } +``` + +Because you must specify an ID, if you run this command 10 times, you still have just one document indexed with the `_version` field incremented to 10. + +Indexes default to one primary shard and one replica. If you want to specify non-default settings, create the index before adding documents: + +```json +PUT more-movies +{ "settings": { "number_of_shards": 6, "number_of_replicas": 2 } } +``` + +## Naming restrictions for indexes + +OpenSearch indexes have the following naming restrictions: + +- All letters must be lowercase. +- Index names can't begin with underscores (`_`) or hyphens (`-`). +- Index names can't contain spaces, commas, or the following characters: + + `:`, `"`, `*`, `+`, `/`, `\`, `|`, `?`, `#`, `>`, or `<` + +## Read data + +After you index a document, you can retrieve it by sending a GET request to the same endpoint that you used for indexing: + +```json +GET movies/_doc/1 + +{ + "_index" : "movies", + "_type" : "_doc", + "_id" : "1", + "_version" : 1, + "_seq_no" : 0, + "_primary_term" : 1, + "found" : true, + "_source" : { + "title" : "Spirited Away" + } +} +``` + +You can see the document in the `_source` object. If the document is not found, the `found` key is `false` and the `_source` object is not part of the response. + +To retrieve multiple documents with a single command, use the `_mget` operation. +The format for retrieving multiple documents is similar to the `_bulk` operation, where you must specify the index and ID in the request body: + +```json +GET _mget +{ + "docs": [ + { + "_index": "", + "_id": "" + }, + { + "_index": "", + "_id": "" + } + ] +} +``` + +To only return specific fields in a document: + +```json +GET _mget +{ + "docs": [ + { + "_index": "", + "_id": "", + "_source": "field1" + }, + { + "_index": "", + "_id": "", + "_source": "field2" + } + ] +} +``` + +To check if a document exists: + +```json +HEAD movies/_doc/ +``` + +If the document exists, you get back a `200 OK` response, and if it doesn't, you get back a `404 - Not Found` error. + +## Update data + +To update existing fields or to add new fields, send a POST request to the `_update` operation with your changes in a `doc` object: + +```json +POST movies/_update/1 +{ + "doc": { + "title": "Castle in the Sky", + "genre": ["Animation", "Fantasy"] + } +} +``` + +Note the updated `title` field and new `genre` field: + +```json +GET movies/_doc/1 + +{ + "_index" : "movies", + "_type" : "_doc", + "_id" : "1", + "_version" : 2, + "_seq_no" : 1, + "_primary_term" : 1, + "found" : true, + "_source" : { + "title" : "Castle in the Sky", + "genre" : [ + "Animation", + "Fantasy" + ] + } +} +``` + +The document also has an incremented `_version` field. Use this field to keep track of how many times a document is updated. + +POST requests make partial updates to documents. To altogether replace a document, use a PUT request: + +```json +PUT movies/_doc/1 +{ + "title": "Spirited Away" +} +``` + +The document with ID of 1 will contain only the `title` field, because the entire document will be replaced with the document indexed in this PUT request. + +Use the `upsert` object to conditionally update documents based on whether they already exist. Here, if the document exists, its `title` field changes to `Castle in the Sky`. If it doesn't, OpenSearch indexes the document in the `upsert` object. + +```json +POST movies/_update/2 +{ + "doc": { + "title": "Castle in the Sky" + }, + "upsert": { + "title": "Only Yesterday", + "genre": ["Animation", "Fantasy"], + "date": 1993 + } +} +``` + +### Example response + +```json +{ + "_index" : "movies", + "_type" : "_doc", + "_id" : "2", + "_version" : 2, + "result" : "updated", + "_shards" : { + "total" : 2, + "successful" : 1, + "failed" : 0 + }, + "_seq_no" : 3, + "_primary_term" : 1 +} +``` + +Each update operation for a document has a unique combination of the `_seq_no` and `_primary_term` values. + +OpenSearch first writes your updates to the primary shard and then sends this change to all the replica shards. An uncommon issue can occur if multiple users of your OpenSearch-based application make updates to existing documents in the same index. In this situation, another user can read and update a document from a replica before it receives your update from the primary shard. Your update operation then ends up updating an older version of the document. In the best case, you and the other user make the same changes, and the document remains accurate. In the worst case, the document now contains out-of-date information. + +To prevent this situation, use the `_seq_no` and `_primary_term` values in the request header: + +```json +POST movies/_update/2?if_seq_no=3&if_primary_term=1 +{ + "doc": { + "title": "Castle in the Sky", + "genre": ["Animation", "Fantasy"] + } +} +``` + +If the document is updated after we retrieved it, the `_seq_no` and `_primary_term` values are different and our update operation fails with a `409 — Conflict` error. + +When using the `_bulk` API, specify the `_seq_no` and `_primary_term` values within the action metadata. + +## Delete data + +To delete a document from an index, use a DELETE request: + +```json +DELETE movies/_doc/1 +``` + +The DELETE operation increments the `_version` field. If you add the document back to the same ID, the `_version` field increments again. This behavior occurs because OpenSearch deletes the document `_source`, but retains its metadata. + + +## Next steps + +- The Index Management (IM) plugin lets you automate recurring index management activities and reduce storage costs. For more information, see [Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/ism/index). + +- For instructions on how to reindex data, see [Reindex data]({{site.url}}{{site.baseurl}}/im-plugin/reindex-data/). + diff --git a/_im-plugin/ism/error-prevention/index.md b/_im-plugin/ism/error-prevention/index.md index 7bedae06..08654fcb 100644 --- a/_im-plugin/ism/error-prevention/index.md +++ b/_im-plugin/ism/error-prevention/index.md @@ -1,11 +1,12 @@ --- layout: default title: ISM Error Prevention -nav_order: 1 +nav_order: 90 has_children: true has_toc: false redirect_from: - /im-plugin/ism/error-prevention/ + - /im-plugin/ism/error-prevention/index/ --- # ISM error prevention diff --git a/_im-plugin/ism/index.md b/_im-plugin/ism/index.md index c37a395b..9d16c20c 100644 --- a/_im-plugin/ism/index.md +++ b/_im-plugin/ism/index.md @@ -1,7 +1,7 @@ --- layout: default title: Index State Management -nav_order: 3 +nav_order: 16 has_children: true redirect_from: - /im-plugin/ism/ diff --git a/_opensearch/reindex-data.md b/_im-plugin/reindex-data.md similarity index 99% rename from _opensearch/reindex-data.md rename to _im-plugin/reindex-data.md index 166eece6..fcb127a6 100644 --- a/_opensearch/reindex-data.md +++ b/_im-plugin/reindex-data.md @@ -1,7 +1,9 @@ --- layout: default title: Reindex data -nav_order: 16 +nav_order: 15 +redirect_from: + - /opensearch/reindex-data/ --- # Reindex data diff --git a/_opensearch/logs.md b/_monitoring-your-cluster/logs.md similarity index 100% rename from _opensearch/logs.md rename to _monitoring-your-cluster/logs.md diff --git a/_opensearch/index-data.md b/_opensearch/index-data.md deleted file mode 100644 index 39dee132..00000000 --- a/_opensearch/index-data.md +++ /dev/null @@ -1,271 +0,0 @@ ---- -layout: default -title: Index data -nav_order: 10 ---- - -# Index data - -You index data using the OpenSearch REST API. Two APIs exist: the index API and the `_bulk` API. - -For situations in which new data arrives incrementally (for example, customer orders from a small business), you might use the index API to add documents individually as they arrive. For situations in which the flow of data is less frequent (for example, weekly updates to a marketing website), you might prefer to generate a file and send it to the `_bulk` API. For large numbers of documents, lumping requests together and using the `_bulk` API offers superior performance. If your documents are enormous, however, you might need to index them individually. - - -## Introduction to indexing - -Before you can search data, you must *index* it. Indexing is the method by which search engines organize data for fast retrieval. The resulting structure is called, fittingly, an index. - -In OpenSearch, the basic unit of data is a JSON *document*. Within an index, OpenSearch identifies each document using a unique ID. - -A request to the index API looks like this: - -```json -PUT /_doc/ -{ "A JSON": "document" } -``` - -A request to the `_bulk` API looks a little different, because you specify the index and ID in the bulk data: - -```json -POST _bulk -{ "index": { "_index": "", "_id": "" } } -{ "A JSON": "document" } -``` - -Bulk data must conform to a specific format, which requires a newline character (`\n`) at the end of every line, including the last line. This is the basic format: - -``` -Action and metadata\n -Optional document\n -Action and metadata\n -Optional document\n -``` - -The document is optional, because `delete` actions don't require a document. The other actions (`index`, `create`, and `update`) all require a document. If you specifically want the action to fail if the document already exists, use the `create` action instead of the `index` action. -{: .note } - -To index bulk data using the `curl` command, navigate to the folder where you have your file saved and run the following command: - -```json -curl -H "Content-Type: application/x-ndjson" -POST https://localhost:9200/data/_bulk -u 'admin:admin' --insecure --data-binary "@data.json" -``` - -If any one of the actions in the `_bulk` API fail, OpenSearch continues to execute the other actions. Examine the `items` array in the response to figure out what went wrong. The entries in the `items` array are in the same order as the actions specified in the request. - -OpenSearch automatically creates an index when you add a document to an index that doesn't already exist. It also automatically generates an ID if you don't specify an ID in the request. This simple example automatically creates the movies index, indexes the document, and assigns it a unique ID: - -```json -POST movies/_doc -{ "title": "Spirited Away" } -``` - -Automatic ID generation has a clear downside: because the indexing request didn't specify a document ID, you can't easily update the document at a later time. Also, if you run this request 10 times, OpenSearch indexes this document as 10 different documents with unique IDs. To specify an ID of 1, use the following request (note the use of PUT instead of POST): - -```json -PUT movies/_doc/1 -{ "title": "Spirited Away" } -``` - -Because you must specify an ID, if you run this command 10 times, you still have just one document indexed with the `_version` field incremented to 10. - -Indexes default to one primary shard and one replica. If you want to specify non-default settings, create the index before adding documents: - -```json -PUT more-movies -{ "settings": { "number_of_shards": 6, "number_of_replicas": 2 } } -``` - -## Naming restrictions for indexes - -OpenSearch indexes have the following naming restrictions: - -- All letters must be lowercase. -- Index names can't begin with underscores (`_`) or hyphens (`-`). -- Index names can't contain spaces, commas, or the following characters: - - `:`, `"`, `*`, `+`, `/`, `\`, `|`, `?`, `#`, `>`, or `<` - -## Read data - -After you index a document, you can retrieve it by sending a GET request to the same endpoint that you used for indexing: - -```json -GET movies/_doc/1 - -{ - "_index" : "movies", - "_type" : "_doc", - "_id" : "1", - "_version" : 1, - "_seq_no" : 0, - "_primary_term" : 1, - "found" : true, - "_source" : { - "title" : "Spirited Away" - } -} -``` - -You can see the document in the `_source` object. If the document is not found, the `found` key is `false` and the `_source` object is not part of the response. - -To retrieve multiple documents with a single command, use the `_mget` operation. -The format for retrieving multiple documents is similar to the `_bulk` operation, where you must specify the index and ID in the request body: - -```json -GET _mget -{ - "docs": [ - { - "_index": "", - "_id": "" - }, - { - "_index": "", - "_id": "" - } - ] -} -``` - -To only return specific fields in a document: - -```json -GET _mget -{ - "docs": [ - { - "_index": "", - "_id": "", - "_source": "field1" - }, - { - "_index": "", - "_id": "", - "_source": "field2" - } - ] -} -``` - -To check if a document exists: - -```json -HEAD movies/_doc/ -``` - -If the document exists, you get back a `200 OK` response, and if it doesn't, you get back a `404 - Not Found` error. - -## Update data - -To update existing fields or to add new fields, send a POST request to the `_update` operation with your changes in a `doc` object: - -```json -POST movies/_update/1 -{ - "doc": { - "title": "Castle in the Sky", - "genre": ["Animation", "Fantasy"] - } -} -``` - -Note the updated `title` field and new `genre` field: - -```json -GET movies/_doc/1 - -{ - "_index" : "movies", - "_type" : "_doc", - "_id" : "1", - "_version" : 2, - "_seq_no" : 1, - "_primary_term" : 1, - "found" : true, - "_source" : { - "title" : "Castle in the Sky", - "genre" : [ - "Animation", - "Fantasy" - ] - } -} -``` - -The document also has an incremented `_version` field. Use this field to keep track of how many times a document is updated. - -POST requests make partial updates to documents. To altogether replace a document, use a PUT request: - -```json -PUT movies/_doc/1 -{ - "title": "Spirited Away" -} -``` - -The document with ID of 1 will contain only the `title` field, because the entire document will be replaced with the document indexed in this PUT request. - -Use the `upsert` object to conditionally update documents based on whether they already exist. Here, if the document exists, its `title` field changes to `Castle in the Sky`. If it doesn't, OpenSearch indexes the document in the `upsert` object. - -```json -POST movies/_update/2 -{ - "doc": { - "title": "Castle in the Sky" - }, - "upsert": { - "title": "Only Yesterday", - "genre": ["Animation", "Fantasy"], - "date": 1993 - } -} -``` - -#### Example response - -```json -{ - "_index" : "movies", - "_type" : "_doc", - "_id" : "2", - "_version" : 2, - "result" : "updated", - "_shards" : { - "total" : 2, - "successful" : 1, - "failed" : 0 - }, - "_seq_no" : 3, - "_primary_term" : 1 -} -``` - -Each update operation for a document has a unique combination of the `_seq_no` and `_primary_term` values. - -OpenSearch first writes your updates to the primary shard and then sends this change to all the replica shards. An uncommon issue can occur if multiple users of your OpenSearch-based application make updates to existing documents in the same index. In this situation, another user can read and update a document from a replica before it receives your update from the primary shard. Your update operation then ends up updating an older version of the document. In the best case, you and the other user make the same changes, and the document remains accurate. In the worst case, the document now contains out-of-date information. - -To prevent this situation, use the `_seq_no` and `_primary_term` values in the request header: - -```json -POST movies/_update/2?if_seq_no=3&if_primary_term=1 -{ - "doc": { - "title": "Castle in the Sky", - "genre": ["Animation", "Fantasy"] - } -} -``` - -If the document is updated after we retrieved it, the `_seq_no` and `_primary_term` values are different and our update operation fails with a `409 — Conflict` error. - -When using the `_bulk` API, specify the `_seq_no` and `_primary_term` values within the action metadata. - -## Delete data - -To delete a document from an index, use a DELETE request: - -```json -DELETE movies/_doc/1 -``` - -The DELETE operation increments the `_version` field. If you add the document back to the same ID, the `_version` field increments again. This behavior occurs because OpenSearch deletes the document `_source`, but retains its metadata. diff --git a/_opensearch/segment-replication/configuration.md b/_opensearch/segment-replication/configuration.md deleted file mode 100644 index 22aeeb9c..00000000 --- a/_opensearch/segment-replication/configuration.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -layout: default -title: Segment replication configuration -nav_order: 12 -parent: Segment replication ---- - -# Segment replication configuration - -Segment replication is an experimental feature. Therefore, we do not recommend the use of segment replication in a production environment. For updates on the progress of segment replication or if you want to leave feedback that could help improve the feature, see the [Segment replication issue](https://github.com/opensearch-project/OpenSearch/issues/2194). -{: .warning } - -To enable the segment replication type, reference the steps below. - -## Enabling the feature flag - -There are several methods for enabling segment replication, depending on the install type. You will also need to set the replication strategy to `SEGMENT` when creating the index. - -### Enable on a node using a tarball install - -The flag is toggled using a new jvm parameter that is set either in `OPENSEARCH_JAVA_OPTS` or in config/jvm.options. - -1. Option 1: Update config/jvm.options by adding the following line: - - ````json - -Dopensearch.experimental.feature.replication_type.enabled=true - ```` - -1. Option 2: Use the `OPENSEARCH_JAVA_OPTS` environment variable: - - ````json - export OPENSEARCH_JAVA_OPTS="-Dopensearch.experimental.feature.replication_type.enabled=true" - ```` -1. Option 3: For developers using Gradle, update run.gradle by adding the following lines: - - ````json - testClusters { - runTask { - testDistribution = 'archive' - if (numZones > 1) numberOfZones = numZones - if (numNodes > 1) numberOfNodes = numNodes - systemProperty 'opensearch.experimental.feature.replication_type.enabled', 'true' - } - } - ```` - -### Enable with Docker containers - -If you're running Docker, add the following line to docker-compose.yml underneath the `opensearch-node` and `environment` section: - -````json -OPENSEARCH_JAVA_OPTS="-Dopensearch.experimental.feature.replication_type.enabled=true" # Enables segment replication -```` - -### Setting the replication strategy on the index - -To set the replication strategy to segment replication, create an index with replication.type set to `SEGMENT`: - -````json -PUT /my-index1 -{ - "settings": { - "index": { - "replication.type": "SEGMENT" - } - } -} -```` - -## Known limitations - -1. Enabling segment replication for an existing index requires [reindexing](https://github.com/opensearch-project/OpenSearch/issues/3685). -1. Rolling upgrades are currently not supported. Full cluster restarts are required when upgrading indexes using segment replication. [Issue 3881](https://github.com/opensearch-project/OpenSearch/issues/3881). -1. [Cross-cluster replication](https://github.com/opensearch-project/OpenSearch/issues/4090) does not currently use segment replication to copy between clusters. -1. Increased network congestion on primary shards. [Issue - Optimize network bandwidth on primary shards](https://github.com/opensearch-project/OpenSearch/issues/4245). -1. Shard allocation algorithms have not been updated to evenly spread primary shards across nodes. -1. Integration with remote-backed storage as the source of replication is [currently unsupported](https://github.com/opensearch-project/OpenSearch/issues/4448). - -### Further resources regarding segment replication - -1. [Known issues](https://github.com/opensearch-project/OpenSearch/issues/2194). -1. Steps for testing (link coming soon). -1. Segment replication blog post (link coming soon). \ No newline at end of file diff --git a/_opensearch/segment-replication/index.md b/_opensearch/segment-replication/index.md deleted file mode 100644 index b7ff2765..00000000 --- a/_opensearch/segment-replication/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default -title: Segment replication -nav_order: 64 -has_children: true -redirect_from: - - /opensearch/segment-replication/ ---- - -# Segment replication - -Segment replication is an experimental feature with OpenSearch 2.3. Therefore, we do not recommend the use of segment replication in a production environment. For updates on the progress of segment replication or if you want leave feedback that could help improve the feature, see the [Segment replication git issue](https://github.com/opensearch-project/OpenSearch/issues/2194). -{: .warning} - -With segment replication, segment files are copied across shards instead of documents being indexed on each shard copy. This improves indexing throughput and lowers resource utilization at the expense of increased network utilization. - -As an experimental feature, segment replication will be behind a feature flag and must be enabled on **each node** of a cluster and pass a new setting during index creation. -{: .note } - -### Potential use cases - -- Users who have high write loads but do not have high search requirements and are comfortable with longer refresh times. -- Users with very high loads who want to add new nodes, as you do not need to index all nodes when adding a new node to the cluster. - -This is the first step in a series of features designed to decouple reads and writes in order to lower compute costs. \ No newline at end of file diff --git a/_opensearch/aggregations.md b/_query-dsl/aggregations/aggregations.md similarity index 98% rename from _opensearch/aggregations.md rename to _query-dsl/aggregations/aggregations.md index 38305997..63e99e47 100644 --- a/_opensearch/aggregations.md +++ b/_query-dsl/aggregations/aggregations.md @@ -1,8 +1,11 @@ --- layout: default title: Aggregations -nav_order: 14 has_children: true +nav_order: 5 +permalink: /aggregations/ +redirect_from: + - /opensearch/aggregations/ --- # Aggregations diff --git a/_opensearch/bucket-agg.md b/_query-dsl/aggregations/bucket-agg.md similarity index 99% rename from _opensearch/bucket-agg.md rename to _query-dsl/aggregations/bucket-agg.md index 35a0a3bc..6154893f 100644 --- a/_opensearch/bucket-agg.md +++ b/_query-dsl/aggregations/bucket-agg.md @@ -2,8 +2,10 @@ layout: default title: Bucket aggregations parent: Aggregations -nav_order: 2 -has_children: false +permalink: /aggregations/bucket-agg/ +nav_order: 3 +redirect_from: + - /opensearch/bucket-agg/ --- # Bucket aggregations diff --git a/_opensearch/geohexgrid-agg.md b/_query-dsl/aggregations/geohexgrid-agg.md similarity index 99% rename from _opensearch/geohexgrid-agg.md rename to _query-dsl/aggregations/geohexgrid-agg.md index f2587fe1..a5831649 100644 --- a/_opensearch/geohexgrid-agg.md +++ b/_query-dsl/aggregations/geohexgrid-agg.md @@ -2,8 +2,8 @@ layout: default title: GeoHex grid aggregations parent: Aggregations +permalink: /aggregations/geohexgrid/ nav_order: 4 -has_children: false --- # GeoHex grid aggregations diff --git a/_opensearch/metric-agg.md b/_query-dsl/aggregations/metric-agg.md similarity index 99% rename from _opensearch/metric-agg.md rename to _query-dsl/aggregations/metric-agg.md index 415d2dfc..bc467776 100644 --- a/_opensearch/metric-agg.md +++ b/_query-dsl/aggregations/metric-agg.md @@ -2,8 +2,10 @@ layout: default title: Metric aggregations parent: Aggregations -nav_order: 1 -has_children: false +nav_order: 2 +permalink: /aggregations/metric-agg/ +redirect_from: + - /opensearch/metric-agg/ --- # Metric aggregations diff --git a/_opensearch/pipeline-agg.md b/_query-dsl/aggregations/pipeline-agg.md similarity index 99% rename from _opensearch/pipeline-agg.md rename to _query-dsl/aggregations/pipeline-agg.md index 57e5e4c5..017ee7e2 100644 --- a/_opensearch/pipeline-agg.md +++ b/_query-dsl/aggregations/pipeline-agg.md @@ -2,7 +2,8 @@ layout: default title: Pipeline aggregations parent: Aggregations -nav_order: 4 +nav_order: 5 +permalink: /aggregations/pipeline-agg/ has_children: false --- diff --git a/_query-dsl/analyzers/language-analyzers.md b/_query-dsl/analyzers/language-analyzers.md new file mode 100644 index 00000000..28833495 --- /dev/null +++ b/_query-dsl/analyzers/language-analyzers.md @@ -0,0 +1,43 @@ +--- +layout: default +title: Language analyzers +nav_order: 45 +parent: Text analyzers +--- + +# Language analyzer + +OpenSearch supports the following language values with the `analyzer` option: +arabic, armenian, basque, bengali, brazilian, bulgarian, catalan, czech, danish, dutch, english, estonian, finnish, french, galician, german, greek, hindi, hungarian, indonesian, irish, italian, latvian, lithuanian, norwegian, persian, portuguese, romanian, russian, sorani, spanish, swedish, turkish, and thai. + +To use the analyzer when you map an index, specify the value within your query. For example, to map your index with the French language analyzer, specify the `french` value for the analyzer field: + +```json + "analyzer": "french" + ``` + +#### Sample Request + +The following query maps an index with the language analyzer set to `french`: + +```json +PUT my-index-000001 + +{ + "mappings": { + "properties": { + "text": { + "type": "text", + "fields": { + "french": { + "type": "text", + "analyzer": "french" + } + } + } + } + } +} +``` + + \ No newline at end of file diff --git a/_im-plugin/refresh-analyzer/index.md b/_query-dsl/analyzers/refresh-analyzer.md similarity index 87% rename from _im-plugin/refresh-analyzer/index.md rename to _query-dsl/analyzers/refresh-analyzer.md index 641d3484..01690b46 100644 --- a/_im-plugin/refresh-analyzer/index.md +++ b/_query-dsl/analyzers/refresh-analyzer.md @@ -2,9 +2,11 @@ layout: default title: Refresh search analyzer nav_order: 50 -has_children: false -redirect_from: /im-plugin/refresh-analyzer/ +parent: Text analyzers has_toc: false +redirect_from: + - /im-plugin/refresh-analyzer/ + - /im-plugin/refresh-analyzer/index/ --- # Refresh search analyzer diff --git a/_opensearch/query-dsl/text-analyzers.md b/_query-dsl/analyzers/text-analyzers.md similarity index 73% rename from _opensearch/query-dsl/text-analyzers.md rename to _query-dsl/analyzers/text-analyzers.md index b618ee31..0003740c 100644 --- a/_opensearch/query-dsl/text-analyzers.md +++ b/_query-dsl/analyzers/text-analyzers.md @@ -1,8 +1,11 @@ --- layout: default title: Text analyzers -parent: Query DSL -nav_order: 75 +nav_order: 190 +has_children: true +permalink: /analyzers/text-analyzers/ +redirect_from: + - /opensearch/query-dsl/text-analyzers/ --- @@ -52,7 +55,7 @@ Each analyzer consists of one tokenizer and zero or more token filters. Differen Option | Valid values | Description :--- | :--- | :--- -`analyzer` | `standard, simple, whitespace, stop, keyword, pattern, language, fingerprint` | The analyzer you want to use for the query. Different analyzers have different character filters, tokenizers, and token filters. The `stop` analyzer, for example, removes stop words (for example, "an," "but," "this") from the query string. For a full list of acceptable language values, see [Language analyzer](#language-analyzer) on this page. +`analyzer` | `standard, simple, whitespace, stop, keyword, pattern, language, fingerprint` | The analyzer you want to use for the query. Different analyzers have different character filters, tokenizers, and token filters. The `stop` analyzer, for example, removes stop words (for example, "an," "but," "this") from the query string. For a full list of acceptable language values, see [Language analyzer]({{site.url}}{{site.baseurl}}/query-dsl/analyzers/language-analyzers/) on this page. `quote_analyzer` | String | This option lets you choose to use the standard analyzer without any options, such as `language` or other analyzers. Usage is `"quote_analyzer": "standard"`. - -## Language analyzer - -OpenSearch supports the following language values with the `analyzer` option: -arabic, armenian, basque, bengali, brazilian, bulgarian, catalan, czech, danish, dutch, english, estonian, finnish, french, galician, german, greek, hindi, hungarian, indonesian, irish, italian, latvian, lithuanian, norwegian, persian, portuguese, romanian, russian, sorani, spanish, swedish, turkish, and thai. - -To use the analyzer when you map an index, specify the value within your query. For example, to map your index with the French language analyzer, specify the `french` value for the analyzer field: - -```json - "analyzer": "french" - ``` - -#### Sample Request - -The following query maps an index with the language analyzer set to `french`: - -```json -PUT my-index-000001 - -{ - "mappings": { - "properties": { - "text": { - "type": "text", - "fields": { - "french": { - "type": "text", - "analyzer": "french" - } - } - } - } - } -} -``` - - \ No newline at end of file diff --git a/_opensearch/query-dsl/compound/bool.md b/_query-dsl/query-dsl/compound/bool.md similarity index 98% rename from _opensearch/query-dsl/compound/bool.md rename to _query-dsl/query-dsl/compound/bool.md index 0e98deeb..897e1838 100644 --- a/_opensearch/query-dsl/compound/bool.md +++ b/_query-dsl/query-dsl/compound/bool.md @@ -4,6 +4,9 @@ title: Boolean queries parent: Compound queries grand_parent: Query DSL nav_order: 10 +permalink: /query-dsl/compound/bool/ +redirect_from: + - /opensearch/query-dsl/compound/bool/ --- # Boolean queries diff --git a/_opensearch/query-dsl/compound/index.md b/_query-dsl/query-dsl/compound/index.md similarity index 93% rename from _opensearch/query-dsl/compound/index.md rename to _query-dsl/query-dsl/compound/index.md index 239af81d..ca74c884 100644 --- a/_opensearch/query-dsl/compound/index.md +++ b/_query-dsl/query-dsl/compound/index.md @@ -4,6 +4,9 @@ title: Compound queries parent: Query DSL has_children: true nav_order: 40 +permalink: /query-dsl/compound/ +redirect_from: + - /opensearch/query-dsl/compound/index/ --- # Compound queries diff --git a/_opensearch/query-dsl/full-text/index.md b/_query-dsl/query-dsl/full-text/index.md similarity index 99% rename from _opensearch/query-dsl/full-text/index.md rename to _query-dsl/query-dsl/full-text/index.md index 6f609631..1b396742 100644 --- a/_opensearch/query-dsl/full-text/index.md +++ b/_query-dsl/query-dsl/full-text/index.md @@ -4,8 +4,10 @@ title: Full-text queries parent: Query DSL has_children: true nav_order: 30 +permalink: /query-dsl/full-text/ redirect_from: - /opensearch/query-dsl/full-text/ + - /opensearch/query-dsl/full-text/index/ --- # Full-text queries diff --git a/_opensearch/query-dsl/full-text/query-string.md b/_query-dsl/query-dsl/full-text/query-string.md similarity index 98% rename from _opensearch/query-dsl/full-text/query-string.md rename to _query-dsl/query-dsl/full-text/query-string.md index 3688a2d2..258caa14 100644 --- a/_opensearch/query-dsl/full-text/query-string.md +++ b/_query-dsl/query-dsl/full-text/query-string.md @@ -4,6 +4,9 @@ title: Query string queries parent: Full-text queries grand_parent: Query DSL nav_order: 25 +permalink: /query-dsl/full-text/query-string/ +redirect_from: + - /opensearch/query-dsl/full-text/query-string/ --- # Query string queries diff --git a/_opensearch/query-dsl/geo-and-xy/geo-bounding-box.md b/_query-dsl/query-dsl/geo-and-xy/geo-bounding-box.md similarity index 98% rename from _opensearch/query-dsl/geo-and-xy/geo-bounding-box.md rename to _query-dsl/query-dsl/geo-and-xy/geo-bounding-box.md index 71773348..0dc63f34 100644 --- a/_opensearch/query-dsl/geo-and-xy/geo-bounding-box.md +++ b/_query-dsl/query-dsl/geo-and-xy/geo-bounding-box.md @@ -4,6 +4,9 @@ title: Geo-bounding box queries parent: Geographic and xy queries grand_parent: Query DSL nav_order: 10 +permalink: /query-dsl/geo-and-xy/geo-bounding-box/ +redirect_from: + - /opensearch/query-dsl/geo-and-xy/geo-bounding-box/ --- # Geo-bounding box queries diff --git a/_opensearch/query-dsl/geo-and-xy/index.md b/_query-dsl/query-dsl/geo-and-xy/index.md similarity index 96% rename from _opensearch/query-dsl/geo-and-xy/index.md rename to _query-dsl/query-dsl/geo-and-xy/index.md index ba9f2b59..7c2dadb4 100644 --- a/_opensearch/query-dsl/geo-and-xy/index.md +++ b/_query-dsl/query-dsl/geo-and-xy/index.md @@ -4,6 +4,9 @@ title: Geographic and xy queries parent: Query DSL has_children: true nav_order: 50 +permalink: /query-dsl/geo-and-xy/ +redirect_from: + - /opensearch/query-dsl/geo-and-xy/index/ --- # Geographic and xy queries diff --git a/_opensearch/query-dsl/geo-and-xy/xy.md b/_query-dsl/query-dsl/geo-and-xy/xy.md similarity index 99% rename from _opensearch/query-dsl/geo-and-xy/xy.md rename to _query-dsl/query-dsl/geo-and-xy/xy.md index a476be33..6b29063b 100644 --- a/_opensearch/query-dsl/geo-and-xy/xy.md +++ b/_query-dsl/query-dsl/geo-and-xy/xy.md @@ -4,6 +4,9 @@ title: xy queries parent: Geographic and xy queries grand_parent: Query DSL nav_order: 50 +permalink: /query-dsl/geo-and-xy/xy/ +redirect_from: + - /opensearch/query-dsl/geo-and-xy/xy/ --- # xy queries diff --git a/_opensearch/query-dsl/index.md b/_query-dsl/query-dsl/index.md similarity index 98% rename from _opensearch/query-dsl/index.md rename to _query-dsl/query-dsl/index.md index 6f7c277b..520e2bd7 100644 --- a/_opensearch/query-dsl/index.md +++ b/_query-dsl/query-dsl/index.md @@ -1,10 +1,12 @@ --- layout: default title: Query DSL -nav_order: 27 +nav_order: 2 has_children: true +permalink: /query-dsl/ redirect_from: - /opensearch/query-dsl/ + - /opensearch/query-dsl/index/ - /docs/opensearch/query-dsl/ --- diff --git a/_opensearch/query-dsl/query-filter-context.md b/_query-dsl/query-dsl/query-filter-context.md similarity index 98% rename from _opensearch/query-dsl/query-filter-context.md rename to _query-dsl/query-dsl/query-filter-context.md index 53f716c2..05996bfd 100644 --- a/_opensearch/query-dsl/query-filter-context.md +++ b/_query-dsl/query-dsl/query-filter-context.md @@ -2,6 +2,7 @@ layout: default title: Query and filter context parent: Query DSL +permalink: /query-dsl/query-filter-context/ nav_order: 5 --- diff --git a/_opensearch/query-dsl/span-query.md b/_query-dsl/query-dsl/span-query.md similarity index 94% rename from _opensearch/query-dsl/span-query.md rename to _query-dsl/query-dsl/span-query.md index 6ed28429..91250584 100644 --- a/_opensearch/query-dsl/span-query.md +++ b/_query-dsl/query-dsl/span-query.md @@ -3,6 +3,9 @@ layout: default title: Span queries parent: Query DSL nav_order: 60 +permalink: /query-dsl/span-query/ +redirect_from: + - /opensearch/query-dsl/span-query/ --- # Span queries diff --git a/_opensearch/query-dsl/term-vs-full-text.md b/_query-dsl/query-dsl/term-vs-full-text.md similarity index 99% rename from _opensearch/query-dsl/term-vs-full-text.md rename to _query-dsl/query-dsl/term-vs-full-text.md index c35fa77b..68a912b5 100644 --- a/_opensearch/query-dsl/term-vs-full-text.md +++ b/_query-dsl/query-dsl/term-vs-full-text.md @@ -2,6 +2,7 @@ layout: default title: Term-level and full-text queries compared parent: Query DSL +permalink: /query-dsl/term-vs-full-text/ nav_order: 10 --- diff --git a/_opensearch/query-dsl/term.md b/_query-dsl/query-dsl/term.md similarity index 99% rename from _opensearch/query-dsl/term.md rename to _query-dsl/query-dsl/term.md index bda2a5f6..38a43f97 100644 --- a/_opensearch/query-dsl/term.md +++ b/_query-dsl/query-dsl/term.md @@ -3,6 +3,9 @@ layout: default title: Term-level queries parent: Query DSL nav_order: 20 +permalink: /query-dsl/term/ +redirect_from: + - /opensearch/query-dsl/term/ --- # Term-level queries diff --git a/_neural-search-plugin/index.md b/_search-plugins/neural-search.md similarity index 99% rename from _neural-search-plugin/index.md rename to _search-plugins/neural-search.md index 6372a290..6cf199c5 100644 --- a/_neural-search-plugin/index.md +++ b/_search-plugins/neural-search.md @@ -1,9 +1,11 @@ --- layout: default title: Neural Search plugin -nav_order: 1 +nav_order: 200 has_children: false has_toc: false +redirect_from: + - /neural-search-plugin/index/ --- # Neural Search plugin diff --git a/_opensearch/point-in-time-api.md b/_search-plugins/point-in-time-api.md similarity index 99% rename from _opensearch/point-in-time-api.md rename to _search-plugins/point-in-time-api.md index 397387e7..69824f16 100644 --- a/_opensearch/point-in-time-api.md +++ b/_search-plugins/point-in-time-api.md @@ -1,9 +1,11 @@ --- layout: default title: Point in Time API -nav_order: 58 +nav_order: 59 has_children: false parent: Point in Time +redirect_from: + - /opensearch/point-in-time-api/ --- # Point in Time API diff --git a/_opensearch/point-in-time.md b/_search-plugins/point-in-time.md similarity index 99% rename from _opensearch/point-in-time.md rename to _search-plugins/point-in-time.md index a6fcf492..4453dde3 100644 --- a/_opensearch/point-in-time.md +++ b/_search-plugins/point-in-time.md @@ -4,6 +4,8 @@ title: Point in Time nav_order: 58 has_children: true has_toc: false +redirect_from: + - /opensearch/point-in-time/ --- # Point in Time diff --git a/_search-plugins/querqy/index.md b/_search-plugins/querqy/index.md index ea980a12..3abd12dc 100644 --- a/_search-plugins/querqy/index.md +++ b/_search-plugins/querqy/index.md @@ -4,7 +4,7 @@ title: Querqy has_children: false redirect_from: - /search-plugins/querqy/ -nav_order: 10 +nav_order: 210 --- # Querqy diff --git a/_opensearch/search-template.md b/_search-plugins/search-template.md similarity index 99% rename from _opensearch/search-template.md rename to _search-plugins/search-template.md index 33b79666..3b9bc7cc 100644 --- a/_opensearch/search-template.md +++ b/_search-plugins/search-template.md @@ -2,6 +2,8 @@ layout: default title: Search templates nav_order: 50 +redirect_from: + - /opensearch/search-template/ --- # Search templates diff --git a/_opensearch/search/autocomplete.md b/_search-plugins/searching-data/autocomplete.md similarity index 99% rename from _opensearch/search/autocomplete.md rename to _search-plugins/searching-data/autocomplete.md index 36276ba4..ce867ed4 100644 --- a/_opensearch/search/autocomplete.md +++ b/_search-plugins/searching-data/autocomplete.md @@ -3,6 +3,8 @@ layout: default title: Autocomplete parent: Searching data nav_order: 24 +redirect_from: + - /opensearch/search/autocomplete/ --- # Autocomplete functionality diff --git a/_opensearch/search/did-you-mean.md b/_search-plugins/searching-data/did-you-mean.md similarity index 100% rename from _opensearch/search/did-you-mean.md rename to _search-plugins/searching-data/did-you-mean.md diff --git a/_opensearch/search/highlight.md b/_search-plugins/searching-data/highlight.md similarity index 99% rename from _opensearch/search/highlight.md rename to _search-plugins/searching-data/highlight.md index 52db512c..7b312e56 100644 --- a/_opensearch/search/highlight.md +++ b/_search-plugins/searching-data/highlight.md @@ -3,6 +3,8 @@ layout: default title: Highlight query matches parent: Searching data nav_order: 23 +redirect_from: + - /opensearch/search/highlight/ --- # Highlight query matches diff --git a/_opensearch/search/index.md b/_search-plugins/searching-data/index.md similarity index 98% rename from _opensearch/search/index.md rename to _search-plugins/searching-data/index.md index 35c6671c..7e1c5a7e 100644 --- a/_opensearch/search/index.md +++ b/_search-plugins/searching-data/index.md @@ -1,7 +1,7 @@ --- layout: default title: Searching data -nav_order: 20 +nav_order: 5 has_children: true has_toc: false redirect_from: /opensearch/ux/ diff --git a/_opensearch/search/paginate.md b/_search-plugins/searching-data/paginate.md similarity index 99% rename from _opensearch/search/paginate.md rename to _search-plugins/searching-data/paginate.md index 660a99f2..a43cfac7 100644 --- a/_opensearch/search/paginate.md +++ b/_search-plugins/searching-data/paginate.md @@ -3,6 +3,8 @@ layout: default title: Paginate results parent: Searching data nav_order: 21 +redirect_from: + - /opensearch/search/paginate/ --- ## Paginate results diff --git a/_opensearch/search/sort.md b/_search-plugins/searching-data/sort.md similarity index 99% rename from _opensearch/search/sort.md rename to _search-plugins/searching-data/sort.md index dac96d17..fa4875d3 100644 --- a/_opensearch/search/sort.md +++ b/_search-plugins/searching-data/sort.md @@ -3,6 +3,8 @@ layout: default title: Sort results parent: Searching data nav_order: 22 +redirect_from: + - /opensearch/search/sort/ --- ## Sort results diff --git a/_troubleshoot/security-admin.md b/_troubleshoot/security-admin.md index 4d6a1de6..4df16df7 100644 --- a/_troubleshoot/security-admin.md +++ b/_troubleshoot/security-admin.md @@ -92,8 +92,7 @@ Connected as CN=node-0.example.com,OU=SSL,O=Test,L=Test,C=DE ERR: CN=node-0.example.com,OU=SSL,O=Test,L=Test,C=DE is not an admin user ``` -You must use an admin certificate when executing the script. To learn more, see [Configure admin certificates]({{site.url}}{{site.baseurl}}/security/configuration/tls#configuring-admin-certificates). - +You must use an admin certificate when executing the script. To learn more, see [Configure admin certificates]({{site.url}}{{site.baseurl}}/security/configuration/tls/#configuring-admin-certificates). ## Use the diagnose option diff --git a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md index c51a5810..238cbac1 100644 --- a/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md +++ b/_tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md @@ -7,6 +7,7 @@ has_children: false grand_parent: Availability and Recovery redirect_from: - /opensearch/snapshots/snapshot-restore/ + - /availability-and-recovery/snapshots/snapshot-restore/ --- # Take and restore snapshots diff --git a/_upgrade-to/upgrade-to.md b/_upgrade-to/upgrade-to.md index 8e6d362c..5059068d 100644 --- a/_upgrade-to/upgrade-to.md +++ b/_upgrade-to/upgrade-to.md @@ -182,7 +182,7 @@ If you are migrating an Open Distro for Elasticsearch cluster, we recommend firs ## Upgrade tool -The `opensearch-upgrade` tool lets you automate some of the steps in [Upgrade to OpenSearch]({{site.url}}{{site.baseurl}}/upgrade-to/upgrade-to/#migrate-to-opensearch), eliminating the need for error-prone manual operations. +The `opensearch-upgrade` tool lets you automate some of the steps in [Migrate to OpenSearch](#migrate-to-opensearch), eliminating the need for error-prone manual operations. The `opensearch-upgrade` tool performs the following functions: @@ -202,8 +202,7 @@ The `opensearch-upgrade` tool doesn't perform an end-to-end upgrade: To perform a rolling upgrade using the [OpenSearch tarball]({{site.url}}{{site.baseurl}}/opensearch/install/tar/) distribution: -Check [Upgrade paths]({{site.url}}{{site.baseurl}}/upgrade-to/upgrade-to/#migration-paths) to make sure that the version you’re upgrading to is supported and whether you need to upgrade to a supported Elasticsearch OSS version first. -{: .note } +Check [Upgrade paths](#migration-paths) to make sure that the version you’re upgrading to is supported and whether you need to upgrade to a supported Elasticsearch OSS version first. 1. Disable shard allocation to prevent Elasticsearch OSS from replicating shards as you shut down nodes: