From 8f66c413c51745e56242eaef54c0a4f4133227fe Mon Sep 17 00:00:00 2001 From: atsushi-matsui Date: Wed, 20 Nov 2024 22:20:56 +0900 Subject: [PATCH 1/5] docs: add CCS based reindex to docs --- docs/changelog/117154.yaml | 5 +++++ docs/reference/docs/reindex.asciidoc | 29 ++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 docs/changelog/117154.yaml diff --git a/docs/changelog/117154.yaml b/docs/changelog/117154.yaml new file mode 100644 index 0000000000000..445a37335243a --- /dev/null +++ b/docs/changelog/117154.yaml @@ -0,0 +1,5 @@ +pr: 117154 +summary: "Add CCS based reindex to docs" +area: Search +type: bug +issues: [] \ No newline at end of file diff --git a/docs/reference/docs/reindex.asciidoc b/docs/reference/docs/reindex.asciidoc index dc27e40ecd90b..629dc3048bbfb 100644 --- a/docs/reference/docs/reindex.asciidoc +++ b/docs/reference/docs/reindex.asciidoc @@ -92,6 +92,9 @@ privilege for the source data stream, index, or alias. in the `reindex.remote.whitelist` setting of `elasticsearch.yml`. See <>. +* If CCS-based reindexing from a remote cluster, you must add the remote cluster setting. See +<>. + * Automatic data stream creation requires a matching index template with data stream enabled. See <>. @@ -1119,6 +1122,32 @@ POST _reindex // TEST[s/otherhost:9200/\${host}/] // TEST[s/\.\.\.,/"username": "test_admin", "password": "x-pack-test-password",/] +[[CCS-based-reindex-from-remote]] +==== CCS based reindex from remote + +Reindex supports CCS based reindexing from a remote Elasticsearch cluster: + +[source,console] +-------------------------------------------------- +POST _reindex +{ + "source": { + "index": "cluster_one:my-index-000001" + }, + "dest": { + "index": "my-new-index-000001" + } +} +-------------------------------------------------- +// TEST[setup:my_index_big] + +The `index` parameter must be specified with the remote cluster name and the index name, separated by +a colon (e.g., cluster_one:my-index-000001). +Additionally, you must configure the remote cluster in advance and retrieve the remote cluster name. +For more details, refer to the reference for <>. + +NOTE: Needs v8.12.0 or later on the reindexing cluster. + [[reindex-ssl]] ===== Configuring SSL parameters From 69985f7d920aa1eb2ea3f0e8e48f17269364f655 Mon Sep 17 00:00:00 2001 From: atsushi-matsui Date: Mon, 25 Nov 2024 08:20:26 +0900 Subject: [PATCH 2/5] omit changelog --- docs/changelog/117154.yaml | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 docs/changelog/117154.yaml diff --git a/docs/changelog/117154.yaml b/docs/changelog/117154.yaml deleted file mode 100644 index 445a37335243a..0000000000000 --- a/docs/changelog/117154.yaml +++ /dev/null @@ -1,5 +0,0 @@ -pr: 117154 -summary: "Add CCS based reindex to docs" -area: Search -type: bug -issues: [] \ No newline at end of file From e0586516ce1d8415759d7ffbb1a97c6021b880be Mon Sep 17 00:00:00 2001 From: atsushi-matsui Date: Mon, 25 Nov 2024 08:21:24 +0900 Subject: [PATCH 3/5] omit note --- docs/reference/docs/reindex.asciidoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/reference/docs/reindex.asciidoc b/docs/reference/docs/reindex.asciidoc index 629dc3048bbfb..1156df00564f9 100644 --- a/docs/reference/docs/reindex.asciidoc +++ b/docs/reference/docs/reindex.asciidoc @@ -1146,8 +1146,6 @@ a colon (e.g., cluster_one:my-index-000001). Additionally, you must configure the remote cluster in advance and retrieve the remote cluster name. For more details, refer to the reference for <>. -NOTE: Needs v8.12.0 or later on the reindexing cluster. - [[reindex-ssl]] ===== Configuring SSL parameters From 34a6708404200dba0aad0371863fb34197779333 Mon Sep 17 00:00:00 2001 From: atsushi-matsui Date: Mon, 25 Nov 2024 08:34:08 +0900 Subject: [PATCH 4/5] expand and use lowercase --- docs/reference/docs/reindex.asciidoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/reference/docs/reindex.asciidoc b/docs/reference/docs/reindex.asciidoc index 1156df00564f9..d6d6421cd231d 100644 --- a/docs/reference/docs/reindex.asciidoc +++ b/docs/reference/docs/reindex.asciidoc @@ -92,7 +92,7 @@ privilege for the source data stream, index, or alias. in the `reindex.remote.whitelist` setting of `elasticsearch.yml`. See <>. -* If CCS-based reindexing from a remote cluster, you must add the remote cluster setting. See +* If ccs-based reindexing from a remote cluster, you must add the remote cluster setting. See <>. * Automatic data stream creation requires a matching index template with data @@ -1122,10 +1122,10 @@ POST _reindex // TEST[s/otherhost:9200/\${host}/] // TEST[s/\.\.\.,/"username": "test_admin", "password": "x-pack-test-password",/] -[[CCS-based-reindex-from-remote]] -==== CCS based reindex from remote +[[ccs-based-reindex-from-remote]] +==== ccs based reindex from remote -Reindex supports CCS based reindexing from a remote Elasticsearch cluster: +Reindex supports Cross-cluster search (<>) based reindexing from a remote Elasticsearch cluster: [source,console] -------------------------------------------------- From 6ae57e05cdb51ec530aab31bcdc1cf7a7a987eca Mon Sep 17 00:00:00 2001 From: atsushi-matsui Date: Fri, 29 Nov 2024 07:51:07 +0900 Subject: [PATCH 5/5] simple note --- docs/reference/docs/reindex.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/docs/reindex.asciidoc b/docs/reference/docs/reindex.asciidoc index d6d6421cd231d..7b945eed208de 100644 --- a/docs/reference/docs/reindex.asciidoc +++ b/docs/reference/docs/reindex.asciidoc @@ -1143,8 +1143,8 @@ POST _reindex The `index` parameter must be specified with the remote cluster name and the index name, separated by a colon (e.g., cluster_one:my-index-000001). -Additionally, you must configure the remote cluster in advance and retrieve the remote cluster name. -For more details, refer to the reference for <>. + +NOTE: Reindexing requires that the remote cluster be configured on the local cluster. [[reindex-ssl]] ===== Configuring SSL parameters