[improve][doc] improve bk_server.conf docs (apache#3715)

* [improve][doc] improve bk_server.conf docs Add default value of allowMultipleDirsUnderSameDiskPartition Signed-off-by: Paul Gier <paul.gier@datastax.com> * [improve][doc] change example conf to match default Signed-off-by: Paul Gier <paul.gier@datastax.com> Signed-off-by: Paul Gier <paul.gier@datastax.com> (cherry picked from commit 0537844)
zymap · Feb 16, 2023 · 540bc14 · 540bc14
1 parent a8df522
commit 540bc14
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/conf/bk_server.conf b/conf/bk_server.conf
@@ -41,8 +41,9 @@
 bookiePort=3181
 
 # Configure the bookie to allow/disallow multiple ledger/index/journal directories
-# in the same filesystem disk partition
-# allowMultipleDirsUnderSameDiskPartition=false
+# in the same filesystem disk partition.
+# Defaults to true.
+# allowMultipleDirsUnderSameDiskPartition=true
 
 # Set the network interface that the bookie should listen on.
 # If not set, the bookie will listen on all interfaces.

diff --git a/site3/website/docs/reference/config.md b/site3/website/docs/reference/config.md
@@ -12,7 +12,7 @@ The table below lists parameters that you can set to configure bookies. All conf
 | Parameter | Description | Default
 | --------- | ----------- | ------- | 
 | bookiePort | The port that the bookie server listens on. | 3181 | 
-| allowMultipleDirsUnderSameDiskPartition | Configure the bookie to allow/disallow multiple ledger/index/journal directories in the same filesystem disk partition |  | 
+| allowMultipleDirsUnderSameDiskPartition | Configure the bookie to allow/disallow multiple ledger/index/journal directories in the same filesystem disk partition. | true | 
 | listeningInterface | The network interface that the bookie should listen on. If not set, the bookie will listen on all interfaces. | eth0 | 
 | advertisedAddress | Configure a specific hostname or IP address that the bookie should use to advertise itself to<br />clients. If not set, bookie will advertised its own IP address or hostname, depending on the<br />`listeningInterface` and `useHostNameAsBookieID` settings.<br /> | eth0 | 
 | allowLoopback | Whether the bookie is allowed to use a loopback interface as its primary<br />interface (the interface it uses to establish its identity). By default, loopback interfaces are *not* allowed as the primary interface.<br /><br />Using a loopback interface as the primary interface usually indicates a configuration error. It's fairly common in some VPS setups, for example, to not configure a hostname or to have the hostname resolve to 127.0.0.1. If this is the case, then all bookies in the cluster will establish their identities as 127.0.0.1:3181, and only one will be able to join the cluster. For VPSs configured like this, you should explicitly set the listening interface.<br /> | false |