[FLINK-13123] Align Stop/Cancel Commands in CLI and REST Interface and Improve Documentation

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.9.0
• Fix Version/s: 1.9.0
• Component/s: Command Line Client, Documentation
• Labels: pull-request-available

Release Note

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.

• Assignee: Konstantin Knauf
• Reporter: Konstantin Knauf
• Created: 05/Jul/19 12:58
• Updated: 11/Jul/19 12:16
• Resolved: 11/Jul/19 12:16

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

Issue Links

• blocks: FLINK-12749 Getting Started - Docker Playgrounds - Flink Cluster Playground
• links to: GitHub Pull Request #9030