Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ZOOKEEPER-2693: Correct the documentation about response to "ruok" 4lw #1608

Closed
wants to merge 2 commits into from
Closed

ZOOKEEPER-2693: Correct the documentation about response to "ruok" 4lw #1608

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3908df3
ZOOKEEPER-2693: Correct the documentation about response to "ruok" 4lw
nemobis Feb 18, 2021
1dd7609
Rephrase ruok whitelist documentation per maoling
nemobis Feb 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions zookeeper-docs/src/main/resources/markdown/zookeeperAdmin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1355,7 +1355,8 @@ of servers -- that is, when deploying clusters of servers.
not enable the command.
By default the whitelist only contains "srvr" command
which zkServer.sh uses. The rest of four letter word commands are disabled
by default.
by default: attempting to use them will gain a response
".... is not executed because it is not in the whitelist."
Here's an example of the configuration that enables stat, ruok, conf, and isro
command while disabling the rest of Four Letter Words command:

Expand Down Expand Up @@ -2242,7 +2243,7 @@ connections respectively.

**New in 3.5.3:**
Four Letter Words need to be explicitly white listed before using.
Please refer **4lw.commands.whitelist**
Please refer to **4lw.commands.whitelist**
described in [cluster configuration section](#sc_clusterOptions) for details.
Moving forward, Four Letter Words will be deprecated, please use
[AdminServer](#sc_adminserver) instead.
Expand All @@ -2269,9 +2270,11 @@ Moving forward, Four Letter Words will be deprecated, please use
Print details about serving environment

* *ruok* :
Tests if server is running in a non-error state. The server
will respond with imok if it is running. Otherwise it will not
respond at all.
Tests if the server is running in a non-error state.
When the whitelist enables ruok, the server will respond with `imok`
if it is running, otherwise it will not respond at all.
When ruok is disabled, the server responds with:
"ruok is not executed because it is not in the whitelist."
A response of "imok" does not necessarily indicate that the
server has joined the quorum, just that the server process is active
nemobis marked this conversation as resolved.
Show resolved Hide resolved
and bound to the specified client port. Use "stat" for details on
Expand Down