[incubator-pulsar] branch master updated: [documentation] Issue 2252: incorrect flags for bin/pulsar (#2341)

[si...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sijie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new 0260df0  [documentation] Issue 2252: incorrect flags for bin/pulsar (#2341)
0260df0 is described below

commit 0260df0fa8b3fc2a28ac32413be648b535a5c6ba
Author: Sijie Guo <gu...@gmail.com>
AuthorDate: Wed Aug 8 11:06:29 2018 -0700

    [documentation] Issue 2252: incorrect flags for bin/pulsar (#2341)
    
    ### Motivation
    
    Fixes #2252
    
    The documentation lists -c and --conf as possible arguments of the bin/pulsar command.
    https://pulsar.incubator.apache.org/docs/v2.0.1-incubating/reference/CliTools/#zookeeper-90gyx
    
    However, the -c and --conf args to bin/pulsar are not respected.
    It seems that the proper way to specify an alternative config file is via env variables,
    eg the PULSAR_ZK_CONF env variable.
    
     ### Changes
    
    Fix the documentation. Since `bin/pulsar` has specified configuration for all the components,
    we have to use environment variables for overriding the configuration files.
---
 site2/docs/reference-cli-tools.md | 61 +++++++++++++++++----------------------
 1 file changed, 26 insertions(+), 35 deletions(-)

diff --git a/site2/docs/reference-cli-tools.md b/site2/docs/reference-cli-tools.md
index bc3394e..7e3c35b 100644
--- a/site2/docs/reference-cli-tools.md
+++ b/site2/docs/reference-cli-tools.md
@@ -45,7 +45,7 @@ Commands:
 
 Example:
 ```bash
-$ pulsar broker --conf /path/to/broker.conf
+$ PULSAR_BROKER_CONF=/path/to/broker.conf pulsar broker
 ```
 
 The table below lists the environment variables that you can use to configure the `pulsar` tool.
@@ -80,17 +80,15 @@ Options
 
 |Option|Description|Default|
 |---|---|---|
-|`-c`, `--config`|Configuration for the bookie server||
 |`-readOnly`|Force start a read-only bookie server|false|
 |`-withAutoRecovery`|Start auto-recover service bookie server|false|
 
 
 Example
 ```bash
-$ pulsar bookie \
+$ PULSAR_BOOKKEEPER_CONF=/path/to/bookkeeper.conf pulsar bookie \
   -readOnly \
-  -withAutoRecovery \
-  --conf /path/to/bookkeeper.conf
+  -withAutoRecovery
 ```
 
 ### `broker`
@@ -105,14 +103,13 @@ $ pulsar broker options
 Options
 |Option|Description|Default|
 |---|---|---|
-|`-c` , `--broker-conf`|Configuration file for the broker||
 |`-bc` , `--bookie-conf`|Configuration file for BookKeeper||
 |`-rb` , `--run-bookie`|Run a BookKeeper bookie on the same host as the Pulsar broker|false|
 |`-ra` , `--run-bookie-autorecovery`|Run a BookKeeper autorecovery daemon on the same host as the Pulsar broker|false|
 
 Example
 ```bash
-$ pulsar broker --broker-conf /path/to/broker.conf
+$ PULSAR_BROKER_CONF=/path/to/broker.conf pulsar broker
 ```
 
 ### `compact-topic`
@@ -127,7 +124,6 @@ Options
 |Flag|Description|Default|
 |---|---|---|
 |`-t` , `--topic`|The Pulsar topic that you would like to compact||
-|`-c` , `--broker-conf`|Configuration file for the broker|${pulsarDirectory}/conf/broker.conf|
 
 Example
 ```bash
@@ -140,17 +136,12 @@ Run a discovery server
 
 Usage
 ```bash
-$ pulsar discovery options
+$ pulsar discovery
 ```
 
-Options
-|Flag|Description|Default|
-|---|---|---|
-|`-c` , `--conf`|Configuration file for the discovery service||
-
 Example
 ```bash
-$ pulsar discovery --conf /path/to/discovery.conf
+$ PULSAR_DISCOVERY_CONF=/path/to/discovery.conf pulsar discovery
 ```
 
 ### `configuration-store`
@@ -159,14 +150,13 @@ Starts up the Pulsar configuration store
 
 Usage
 ```bash
-$ pulsar configuration-store options
+$ pulsar configuration-store
 ```
 
-Options
-|Flag|Description|Default|
-|---|---|---|
-|`-c` , `--conf`|Configuration file for the configuration store||
-
+Example
+```bash
+$ PULSAR_CONFIGURATION_STORE_CONF=/path/to/configuration_store.conf pulsar configuration-store
+```
 
 ### `initialize-cluster-metadata`
 
@@ -201,13 +191,12 @@ $ pulsar proxy options
 Options
 |Flag|Description|Default|
 |---|---|---|
-|`-c` , `--config`|Path to a Pulsar proxy configuration file||
 |`--configuration-store`|Configuration store connection string||
 |`-zk` , `--zookeeper-servers`|Local ZooKeeper connection string||
 
 Example
 ```bash
-$ pulsar proxy \
+$ PULSAR_PROXY_CONF=/path/to/proxy.conf pulsar proxy \
   --zookeeper-servers zk-0,zk-1,zk2 \
   --configuration-store zk-0,zk-1,zk-2
 ```
@@ -227,7 +216,6 @@ Options
 |`-a` , `--advertised-address`|The standalone broker advertised address||
 |`--bookkeeper-dir`|Local bookies’ base data directory|data/standalone/bookeeper|
 |`--bookkeeper-port`|Local bookies’ base port|3181|
-|`-c` , `--config`|Configuration file path||
 |`--no-broker`|Only start ZooKeeper and BookKeeper services, not the broker|false|
 |`--num-bookies`|The number of local bookies|1|
 |`--only-broker`|Only start the Pulsar broker service (not ZooKeeper or BookKeeper)||
@@ -235,19 +223,22 @@ Options
 |`--zookeeper-dir`|Local ZooKeeper’s data directory|data/standalone/zookeeper|
 |`--zookeeper-port` |Local ZooKeeper’s port|2181|
 
+Example
+```bash
+$ PULSAR_STANDALONE_CONF=/path/to/standalone.conf pulsar standalone
+```
 
 ### `websocket`
 
 Usage
 ```bash
-$ pulsar websocket options
+$ pulsar websocket
 ```
 
-Options
-|Flag|Description|Default|
-|---|---|---|
-|`-c`, `--conf`|Configuration file for WebSocket service||
-
+Example
+```bash
+$ PULSAR_WEBSOCKET_CONF=/path/to/websocket.conf pulsar websocket
+```
 
 ### `zookeeper`
 
@@ -255,13 +246,13 @@ Starts up a ZooKeeper cluster
 
 Usage
 ```bash
-$ pulsar zookeeper options
+$ pulsar zookeeper
 ```
 
-Options
-|Flag|Description|Default|
-|---|---|---|
-|`-c`, `--conf`|Configuration file for ZooKeeper||
+Example
+```bash
+$ PULSAR_ZK_CONF=/path/to/zookeeper.conf pulsar zookeeper
+```
 
 
 ### `zookeeper-shell`