kudu-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From granthe...@apache.org
Subject [1/2] kudu git commit: tools: add more detail about unsafe_change_config
Date Fri, 23 Feb 2018 17:52:14 GMT
Repository: kudu
Updated Branches:
  refs/heads/master 1cf8ad189 -> e94556ef7

tools: add more detail about unsafe_change_config

Given the tooling docs pages are auto-generated from the descriptions
provided by the tools directly, it'd be helpful to start describing when
to use each tool, in addition to the action itself.

In particular, in the docs page, when searching for the word "evict",
it'd be nice to be pointed to the `unsafe_change_config` tool.

Change-Id: If389f9fec4926b798c9885dac17b4de136644239
Reviewed-on: http://gerrit.cloudera.org:8080/9278
Reviewed-by: Mike Percy <mpercy@apache.org>
Tested-by: Kudu Jenkins

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

Branch: refs/heads/master
Commit: 52ca55ac29282a15213803c23946b6ee17c1c134
Parents: 1cf8ad1
Author: Andrew Wong <awong@cloudera.com>
Authored: Fri Feb 9 11:51:04 2018 -0800
Committer: Andrew Wong <awong@cloudera.com>
Committed: Fri Feb 23 06:38:30 2018 +0000

 src/kudu/tools/tool_action_remote_replica.cc | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/kudu/tools/tool_action_remote_replica.cc b/src/kudu/tools/tool_action_remote_replica.cc
index 77b6e6b..e910783 100644
--- a/src/kudu/tools/tool_action_remote_replica.cc
+++ b/src/kudu/tools/tool_action_remote_replica.cc
@@ -434,9 +434,13 @@ unique_ptr<Mode> BuildRemoteReplicaMode() {
   unique_ptr<Action> unsafe_change_config =
       ActionBuilder("unsafe_change_config", &UnsafeChangeConfig)
       .Description("Force the specified replica to adopt a new Raft config")
-      .ExtraDescription("The members of the new Raft config must be a subset "
+      .ExtraDescription("This tool is useful when a config change is "
+                        "necessary because a tablet cannot make progress with "
+                        "its current Raft configuration (e.g. to evict "
+                        "followers when a majority is unavailable).\n\nNote: "
+                        "The members of the new Raft config must be a subset "
                         "of (or the same as) the members of the existing "
-                        "committed Raft config on that replica.")
+                        "committed Raft config.")
       .AddRequiredParameter({ kTServerAddressArg, kTServerAddressDesc })
       .AddRequiredParameter({ kTabletIdArg, kTabletIdArgDesc })
       .AddRequiredVariadicParameter({ kPeerUUIDsArg, kPeerUUIDsArgDesc })

View raw message