ferenc-csaky commented on code in PR #854: URL: https://github.com/apache/flink-kubernetes-operator/pull/854#discussion_r1686476104
########## docs/content/docs/custom-resource/snapshots.md: ########## @@ -0,0 +1,117 @@ +--- +title: "Snapshots" +weight: 3 +type: docs +aliases: + - /custom-resource/snapshots.html +--- +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +# Snapshots + +To create, list and delete snapshots you can use the custom resource called FlinkStateSnapshot. The operator will use the same controller flow as in the case of FlinkDeployment and FlinkSessionJob to trigger the savepoint/checkpoint and observe its status. + +This feature deprecates the old `savepointInfo` and `checkpointInfo` fields found in the Flink resource CR status, alongside with spec fields `initialSavepointPath`, `savepointTriggerNonce` and `checkpointTriggerNonce`. It is enabled by default by the configuration option `kubernetes.operator.snapshot.resource.enabled`. You can turn it off and the operator will keep using the deprecated status fields to track snapshots. Review Comment: nit: As a rule of thumb, IMO it is a good practice to start every sentence in a new line. MD will render it into 1 paragraph and it keeps text in a more readable format in most cases. If there are a really long sentence, probably it would worth to consider rewording it anyways, so it can be a good indicator for that too. :) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
