You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zookeeper.apache.org by sy...@apache.org on 2020/08/24 07:50:57 UTC

[zookeeper] branch branch-3.6 updated: ZOOKEEPER-3893: Enhance documentation for property ssl.clientAuth

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

symat pushed a commit to branch branch-3.6
in repository https://gitbox.apache.org/repos/asf/zookeeper.git


The following commit(s) were added to refs/heads/branch-3.6 by this push:
     new b42d76c  ZOOKEEPER-3893: Enhance documentation for property ssl.clientAuth
b42d76c is described below

commit b42d76cd14618e7119c0d39150407405b7e87731
Author: Sankalp Bhatia <sa...@gmail.com>
AuthorDate: Mon Aug 24 07:47:38 2020 +0000

    ZOOKEEPER-3893: Enhance documentation for property ssl.clientAuth
    
    Currently, the documentation for this property just mentions TBD (check https://zookeeper.apache.org/doc/r3.5.7/zookeeperAdmin.html). I believe this was ignored until versions 3.5.7 (https://issues.apache.org/jira/browse/ZOOKEEPER-3674) and a fix was made. It will be good to add some documentation around it.
    
    Author: Sankalp Bhatia <sa...@gmail.com>
    Author: Sankalp <sa...@amazon.com>
    
    Reviewers: Christopher Tubbs <ct...@apache.org>, Enrico Olivelli <eo...@apache.org>, Mate Szalay-Beko <sy...@apache.org>
    
    Closes #1405 from sankalpbhatia/master
    
    (cherry picked from commit fa846cbb70c031bdc126977d453dae1812b0012a)
    Signed-off-by: Mate Szalay-Beko <sy...@apache.org>
---
 zookeeper-docs/src/main/resources/markdown/zookeeperAdmin.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/zookeeper-docs/src/main/resources/markdown/zookeeperAdmin.md b/zookeeper-docs/src/main/resources/markdown/zookeeperAdmin.md
index bc16647..db56d6e 100644
--- a/zookeeper-docs/src/main/resources/markdown/zookeeperAdmin.md
+++ b/zookeeper-docs/src/main/resources/markdown/zookeeperAdmin.md
@@ -1471,8 +1471,14 @@ and [SASL authentication for ZooKeeper](https://cwiki.apache.org/confluence/disp
 
 * *ssl.clientAuth* and *ssl.quorum.clientAuth* :
     (Java system properties: **zookeeper.ssl.clientAuth** and **zookeeper.ssl.quorum.clientAuth**)
-    **New in 3.5.5:**
-    TBD
+    **Added in 3.5.5, but broken until 3.5.7:**
+    Specifies options to authenticate ssl connections from clients. Valid values are
+ 
+     * "none": server will not request client authentication 
+     * "want": server will "request" client authentication 
+     * "need": server will "require" client authentication
+
+     Default: "need"
 
 * *ssl.handshakeDetectionTimeoutMillis* and *ssl.quorum.handshakeDetectionTimeoutMillis* :
     (Java system properties: **zookeeper.ssl.handshakeDetectionTimeoutMillis** and **zookeeper.ssl.quorum.handshakeDetectionTimeoutMillis**)