[kudu] branch master updated: KUDU-3408 Better "kudurc" documentation

[ab...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

abukor pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kudu.git


The following commit(s) were added to refs/heads/master by this push:
     new 0eee0d940 KUDU-3408 Better "kudurc" documentation
0eee0d940 is described below

commit 0eee0d940b40f1028dae1029ad2bae42339c0e5f
Author: mammadli.khazar <ma...@cloudera.com>
AuthorDate: Tue Nov 22 02:39:07 2022 +0100

    KUDU-3408 Better "kudurc" documentation
    
    Kudu CLI provides the possibility to have cluster aliases to provide the
    list of master addresses in a "kudurc" file. This is quite useful
    feature, as it negates the need for the users to remember/type the list
    of master addresses everytime they want to invoke a Kudu CLI command.
    This patch adds a reference to this feature in Quickstart.adoc to make
    it more apparent to new users. It also makes the possibility of using
    environment variables for substituting Master Addresses with KUDU CLI
    more apparent.
    
    Change-Id: I33d9a6d579343ff7333af955bf309ac66bfb0c7b
    Reviewed-on: http://gerrit.cloudera.org:8080/19263
    Tested-by: Kudu Jenkins
    Reviewed-by: Alexey Serbin <al...@apache.org>
    Reviewed-by: Attila Bukor <ab...@apache.org>
---
 docs/quickstart.adoc | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/docs/quickstart.adoc b/docs/quickstart.adoc
index c93047364..b9a4d9539 100644
--- a/docs/quickstart.adoc
+++ b/docs/quickstart.adoc
@@ -121,6 +121,21 @@ kudu cluster ksck localhost:7051,localhost:7151,localhost:7251
 NOTE: Setting `KUDU_USER_NAME=kudu` simplifies using Kudu from various user
 accounts in a non-secure environment.
 
+NOTE: Remembering master addresses each time when using the `kudu` command
+line tool can be unwieldy. As an alternative to this,
+<<administration.adoc#using_cluster_names_in_kudu_tool,the command line tool
+can identify clusters by name.>>
+
+NOTE: Setting environment variables in the current shell session in order to Master
+addresses and substituting them later on can also simplify the calls to Kudu CLI
+greatly.
+
+[source,bash]
+----
+export KUDU_MASTER_ADDRESSES=localhost:7051,localhost:7151,localhost:7251
+kudu table list $KUDU_MASTER_ADDRESSES
+----
+
 == Running a Brief Example
 
 Now that a Kudu cluster is up and running, examples and integrations can be