Updates CRD docs to accurately reflect the behavior of 'savepointpath'. #227
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
HunterEl
requested review from
anandswaminathan,
maghamravi,
mwylde and
premsantosh
as code owners
maghamravi
reviewed
Feb 17, 2021
| @@ -103,6 +103,8 @@ Below is the list of fields in the custom resource and their description: | |||
|
|
|||
| * **savepointPath** `type:string` | |||
| If specified, the application state will be restored from this savepoint. | |||
|
|
|||
| **This will only have an effect on the first deploy of a cluster. Specifying a savepoint path as an update to an already running cluster is treated as a noop.** | |||
There was a problem hiding this comment.
nit: What are your thoughts on s/cluster/application/g ? The reason is the existing documentation talks in terms application all along and using the same term minimizes confusion.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Spawned from a question in the community slack channel for this project: Link to slack conversation.
Specifying
savepointpathas an update to an already running cluster is treated as a noop, this wasn't clear from the documentation and took us some time to figure this one out. Would be nice if the documentation clearly stated the behavior of this field and how it's expected to behave.