Fix missing reference doc for 3.1.x

static/reference/3.1.x/README.md

@@ -0,0 +1,3 @@
+# Welcome
+
+> Welcome to Pulsar Configuration Docs.

static/reference/3.1.x/_sidebar.md

@@ -0,0 +1,61 @@
+- [Configuration]()
+  - [Pulsar](config/)
+    - [BookKeeper](config/reference-configuration-bookkeeper)
+    - [Broker](config/reference-configuration-broker)
+    - [Client](config/reference-configuration-client)
+    - [Log4j](config/reference-configuration-log4j)
+    - [Log4j shell](config/reference-configuration-log4j-shell)
+    - [Standalone](config/reference-configuration-standalone)
+    - [WebSocket](config/reference-configuration-websocket)
+    - [Pulsar proxy](config/reference-configuration-pulsar-proxy)
+    - [ZooKeeper](config/reference-configuration-zookeeper)
+  - [Client](client/)
+    - [Client](client/client-configuration-client)
+    - [Producer](client/client-configuration-producer)
+    - [Consumer](client/client-configuration-consumer)
+    - [Reader](client/client-configuration-reader)
+- [CLI Tools](cli.md)
+  - [pulsar-admin](pulsar-admin/)
+    - [broker-stats](pulsar-admin/broker-stats.md)
+    - [brokers](pulsar-admin/brokers.md)
+    - [bookies](pulsar-admin/bookies.md)
+    - [clusters](pulsar-admin/clusters.md)
+    - [functions](pulsar-admin/functions.md)
+    - [functions-worker](pulsar-admin/functions-worker.md)
+    - [namespaces](pulsar-admin/namespaces.md)
+    - [ns-isolation-policy](pulsar-admin/ns-isolation-policy.md)
+    - [sources](pulsar-admin/sources.md)
+    - [sinks](pulsar-admin/sinks.md)
+    - [topics](pulsar-admin/topics.md)
+    - [topicPolicies](pulsar-admin/topicPolicies.md)
+    - [proxy-stats](pulsar-admin/proxy-stats.md)
+    - [resourcegroups](pulsar-admin/resourcegroups.md)
+    - [transactions](pulsar-admin/transactions.md)
+    - [tenants](pulsar-admin/tenants.md)
+    - [resource-quotas](pulsar-admin/resource-quotas.md)
+    - [schemas](pulsar-admin/schemas.md)
+    - [packages](pulsar-admin/packages.md)
+  - [pulsar](pulsar/)
+    - [broker](pulsar/broker.md)
+    - [broker-tool](pulsar/broker-tool.md)
+    - [compact-topic](pulsar/compact-topic.md)
+    - [tokens](pulsar/tokens.md)
+    - [proxy](pulsar/proxy.md)
+    - [functions-worker](pulsar/functions-worker.md)
+    - [standalone](pulsar/standalone.md)
+    - [initialize-cluster-metadata](pulsar/initialize-cluster-metadata.md)
+    - [delete-cluster-metadata](pulsar/delete-cluster-metadata.md)
+    - [initialize-transaction-coordinator-metadata](pulsar/initialize-transaction-coordinator-metadata.md)
+    - [initialize-namespace](pulsar/initialize-namespace.md)
+    - [version](pulsar/version.md)
+    - [websocket](pulsar/websocket.md)
+  - [pulsar-client](pulsar-client/)
+    - [pulsar-client](pulsar-client/pulsar-client.md)
+  - [pulsar-daemon](pulsar-daemon/)
+    - [pulsar-daemon](pulsar-daemon/pulsar-daemon.md)
+  - [pulsar-perf](pulsar-perf/)
+    - [pulsar-perf](pulsar-perf/pulsar-perf.md)
+  - [pulsar-shell](pulsar-shell/)
+    - [pulsar-shell](pulsar-shell/pulsar-shell.md)
+  - [bookkeeper](bookkeeper/)
+    - [bookkeeper](bookkeeper/bookkeeper.md)

static/reference/3.1.x/bookkeeper/README.md

@@ -0,0 +1 @@
+> Docs for `bookkeeper`.

static/reference/3.1.x/bookkeeper/bookkeeper.md

