Uploaded image for project: 'Flink'
  1. Flink
  2. FLINK-21666

Consistent documentation and recommendations regarding Stop vs Cancel with savepoint

    XMLWordPrintableJSON

    Details

      Description

      Background

      Cancel with savepoint is marked as deprecated in the cli-documentation. Cancel with savepoint is not marked as deprecated in the REST-API documentation.

      The documentation explaining why stop should be preferred over cancel with savepoint could be improved for the CLI-case and is non existent for the REST case.

      Actions needed

      • Make it clear what the semantics of cancel with savepoint and stop with savepoint are.
        • I think that the documentation in https://ci.apache.org/projects/flink/flink-docs-stable/deployment/cli.html for Stop is a good start but could be further improved. Especially to mention that no new data will be processed by the sources after the stop is initiated.
        • For Cancel, the documentation on the same page as above is really sparse. In exactly what way is a job terminated ungracefully when using Cancel with savepoint? 
      • If there are no valid use cases when anyone could benefit from using cancel with savepoint, document/deprecate to make it less likely that cancel with savepoint will be used by mistake instead of stop.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              thomas.eckestad@gmail.com Thomas Eckestad
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated: