You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@bookkeeper.apache.org by si...@apache.org on 2019/02/20 12:11:06 UTC
[bookkeeper] branch master updated: [DOC] Fix command path in
documents
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/bookkeeper.git
The following commit(s) were added to refs/heads/master by this push:
new 31901ff [DOC] Fix command path in documents
31901ff is described below
commit 31901ffd1041fa4cd8374aa4a32ef0ef372a8b8f
Author: Like <li...@163.com>
AuthorDate: Wed Feb 20 20:11:00 2019 +0800
[DOC] Fix command path in documents
Closes #1556
Reviewers: Enrico Olivelli <eo...@gmail.com>, Sijie Guo <si...@apache.org>
This closes #1948 from liketic/fix-cmd-dir
---
docker/README.md | 6 +++---
site/_data/cli/bookkeeper-daemon.yaml | 2 +-
site/_data/cli/bookkeeper.yaml | 2 +-
site/_includes/shell.html | 2 +-
site/docs/latest/admin/autorecovery.md | 10 +++++-----
site/docs/latest/admin/bookies.md | 24 ++++++++++++------------
site/docs/latest/api/ledger-api.md | 2 +-
site/docs/latest/deployment/manual.md | 4 ++--
site/docs/latest/getting-started/run-locally.md | 2 +-
9 files changed, 27 insertions(+), 27 deletions(-)
diff --git a/docker/README.md b/docker/README.md
index 6cd337f..66fa081 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -230,10 +230,10 @@ Usually we could config files bk_server.conf, bkenv.sh, log4j.properties, and lo
Be careful where you put the transaction log (journal). A dedicated transaction log device is key to consistent good performance. Putting the log on a busy device will adversely effect performance.
-Here is some useful and graceful command the could be used to replace the default command, once you want to delete the cookeis and do auto recovery:
+Here is some useful and graceful command the could be used to replace the default command, once you want to delete the cookies and do auto recovery:
```
-/bookkeeper/bookkeeper-server/bin/bookkeeper shell bookieformat -nonInteractive -force -deleteCookie
-/bookkeeper/bookkeeper-server/bin/bookkeeper autorecovery
+/bookkeeper/bin/bookkeeper shell bookieformat -nonInteractive -force -deleteCookie
+/bookkeeper/bin/bookkeeper autorecovery
```
Use them, and replace the default [CMD] when you wanted to do things other than start a bookie.
diff --git a/site/_data/cli/bookkeeper-daemon.yaml b/site/_data/cli/bookkeeper-daemon.yaml
index 86318ed..97fc029 100644
--- a/site/_data/cli/bookkeeper-daemon.yaml
+++ b/site/_data/cli/bookkeeper-daemon.yaml
@@ -1,5 +1,5 @@
description: Manages bookies.
-root_path: bookkeeper-server/bin
+root_path: bin
commands:
- name: bookie
description: Runs the bookie server.
diff --git a/site/_data/cli/bookkeeper.yaml b/site/_data/cli/bookkeeper.yaml
index 0b9bbd4..cc4b2ec 100644
--- a/site/_data/cli/bookkeeper.yaml
+++ b/site/_data/cli/bookkeeper.yaml
@@ -1,5 +1,5 @@
description: Manages bookies.
-root_path: bookkeeper-server/bin
+root_path: bin
commands:
- name: bookie
description: Starts up a bookie.
diff --git a/site/_includes/shell.html b/site/_includes/shell.html
index ef7caf0..5e0927f 100644
--- a/site/_includes/shell.html
+++ b/site/_includes/shell.html
@@ -8,7 +8,7 @@
<h5>Usage</h5>
```shell
-$ bookkeeper-server/bin/bookkeeper shell {{ command.name }}{% if command.argument %} \
+$ bin/bookkeeper shell {{ command.name }}{% if command.argument %} \
{{ command.argument }}{% endif %}{% if command.options %} \
<options>{% endif %}
```
diff --git a/site/docs/latest/admin/autorecovery.md b/site/docs/latest/admin/autorecovery.md
index b1dd078..e64dbac 100644
--- a/site/docs/latest/admin/autorecovery.md
+++ b/site/docs/latest/admin/autorecovery.md
@@ -18,7 +18,7 @@ You can manually recover failed bookies using the [`bookkeeper`](../../reference
Here's an example:
```bash
-$ bookkeeper-server/bin/bookkeeper shell recover \
+$ bin/bookkeeper shell recover \
zk1.example.com:2181 \ # IP and port for ZooKeeper
192.168.1.10:3181 # IP and port for the failed bookie
```
@@ -26,7 +26,7 @@ $ bookkeeper-server/bin/bookkeeper shell recover \
If you wish, you can also specify which bookie you'd like to rereplicate to. Here's an example:
```bash
-$ bookkeeper-server/bin/bookkeeper shell recover \
+$ bin/bookkeeper shell recover \
zk1.example.com:2181 \ # IP and port for ZooKeeper
192.168.1.10:3181 \ # IP and port for the failed bookie
192.168.1.11:3181 # IP and port for the bookie to rereplicate to
@@ -58,7 +58,7 @@ AutoRecovery can be run in two ways:
You can start up AutoRecovery using the [`autorecovery`](../../reference/cli#bookkeeper-autorecovery) command of the [`bookkeeper`](../../reference/cli) CLI tool.
```bash
-$ bookkeeper-server/bin/bookkeeper autorecovery
+$ bin/bookkeeper autorecovery
```
> The most important thing to ensure when starting up AutoRecovery is that the ZooKeeper connection string specified by the [`zkServers`](../../reference/config#zkServers) parameter points to the right ZooKeeper cluster.
@@ -78,13 +78,13 @@ You can disable AutoRecovery at any time, for example during maintenance. Disabl
You can disable AutoRecover using the [`bookkeeper`](../../reference/cli#bookkeeper-shell-autorecovery) CLI tool:
```bash
-$ bookkeeper-server/bin/bookkeeper shell autorecovery -disable
+$ bin/bookkeeper shell autorecovery -disable
```
Once disabled, you can reenable AutoRecovery using the [`enable`](../../reference/cli#bookkeeper-shell-autorecovery) shell command:
```bash
-$ bookkeeper-server/bin/bookkeeper shell autorecovery -enable
+$ bin/bookkeeper shell autorecovery -enable
```
## AutoRecovery architecture
diff --git a/site/docs/latest/admin/bookies.md b/site/docs/latest/admin/bookies.md
index 1b0427d..68e8a7d 100644
--- a/site/docs/latest/admin/bookies.md
+++ b/site/docs/latest/admin/bookies.md
@@ -31,13 +31,13 @@ You can run bookies either in the foreground or in the background, using [nohup]
To start a bookie in the foreground, use the [`bookie`](../../reference/cli#bookkeeper-bookie) command of the [`bookkeeper`](../../reference/cli#bookkeeper) CLI tool:
```shell
-$ bookkeeper-server/bin/bookkeeper bookie
+$ bin/bookkeeper bookie
```
To start a bookie in the background, use the [`bookkeeper-daemon.sh`](../../reference/cli#bookkeeper-daemon.sh) script and run `start bookie`:
```shell
-$ bookkeeper-server/bin/bookkeeper-daemon.sh start bookie
+$ bin/bookkeeper-daemon.sh start bookie
```
### Local bookies
@@ -47,7 +47,7 @@ The instructions above showed you how to run bookies intended for production use
This would spin up a local ensemble of 6 bookies:
```shell
-$ bookkeeper-server/bin/bookkeeper localbookie 6
+$ bin/bookkeeper localbookie 6
```
> When you run a local bookie ensemble, all bookies run in a single JVM process.
@@ -75,7 +75,7 @@ To enable logging for a bookie, create a `log4j.properties` file and point the `
```shell
$ export BOOKIE_LOG_CONF=/some/path/log4j.properties
-$ bookkeeper-server/bin/bookkeeper bookie
+$ bin/bookkeeper bookie
```
## Upgrading
@@ -99,25 +99,25 @@ Flag | Action
A standard upgrade pattern is to run an upgrade...
```shell
-$ bookkeeper-server/bin/bookkeeper upgrade --upgrade
+$ bin/bookkeeper upgrade --upgrade
```
...then check that everything is working normally, then kill the bookie. If everything is okay, finalize the upgrade...
```shell
-$ bookkeeper-server/bin/bookkeeper upgrade --finalize
+$ bin/bookkeeper upgrade --finalize
```
...and then restart the server:
```shell
-$ bookkeeper-server/bin/bookkeeper bookie
+$ bin/bookkeeper bookie
```
If something has gone wrong, you can always perform a rollback:
```shell
-$ bookkeeper-server/bin/bookkeeper upgrade --rollback
+$ bin/bookkeeper upgrade --rollback
```
## Formatting
@@ -127,13 +127,13 @@ You can format bookie metadata in ZooKeeper using the [`metaformat`](../../refer
By default, formatting is done in interactive mode, which prompts you to confirm the format operation if old data exists. You can disable confirmation using the `-nonInteractive` flag. If old data does exist, the format operation will abort *unless* you set the `-force` flag. Here's an example:
```shell
-$ bookkeeper-server/bin/bookkeeper shell metaformat
+$ bin/bookkeeper shell metaformat
```
You can format the local filesystem data on a bookie using the [`bookieformat`](../../reference/cli#bookkeeper-shell-bookieformat) command on each bookie. Here's an example:
```shell
-$ bookkeeper-server/bin/bookkeeper shell bookieformat
+$ bin/bookkeeper shell bookieformat
```
> The `-force` and `-nonInteractive` flags are also available for the `bookieformat` command.
@@ -162,7 +162,7 @@ If the change was the result of an accidental configuration change, the change c
1. Run the following command to re-replicate the data:
```bash
- $ bookkeeper-server/bin/bookkeeper shell recover \
+ $ bin/bookkeeper shell recover \
<zkserver> \
<oldbookie> \
<newbookie>
@@ -171,7 +171,7 @@ If the change was the result of an accidental configuration change, the change c
The ZooKeeper server, old bookie, and new bookie, are all identified by their external IP and `bookiePort` (3181 by default). Here's an example:
```bash
- $ bookkeeper-server/bin/bookkeeper shell recover \
+ $ bin/bookkeeper shell recover \
zk1.example.com \
192.168.1.10:3181 \
192.168.1.10:3181
diff --git a/site/docs/latest/api/ledger-api.md b/site/docs/latest/api/ledger-api.md
index 22dacb5..38f436d 100644
--- a/site/docs/latest/api/ledger-api.md
+++ b/site/docs/latest/api/ledger-api.md
@@ -302,7 +302,7 @@ Before you start, you will need to have a BookKeeper cluster running locally on
To start up a cluster consisting of six {% pop bookies %} locally:
```shell
-$ bookkeeper-server/bin/bookkeeper localbookie 6
+$ bin/bookkeeper localbookie 6
```
You can specify a different number of bookies if you'd like.
diff --git a/site/docs/latest/deployment/manual.md b/site/docs/latest/deployment/manual.md
index daafd55..49800da 100644
--- a/site/docs/latest/deployment/manual.md
+++ b/site/docs/latest/deployment/manual.md
@@ -26,7 +26,7 @@ zkServers=100.0.0.1:2181,100.0.0.2:2181,100.0.0.3:2181
Once the bookie's configuration is set, you can start it up using the [`bookie`](../../reference/cli#bookkeeper-bookie) command of the [`bookkeeper`](../../reference/cli#bookkeeper) CLI tool:
```shell
-$ bookkeeper-server/bin/bookkeeper bookie
+$ bin/bookkeeper bookie
```
> You can also build BookKeeper [by cloning it from source](../../getting-started/installation#clone) or [using Maven](../../getting-started/installation#build-using-maven).
@@ -40,7 +40,7 @@ $ bookkeeper-server/bin/bookkeeper bookie
Once you've started up a cluster of bookies, you need to set up cluster metadata for the cluster by running the following command from any bookie in the cluster:
```shell
-$ bookkeeper-server/bin/bookkeeper shell metaformat
+$ bin/bookkeeper shell metaformat
```
You can run in the formatting
diff --git a/site/docs/latest/getting-started/run-locally.md b/site/docs/latest/getting-started/run-locally.md
index edbfab9..5201403 100644
--- a/site/docs/latest/getting-started/run-locally.md
+++ b/site/docs/latest/getting-started/run-locally.md
@@ -10,7 +10,7 @@ toc_disable: true
This would start up an ensemble with 10 bookies:
```shell
-$ bookkeeper-server/bin/bookkeeper localbookie 10
+$ bin/bookkeeper localbookie 10
```
> When you start up an ensemble using `localbookie`, all bookies run in a single JVM process.