@@ -0,0 +1,94 @@
+# bookkeeper
+A tool for managing BookKeeper.
+
+### Environment variables
+
+The table below lists the environment variables that you can use to configure the bookkeeper tool.
+
+|Variable|Description|Default|
+|---|---|---|
+|BOOKIE_LOG_CONF|Log4j configuration file|conf/log4j2.yaml|
+|BOOKIE_CONF|BookKeeper configuration file|conf/bk_server.conf|
+|BOOKIE_EXTRA_OPTS|Extra options to be passed to the JVM||
+|BOOKIE_EXTRA_CLASSPATH|Extra paths for BookKeeper's classpath||
+|ENTRY_FORMATTER_CLASS|The Java class used to format entries||
+|BOOKIE_PID_DIR|Folder where the BookKeeper server PID file should be stored||
+|BOOKIE_STOP_TIMEOUT|Wait time before forcefully killing the Bookie server instance if attempts to stop it are not successful||
+|BOOKIE_GC_LOG|Gc options to be passed to the jvm||
+
+
+### autorecovery
+Runs an auto-recovery service
+
+Usage
+
+```bash
+bookkeeper autorecovery options
+```
+
+Options
+
+|Flag|Description|Default|
+|---|---|---|
+|`-c`, `--conf`|Configuration for the auto-recovery||
+
+
+### bookie
+Starts up a BookKeeper server (aka bookie)
+
+Usage
+
+```bash
+bookkeeper bookie options
+```
+
+Options
+
+|Flag|Description|Default|
+|---|---|---|
+|`-c`, `--conf`|Configuration for the auto-recovery||
+|-readOnly|Force start a read-only bookie server|false|
+|-withAutoRecovery|Start auto-recovery service bookie server|false|
+
+
+### localbookie
+Runs a test ensemble of N bookies locally
+
+Usage
+
+```bash
+bookkeeper localbookie N
+```
+
+### upgrade
+Upgrade the bookie’s filesystem
+
+Usage
+
+```bash
+bookkeeper upgrade options
+```
+
+Options
+
+|Flag|Description|Default|
+|---|---|---|
+|`-c`, `--conf`|Configuration for the auto-recovery||
+|`-u`, `--upgrade`|Upgrade the bookie’s directories||
+
+
+### shell
+Run shell for admin commands. To see a full listing of those commands, run bookkeeper shell without an argument.
+
+Usage
+
+```bash
+bookkeeper shell
+```
+
+Example
+
+```bash
+bookkeeper shell bookiesanity
+```
+

static/reference/3.1.x/cli.md

@@ -0,0 +1,3 @@
+# Welcome
+
+> Welcome to Pulsar CLI Tools Docs.

static/reference/3.1.x/pulsar-daemon/README.md

@@ -0,0 +1 @@
+> Docs for `pulsar-daemon`.

static/reference/3.1.x/pulsar-daemon/pulsar-daemon.md

