This is an automated email from the ASF dual-hosted git repository. adar pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/kudu.git
commit dfd516dd0697e30eb810b249bb87ad9358bb8545 Author: Yingchun Lai <[email protected]> AuthorDate: Tue Jun 11 16:22:14 2019 +0800 [docs] Add docs for CLI cluster name resolver Change-Id: Ib94a44b76008bc9d24e428000205e7c90e3ae653 Reviewed-on: http://gerrit.cloudera.org:8080/13579 Reviewed-by: Adar Dembo <[email protected]> Tested-by: Adar Dembo <[email protected]> --- docs/administration.adoc | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/administration.adoc b/docs/administration.adoc index 830b99e..aa7936e 100644 --- a/docs/administration.adoc +++ b/docs/administration.adoc @@ -1441,3 +1441,39 @@ WARNING: Do not shut down multiple tablet servers at once. To remove multiple tablet servers from the cluster, follow the above instructions for each tablet server, ensuring that the previous tablet server is removed from the cluster and `ksck` is healthy before shutting down the next. + +[[using_cluster_names_in_kudu_tool]] +=== Using cluster names in the `kudu` command line tool + +When using the `kudu` command line tool, it can be difficult to remember the +precise list of Kudu master RPC addresses needed to communicate with a cluster, +especially when managing multiple clusters. As an alternative, the command line +tool can identify clusters by name. To use this functionality: + +. Create a new directory to store the Kudu configuration file. +. Export the path to this directory in the `KUDU_CONFIG` environment variable. +. Create a file called `kudurc` in the new directory. +. Populate `kudurc` as follows, substituting your own cluster names and RPC + addresses: ++ +---- +clusters_info: + cluster_name1: + master_addresses: ip1:port1,ip2:port2,ip3:port3 + cluster_name2: + master_addresses: ip4:port4 +---- ++ +. When using the `kudu` command line tool, replace the list of Kudu master RPC + addresses with the cluster name, prepended with the character `@`. + + Example:: ++ +---- +$ sudo -u kudu kudu ksck @cluster_name1 +---- ++ + + +NOTE: Cluster names may be used as input in any invocation of the `kudu` command +line tool that expects a list of Kudu master RPC addresses.
