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

Align Stop/Cancel Commands in CLI and REST Interface and Improve Documentation

    XMLWordPrintableJSON

    Details

    • Release Note:
      Hide
      From now on, the {{stop}} command with no further arguments (gracefully) stops the job with a savepoint at the default savepoint location, as configured by the user. This changes the semantics of the pre-existing stop command, as agreed in the mailing list.
      Show
      From now on, the {{stop}} command with no further arguments (gracefully) stops the job with a savepoint at the default savepoint location, as configured by the user. This changes the semantics of the pre-existing stop command, as agreed in the mailing list.

      Description

      Currently, the REST API and CLI around stopping and cancelling jobs are not aligned in terms of terminology and the differences between cancel and job are not as clear as they could be.

      I would like to make the following changes to the CLI:

      • add deprecation warning for cancel -s command and redirect users to stop
      • rename -s of stop command to -p for savepoint location. Emphasize that this is optional, as a savepoint is taken in any case

      I would like to make the following changes to the REST API:

      • Rename stop-with-savepoint to stop
      • Rename "endOfEventTime" to "drain" in accordance with the CLI

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                knaufk Konstantin Knauf
                Reporter:
                knaufk Konstantin Knauf
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 20m
                  20m