@@ -0,0 +1,40 @@
+# pulsar-daemon
+
+A wrapper around the pulsar tool that’s used to start and stop processes, such as ZooKeeper, bookies, and Pulsar brokers, in the background using nohup.
+
+pulsar-daemon has a similar interface to the pulsar command but adds start and stop commands for various services. For a listing of those services, run pulsar-daemon to see the help output or see the documentation for the pulsar command.
+
+### start
+Start a service in the background using nohup.
+
+**Tip**
+
+> You can use flags to perform more tasks. For example, `pulsar-daemon start standalone -nfw -nss` can start Pulsar faster in the background (without function workers and stream storage). `pulsar-daemon start standalone` flags are the same as `pulsar standalone` flags. For the complete flag list, see flags of the `pulsar standalone` command on the [Pulsar Reference Site](https://pulsar.apache.org/reference).
+
+Usage
+
+```bash
+pulsar-daemon start service
+```
+
+### stop
+Stop a service that’s already been started using start.
+
+Usage
+
+```bash
+pulsar-daemon stop service options
+```
+
+Options
+
+|Flag|Description|Default|
+|---|---|---|
+|-force|Stop the service forcefully if not stopped by normal shutdown.|false|
+
+### restart
+Restart a service that has already been started.
+
+```bash
+pulsar-daemon restart service
+```

static/reference/3.1.x/pulsar-shell/README.md

@@ -0,0 +1 @@
+> Docs for `pulsar-shell`.

static/reference/3.1.x/pulsar-shell/pulsar-shell.md

@@ -0,0 +1,149 @@
+# pulsar-shell
+
+[Pulsar shell](https://pulsar.apache.org/docs/next/administration-pulsar-shell) tool.
+
+### Interactive mode
+
+Usage
+
+```bash
+pulsar-shell
+```
+
+| Flag               | Description                                                               | Default          |
+|--------------------|---------------------------------------------------------------------------|------------------|
+| `-c`, `--config`   | Client configuration file. It is used as a `default` config.           | conf/client.conf | 
+| `--fail-on-error` | If true, the shell is interrupted when a command throws an exception.  | false            | 
+| `-h`, `--help`     | Show this help.                                                            | |
+
+
+### Non interactive mode
+
+Usage
+
+```bash
+pulsar-shell -f [FILE]
+pulsar-shell -e [COMMAND]
+echo "[COMMAND]" | pulsar-shell -
+```
+
+| Flag                      | Description                                                                                         | Default         |
+|---------------------------|-----------------------------------------------------------------------------------------------------|-----------------|
+| `-c`, `--config`          | Client configuration file. It is used as a `default` config.                                     | conf/client.conf | 
+| `--fail-on-error`         | If true, the shell is interrupted when a command throws an exception.                            | false           | 
+| `-np`, `--no-progress`    | Display raw output of the commands without the fancy progress visualization.                        | false           | 
+| `-f`, `--filename`        | Input filename with a list of commands to be executed. Each command must be separated by a newline. |                 |
+| `-e`, `--execute-command` | Execute this command and exit.                                                                      | |
+| `-` | Read commands from the standard input.                                                              | |
+| `-h`, `--help`     | Show this help.                                                                                      | |
+
+
+Commands
+* `admin` - See [Admin API](admin-api-overview.md)
+* `client` - See [pulsar-client](#pulsar-client)
+* `config`
+
+
+### config
+
+Manage shell configurations.
+
+#### use
+
+Use a specific configuration for next commands.
+
+```bash
+default(localhost)> config use mycluster
+```
+
+#### create
+
+Create a new configuration.
+
+```bash
+default(localhost)> config create --file ./conf/client.conf mycluster
+```
+
+| Flag     | Description              | Default         |
+|----------|--------------------------|-----------------|
+| `--file` | File path of the config. |  | 
+| `--url`  | URL of the config.       |  |
+| `--value`  | Inline value of the config. Base64-encoded value is supported with the prefix `base64:`. |  |
+
+#### clone
+
+Create a new configuration cloning an existing one.
+
+```bash
+default(localhost)> config clone mycluster --name mycluster2
+```
+
+| Flag     | Description              | Default         |
+|----------|--------------------------|-----------------|
+| `--name` | Name of the new config.  |                 | 
+
+#### update
+
+Update an existing configuration.
+
+```bash
+default(localhost)> config update --file ./conf/client.conf mycluster
+```
+
+| Flag     | Description              | Default         |
+|----------|--------------------------|-----------------|
+| `--file` | File path of the config. |  | 
+| `--url`  | URL of the config.       |  |
+| `--value`  | Inline value of the config. Base64-encoded value is supported with the prefix `base64:`. |  |
+
+#### set-property
+
+Set a value for a specified configuration property.
+
+```bash
+default(localhost)> config set-property -p webServiceUrl -v http://<cluster-hostname> mycluster
+```
+
+| Flag               | Description                 | Default         |
+|--------------------|-----------------------------|-----------------|
+| `-p`, `--property` | Property name to update.    |  | 
+| `-v`, `--value`    | New value for the property. |  |
+
+
+#### get-property
+
+Get the value for a specified configuration property.
+
+```bash
+default(localhost)> config get-property -p webServiceUrl mycluster
+```
+
+| Flag               | Description                 | Default         |
+|--------------------|-----------------------------|-----------------|
+| `-p`, `--property` | Property name to update.    |  | 
+
+
+#### view
+
+View details of a config.
+
+```bash
+default(localhost)> config view mycluster
+```
+
+#### delete
+
+Delete a config. You can't delete a config if it's currently used.
+
+```bash
+default(localhost)> config delete mycluster
+```
+
+
+#### list
+
+List all the configuration names.
+
+```bash
+default(localhost)> config list
+```