[improve][misc] Improve examples of ciphers and protocols (apache#18741)

Signed-off-by: Zixuan Liu <[email protected]>
teaey · Dec 5, 2022 · e498702 · e498702
1 parent ecf83d0
commit e498702
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 16 deletions.
diff --git a/conf/broker.conf b/conf/broker.conf
@@ -52,12 +52,14 @@ webServicePortTls=
 
 # Specify the tls protocols the broker's web service will use to negotiate during TLS handshake
 # (a comma-separated list of protocol names).
-# Examples:- [TLSv1.3, TLSv1.2]
+# Examples:
+# webServiceTlsProtocols=TLSv1.3,TLSv1.2
 webServiceTlsProtocols=
 
 # Specify the tls cipher the broker will use to negotiate during TLS Handshake
 # (a comma-separated list of ciphers).
-# Examples:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]
+# Examples:
+# webServiceTlsCiphers=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
 webServiceTlsCiphers=
 
 # Hostname or IP address the service binds on, default is 0.0.0.0.
@@ -680,12 +682,14 @@ tlsAllowInsecureConnection=false
 
 # Specify the tls protocols the broker will use to negotiate during TLS handshake
 # (a comma-separated list of protocol names).
-# Examples:- [TLSv1.3, TLSv1.2]
+# Examples:
+# tlsProtocols=TLSv1.3,TLSv1.2
 tlsProtocols=
 
 # Specify the tls cipher the broker will use to negotiate during TLS Handshake
 # (a comma-separated list of ciphers).
-# Examples:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]
+# Examples:
+# tlsCiphers=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
 tlsCiphers=
 
 # Trusted client certificates are required for to connect TLS
@@ -773,14 +777,16 @@ brokerClientTlsTrustStorePassword=
 
 # Specify the tls cipher the internal client will use to negotiate during TLS Handshake
 # (a comma-separated list of ciphers)
-# e.g.  [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256].
 # used by the internal client to authenticate with Pulsar brokers
+# Examples:
+# brokerClientTlsCiphers=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
 brokerClientTlsCiphers=
 
 # Specify the tls protocols the broker will use to negotiate during TLS handshake
 # (a comma-separated list of protocol names).
-# e.g.  [TLSv1.3, TLSv1.2]
 # used by the internal client to authenticate with Pulsar brokers
+# Example:
+# brokerClientTlsProtocols=TLSv1.3,TLSv1.2
 brokerClientTlsProtocols=
 
 # You can add extra configuration options for the Pulsar Client and the Pulsar Admin Client

diff --git a/conf/proxy.conf b/conf/proxy.conf
@@ -116,12 +116,14 @@ tlsTrustStorePassword=
 
 # Specify the tls protocols the proxy's web service will use to negotiate during TLS handshake
 # (a comma-separated list of protocol names).
-# Examples:- [TLSv1.3, TLSv1.2]
+# Examples:
+# webServiceTlsProtocols=TLSv1.3,TLSv1.2
 webServiceTlsProtocols=
 
 # Specify the tls cipher the proxy will use to negotiate during TLS Handshake
 # (a comma-separated list of ciphers).
-# Examples:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]
+# Examples:
+# webServiceTlsCiphers=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
 webServiceTlsCiphers=
 
 # Allowed broker target ports
@@ -227,12 +229,14 @@ tlsHostnameVerificationEnabled=false
 
 # Specify the tls protocols the broker will use to negotiate during TLS handshake
 # (a comma-separated list of protocol names).
-# Examples:- [TLSv1.3, TLSv1.2]
+# Examples:
+# tlsProtocols=TLSv1.3,TLSv1.2
 tlsProtocols=
 
 # Specify the tls cipher the broker will use to negotiate during TLS Handshake
 # (a comma-separated list of ciphers).
-# Examples:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]
+# Examples:
+# tlsCiphers=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
 tlsCiphers=
 
 # Whether client certificates are required for TLS. Connections are rejected if the client

diff --git a/conf/standalone.conf b/conf/standalone.conf
@@ -378,12 +378,14 @@ tlsAllowInsecureConnection=false
 
 # Specify the tls protocols the broker will use to negotiate during TLS handshake
 # (a comma-separated list of protocol names).
-# Examples:- [TLSv1.3, TLSv1.2]
+# Examples:
+# tlsProtocols=TLSv1.3,TLSv1.2
 tlsProtocols=
 
 # Specify the tls cipher the broker will use to negotiate during TLS Handshake
 # (a comma-separated list of ciphers).
-# Examples:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]
+# Examples:
+# tlsCiphers=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
 tlsCiphers=
 
 # Trusted client certificates are required for to connect TLS
@@ -469,14 +471,16 @@ brokerClientTlsTrustStorePassword=
 
 # Specify the tls cipher the internal client will use to negotiate during TLS Handshake
 # (a comma-separated list of ciphers)
-# e.g.  [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256].
 # used by the internal client to authenticate with Pulsar brokers
+# Examples:
+# brokerClientTlsCiphers=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
 brokerClientTlsCiphers=
 
 # Specify the tls protocols the broker will use to negotiate during TLS handshake
 # (a comma-separated list of protocol names).
-# e.g.  [TLSv1.3, TLSv1.2]
 # used by the internal client to authenticate with Pulsar brokers
+# Examples:
+# brokerClientTlsProtocols=TLSv1.3,TLSv1.2
 brokerClientTlsProtocols=
 
 # Enable or disable system topic

diff --git a/conf/websocket.conf b/conf/websocket.conf
@@ -166,12 +166,14 @@ tlsTrustStorePassword=
 
 # Specify the tls protocols the proxy's web service will use to negotiate during TLS handshake
 # (a comma-separated list of protocol names).
-# Examples:- [TLSv1.3, TLSv1.2]
+# Examples:
+# webServiceTlsProtocols=TLSv1.3,TLSv1.2
 webServiceTlsProtocols=
 
 # Specify the tls cipher the proxy will use to negotiate during TLS Handshake
 # (a comma-separated list of ciphers).
-# Examples:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]
+# Examples:
+# webServiceTlsCiphers=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
 webServiceTlsCiphers=
 
 ### --- Deprecated config variables --- ###