kudu-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aw...@apache.org
Subject [4/4] kudu git commit: docs: update docs for metadata dir
Date Sat, 20 Jan 2018 01:18:49 GMT
docs: update docs for metadata dir

Commit 64926335fe263b43f1493c03a91ea999759dfc71 introduced the
fs_metadata_dir flag. Given the significance of this flag, the docs have
been updated accordingly.

I didn't document the behavior from Kudu 1.6 and below, as the important
details are already noted in the flag definition.

Rendered versions here:
https://github.com/andrwng/kudu/blob/metadata-docs/docs/administration.adoc#disk_failure_recovery
https://github.com/andrwng/kudu/blob/metadata-docs/docs/configuration.adoc#directory_configuration

Change-Id: I333d32080106cd83b92ad2060f3239b9c44d201b
Reviewed-on: http://gerrit.cloudera.org:8080/9068
Tested-by: Andrew Wong <awong@cloudera.com>
Reviewed-by: Alex Rodoni <arodoni@cloudera.com>
Reviewed-by: Adar Dembo <adar@cloudera.com>


Project: http://git-wip-us.apache.org/repos/asf/kudu/repo
Commit: http://git-wip-us.apache.org/repos/asf/kudu/commit/6626e109
Tree: http://git-wip-us.apache.org/repos/asf/kudu/tree/6626e109
Diff: http://git-wip-us.apache.org/repos/asf/kudu/diff/6626e109

Branch: refs/heads/master
Commit: 6626e109d4c2d729c1efef22ae90d800a2a23bd2
Parents: 57b148a
Author: Andrew Wong <awong@cloudera.com>
Authored: Thu Jan 18 15:09:09 2018 -0800
Committer: Andrew Wong <awong@cloudera.com>
Committed: Sat Jan 20 01:15:48 2018 +0000

----------------------------------------------------------------------
 docs/administration.adoc |  2 +-
 docs/configuration.adoc  | 38 ++++++++++++++++++++++++--------------
 2 files changed, 25 insertions(+), 15 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kudu/blob/6626e109/docs/administration.adoc
----------------------------------------------------------------------
diff --git a/docs/administration.adoc b/docs/administration.adoc
index b8f6361..becdebe 100644
--- a/docs/administration.adoc
+++ b/docs/administration.adoc
@@ -814,7 +814,7 @@ releases.
 | Node Type | Kudu Directory Type | Kudu Releases that Crash on Disk Failure
 | Master | All | All
 | Tablet Server | Directory containing WALs | All
-| Tablet Server | Directory containing data blocks and tablet metadata | All
+| Tablet Server | Directory containing tablet metadata | All
 | Tablet Server | Directory containing data blocks only | Pre-1.6.0
 |===
 

http://git-wip-us.apache.org/repos/asf/kudu/blob/6626e109/docs/configuration.adoc
----------------------------------------------------------------------
diff --git a/docs/configuration.adoc b/docs/configuration.adoc
index d397917..55aea8d 100644
--- a/docs/configuration.adoc
+++ b/docs/configuration.adoc
@@ -61,20 +61,28 @@ maintained in future releases.
 === Directory Configurations
 Every Kudu node requires the specification of directory flags. The
 `--fs_wal_dir` configuration indicates where Kudu will place its write-ahead
-logs. It is recommended, although not necessary, that this directory is placed
-on a high-performance drive (one with high bandwidth and low latency, e.g. a
-solid-state drive). The `--fs_data_dirs` configuration indicates where Kudu
-will write its data blocks. This is a comma-separated list of directories; if
-multiple are specified, data will be striped across the directories. Kudu will
-also place metadata for each tablet in the first specified directory. If not
-specified, data blocks will be placed in the directory specified by
-`--fs_wal_dir`. Additionally, `--fs_wal_dir` may be the same as _one of_ the
-directories listed in `--fs_data_dirs`, but must not be a sub-directory of any
-of them.
-
-WARNING: Once these flags are set, they are difficult to change, often requiring
-the entire node to be rebuilt. For more details, see the
-link:administration.html#change_dir_config[Kudu Administration docs].
+logs. The `--fs_metadata_dir` configuration indicates where Kudu will place
+metadata for each tablet. It is recommended, although not necessary, that these
+directories be placed on a high-performance drives with high bandwidth and low
+latency, e.g. solid-state drives. If `--fs_metadata_dir` is not specified,
+metadata will be placed in the directory specified by `--fs_wal_dir`.
+
+The `--fs_data_dirs` configuration indicates where Kudu will write its data
+blocks. This is a comma-separated list of directories; if multiple values are
+specified, data will be striped across the directories. If not specified, data
+blocks will be placed in the directory specified by `--fs_wal_dir`.
+
+Additionally, `--fs_wal_dir` and `--fs_metadata_dir` may be the same as _one
+of_ the directories listed in `--fs_data_dirs`, but must not be sub-directories
+of any of them.
+
+WARNING: Once `--fs_data_dirs` is set, it is difficult to change, requiring
+extra tooling, or in some cases, the entire node to be rebuilt. For more
+details, see the link:administration.html#change_dir_config[Kudu Administration
+docs].
+
+NOTE: The `--fs_wal_dir` and `--fs_metadata_dir` configurations can be changed,
+provided the contents of the directories are also moved to match the flags.
 
 === Configuring the Kudu Master
 To see all available configuration options for the `kudu-master` executable, run it
@@ -91,6 +99,7 @@ $ kudu-master --help
 |--master_addresses | string | localhost |  Comma-separated list of all the RPC
 addresses for Master consensus-configuration. If not specified, assumes a standalone Master.
 |--fs_data_dirs | string | | List of directories where the Master will place its data blocks.
+|--fs_metadata_dir | string | | The directory where the Master will place its tablet metadata.
 |--fs_wal_dir | string | | The directory where the Master will place its write-ahead logs.
 |--log_dir | string | /tmp | The directory to store Master log files.
 |===
@@ -110,6 +119,7 @@ $ kudu-tserver --help
 | Flag      | Valid Options     | Default     | Description
 
 |--fs_data_dirs | string |  | List of directories where the Tablet Server will place its
data blocks.
+|--fs_metadata_dir | string |  | The directory where the Tablet Server will place its tablet
metadata.
 |--fs_wal_dir | string | | The directory where the Tablet Server will place its write-ahead
logs.
 |--log_dir | string | /tmp | The directory to store Tablet Server log files
 |--tserver_master_addrs | string | `127.0.0.1:7051` |  Comma separated


Mime
View raw message