Skip to content

Commit

Permalink
More doc detail for maxCheckpointRestoreAgeSeconds (#200)
Browse files Browse the repository at this point in the history
  • Loading branch information
haltwise authored May 15, 2020
1 parent e470b4a commit 93cf7f4
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions docs/crd.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,10 +132,7 @@ Below is the list of fields in the custom resource and their description
If an application is successfully rolled back, it is moved to a *DeployFailed* phase. Un-setting or setting `ForceRollback` to `False` will allow updates to progress normally.

* **maxCheckpointRestoreAgeSeconds** `type:int32`
Used to prevent the application from restoring state from a checkpoint whose age (in seconds) is greater than the value set. It defaults to 1 hour (3600 seconds). This config
is used during the operator update workflow. This default exists only
to protect one from accidentally restarting the application using a very old checkpoint (which might put your application
under huge load). **Note:** this doesn't affect the flink application's checkpointing mechanism in anyway.
If the operator is unable to successfully take a savepoint of the existing job when updating, it may fall back to instead using the job's most recent checkpoint. This parameter determines the maximum checkpoint age (in seconds) that is eligible for use during update; the operator won't automatically roll back the application state to a checkpoint older than this. This check is done prior to cancelling the existing job; if no savepoint or valid checkpoint is available, deploy will fail and leave the existing job running. It defaults to 1 hour (3600 seconds), to protect one from accidentally restarting the application using a very old checkpoint (which might put your application under huge load / result in lots of duplicate data). **Note:** This doesn't affect the flink application's checkpointing mechanism in anyway.

* **tearDownVersionHash** `type:string`
Used **only** with the BlueGreen deployment mode. This is set typically once a FlinkApplication successfully transitions to the `DualRunning` phase.
Expand Down

0 comments on commit 93cf7f4

Please sign in to comment.