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

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

Add CCS based reindex in doc page #117154

wants to merge 6 commits into from

Conversation

atsushi-matsui
Copy link

close #116999

Add CCS-based reindex to docs.

@github-actions GitHub Actions
Copy link
Contributor

Documentation preview:

@elasticsearchmachine elasticsearchmachine added v9.0.0 external-contributor Pull request authored by a developer outside the Elasticsearch team needs:triage Requires assignment of a team area label labels Nov 20, 2024
@atsushi-matsui atsushi-matsui force-pushed the feature/docs/add-css-based-reindex-to-docs branch from 4376cfe to 8f66c41 Compare November 20, 2024 15:14
@atsushi-matsui atsushi-matsui changed the title docs: add CCS based reindex to docs Add CCS based reindex in doc page Nov 20, 2024
@gbanasiak gbanasiak added >docs General docs changes :Distributed Indexing/Reindex Issues relating to reindex that are not caused by issues further down labels Nov 22, 2024
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:Distributed Indexing Meta label for Distributed Indexing team labels Nov 22, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Nov 22, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-distributed-indexing (Team:Distributed Indexing)

@kingherc kingherc added auto-backport Automatically create backport pull requests when merged v8.18.0 v8.16.2 v8.17.1 labels Nov 22, 2024
kingherc
kingherc reviewed Nov 22, 2024
View reviewed changes
Copy link
Contributor

@kingherc kingherc left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Nice going! Added labels to automatically backport this to previous versions once approved and merged.

I think this looks fine to me in general. But I'd like to assign this to @ankikuma who's been more involved with reindex to take a look and finally approve, if possible.

@kingherc kingherc requested a review from ankikuma November 22, 2024 09:52
@atsushi-matsui
Copy link
Author

@kingherc
Thank you for your comment. I have corrected it, so please check it.

kingherc
kingherc reviewed Nov 25, 2024
View reviewed changes
Copy link
Contributor

@kingherc kingherc left a comment

Choose a reason for hiding this comment

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

Thanks! Looks good to me. @ankikuma would you be able to handle final review & approval?

@ankikuma
Copy link
Contributor

Based on this PR, I think we might also need to mention ignore_unavailable and skip_unavailable settings, for a more comprehensive documentation. Adding Albert to the review since he reviewed the PR that added support for reindex over CCS.

albertzaharovits
albertzaharovits reviewed Nov 28, 2024
View reviewed changes
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
<<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.

albertzaharovits
albertzaharovits reviewed Nov 28, 2024
View reviewed changes
docs/reference/docs/reindex.asciidoc
Comment on lines +1125 to +1128
[[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:
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.

@leemthompo
Copy link
Contributor

run docs-build

@leemthompo
Copy link
Contributor

@elasticsearchmachine test this

@leemthompo
Copy link
Contributor

Important

Elastic documentation is migrating to Markdown for version 9.0+. See the migration guide for details.

ℹ️ What's happening?

  • Starting January 29, we will start closing all unmerged documentation PRs targeting main/master
  • We're migrating from AsciiDoc to Markdown for 9.0+
  • 9.0 docs will be frozen from January 29 until February 20 2024
  • NOTE: PRs that include both code and documentation changes will remain open

What do I need to do?

For <=8.x docs:

  1. Rebase your PR to target the relevant 8.x branch instead
  2. The content can remain in AsciiDoc format

For 9.0+ docs:

Option 1:

  • Draft docs in Markdown
  • Once migration freeze ends, find the relevant page in the new docs system and use the edit options to submit your changes

Option 2:

💡 Need help?

  1. For Elasticians: Ask in #docs Slack channel
  2. For external contributors: Open an issue in elastic/docs-content

@leemthompo
Copy link
Contributor

@ankikuma @atsushi-matsui @albertzaharovits Please merge this PR today before the migration freeze. I just merged main, but there was a docs-check CI failure on previous commit that might require investigating. Thanks!

@github-actions GitHub Actions
Copy link
Contributor

Warning

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

@atsushi-matsui atsushi-matsui force-pushed the feature/docs/add-css-based-reindex-to-docs branch from 546605f to 670899d Compare February 19, 2025 01:06
@github-actions GitHub Actions
Copy link
Contributor

Warning

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kingherc kingherc kingherc left review comments

@ankikuma ankikuma ankikuma approved these changes

@albertzaharovits albertzaharovits Awaiting requested review from albertzaharovits

Assignees

@ankikuma ankikuma

Labels
auto-backport Automatically create backport pull requests when merged :Distributed Indexing/Reindex Issues relating to reindex that are not caused by issues further down >docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Distributed Indexing Meta label for Distributed Indexing team Team:Docs Meta label for docs team v8.16.7 v8.17.7 v8.19.0 v9.1.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add reindex via css to document
7 participants
@atsushi-matsui @elasticsearchmachine @ankikuma @leemthompo @albertzaharovits @kingherc @gbanasiak