diff --git a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdGenerateDocument.java b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdGenerateDocument.java index 2721c2ea3ab8e..0b2ba1eda065d 100644 --- a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdGenerateDocument.java +++ b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdGenerateDocument.java @@ -107,9 +107,6 @@ private void generateDocument(StringBuilder sb, String module, JCommander obj) { .append("\n```"); sb.append("\n\n"); CmdBase cmdObj = (CmdBase) obj.getObjects().get(0); - for (String s : cmdObj.jcommander.getCommands().keySet()) { - sb.append("* `").append(s).append("`\n"); - } cmdObj.jcommander.getCommands().forEach((subK, subV) -> { sb.append("\n\n## ").append(subK).append("\n\n"); sb.append(cmdObj.getUsageFormatter().getCommandDescription(subK)).append("\n\n"); diff --git a/pulsar-client-tools/src/main/java/org/apache/pulsar/client/cli/CmdGenerateDocumentation.java b/pulsar-client-tools/src/main/java/org/apache/pulsar/client/cli/CmdGenerateDocumentation.java index b992843643aed..b33f756f56b09 100644 --- a/pulsar-client-tools/src/main/java/org/apache/pulsar/client/cli/CmdGenerateDocumentation.java +++ b/pulsar-client-tools/src/main/java/org/apache/pulsar/client/cli/CmdGenerateDocumentation.java @@ -68,9 +68,6 @@ protected String generateDocument(String module, JCommander parentCmd) { .append("$ pulsar-client ").append(module).append(" [options]") .append("\n```"); sb.append("\n\n"); - for (String s : cmd.getCommands().keySet()) { - sb.append("* `").append(s).append("`\n"); - } sb.append("|Flag|Description|Default|\n"); sb.append("|---|---|---|\n"); List options = cmd.getParameters(); diff --git a/pulsar-common/src/main/java/org/apache/pulsar/common/util/BaseGenerateDocumentation.java b/pulsar-common/src/main/java/org/apache/pulsar/common/util/BaseGenerateDocumentation.java index c253474755a69..d5e5374de18b0 100644 --- a/pulsar-common/src/main/java/org/apache/pulsar/common/util/BaseGenerateDocumentation.java +++ b/pulsar-common/src/main/java/org/apache/pulsar/common/util/BaseGenerateDocumentation.java @@ -151,7 +151,6 @@ protected void writeDocListByFieldContext(List> final Field field = fieldPair.getKey(); field.setAccessible(true); - sb.append("### ").append(field.getName()).append("\n"); sb.append(fieldContext.doc().replace(">", "\\>")).append("\n\n"); sb.append("**Type**: `").append(field.getType().getCanonicalName()).append("`\n\n"); @@ -187,12 +186,6 @@ public int compare(Pair o1, Pair This page is automatically generated from code files.\n" - + "If you find something inaccurate, feel free to update `"; - protected String suffix = "\n`.\n"; - - protected String generateDocByFieldContext(String className, String type, StringBuilder sb) throws Exception { Class clazz = Class.forName(className); Object obj = clazz.getDeclaredConstructor().newInstance(); @@ -214,10 +207,7 @@ protected String generateDocByFieldContext(String className, String type, String List> deprecatedFields = fieldList.stream().filter(p -> p.getValue().deprecated()).collect(Collectors.toList()); - - sb.append("# ").append(type).append("\n"); - - sb.append(prefix).append(className).append(suffix); + sb.append("# ").append(type).append("\n\n"); sb.append("## Required\n"); writeDocListByFieldContext(requiredFields, sb, obj); sb.append("## Optional\n"); @@ -239,8 +229,7 @@ protected String generateDocByApiModelProperty(String className, String type, St List requiredFields = fieldList.stream().filter(isRequiredApiModel).collect(Collectors.toList()); List optionalFields = fieldList.stream().filter(isOptionalApiModel).collect(Collectors.toList()); - sb.append("# ").append(type).append("\n"); - sb.append(prefix).append(className).append(suffix); + sb.append("# ").append(type).append("\n\n"); sb.append("## Required\n"); writeDocListByApiModel(requiredFields, sb, obj); sb.append("## Optional\n"); diff --git a/pulsar-common/src/main/java/org/apache/pulsar/common/util/CmdGenerateDocs.java b/pulsar-common/src/main/java/org/apache/pulsar/common/util/CmdGenerateDocs.java index b97efcdfa6b2a..e24ae2b139d8e 100644 --- a/pulsar-common/src/main/java/org/apache/pulsar/common/util/CmdGenerateDocs.java +++ b/pulsar-common/src/main/java/org/apache/pulsar/common/util/CmdGenerateDocs.java @@ -116,12 +116,6 @@ private String generateDocument(String module, JCommander commander) { && cmd.getObjects().get(0).getClass().getName().equals("com.beust.jcommander.JCommander")) { JCommander cmdObj = (JCommander) cmd.getObjects().get(0); sb.append(" subcommand").append("\n```").append("\n\n"); - for (String s : cmdObj.getCommands().keySet()) { - if (s.equals(name)) { - continue; - } - sb.append("* `").append(s).append("`\n"); - } cmdObj.getCommands().forEach((subK, subV) -> { if (!subK.equals(name)) { sb.append("\n\n## ").append(subK).append("\n\n"); diff --git a/pulsar-testclient/src/main/java/org/apache/pulsar/testclient/CmdGenerateDocumentation.java b/pulsar-testclient/src/main/java/org/apache/pulsar/testclient/CmdGenerateDocumentation.java index 975faccc0064b..d36077dca6126 100644 --- a/pulsar-testclient/src/main/java/org/apache/pulsar/testclient/CmdGenerateDocumentation.java +++ b/pulsar-testclient/src/main/java/org/apache/pulsar/testclient/CmdGenerateDocumentation.java @@ -103,9 +103,6 @@ private static String generateDocument(String module, JCommander parentCmd) { .append("$ pulsar-perf ").append(module).append(" [options]") .append("\n```"); sb.append("\n\n"); - for (String s : cmd.getCommands().keySet()) { - sb.append("* `").append(s).append("`\n"); - } sb.append("|Flag|Description|Default|\n"); sb.append("|---|---|---|\n"); List options = cmd.getParameters(); diff --git a/site2/docs/reference-cli-bookkeeper.md b/site2/docs/reference-cli-bookkeeper.md deleted file mode 100644 index 2f6cf6ac7e85c..0000000000000 --- a/site2/docs/reference-cli-bookkeeper.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -id: reference-cli-bookkeeper -title: Pulsar CLI tools - bookkeeper -sidebar_label: "cli-bookkeeper" ---- - -## `bookkeeper` -A tool for managing BookKeeper. - -Usage - -```bash -bookkeeper command -``` - -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 -``` - diff --git a/site2/docs/reference-cli-broker-tool.md b/site2/docs/reference-cli-broker-tool.md deleted file mode 100644 index 56e2de9f5a288..0000000000000 --- a/site2/docs/reference-cli-broker-tool.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: reference-cli-broker-tool -title: Pulsar CLI tools - broker-tool -sidebar_label: "cli-broker-tool" ---- - -## `broker-tool` - -The `broker- tool` is used for operations on a specific broker. - -Usage - -```bash -broker-tool command -``` - -Example - -Two ways to get more information about a command as below: - -```bash -broker-tool help command -broker-tool command --help -``` - -### `load-report` - -Collect the load report of a specific broker. -The command is run on a broker, and used for troubleshooting why broker can’t collect right load report. - -Options - -|Flag|Description|Default| -|---|---|---| -|`-i`, `--interval`| Interval to collect load report, in milliseconds || -|`-h`, `--help`| Display help information || diff --git a/site2/docs/reference-cli-pulsar-daemon.md b/site2/docs/reference-cli-pulsar-daemon.md deleted file mode 100644 index b210f1793da3f..0000000000000 --- a/site2/docs/reference-cli-pulsar-daemon.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: reference-cli-pulsar-daemon -title: Pulsar CLI tools - pulsar-daemon -sidebar_label: "cli-pulsar-daemon" ---- - -## `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. - -Usage - -```bash -pulsar-daemon command -``` - -### `start` -Start a service in the background using nohup. - -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 -``` \ No newline at end of file diff --git a/site2/docs/reference-cli-pulsar-shell.md b/site2/docs/reference-cli-pulsar-shell.md deleted file mode 100644 index fc22af59034a2..0000000000000 --- a/site2/docs/reference-cli-pulsar-shell.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -id: reference-cli-pulsar-shell -title: Pulsar CLI tools - pulsar-shell -sidebar_label: "cli-pulsar-shell" ---- - -## `pulsar-shell` - -[Pulsar shell](administration-pulsar-shell.md) tool. - -### Interactive mode - -Usage - -```bash -pulsar-shell -``` - -Options - -| 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 - -``` - -Options - -| 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 -``` - -Options - -| 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:`. | | - -#### `update` - -Update an existing configuration. - -```bash -default(localhost)> config update --file ./conf/client.conf mycluster -``` - -Options - -| 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:// mycluster -``` - -Options - -| 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 -``` - -Options - -| 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 -``` \ No newline at end of file diff --git a/site2/docs/reference-configuration.md b/site2/docs/reference-configuration.md new file mode 100644 index 0000000000000..8671e87999cfe --- /dev/null +++ b/site2/docs/reference-configuration.md @@ -0,0 +1,7 @@ +--- +id: reference-configuration +title: Pulsar Configuration +sidebar_label: "Pulsar Configuration" +--- + +For a complete list of Pulsar configuration, visit the [Pulsar Reference](http://pulsar.apache.org/reference/#/) website. diff --git a/site2/website/sidebars.json b/site2/website/sidebars.json index fa21f2fbceac2..3d59f5e17ba12 100644 --- a/site2/website/sidebars.json +++ b/site2/website/sidebars.json @@ -368,11 +368,7 @@ "items": [ "reference-terminology", "reference-cli-tools", - { - "type": "link", - "href": "https://pulsar.apache.org/reference", - "label": "Pulsar configuration" - }, + "reference-configuration", "reference-metrics", "reference-rest-api-overview", {