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.

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

Updates CRD docs to accurately reflect the behavior of 'savepointpath'. #227

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+2 −0
Open

Updates CRD docs to accurately reflect the behavior of 'savepointpath'. #227

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/crd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.**
Copy link
Contributor

Choose a reason for hiding this comment

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

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.


* **savepointDisabled** `type:boolean`
If specified, during an update, the current application (if existing) is cancelled without taking a savepoint.
Expand Down