[YUNIKORN-2524] add documentation for recovery queue (root.@recovery@) #459
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this PR for?
the recovery queue is unqueryable directly but we can observe the recovery queue name via app Restful API (
ws/v1/partition/%s/application/%s
).Hence, we should write documents for recovery queue. Otherwise, it would be surprise to users when they see the incomprehensible queue and they get nothing from our docs.
This should be a full documentation of the recovery queue and its purpose. I think we overlooked that until now. With the change to set the force flag in the k8shim we now can see the queue.
We should explain the initialisation process and the roll of the queue:
What type of PR is it?
Todos
What is the Jira issue?
https://issues.apache.org/jira/browse/YUNIKORN-2524
How should this be tested?
Screenshots (if appropriate)
Questions: