This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new eaf427144d02 Docs sync done from apache/pulsar (#4924052)
eaf427144d02 is described below
commit eaf427144d02706b666ec3ac822b090f4f1d1227
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue Apr 23 01:34:38 2024 +0000
Docs sync done from apache/pulsar (#4924052)
---
.../next/config/reference-configuration-broker.md | 35 ++++++++++++++++++++++
.../config/reference-configuration-pulsar-proxy.md | 35 ++++++++++++++++++++++
.../config/reference-configuration-standalone.md | 35 ++++++++++++++++++++++
.../config/reference-configuration-websocket.md | 35 ++++++++++++++++++++++
static/swagger/master/swagger.json | 9 ++++++
static/swagger/master/v2/swagger.json | 9 ++++++
6 files changed, 158 insertions(+)
diff --git a/static/reference/next/config/reference-configuration-broker.md
b/static/reference/next/config/reference-configuration-broker.md
index cab9e7f7e7ba..2545e65d0b81 100644
--- a/static/reference/next/config/reference-configuration-broker.md
+++ b/static/reference/next/config/reference-configuration-broker.md
@@ -3868,6 +3868,29 @@ If enabled the feature that transaction pending ack log
batch, this attribute me
**Category**: Server
+### webServiceHaProxyProtocolEnabled
+Enable or disable the use of HA proxy protocol for resolving the client IP for
http/https requests. Default is false.
+
+**Type**: `boolean`
+
+**Default**: `false`
+
+**Dynamic**: `false`
+
+**Category**: Server
+
+### webServiceLogDetailedAddresses
+Add detailed client/remote and server/local addresses and ports to http/https
request logging.
+Defaults to true when either webServiceHaProxyProtocolEnabled or
webServiceTrustXForwardedFor is enabled.
+
+**Type**: `java.lang.Boolean`
+
+**Default**: `null`
+
+**Dynamic**: `false`
+
+**Category**: Server
+
### webServicePort
The port for serving http requests
@@ -3901,6 +3924,18 @@ Specify the TLS provider for the web service: SunJSSE,
Conscrypt and etc.
**Category**: Server
+### webServiceTrustXForwardedFor
+Trust X-Forwarded-For header for resolving the client IP for http/https
requests.
+Default is false.
+
+**Type**: `boolean`
+
+**Default**: `false`
+
+**Dynamic**: `false`
+
+**Category**: Server
+
### bookkeeperClientAuthenticationParameters
Parameters for bookkeeper auth plugin
diff --git
a/static/reference/next/config/reference-configuration-pulsar-proxy.md
b/static/reference/next/config/reference-configuration-pulsar-proxy.md
index 655b98e5dc51..f0895b2f888a 100644
--- a/static/reference/next/config/reference-configuration-pulsar-proxy.md
+++ b/static/reference/next/config/reference-configuration-pulsar-proxy.md
@@ -955,6 +955,29 @@ Path for the file used to determine the rotation status
for the proxy instance w
**Category**: Server
+### webServiceHaProxyProtocolEnabled
+Enable or disable the use of HA proxy protocol for resolving the client IP for
http/https requests. Default is false.
+
+**Type**: `boolean`
+
+**Default**: `false`
+
+**Dynamic**: `false`
+
+**Category**: Server
+
+### webServiceLogDetailedAddresses
+Add detailed client/remote and server/local addresses and ports to http/https
request logging.
+Defaults to true when either webServiceHaProxyProtocolEnabled or
webServiceTrustXForwardedFor is enabled.
+
+**Type**: `java.lang.Boolean`
+
+**Default**: `null`
+
+**Dynamic**: `false`
+
+**Category**: Server
+
### webServicePort
The port for serving http requests
@@ -977,6 +1000,18 @@ The port for serving https requests
**Category**: Server
+### webServiceTrustXForwardedFor
+Trust X-Forwarded-For header for resolving the client IP for http/https
requests.
+Default is false.
+
+**Type**: `boolean`
+
+**Default**: `false`
+
+**Dynamic**: `false`
+
+**Category**: Server
+
### tlsAllowInsecureConnection
Accept untrusted TLS certificate from client.
diff --git a/static/reference/next/config/reference-configuration-standalone.md
b/static/reference/next/config/reference-configuration-standalone.md
index cab9e7f7e7ba..2545e65d0b81 100644
--- a/static/reference/next/config/reference-configuration-standalone.md
+++ b/static/reference/next/config/reference-configuration-standalone.md
@@ -3868,6 +3868,29 @@ If enabled the feature that transaction pending ack log
batch, this attribute me
**Category**: Server
+### webServiceHaProxyProtocolEnabled
+Enable or disable the use of HA proxy protocol for resolving the client IP for
http/https requests. Default is false.
+
+**Type**: `boolean`
+
+**Default**: `false`
+
+**Dynamic**: `false`
+
+**Category**: Server
+
+### webServiceLogDetailedAddresses
+Add detailed client/remote and server/local addresses and ports to http/https
request logging.
+Defaults to true when either webServiceHaProxyProtocolEnabled or
webServiceTrustXForwardedFor is enabled.
+
+**Type**: `java.lang.Boolean`
+
+**Default**: `null`
+
+**Dynamic**: `false`
+
+**Category**: Server
+
### webServicePort
The port for serving http requests
@@ -3901,6 +3924,18 @@ Specify the TLS provider for the web service: SunJSSE,
Conscrypt and etc.
**Category**: Server
+### webServiceTrustXForwardedFor
+Trust X-Forwarded-For header for resolving the client IP for http/https
requests.
+Default is false.
+
+**Type**: `boolean`
+
+**Default**: `false`
+
+**Dynamic**: `false`
+
+**Category**: Server
+
### bookkeeperClientAuthenticationParameters
Parameters for bookkeeper auth plugin
diff --git a/static/reference/next/config/reference-configuration-websocket.md
b/static/reference/next/config/reference-configuration-websocket.md
index 8c7aafbd951e..fec6018fe780 100644
--- a/static/reference/next/config/reference-configuration-websocket.md
+++ b/static/reference/next/config/reference-configuration-websocket.md
@@ -475,6 +475,29 @@ TLS TrustStore type configuration in WebSocket: JKS, PKCS12
**Category**:
+### webServiceHaProxyProtocolEnabled
+Enable or disable the use of HA proxy protocol for resolving the client IP for
http/https requests. Default is false.
+
+**Type**: `boolean`
+
+**Default**: `false`
+
+**Dynamic**: `false`
+
+**Category**:
+
+### webServiceLogDetailedAddresses
+Add detailed client/remote and server/local addresses and ports to http/https
request logging.
+Defaults to true when either webServiceHaProxyProtocolEnabled or
webServiceTrustXForwardedFor is enabled.
+
+**Type**: `java.lang.Boolean`
+
+**Default**: `null`
+
+**Dynamic**: `false`
+
+**Category**:
+
### webServicePort
Port to use to server HTTP request
@@ -523,6 +546,18 @@ Example:- [TLSv1.3, TLSv1.2]
**Category**:
+### webServiceTrustXForwardedFor
+Trust X-Forwarded-For header for resolving the client IP for http/https
requests.
+Default is false.
+
+**Type**: `boolean`
+
+**Default**: `false`
+
+**Dynamic**: `false`
+
+**Category**:
+
### webSocketConnectionsPerBroker
Number of connections per broker in Pulsar client used in WebSocket proxy
diff --git a/static/swagger/master/swagger.json
b/static/swagger/master/swagger.json
index 973749c7c455..8014c7306d75 100644
--- a/static/swagger/master/swagger.json
+++ b/static/swagger/master/swagger.json
@@ -4581,6 +4581,12 @@
"validateConnectorConfig": {
"type": "boolean"
},
+ "webServiceHaProxyProtocolEnabled": {
+ "type": "boolean"
+ },
+ "webServiceLogDetailedAddresses": {
+ "type": "boolean"
+ },
"webServiceTlsCiphers": {
"items": {
"type": "string"
@@ -4595,6 +4601,9 @@
"type": "array",
"uniqueItems": true
},
+ "webServiceTrustXForwardedFor": {
+ "type": "boolean"
+ },
"workerHostname": {
"type": "string"
},
diff --git a/static/swagger/master/v2/swagger.json
b/static/swagger/master/v2/swagger.json
index 973749c7c455..8014c7306d75 100644
--- a/static/swagger/master/v2/swagger.json
+++ b/static/swagger/master/v2/swagger.json
@@ -4581,6 +4581,12 @@
"validateConnectorConfig": {
"type": "boolean"
},
+ "webServiceHaProxyProtocolEnabled": {
+ "type": "boolean"
+ },
+ "webServiceLogDetailedAddresses": {
+ "type": "boolean"
+ },
"webServiceTlsCiphers": {
"items": {
"type": "string"
@@ -4595,6 +4601,9 @@
"type": "array",
"uniqueItems": true
},
+ "webServiceTrustXForwardedFor": {
+ "type": "boolean"
+ },
"workerHostname": {
"type": "string"
},
