Skip to content

Add CCS based reindex in doc page #117154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add CCS based reindex in doc page #117154

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8f66c41
docs: add CCS based reindex to docs
atsushi-matsui Nov 20, 2024
69985f7
omit changelog
atsushi-matsui Nov 24, 2024
e058651
omit note
atsushi-matsui Nov 24, 2024
34a6708
expand and use lowercase
atsushi-matsui Nov 24, 2024
6ae57e0
simple note
atsushi-matsui Nov 28, 2024
670899d
Merge branch 'main' into feature/docs/add-css-based-reindex-to-docs
leemthompo Jan 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/reference/docs/reindex.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ privilege for the source data stream, index, or alias.
in the `reindex.remote.whitelist` setting of `elasticsearch.yml`. See
<<reindex-from-remote>>.

* If ccs-based reindexing from a remote cluster, you must add the remote cluster setting. See
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* If ccs-based reindexing from a remote cluster, you must add the remote cluster setting. See
* If reindexing from a remote cluster, you must add the remote cluster setting. See

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since it looks like a condition for performing an existing reindex, I think it would be better to give it a different name to avoid confusing users.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I agree that we should keep the terminology to "ccs-based reindexing" to distinguish this from the pre-existing functionality of reindexing from a remote cluster.

<<add-remote-clusters>>.

* Automatic data stream creation requires a matching index template with data
stream enabled. See <<set-up-a-data-stream>>.

Expand Down Expand Up @@ -1119,6 +1122,30 @@ 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 Cross-cluster search (<<modules-cross-cluster-search,{ccs}>>) based reindexing from a remote Elasticsearch cluster:
Comment on lines +1131 to +1134
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[[ccs-based-reindex-from-remote]]
==== ccs based reindex from remote
Reindex supports Cross-cluster search (<<modules-cross-cluster-search,{ccs}>>) based reindexing from a remote Elasticsearch cluster:
[[reindex-from-remote-cluster]]
==== reindex from remote cluster
Reindex supports sourcing documents from a remote Elasticsearch cluster:

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since a section named reindex-from-remote already exists, won't it be difficult to understand what the difference is with reindex-from-remote-cluster?
You said that ccs is a low-level feature and we don't need to worry about it too much, but I think it would be better to clarify the difference with the existing remote reindex.


[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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't follow what "retrieve the remote cluster name" means here.
Perhaps, it should all be rephrased more simply such as: "Note that reindexing requires that the remote cluster be configured on the local cluster."

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That certainly seems confusing.
I'll rephrase it to a simpler version.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

simple note

For more details, refer to the reference for <<add-remote-clusters>>.

[[reindex-ssl]]
===== Configuring SSL parameters

Expand Down