[GitHub] flink pull request #5786: [FLINK-9109] [doc] Update documentation for CLI

[asfgit]

Github user asfgit closed the pull request at:

https://github.com/apache/flink/pull/5786


---

[GitHub] flink pull request #5786: [FLINK-9109] [doc] Update documentation for CLI

[tillrohrmann]

Github user tillrohrmann commented on a diff in the pull request:

https://github.com/apache/flink/pull/5786#discussion_r193040157
  
--- Diff: docs/ops/cli.md ---
@@ -287,6 +287,16 @@ Action "run" compiles and runs a program.
   sub-paths for high availability 
mode
  -ynl,--yarnnodeLabelSpecify YARN node label for 
   the YARN application 
+ -z,--zookeeperNamespace Namespace to create the Zookeeper
+  sub-paths for high availability 
mode
+
+  Options for default mode:
--- End diff --

This is basically the `CLI` output when running it with `-h`. The order is 
defined by the order in which we register the `CustomCommandLines`. Since the 
`DefaultCLI` and `LegacyCLI` are the fall back `CustomCommandLines`, they need 
to be registered last. Therefore, I would like to keep the documentation it 
like it is.


---

[GitHub] flink pull request #5786: [FLINK-9109] [doc] Update documentation for CLI

[zentol]

Github user zentol commented on a diff in the pull request:

https://github.com/apache/flink/pull/5786#discussion_r192983985
  
--- Diff: docs/ops/cli.md ---
@@ -287,6 +287,16 @@ Action "run" compiles and runs a program.
   sub-paths for high availability 
mode
  -ynl,--yarnnodeLabelSpecify YARN node label for 
   the YARN application 
+ -z,--zookeeperNamespace Namespace to create the Zookeeper
+  sub-paths for high availability 
mode
+
+  Options for default mode:
--- End diff --

Can we list this above the yarn options?


---

[GitHub] flink pull request #5786: [FLINK-9109] [doc] Update documentation for CLI

[tillrohrmann]

Github user tillrohrmann commented on a diff in the pull request:

https://github.com/apache/flink/pull/5786#discussion_r179766125
  
--- Diff: docs/ops/cli.md ---
@@ -300,70 +306,134 @@ Action "info" shows the optimized execution plan of 
the program (JSON).
   program. Optional flag to override 
the
   default value specified in the
   configuration.
-  Options for yarn-cluster mode:
- -yid,--yarnapplicationIdAttach to running YARN session
-
 
 
 Action "list" lists running and scheduled programs.
 
   Syntax: list [OPTIONS]
   "list" action options:
- -m,--jobmanagerAddress of the JobManager (master) to 
which
-   to connect. Use this flag to connect to 
a
-   different JobManager than the one 
specified
-   in the configuration.
- -r,--running  Show only running programs and their 
JobIDs
- -s,--scheduledShow only scheduled programs and their 
JobIDs
+ -r,--running Show only running programs and their JobIDs
+ -s,--scheduled   Show only scheduled programs and their JobIDs
   Options for yarn-cluster mode:
+ -m,--jobmanager Address of the JobManager (master) to
+  which to connect. Use this flag to 
connect
+  to a different JobManager than the 
one
+  specified in the configuration.
  -yid,--yarnapplicationIdAttach to running YARN session
+ -z,--zookeeperNamespace Namespace to create the Zookeeper
+  sub-paths for high availability mode
+
+  Options for flip6 mode:
+ -m,--jobmanagerAddress of the JobManager (master) to 
which
+ to connect. Use this flag to connect 
to a
+ different JobManager than the one 
specified
+ in the configuration.
+ -z,--zookeeperNamespaceNamespace to create the Zookeeper 
sub-paths
+ for high availability mode
 
 
 
 Action "stop" stops a running program (streaming jobs only).
 
   Syntax: stop [OPTIONS] 
   "stop" action options:
