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

Add troubleshooting guide for corrupt repository #88391

Merged
merged 15 commits into from
Jul 14, 2022

Conversation

andreidan
Copy link
Contributor

@andreidan andreidan commented Jul 8, 2022

This adds a troubleshooting guide for the situation when multiple clusters
are writing to the same snapshot repository, resulting in a corrupt repository.

Preview link https://elasticsearch_88391.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/add-repository.html

@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Data Management Meta label for data/management team labels Jul 8, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-data-management (Team:Data Management)

@elasticmachine
Copy link
Collaborator

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

@@ -0,0 +1,11 @@
[[add-repository]]
== Mark repository as read-only in other deployments and re-create it in this deployment
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't like this title. Any better suggestions?

Copy link
Contributor

Choose a reason for hiding this comment

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

In troubleshooting pages, the title typically denotes the problem that the user is encountering and trying to solve. In which case, maybe something like Multiple deployments writing to the same repository could be a good title.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the suggestion Adam. I'll make this change.

Copy link
Member

@dakrone dakrone left a comment

Choose a reason for hiding this comment

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

I left some general comments, I think we should replace "re-add" with "recreate" since re-add is an awkward semi-not-really-a-word-word.

Otherwise, this is a semi-complicated remediation, so I'm not sure how to simplify it more.

Comment on lines 5 to 6
we want to keep writing to the repository the "main" deployment (the current cluster),
and the other one(s) where we'll mark the repository as read-only the "secondary"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
we want to keep writing to the repository the "main" deployment (the current cluster),
and the other one(s) where we'll mark the repository as read-only the "secondary"
we want to keep writing to the repository the "primary" deployment (the current cluster),
and the other one(s) where we'll mark the repository as read-only the "secondary"

Feels like if we go with "secondary" maybe we should use "primary" also?

Copy link
Member

@dakrone dakrone left a comment

Choose a reason for hiding this comment

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

LGTM, I left a few more nits, but up to you. Thanks for writing these!

@andreidan
Copy link
Contributor Author

@elasticmachine update branch

@andreidan andreidan merged commit f3431e1 into elastic:master Jul 14, 2022
andreidan added a commit to andreidan/elasticsearch that referenced this pull request Jul 14, 2022
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.3

elasticsearchmachine pushed a commit that referenced this pull request Jul 14, 2022
weizijun added a commit to weizijun/elasticsearch that referenced this pull request Jul 15, 2022
* upstream/master: (2974 commits)
  Reserved cluster state service (elastic#88527)
  Add transport action immutable state checks (elastic#88491)
  Remove suggest flag from index stats docs (elastic#85479)
  Polling cluster formation state for master-is-stable health indicator (elastic#88397)
  Add test execution guide in yamlRestTest asciidoc (elastic#88490)
  Add troubleshooting guide for corrupt repository (elastic#88391)
  [Transform] Finetune Schedule to be less noisy on retry and retry slower (elastic#88531)
  Updatable API keys - auto-update legacy RDs (elastic#88514)
  Fix typo in TransportForceMergeAction and TransportClearIndicesCacheA… (elastic#88064)
  Fixed NullPointerException on bulk request (elastic#88358)
  Avoid needless index metadata builders during reroute (elastic#88506)
  Set metadata on request in API key noop test (elastic#88507)
  Fix passing positional args to ES in Docker (elastic#88502)
  Improve description for task api detailed param (elastic#88493)
  Support cartesian shape with doc values (elastic#88487)
  Promote usage of Subjects in Authentication class (elastic#88494)
  Add CCx 2.0 feature flag (elastic#88451)
  Reword the watcher 'always' and 'never' condition docs (elastic#86105)
  Simplify azure discovery installation docs (elastic#88404)
  Breakup FIPS CI testing jobs
  ...

# Conflicts:
#	server/src/main/java/org/elasticsearch/index/mapper/NumberFieldMapper.java
#	x-pack/plugin/mapper-aggregate-metric/src/main/java/org/elasticsearch/xpack/aggregatemetric/mapper/AggregateDoubleMetricFieldMapper.java
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Health >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v8.3.3 v8.4.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants