This is an automated email from the ASF dual-hosted git repository.
mmarshall pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 45364be101a Fix Documentation for Client Pass Through Configuration
(#16410)
45364be101a is described below
commit 45364be101abd4a67d184652931c36d628bf38de
Author: Michael Marshall <[email protected]>
AuthorDate: Fri Jul 8 16:03:35 2022 -0500
Fix Documentation for Client Pass Through Configuration (#16410)
* Fix table formatting
* Document pass through configuration for 2.10.1 docs
* Update
site2/website/versioned_docs/version-2.10.1/reference-configuration.md
Co-authored-by: Anonymitaet <[email protected]>
* Update
site2/website/versioned_docs/version-2.10.1/reference-configuration.md
Co-authored-by: Anonymitaet <[email protected]>
* Update
site2/website/versioned_docs/version-2.10.1/reference-configuration.md
Co-authored-by: Anonymitaet <[email protected]>
* Update
site2/website/versioned_docs/version-2.10.1/reference-configuration.md
Co-authored-by: Anonymitaet <[email protected]>
Co-authored-by: Dave Fisher <[email protected]>
Co-authored-by: Anonymitaet <[email protected]>
---
site2/docs/reference-configuration.md | 3 +++
.../version-2.10.1/reference-configuration.md | 30 ++++++++++++++++++++++
2 files changed, 33 insertions(+)
diff --git a/site2/docs/reference-configuration.md
b/site2/docs/reference-configuration.md
index 5d2cb1f9db8..a57d02995c0 100644
--- a/site2/docs/reference-configuration.md
+++ b/site2/docs/reference-configuration.md
@@ -400,6 +400,7 @@ brokerServiceCompactionThresholdInBytes|If the estimated
backlog size is greater
It's possible to configure some clients by using the appropriate prefix.
|Prefix|Description|
+|---|---|
|brokerClient_| Configure **all** the broker's Pulsar Clients and Pulsar Admin
Clients. These configurations are applied after hard coded configuration and
before the above brokerClient configurations named above.|
|bookkeeper_| Configure the broker's bookkeeper clients used by managed
ledgers and the BookkeeperPackagesStorage bookkeeper client. Takes precedence
over most other configuration values.|
@@ -788,6 +789,7 @@ The following parameters have been deprecated in the
`conf/standalone.conf` file
It's possible to configure some clients by using the appropriate prefix.
|Prefix|Description|
+|---|---|
|brokerClient_| Configure **all** the broker's Pulsar Clients. These
configurations are applied after hard coded configuration and before the above
brokerClient configurations named above.|
#### Deprecated parameters of WebSocket
@@ -864,6 +866,7 @@ The [Pulsar
proxy](concepts-architecture-overview.md#pulsar-proxy) can be config
It's possible to configure some clients by using the appropriate prefix.
|Prefix|Description|
+|---|---|
|brokerClient_| Configure **all** the proxy's Pulsar Clients. These
configurations are applied after hard coded configuration and before the above
brokerClient configurations named above.|
#### Deprecated parameters of Pulsar proxy
diff --git
a/site2/website/versioned_docs/version-2.10.1/reference-configuration.md
b/site2/website/versioned_docs/version-2.10.1/reference-configuration.md
index 4df15fdf782..b261317782b 100644
--- a/site2/website/versioned_docs/version-2.10.1/reference-configuration.md
+++ b/site2/website/versioned_docs/version-2.10.1/reference-configuration.md
@@ -378,6 +378,20 @@ brokerServiceCompactionThresholdInBytes|If the estimated
backlog size is greater
| strictBookieAffinityEnabled | Enable or disable the strict bookie isolation
strategy. If enabled, <br /> - `bookie-ensemble` first tries to choose bookies
that belong to a namespace's affinity group. If the number of bookies is not
enough, then the rest bookies are chosen. <br /> - If namespace has no affinity
group, `bookie-ensemble` only chooses bookies that belong to no region. If the
number of bookies is not enough, `BKNotEnoughBookiesException` is thrown.|
false |
|narExtractionDirectory | The extraction directory of the nar package. <br
/>Available for Protocol Handler, Additional Servlets, Entry Filter,
Offloaders, Broker Interceptor. | System.getProperty("java.io.tmpdir") |
+#### Configuration override for clients internal to broker
+
+It's possible to configure some clients by using the appropriate prefix.
+
+|Prefix|Description|
+|---|---|
+|brokerClient_| Configure **all** the broker's Pulsar Clients and Pulsar Admin
Clients. These configurations are applied after hard coded configuration and
before the above broker client configurations named above.|
+|bookkeeper_| Configure the broker's BookKeeper clients used by managed
ledgers and the BookkeeperPackagesStorage bookkeeper client. Takes precedence
over most other configuration values.|
+
+::: Note
+
+When running the function worker within the broker, these prefixed
configurations do not apply to any of those clients. You must configure those
clients using the `functions_worker.yml` file.
+
+:::
#### Deprecated parameters of Broker
The following parameters have been deprecated in the `conf/broker.conf` file.
@@ -747,6 +761,14 @@ The following parameters have been deprecated in the
`conf/standalone.conf` file
|tlsKeyFilePath |||
|tlsTrustCertsFilePath|||
+#### Configuration Override For Clients Internal to WebSocket
+
+It's possible to configure some clients by using the appropriate prefix.
+
+|Prefix|Description|
+|---|---|
+|brokerClient_| Configure **all** the broker's Pulsar Clients. These
configurations are applied after hard coded configuration and before the above
brokerClient configurations named above.|
+
#### Deprecated parameters of WebSocket
The following parameters have been deprecated in the `conf/websocket.conf`
file.
@@ -813,6 +835,14 @@ The [Pulsar
proxy](concepts-architecture-overview.md#pulsar-proxy) can be config
| numIOThreads | Number of threads used for Netty IO. | 2 *
Runtime.getRuntime().availableProcessors() |
| numAcceptorThreads | Number of threads used for Netty Acceptor. | 1 |
+#### Configuration Override For Clients Internal to Proxy
+
+It's possible to configure some clients by using the appropriate prefix.
+
+|Prefix|Description|
+|---|---|
+|brokerClient_| Configure **all** the proxy's Pulsar Clients. These
configurations are applied after hard coded configuration and before the above
brokerClient configurations named above.|
+
#### Deprecated parameters of Pulsar proxy
The following parameters have been deprecated in the `conf/proxy.conf` file.