- -m,--jobmanagerAddress of the JobManager (master) to 
which
-   to connect. Use this flag to connect to 
a
-   different JobManager than the one 
specified
-   in the configuration.
+
   Options for yarn-cluster mode:
+ -m,--jobmanager Address of the JobManager (master) to
+  which to connect. Use this flag to 
connect
+  to a different JobManager than the 
one
+  specified in the configuration.
  -yid,--yarnapplicationIdAttach to running YARN session
+ -z,--zookeeperNamespace Namespace to create the Zookeeper
+  sub-paths for high availability mode
+
+  Options for flip6 mode:
--- End diff --

Good point @zentol. Have to update the PR accordingly.


---

[GitHub] flink pull request #5786: [FLINK-9109] [doc] Update documentation for CLI

[zentol]

Github user zentol commented on a diff in the pull request:

https://github.com/apache/flink/pull/5786#discussion_r179716924
  
--- Diff: docs/ops/cli.md ---
@@ -300,70 +306,134 @@ Action "info" shows the optimized execution plan of 
the program (JSON).
   program. Optional flag to override 
the
   default value specified in the
   configuration.
-  Options for yarn-cluster mode:
- -yid,--yarnapplicationIdAttach to running YARN session
-
 
 
 Action "list" lists running and scheduled programs.
 
   Syntax: list [OPTIONS]
   "list" action options:
- -m,--jobmanagerAddress of the JobManager (master) to 
which
-   to connect. Use this flag to connect to 
a
-   different JobManager than the one 
specified
-   in the configuration.
- -r,--running  Show only running programs and their 
JobIDs
- -s,--scheduledShow only scheduled programs and their 
JobIDs
+ -r,--running Show only running programs and their JobIDs
+ -s,--scheduled   Show only scheduled programs and their JobIDs
   Options for yarn-cluster mode:
+ -m,--jobmanager Address of the JobManager (master) to
+  which to connect. Use this flag to 
connect
+  to a different JobManager than the 
one
+  specified in the configuration.
  -yid,--yarnapplicationIdAttach to running YARN session
+ -z,--zookeeperNamespace Namespace to create the Zookeeper
+  sub-paths for high availability mode
+
+  Options for flip6 mode:
+ -m,--jobmanagerAddress of the JobManager (master) to 
which
+ to connect. Use this flag to connect 
to a
+ different JobManager than the one 
specified
+ in the configuration.
+ -z,--zookeeperNamespaceNamespace to create the Zookeeper 
sub-paths
+ for high availability mode
 
 
 
 Action "stop" stops a running program (streaming jobs only).
 
   Syntax: stop [OPTIONS] 
   "stop" action options:
- -m,--jobmanagerAddress of the JobManager (master) to 
which
-   to connect. Use this flag to connect to 
a
-   different JobManager than the one 
specified
-   in the configuration.
+
   Options for yarn-cluster mode:
+ -m,--jobmanager Address of the JobManager (master) to
+  which to connect. Use this flag to 
connect
+  to a different JobManager than the 
one
+  specified in the configuration.
  -yid,--yarnapplicationIdAttach to running YARN session
+ -z,--zookeeperNamespace Namespace to create the Zookeeper
+  sub-paths for high availability mode
+
+  Options for flip6 mode:
--- End diff --

You recently removed flip6 references from classes, do we retain them in 
the documentation?


---

[GitHub] flink pull request #5786: [FLINK-9109] [doc] Update documentation for CLI

[tillrohrmann]

GitHub user tillrohrmann opened a pull request:

https://github.com/apache/flink/pull/5786

[FLINK-9109] [doc] Update documentation for CLI

## What is the purpose of the change

Update documentation for CLI.


You can merge this pull request into a Git repository by running:

$ git pull https://github.com/tillrohrmann/flink 
addDocumentationForModifyCommand

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/flink/pull/5786.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #5786


commit 2822c0eadfd5469fb293d73b2c9466def1f38607
Author: Till Rohrmann 
Date:   2018-03-29T11:36:34Z

[FLINK-9109] [doc] Update documentation for CLI




---