Skip to content

Commit a811b2a

Browse files
zwOvOAnup Ghatage
authored andcommitted
[improve] fix doc & fix listfilesondisc cmd description (apache#4184)
Descriptions of the changes in this PR: ## Journal settings | Parameter | Description | Default | --------- | ----------- | ------- | | journalDirectories | The directories to which Bookkeeper outputs its write-ahead log (WAL). Could define multi directories to store write head logs, separated by ','.<br />For example:<br /> journalDirectories=/tmp/bk-journal1,/tmp/bk-journal2<br />If journalDirectories is set, bookies will skip journalDirectory and use this setting directory.<br /> | /tmp/bk-journal | | journalDirectory | @deprecated since 4.5.0, in favor of using `journalDirectories`.<br /><br />The directory to which Bookkeeper outputs its write-ahead log (WAL).<br /> | /tmp/bk-txn | ### Motivation update doc about conf#JournalDirectory 2 conf#JournalDirectories& fix listfilesondisc cmd description ### Changes Master Issue: apache#4183
1 parent 2ac7aa9 commit a811b2a

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

bookkeeper-server/src/main/java/org/apache/bookkeeper/bookie/BookieShell.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1417,12 +1417,12 @@ public int runCmd(CommandLine cmdLine) throws Exception {
14171417

14181418
@Override
14191419
String getDescription() {
1420-
return "List the files in JournalDirectory/LedgerDirectories/IndexDirectories.";
1420+
return "List the files in JournalDirectories/LedgerDirectories/IndexDirectories.";
14211421
}
14221422

14231423
@Override
14241424
String getUsage() {
1425-
return "listfilesondisc List the files in JournalDirectory/LedgerDirectories/IndexDirectories \n"
1425+
return "listfilesondisc List the files in JournalDirectories/LedgerDirectories/IndexDirectories \n"
14261426
+ " Usage: listfilesondisc [options]\n"
14271427
+ " Options:\n"
14281428
+ " -txn, --journal\n"

bookkeeper-server/src/main/java/org/apache/bookkeeper/tools/cli/commands/bookie/ListFilesOnDiscCommand.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@
3434
import org.slf4j.LoggerFactory;
3535

3636
/**
37-
* Command to list the files in JournalDirectory/LedgerDirectories/IndexDirectories.
37+
* Command to list the files in JournalDirectories/LedgerDirectories/IndexDirectories.
3838
*/
3939
public class ListFilesOnDiscCommand extends BookieCommand<ListFilesOnDiscCommand.LFODFlags > {
4040

4141
private static final String NAME = "listfilesondisc";
42-
private static final String DESC = "List the files in JournalDirectory/LedgerDirectories/IndexDirectories.";
42+
private static final String DESC = "List the files in JournalDirectories/LedgerDirectories/IndexDirectories.";
4343
private static final Logger LOG = LoggerFactory.getLogger(ListFilesOnDiscCommand.class);
4444

4545
public ListFilesOnDiscCommand() {

docker/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ $ docker run --name bookie1 -d \
157157
-v $(local_configure_dir):/opt/bookkeeper/conf/ \ < == use 2nd approach, mount dir contains config_files
158158
-e BK_bookiePort=3181 \ < == use 1st approach, set bookiePort
159159
-e BK_zkServers=zk-server1:2181,zk-server2:2181 \ < == use 1st approach, set zookeeper servers
160-
-e BK_journalPreAllocSizeMB=32 \ < == use 1st approach, set journalPreAllocSizeMB in [bk_server.conf](https://github.com/apache/bookkeeper/blob/master/bookkeeper-server/conf/bk_server.conf)
160+
-e BK_journalPreAllocSizeMB=32 \ < == use 1st approach, set journalPreAllocSizeMB in [bk_server.conf](https://github.com/apache/bookkeeper/blob/master/conf/bk_server.conf)
161161
apache/bookkeeper
162162
```
163163

@@ -214,7 +214,7 @@ Default value is empty - " ". so ledgers dir in zookeeper will be at "/ledgers"
214214
#### `BK_DATA_DIR`
215215
This variable allows you to specify where to store data in docker instance.
216216

217-
This could be override by env vars "BK_journalDirectory", "BK_ledgerDirectories", "BK_indexDirectories" and also `journalDirectory`, `ledgerDirectories`, `indexDirectories` in [bk_server.conf](https://github.com/apache/bookkeeper/blob/master/bookkeeper-server/conf/bk_server.conf).
217+
This could be override by env vars "BK_journalDirectories", "BK_ledgerDirectories", "BK_indexDirectories" and also `journalDirectories`, `ledgerDirectories`, `indexDirectories` in [bk_server.conf](https://github.com/apache/bookkeeper/blob/master/conf/bk_server.conf).
218218

219219
Default value is "/data/bookkeeper", which contains volumes `/data/bookkeeper/journal`, `/data/bookkeeper/ledgers` and `/data/bookkeeper/index` to hold Bookkeeper data in docker.
220220

site3/website/docs/admin/bookies.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ Parameter | Description | Default
6868
:---------|:------------|:-------
6969
`bookiePort` | The TCP port that the bookie listens on | `3181`
7070
`zkServers` | A comma-separated list of ZooKeeper servers in `hostname:port` format | `localhost:2181`
71-
`journalDirectory` | The directory where the [log device](../getting-started/concepts#log-device) stores the bookie's write-ahead log (WAL) | `/tmp/bk-txn`
71+
`journalDirectories` | The directories where the [log device](../getting-started/concepts#log-device) stores the bookie's write-ahead log (WAL, as a comma-separated list) | `/tmp/bk-txn`
7272
`ledgerDirectories` | The directories where the [ledger device](../getting-started/concepts#ledger-device) stores the bookie's ledger entries (as a comma-separated list) | `/tmp/bk-data`
7373

74-
> Ideally, the directories specified `journalDirectory` and `ledgerDirectories` should be on difference devices.
74+
> Ideally, the directories specified `journalDirectories` and `ledgerDirectories` should be on difference devices.
7575
7676
## Logging
7777

@@ -163,7 +163,7 @@ org.apache.bookkeeper.bookie.BookieException$InvalidCookieException
163163
If the change was the result of an accidental configuration change, the change can be reverted and the bookie can be restarted. However, if the change *cannot* be reverted, such as is the case when you want to add a new disk or replace a disk, the bookie must be wiped and then all its data re-replicated onto it.
164164

165165
1. Increment the [`bookiePort`](../reference/config#bookiePort) parameter in the [`bk_server.conf`](../reference/config)
166-
1. Ensure that all directories specified by [`journalDirectory`](../reference/config#journalDirectory) and [`ledgerDirectories`](../reference/config#ledgerDirectories) are empty.
166+
1. Ensure that all directories specified by [`journalDirectories`](../reference/config#journalDirectories) and [`ledgerDirectories`](../reference/config#ledgerDirectories) are empty.
167167
1. [Start the bookie](#starting-and-stopping-bookies).
168168
1. Run the following command to re-replicate the data:
169169

site3/website/docs/reference/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ $ bin/bookkeeper shell listbookies \
310310

311311
### listfilesondisc {#bookkeeper-shell-listfilesondisc}
312312

313-
List the files in JournalDirectory/LedgerDirectories/IndexDirectories.
313+
List the files in JournalDirectories/LedgerDirectories/IndexDirectories.
314314

315315
##### Usage
316316

site3/website/src/pages/community/coding-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Please log the _stack traces_ at **ERROR** level, but never at **INFO** level or
6868

6969
* Names should be thought through from the point of view of the person using the config.
7070
* The default values should be thought as best value for people who runs the program without tuning parameters.
71-
* All configuration settings should be added to [default configuration file](https://github.com/apache/bookkeeper/blob/master/bookkeeper-server/conf/bk_server.conf) and [documented](https://github.com/apache/bookkeeper/blob/master/site/_data/config/bk_server.yaml).
71+
* All configuration settings should be added to [default configuration file](https://github.com/apache/bookkeeper/blob/master/conf/bk_server.conf) and [documented](https://github.com/apache/bookkeeper/blob/master/site/_data/config/bk_server.yaml).
7272

7373
### Concurrency
7474

0 commit comments

Comments
 (0)