Skip to content
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.

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

[DOCS] uni-directional CCR disaster recovery #87099

Closed
wants to merge 15 commits into from

Conversation

Leaf-Lin
Copy link
Contributor

@Leaf-Lin Leaf-Lin commented May 25, 2022

Detailed step-by-step tutorial for uni-directional CCR disaster recovery

closes: #84854

@Leaf-Lin Leaf-Lin added the Team:Docs Meta label for docs team label May 25, 2022
@elasticmachine
Copy link
Collaborator

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

@Leaf-Lin Leaf-Lin added the :Distributed Indexing/CCR Issues around the Cross Cluster State Replication features label May 25, 2022
@elasticmachine elasticmachine added the Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. label May 25, 2022
@elasticmachine
Copy link
Collaborator

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

@Leaf-Lin Leaf-Lin requested a review from henningandersen May 25, 2022 06:45
@Leaf-Lin Leaf-Lin requested a review from lockewritesdocs May 25, 2022 06:47
@elasticsearchmachine elasticsearchmachine changed the base branch from master to main July 22, 2022 23:07
@mark-vieira mark-vieira added v8.5.0 and removed v8.4.0 labels Jul 27, 2022
@elasticsearchmachine elasticsearchmachine removed the Team:Docs Meta label for docs team label Jul 27, 2022
@Leaf-Lin Leaf-Lin linked an issue Aug 29, 2022 that may be closed by this pull request
@lockewritesdocs lockewritesdocs added >docs General docs changes v8.3.4 v8.4.2 labels Sep 9, 2022
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Sep 9, 2022
@kingherc kingherc added v8.4.3 and removed v8.4.2 labels Sep 15, 2022
@henningandersen
Copy link
Contributor

@elasticmachine run elasticsearch-ci/docs
@elasticmachine run elasticsearch-ci/docs-check

Copy link
Contributor

@henningandersen henningandersen left a comment

Choose a reason for hiding this comment

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

You will need to include this new page in order to make it visible (and to be able to preview it).

@csoulios csoulios added v8.6.0 and removed v8.5.0 labels Sep 21, 2022
@Leaf-Lin
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs
@elasticmachine run elasticsearch-ci/docs-check

@lockewritesdocs
Copy link
Contributor

lockewritesdocs commented Sep 23, 2022

I added this file to the table of contents so that it displays in the navigation. I also made changes to the introductory section, but I have questions about how this tutorial works. We make a lot of assumptions in this document. For example, the first step says:

  1. On the Clients side, pause ingestion of my_index into prod1.

TIP: Ensure no writes are occurring on the leader index (if the data centre is
down, or cluster is unavailable, no action needed).

How do you pause ingestion? Through Kibana? If so, where? What is "the Clients side"? How can I tell if writes are occurring on the leader index or check the cluster's availability?

I don't think that we can assume users have all of this knowledge and instinctually know where to complete these tasks. We should be much more prescriptive and provide both direction (such as where to go in the Cloud console) and examples.

@Leaf-Lin, can you help to provide some additional context?

@Leaf-Lin
Copy link
Contributor Author

Leaf-Lin commented Nov 10, 2022

I've made some changes to this doc including clarifying how to pause ingest on the client side and adding an image to clarify the 3 scenarios.

Preview page is available in: https://elasticsearch_87099.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/ccr-disaster-recovery-uni-directional-tutorial.html

Btw, I only changed this one page, but the https://elasticsearch_87099.docs-preview.app.elstc.co/diff shows a lot of changes, I hope that won't be merged.

remove mutable limitation
@cla-checker-service
Copy link

❌ Author of the following commits did not sign a Contributor Agreement:
2a36acd, 0cda1b7

Please, read and sign the above mentioned agreement if you want to contribute to this project

@Leaf-Lin
Copy link
Contributor Author

Closing this in favour of #91491

@Leaf-Lin Leaf-Lin closed this Nov 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Indexing/CCR Issues around the Cross Cluster State Replication features >docs General docs changes Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team v8.3.4 v8.4.4 v8.7.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Step-by-step tutorial for uni-directional CCR failover
9 participants