You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by ti...@apache.org on 2022/11/18 10:06:43 UTC

[pulsar-site] branch main updated: Add client config reference main page (#294)

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

tison 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 276b5cacd14 Add client config reference main page (#294)
276b5cacd14 is described below

commit 276b5cacd14f8bb0aa053a54dc544cca4973ba6c
Author: momo-jun <60...@users.noreply.github.com>
AuthorDate: Fri Nov 18 18:06:37 2022 +0800

    Add client config reference main page (#294)
---
 .../static/reference/next/config/README.md         | 29 +++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/site2/website-next/static/reference/next/config/README.md b/site2/website-next/static/reference/next/config/README.md
index 889b0f555a3..a8d9ec8ae84 100644
--- a/site2/website-next/static/reference/next/config/README.md
+++ b/site2/website-next/static/reference/next/config/README.md
@@ -1 +1,28 @@
-> Docs for Pulsar Configuration.
+## Pulsar configurations
+
+Pulsar offers several command-line tools that you can use for managing Pulsar installations, performance testing, using command-line producers and consumers, and more.
+
+You can manage Pulsar configurations through configuration files in the [`conf`](https://github.com/apache/pulsar/tree/master/conf) directory of a Pulsar installation.
+
+- [BookKeeper](/next/config/reference-configuration-bookkeeper)
+- [Broker](/next/config/reference-configuration-broker)
+- [Client](/next/config/reference-configuration-client)
+- [Log4j](/next/config/reference-configuration-log4j)
+- [Log4j shell](/next/config/reference-configuration-log4j-shell)
+- [Standalone](/next/config/reference-configuration-standalone)
+- [WebSocket](/next/config/reference-configuration-websocket)
+- [Pulsar proxy](/next/config/reference-configuration-pulsar-proxy)
+- [ZooKeeper](/next/config/reference-configuration-zookeeper)
+
+### Override client configurations
+
+If you want to override the configurations of clients internal to brokers, websockets, and proxies, you can use the following prefix.
+
+| Prefix        | Description                                                                                                                                                                                                                  |
+|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| brokerClient_ | Configure **all** the Pulsar Clients and Pulsar Admin Clients of brokers, websockets, and proxies. These configurations are applied after hard-coded configurations and before the client configurations named in this site. |
+| bookkeeper_   | Configure the broker's BookKeeper clients used by managed ledgers and the BookkeeperPackagesStorage bookkeeper client. Takes precedence over most other configuration values.                                                |
+
+> Notes:
+> * This override feature only applies to Pulsar 2.10.1 and later versions.
+> * When running the function worker within the broker, you have to configure those clients by using the `functions_worker.yml` file. These prefixed configurations do not apply to any of those clients.
\ No newline at end of file