[GitHub] [flink] knaufk opened a new pull request #9030: [FLINK-13123] Align Stop/Cancel Commands in CLI and REST Interface and Improve Documentation

[GitBox <gi...@apache.org>]

knaufk opened a new pull request #9030: [FLINK-13123] Align Stop/Cancel Commands in CLI and REST Interface and Improve Documentation
URL: https://github.com/apache/flink/pull/9030
 
 
   ## What is the purpose of the change
   
   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
   
   ## Brief change log
   
   
   * [hotfix] [docs] add missing YARN options in CLI docs
   * [cli] add deperecation warning to "cancel -s"
   * [cli] rename "-s" parameter of stop command
   * [rest] align terminology of "stop" endpoint with cli
   * [hotfix] [docs] fix typo in docs/README.md 
   
   
   ## Verifying this change
   
   * run tests in flink-clients, flink-runtime-web and flink-runtime
   
   ## Does this pull request potentially affect one of the following parts:
   
     - Dependencies (does it add or upgrade a dependency): no
     - The public API, i.e., is any changed class annotated with `@Public(Evolving)`: yes
     - The serializers: no
     - The runtime per-record code paths (performance sensitive): no
     - Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: yes
     - The S3 file system connector: no
   
   ## Documentation
   
     - Does this pull request introduce a new feature? no
     - If yes, how is the feature documented? docs
   

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services