#

# Licensed to the Apache Software Foundation (ASF) under one

# or more contributor license agreements. See the NOTICE file

# distributed with this work for additional information

# regarding copyright ownership. The ASF licenses this file

# to you under the Apache License, Version 2.0 (the

# "License"); you may not use this file except in compliance

# with the License. You may obtain a copy of the License at

#

# http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing,

# software distributed under the License is distributed on an

# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

# KIND, either express or implied. See the License for the

# specific language governing permissions and limitations

# under the License.

#

### --- General broker settings --- ###

# The metadata store URL

# Examples:

# * zk:my-zk-1:2181,my-zk-2:2181,my-zk-3:2181

# * my-zk-1:2181,my-zk-2:2181,my-zk-3:2181 (will default to ZooKeeper when the schema is not specified)

# * zk:my-zk-1:2181,my-zk-2:2181,my-zk-3:2181/my-chroot-path (to add a ZK chroot path)

metadataStoreUrl=

# The metadata store URL for the configuration data. If empty, we fall back to use metadataStoreUrl

configurationMetadataStoreUrl=

# Broker data port

brokerServicePort=6650

# Broker data port for TLS - By default TLS is disabled

brokerServicePortTls=

# Port to use to server HTTP request

webServicePort=8080

# Port to use to server HTTPS request - By default TLS is disabled

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]

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]

webServiceTlsCiphers=

# Hostname or IP address the service binds on, default is 0.0.0.0.

bindAddress=0.0.0.0

# Extra bind addresses for the service: <listener_name>:<scheme>://<host>:<port>,[...]

bindAddresses=

# Hostname or IP address the service advertises to the outside world. If not set, the value of InetAddress.getLocalHost().getHostName() is used.

advertisedAddress=

# Used to specify multiple advertised listeners for the broker.

# The value must format as <listener_name>:pulsar://<host>:<port>,

# multiple listeners should separate with commas.

# Do not use this configuration with advertisedAddress and brokerServicePort.

# The Default value is absent means use advertisedAddress and brokerServicePort.

# advertisedListeners=

# Used to specify the internal listener name for the broker.

# The listener name must contain in the advertisedListeners.

# The Default value is absent, the broker uses the first listener as the internal listener.

# internalListenerName=

# Enable or disable the HAProxy protocol.

haProxyProtocolEnabled=false

# Number of threads to config Netty Acceptor. Default is 1

numAcceptorThreads=

# Number of threads to use for Netty IO. Default is set to 2 * Runtime.getRuntime().availableProcessors()

numIOThreads=

# Number of threads to use for ordered executor. The ordered executor is used to operate with zookeeper,

# such as init zookeeper client, get namespace policies from zookeeper etc. It also used to split bundle. Default is 8

numOrderedExecutorThreads=8

# Number of threads to use for HTTP requests processing. Default is set to 2 * Runtime.getRuntime().availableProcessors()

numHttpServerThreads=

# Number of thread pool size to use for pulsar broker service.

# The executor in thread pool will do basic broker operation like load/unload bundle, update managedLedgerConfig,

# update topic/subscription/replicator message dispatch rate, do leader election etc.

# Default is Runtime.getRuntime().availableProcessors()

numExecutorThreadPoolSize=

# Number of thread pool size to use for pulsar zookeeper callback service

# The cache executor thread pool is used for restarting global zookeeper session.

# Default is 10

numCacheExecutorThreadPoolSize=10

# Option to enable busy-wait settings. Default is false.

# WARNING: This option will enable spin-waiting on executors and IO threads in order to reduce latency during

# context switches. The spinning will consume 100% CPU even when the broker is not doing any work. It is recommended to

# reduce the number of IO threads and BK client threads to only have few CPU cores busy.

enableBusyWait=false

# Flag to control features that are meant to be used when running in standalone mode

isRunningStandalone=

# Name of the cluster to which this broker belongs to

clusterName=

# The maximum number of tenants that each pulsar cluster can create

# This configuration is not precise control, in a concurrent scenario, the threshold will be exceeded

maxTenants=0

# Enable cluster's failure-domain which can distribute brokers into logical region

failureDomainsEnabled=false

# Metadata store session timeout in milliseconds

metadataStoreSessionTimeoutMillis=30000

# Metadata store operation timeout in seconds

metadataStoreOperationTimeoutSeconds=30

# Metadata store cache expiry time in seconds

metadataStoreCacheExpirySeconds=300

# Time to wait for broker graceful shutdown. After this time elapses, the process will be killed

brokerShutdownTimeoutMs=60000

# Flag to skip broker shutdown when broker handles Out of memory error

skipBrokerShutdownOnOOM=false

# Enable backlog quota check. Enforces action on topic when the quota is reached

backlogQuotaCheckEnabled=true

# How often to check for topics that have reached the quota

backlogQuotaCheckIntervalInSeconds=60

# Default per-topic backlog quota limit, less than 0 means no limitation. default is -1.

backlogQuotaDefaultLimitBytes=-1

# Default per-topic backlog quota time limit in second, less than 0 means no limitation. default is -1.

backlogQuotaDefaultLimitSecond=-1

# Default backlog quota retention policy. Default is producer_request_hold

# 'producer_request_hold' Policy which holds producer's send request until the resource becomes available (or holding times out)

# 'producer_exception' Policy which throws javax.jms.ResourceAllocationException to the producer

# 'consumer_backlog_eviction' Policy which evicts the oldest message from the slowest consumer's backlog

backlogQuotaDefaultRetentionPolicy=producer_request_hold

# Default ttl for namespaces if ttl is not already configured at namespace policies. (disable default-ttl with value 0)

ttlDurationDefaultInSeconds=0

# Enable topic auto creation if new producer or consumer connected (disable auto creation with value false)

allowAutoTopicCreation=true

# The type of topic that is allowed to be automatically created.(partitioned/non-partitioned)

allowAutoTopicCreationType=non-partitioned

# Enable subscription auto creation if new consumer connected (disable auto creation with value false)

allowAutoSubscriptionCreation=true

# The number of partitioned topics that is allowed to be automatically created if allowAutoTopicCreationType is partitioned.

defaultNumPartitions=1

# Enable the deletion of inactive topics. This parameter need to cooperate with the allowAutoTopicCreation parameter.

# If brokerDeleteInactiveTopicsEnabled is set to true, we should ensure that allowAutoTopicCreation is also set to true.

brokerDeleteInactiveTopicsEnabled=true

# How often to check for inactive topics

brokerDeleteInactiveTopicsFrequencySeconds=60

# Set the inactive topic delete mode. Default is delete_when_no_subscriptions

# 'delete_when_no_subscriptions' mode only delete the topic which has no subscriptions and no active producers

# 'delete_when_subscriptions_caught_up' mode only delete the topic that all subscriptions has no backlogs(caught up)

# and no active producers/consumers

brokerDeleteInactiveTopicsMode=delete_when_no_subscriptions

# Metadata of inactive partitioned topic will not be cleaned up automatically by default.

# Note: If `allowAutoTopicCreation` and this option are enabled at the same time,

# it may appear that a partitioned topic has just been deleted but is automatically created as a non-partitioned topic.

brokerDeleteInactivePartitionedTopicMetadataEnabled=false

# Max duration of topic inactivity in seconds, default is not present

# If not present, 'brokerDeleteInactiveTopicsFrequencySeconds' will be used

# Topics that are inactive for longer than this value will be deleted

brokerDeleteInactiveTopicsMaxInactiveDurationSeconds=

# Allow you to delete a tenant forcefully.

forceDeleteTenantAllowed=false

# Allow you to delete a namespace forcefully.

forceDeleteNamespaceAllowed=false

# Max pending publish requests per connection to avoid keeping large number of pending

# requests in memory. Default: 1000

maxPendingPublishRequestsPerConnection=1000

# How frequently to proactively check and purge expired messages

messageExpiryCheckIntervalInMinutes=5

# How long to delay rewinding cursor and dispatching messages when active consumer is changed

activeConsumerFailoverDelayTimeMillis=1000

# How long to delete inactive subscriptions from last consuming

# When it is 0, inactive subscriptions are not deleted automatically

subscriptionExpirationTimeMinutes=0

# Enable subscription message redelivery tracker to send redelivery count to consumer (default is enabled)

subscriptionRedeliveryTrackerEnabled=true

# How frequently to proactively check and purge expired subscription

subscriptionExpiryCheckIntervalInMinutes=5

# Enable subscription types (default is all type enabled)

# SubscriptionTypes : Exclusive,Shared,Failover,Key_Shared

# Example : Exclusive,Shared

# Above example will disable Failover and Key_Shared subscription types

subscriptionTypesEnabled=Exclusive,Shared,Failover,Key_Shared

# On KeyShared subscriptions, with default AUTO_SPLIT mode, use splitting ranges or

# consistent hashing to reassign keys to new consumers

subscriptionKeySharedUseConsistentHashing=true

# On KeyShared subscriptions, number of points in the consistent-hashing ring.

# The higher the number, the more equal the assignment of keys to consumers

subscriptionKeySharedConsistentHashingReplicaPoints=100

# Set the default behavior for message deduplication in the broker

# This can be overridden per-namespace. If enabled, broker will reject

# messages that were already stored in the topic

brokerDeduplicationEnabled=false

# Maximum number of producer information that it's going to be

# persisted for deduplication purposes

brokerDeduplicationMaxNumberOfProducers=10000

# How often is the thread pool scheduled to check whether a snapshot needs to be taken.(disable with value 0)

brokerDeduplicationSnapshotFrequencyInSeconds=120

# If this time interval is exceeded, a snapshot will be taken.

# It will run simultaneously with `brokerDeduplicationEntriesInterval`

brokerDeduplicationSnapshotIntervalSeconds=120

# Number of entries after which a dedup info snapshot is taken.

# A larger interval will lead to fewer snapshots being taken, though it would

# increase the topic recovery time when the entries published after the

# snapshot need to be replayed.

brokerDeduplicationEntriesInterval=1000

# Time of inactivity after which the broker will discard the deduplication information

# relative to a disconnected producer. Default is 6 hours.

brokerDeduplicationProducerInactivityTimeoutMinutes=360

# When a namespace is created without specifying the number of bundle, this

# value will be used as the default

defaultNumberOfNamespaceBundles=4

# The maximum number of namespaces that each tenant can create

# This configuration is not precise control, in a concurrent scenario, the threshold will be exceeded

maxNamespacesPerTenant=0

# Max number of topics allowed to be created in the namespace. When the topics reach the max topics of the namespace,

# the broker should reject the new topic request(include topic auto-created by the producer or consumer)

# until the number of connected consumers decrease.

# Using a value of 0, is disabling maxTopicsPerNamespace-limit check.

maxTopicsPerNamespace=0

# The maximum number of connections in the broker. If it exceeds, new connections are rejected.

brokerMaxConnections=0

# The maximum number of connections per IP. If it exceeds, new connections are rejected.

brokerMaxConnectionsPerIp=0

# Allow schema to be auto updated at broker level. User can override this by

# 'is_allow_auto_update_schema' of namespace policy.

isAllowAutoUpdateSchemaEnabled=true

# Enable check for minimum allowed client library version

clientLibraryVersionCheckEnabled=false

# Path for the file used to determine the rotation status for the broker when responding

# to service discovery health checks

statusFilePath=

# If true, (and ModularLoadManagerImpl is being used), the load manager will attempt to

# use only brokers running the latest software version (to minimize impact to bundles)

preferLaterVersions=false

# Max number of unacknowledged messages allowed to receive messages by a consumer on a shared subscription. Broker will stop sending

# messages to consumer once, this limit reaches until consumer starts acknowledging messages back.

# Using a value of 0, is disabling unackeMessage limit check and consumer can receive messages without any restriction

maxUnackedMessagesPerConsumer=50000

# Max number of unacknowledged messages allowed per shared subscription. Broker will stop dispatching messages to

# all consumers of the subscription once this limit reaches until consumer starts acknowledging messages back and

# unack count reaches to limit/2. Using a value of 0, is disabling unackedMessage-limit

# check and dispatcher can dispatch messages without any restriction

maxUnackedMessagesPerSubscription=200000

# Max number of unacknowledged messages allowed per broker. Once this limit reaches, broker will stop dispatching

# messages to all shared subscription which has higher number of unack messages until subscriptions start

# acknowledging messages back and unack count reaches to limit/2. Using a value of 0, is disabling

# unackedMessage-limit check and broker doesn't block dispatchers

maxUnackedMessagesPerBroker=0

# Once broker reaches maxUnackedMessagesPerBroker limit, it blocks subscriptions which has higher unacked messages

# than this percentage limit and subscription will not receive any new messages until that subscription acks back

# limit/2 messages

maxUnackedMessagesPerSubscriptionOnBrokerBlocked=0.16

# Broker periodically checks if subscription is stuck and unblock if flag is enabled. (Default is disabled)

unblockStuckSubscriptionEnabled=false

# Tick time to schedule task that checks topic publish rate limiting across all topics

# Reducing to lower value can give more accuracy while throttling publish but

# it uses more CPU to perform frequent check. (Disable publish throttling with value 0)

topicPublisherThrottlingTickTimeMillis=10

# Enable precise rate limit for topic publish

preciseTopicPublishRateLimiterEnable=false

# Tick time to schedule task that checks broker publish rate limiting across all topics

# Reducing to lower value can give more accuracy while throttling publish but

# it uses more CPU to perform frequent check. (Disable publish throttling with value 0)

brokerPublisherThrottlingTickTimeMillis=50

# Max Rate(in 1 seconds) of Message allowed to publish for a broker if broker publish rate limiting enabled

# (Disable message rate limit with value 0)

brokerPublisherThrottlingMaxMessageRate=0

# Max Rate(in 1 seconds) of Byte allowed to publish for a broker if broker publish rate limiting enabled.

# (Disable byte rate limit with value 0)

brokerPublisherThrottlingMaxByteRate=0

# Max Rate(in 1 seconds) of Message allowed to publish for a topic if topic publish rate limiting enabled

# (Disable byte rate limit with value 0)

maxPublishRatePerTopicInMessages=0

#Max Rate(in 1 seconds) of Byte allowed to publish for a topic if topic publish rate limiting enabled.

# (Disable byte rate limit with value 0)

maxPublishRatePerTopicInBytes=0

# Too many subscribe requests from a consumer can cause broker rewinding consumer cursors and loading data from bookies,

# hence causing high network bandwidth usage

# When the positive value is set, broker will throttle the subscribe requests for one consumer.

# Otherwise, the throttling will be disabled. The default value of this setting is 0 - throttling is disabled.

subscribeThrottlingRatePerConsumer=0

# Rate period for {subscribeThrottlingRatePerConsumer}. Default is 30s.

subscribeRatePeriodPerConsumerInSecond=30

# Default messages per second dispatch throttling-limit for whole broker. Using a value of 0, is disabling default

# message dispatch-throttling

dispatchThrottlingRateInMsg=0

# Default bytes per second dispatch throttling-limit for whole broker. Using a value of 0, is disabling

# default message-byte dispatch-throttling

dispatchThrottlingRateInByte=0

# Default messages per second dispatch throttling-limit for every topic. Using a value of 0, is disabling default

# message dispatch-throttling

dispatchThrottlingRatePerTopicInMsg=0

# Default bytes per second dispatch throttling-limit for every topic. Using a value of 0, is disabling

# default message-byte dispatch-throttling

dispatchThrottlingRatePerTopicInByte=0

# Apply dispatch rate limiting on batch message instead individual

# messages with in batch message. (Default is disabled)

dispatchThrottlingOnBatchMessageEnabled=false

# Default number of message dispatching throttling-limit for a subscription.

# Using a value of 0, is disabling default message dispatch-throttling.

dispatchThrottlingRatePerSubscriptionInMsg=0

# Default number of message-bytes dispatching throttling-limit for a subscription.

# Using a value of 0, is disabling default message-byte dispatch-throttling.

dispatchThrottlingRatePerSubscriptionInByte=0

# Default messages per second dispatch throttling-limit for every replicator in replication.

# Using a value of 0, is disabling replication message dispatch-throttling

dispatchThrottlingRatePerReplicatorInMsg=0

# Default bytes per second dispatch throttling-limit for every replicator in replication.

# Using a value of 0, is disabling replication message-byte dispatch-throttling

dispatchThrottlingRatePerReplicatorInByte=0

# Dispatch rate-limiting relative to publish rate.

# (Enabling flag will make broker to dynamically update dispatch-rate relatively to publish-rate:

# throttle-dispatch-rate = (publish-rate + configured dispatch-rate).

dispatchThrottlingRateRelativeToPublishRate=false

# By default we enable dispatch-throttling for both caught up consumers as well as consumers who have

# backlog.

dispatchThrottlingOnNonBacklogConsumerEnabled=true

# Max number of entries to read from bookkeeper. By default it is 100 entries.

dispatcherMaxReadBatchSize=100

# Max size in bytes of entries to read from bookkeeper. By default it is 5MB.

dispatcherMaxReadSizeBytes=5242880

# Min number of entries to read from bookkeeper. By default it is 1 entries.

# When there is an error occurred on reading entries from bookkeeper, the broker

# will backoff the batch size to this minimum number."

dispatcherMinReadBatchSize=1

# Max number of entries to dispatch for a shared subscription. By default it is 20 entries.

dispatcherMaxRoundRobinBatchSize=20

# The read failure backoff initial time in milliseconds. By default it is 15s.

dispatcherReadFailureBackoffInitialTimeInMs=15000

# The read failure backoff max time in milliseconds. By default it is 60s.

dispatcherReadFailureBackoffMaxTimeInMs=60000

# The read failure backoff mandatory stop time in milliseconds. By default it is 0s.

dispatcherReadFailureBackoffMandatoryStopTimeInMs=0

# Precise dispathcer flow control according to history message number of each entry

preciseDispatcherFlowControl=false

# Class name of Pluggable entry filter that can decide whether the entry needs to be filtered

# You can use this class to decide which entries can be sent to consumers.

# Multiple classes need to be separated by commas.

entryFilterNames=

# The directory for all the entry filter implementations

entryFiltersDirectory=

# Max number of concurrent lookup request broker allows to throttle heavy incoming lookup traffic

maxConcurrentLookupRequest=50000

# Max number of concurrent topic loading request broker allows to control number of zk-operations

maxConcurrentTopicLoadRequest=5000

# Max concurrent non-persistent message can be processed per connection

maxConcurrentNonPersistentMessagePerConnection=1000

# Number of worker threads to serve non-persistent topic

numWorkerThreadsForNonPersistentTopic=

# Enable broker to load persistent topics

enablePersistentTopics=true

# Enable broker to load non-persistent topics

enableNonPersistentTopics=true

# Enable to run bookie along with broker

enableRunBookieTogether=false

# Enable to run bookie autorecovery along with broker

enableRunBookieAutoRecoveryTogether=false

# Max number of producers allowed to connect to topic. Once this limit reaches, Broker will reject new producers

# until the number of connected producers decrease.

# Using a value of 0, is disabling maxProducersPerTopic-limit check.

maxProducersPerTopic=0

# Max number of producers with the same IP address allowed to connect to topic.

# Once this limit reaches, Broker will reject new producers until the number of

# connected producers with the same IP address decrease.

# Using a value of 0, is disabling maxSameAddressProducersPerTopic-limit check.

maxSameAddressProducersPerTopic=0

# Enforce producer to publish encrypted messages.(default disable).

encryptionRequireOnProducer=false

# Max number of consumers allowed to connect to topic. Once this limit reaches, Broker will reject new consumers

# until the number of connected consumers decrease.

# Using a value of 0, is disabling maxConsumersPerTopic-limit check.

maxConsumersPerTopic=0

# Max number of consumers with the same IP address allowed to connect to topic.

# Once this limit reaches, Broker will reject new consumers until the number of

# connected consumers with the same IP address decrease.

# Using a value of 0, is disabling maxSameAddressConsumersPerTopic-limit check.

maxSameAddressConsumersPerTopic=0

# Max number of subscriptions allowed to subscribe to topic. Once this limit reaches, broker will reject

# new subscription until the number of subscribed subscriptions decrease.

# Using a value of 0, is disabling maxSubscriptionsPerTopic limit check.

maxSubscriptionsPerTopic=0

# Max number of consumers allowed to connect to subscription. Once this limit reaches, Broker will reject new consumers

# until the number of connected consumers decrease.

# Using a value of 0, is disabling maxConsumersPerSubscription-limit check.

maxConsumersPerSubscription=0

# Max size of messages.

maxMessageSize=5242880

# Interval between checks to see if topics with compaction policies need to be compacted

brokerServiceCompactionMonitorIntervalInSeconds=60

# The estimated backlog size is greater than this threshold, compression will be triggered.

# Using a value of 0, is disabling compression check.

brokerServiceCompactionThresholdInBytes=0

# Timeout for the compaction phase one loop.

# If the execution time of the compaction phase one loop exceeds this time, the compaction will not proceed.

brokerServiceCompactionPhaseOneLoopTimeInSeconds=30

# Whether to enable the delayed delivery for messages.

# If disabled, messages will be immediately delivered and there will

# be no tracking overhead.

delayedDeliveryEnabled=true

# Control the tick time for when retrying on delayed delivery,

# affecting the accuracy of the delivery time compared to the scheduled time.

# Default is 1 second.

delayedDeliveryTickTimeMillis=1000

# Whether to enable acknowledge of batch local index.

acknowledgmentAtBatchIndexLevelEnabled=false

# Enable tracking of replicated subscriptions state across clusters.

enableReplicatedSubscriptions=true

# Frequency of snapshots for replicated subscriptions tracking.

replicatedSubscriptionsSnapshotFrequencyMillis=1000

# Timeout for building a consistent snapshot for tracking replicated subscriptions state.

replicatedSubscriptionsSnapshotTimeoutSeconds=30

# Max number of snapshot to be cached per subscription.

replicatedSubscriptionsSnapshotMaxCachedPerSubscription=10

# Max memory size for broker handling messages sending from producers.

# If the processing message size exceed this value, broker will stop read data

# from the connection. The processing messages means messages are sends to broker

# but broker have not send response to client, usually waiting to write to bookies.

# It's shared across all the topics running in the same broker.

# Use -1 to disable the memory limitation. Default is 1/2 of direct memory.

maxMessagePublishBufferSizeInMB=

# Check between intervals to see if consumed ledgers need to be trimmed

# Use 0 or negative number to disable the check

retentionCheckIntervalInSeconds=120

# Control the frequency of checking the max message size in the topic policy.

# The default interval is 60 seconds.

maxMessageSizeCheckIntervalInSeconds=60

# Max number of partitions per partitioned topic

# Use 0 or negative number to disable the check

maxNumPartitionsPerPartitionedTopic=0

# There are two policies to apply when broker metadata session expires: session expired happens, "shutdown" or "reconnect".

# With "shutdown", the broker will be restarted.

# With "reconnect", the broker will keep serving the topics, while attempting to recreate a new session.

zookeeperSessionExpiredPolicy=reconnect

# Enable or disable system topic

systemTopicEnabled=false

# The schema compatibility strategy is used for system topics.

# Available values: ALWAYS_INCOMPATIBLE, ALWAYS_COMPATIBLE, BACKWARD, FORWARD, FULL, BACKWARD_TRANSITIVE, FORWARD_TRANSITIVE, FULL_TRANSITIVE

systemTopicSchemaCompatibilityStrategy=ALWAYS_COMPATIBLE

# Enable or disable topic level policies, topic level policies depends on the system topic

# Please enable the system topic first.

topicLevelPoliciesEnabled=false

# If a topic remains fenced for this number of seconds, it will be closed forcefully.

# If it is set to 0 or a negative number, the fenced topic will not be closed.

topicFencingTimeoutSeconds=0

### --- Authentication --- ###

# Role names that are treated as "proxy roles". If the broker sees a request with

#role as proxyRoles - it will demand to see a valid original principal.

proxyRoles=

# If this flag is set then the broker authenticates the original Auth data

# else it just accepts the originalPrincipal and authorizes it (if required).

authenticateOriginalAuthData=false

# Tls cert refresh duration in seconds (set 0 to check on every new connection)

tlsCertRefreshCheckDurationSec=300

# Path for the TLS certificate file

tlsCertificateFilePath=

# Path for the TLS private key file

tlsKeyFilePath=

# Path for the trusted TLS certificate file.

# This cert is used to verify that any certs presented by connecting clients

# are signed by a certificate authority. If this verification

# fails, then the certs are untrusted and the connections are dropped.

tlsTrustCertsFilePath=

# Accept untrusted TLS certificate from client.

# If true, a client with a cert which cannot be verified with the

# 'tlsTrustCertsFilePath' cert will allowed to connect to the server,

# though the cert will not be used for client authentication.

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]

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]

tlsCiphers=

# Trusted client certificates are required for to connect TLS

# Reject the Connection if the Client Certificate is not trusted.

# In effect, this requires that all connecting clients perform TLS client

# authentication.

tlsRequireTrustedClientCertOnConnect=false

# Specify the TLS provider for the broker service:

# When using TLS authentication with CACert, the valid value is either OPENSSL or JDK.

# When using TLS authentication with KeyStore, available values can be SunJSSE, Conscrypt and etc.

tlsProvider=

### --- KeyStore TLS config variables --- ###

## Note that some of the above TLS configs also apply to the KeyStore TLS configuration.

# Enable TLS with KeyStore type configuration in broker.

tlsEnabledWithKeyStore=false

# TLS KeyStore type configuration in broker: JKS, PKCS12

tlsKeyStoreType=JKS

# TLS KeyStore path in broker

tlsKeyStore=

# TLS KeyStore password for broker

tlsKeyStorePassword=

# TLS TrustStore type configuration in broker: JKS, PKCS12

tlsTrustStoreType=JKS

# TLS TrustStore path in broker

tlsTrustStore=

# TLS TrustStore password in broker, default value is empty password

tlsTrustStorePassword=

# Whether internal client use KeyStore type to authenticate with Pulsar brokers

brokerClientTlsEnabledWithKeyStore=false

# The TLS Provider used by internal client to authenticate with other Pulsar brokers

brokerClientSslProvider=

# TLS TrustStore type configuration for internal client: JKS, PKCS12

# used by the internal client to authenticate with Pulsar brokers

brokerClientTlsTrustStoreType=JKS

# TLS TrustStore path for internal client

# used by the internal client to authenticate with Pulsar brokers

brokerClientTlsTrustStore=

# TLS TrustStore password for internal client,

# used by the internal client to authenticate with Pulsar brokers

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

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

brokerClientTlsProtocols=

### --- Metadata Store --- ###

# Whether we should enable metadata operations batching

metadataStoreBatchingEnabled=true

# Maximum delay to impose on batching grouping

metadataStoreBatchingMaxDelayMillis=5

# Maximum number of operations to include in a singular batch

metadataStoreBatchingMaxOperations=1000

# Maximum size of a batch

metadataStoreBatchingMaxSizeKb=128

### --- Authentication --- ###

# Enable authentication

authenticationEnabled=false

# Authentication provider name list, which is comma separated list of class names

authenticationProviders=

# Interval of time for checking for expired authentication credentials

authenticationRefreshCheckSeconds=60

# Enforce authorization

authorizationEnabled=false

# Authorization provider fully qualified class-name

authorizationProvider=org.apache.pulsar.broker.authorization.PulsarAuthorizationProvider

# Allow wildcard matching in authorization

# (wildcard matching only applicable if wildcard-char:

# * presents at first or last position eg: *.pulsar.service, pulsar.service.*)

authorizationAllowWildcardsMatching=false

# Role names that are treated as "super-user", meaning they will be able to do all admin

# operations and publish/consume from all topics

superUserRoles=

# Authentication settings of the broker itself. Used when the broker connects to other brokers,

# either in same or other clusters

brokerClientTlsEnabled=false

brokerClientAuthenticationPlugin=

brokerClientAuthenticationParameters=

brokerClientTrustCertsFilePath=

# Supported Athenz provider domain names(comma separated) for authentication

athenzDomainNames=

# When this parameter is not empty, unauthenticated users perform as anonymousUserRole

anonymousUserRole=

### --- Token Authentication Provider --- ###

## Symmetric key

# Configure the secret key to be used to validate auth tokens

# The key can be specified like:

# tokenSecretKey=data:;base64,xxxxxxxxx

# tokenSecretKey=file:///my/secret.key ( Note: key file must be DER-encoded )

tokenSecretKey=

## Asymmetric public/private key pair

# Configure the public key to be used to validate auth tokens

# The key can be specified like:

# tokenPublicKey=data:;base64,xxxxxxxxx

# tokenPublicKey=file:///my/public.key ( Note: key file must be DER-encoded )

tokenPublicKey=

# The token "claim" that will be interpreted as the authentication "role" or "principal" by AuthenticationProviderToken (defaults to "sub" if blank)

tokenAuthClaim=

# The token audience "claim" name, e.g. "aud", that will be used to get the audience from token.

# If not set, audience will not be verified.

tokenAudienceClaim=

# The token audience stands for this broker. The field `tokenAudienceClaim` of a valid token, need contains this.

tokenAudience=

### --- SASL Authentication Provider --- ###

# This is a regexp, which limits the range of possible ids which can connect to the Broker using SASL.

# Default value: `SaslConstants.JAAS_CLIENT_ALLOWED_IDS_DEFAULT`, which is ".*pulsar.*",

# so only clients whose id contains 'pulsar' are allowed to connect.

saslJaasClientAllowedIds=

# Service Principal, for login context name.

# Default value `SaslConstants.JAAS_DEFAULT_BROKER_SECTION_NAME`, which is "Broker".

saslJaasServerSectionName=

### --- HTTP Server config --- ###

# If >0, it will reject all HTTP requests with bodies larged than the configured limit

httpMaxRequestSize=-1

# If true, the broker will reject all HTTP requests using the TRACE and TRACK verbs.

# This setting may be necessary if the broker is deployed into an environment that uses http port

# scanning and flags web servers allowing the TRACE method as insecure.

disableHttpDebugMethods=false

# Enable the enforcement of limits on the incoming HTTP requests

httpRequestsLimitEnabled=false

# Max HTTP requests per seconds allowed. The excess of requests will be rejected with HTTP code 429 (Too many requests)

httpRequestsMaxPerSecond=100.0

# Capacity for thread pool queue in the HTTP server

httpServerThreadPoolQueueSize=8192

# Capacity for accept queue in the HTTP server

httpServerAcceptQueueSize=8192

# Maximum number of inbound http connections. (0 to disable limiting)

maxHttpServerConnections=2048

# Max concurrent web requests

maxConcurrentHttpRequests=1024

### --- BookKeeper Client --- ###

# Metadata service uri that bookkeeper is used for loading corresponding metadata driver

# and resolving its metadata service location.

# This value can be fetched using `bookkeeper shell whatisinstanceid` command in BookKeeper cluster.

# For example: zk+hierarchical://localhost:2181/ledgers

# The metadata service uri list can also be semicolon separated values like below:

# zk+hierarchical://zk1:2181;zk2:2181;zk3:2181/ledgers

bookkeeperMetadataServiceUri=

# Authentication plugin to use when connecting to bookies

bookkeeperClientAuthenticationPlugin=

# BookKeeper auth plugin implementatation specifics parameters name and values

bookkeeperClientAuthenticationParametersName=

bookkeeperClientAuthenticationParameters=

# Timeout for BK add / read operations

bookkeeperClientTimeoutInSeconds=30

# Number of BookKeeper client worker threads

# Default is Runtime.getRuntime().availableProcessors()

bookkeeperClientNumWorkerThreads=

# Speculative reads are initiated if a read request doesn't complete within a certain time

# Using a value of 0, is disabling the speculative reads

bookkeeperClientSpeculativeReadTimeoutInMillis=0

# Number of channels per bookie

bookkeeperNumberOfChannelsPerBookie=16

# Use older Bookkeeper wire protocol with bookie

bookkeeperUseV2WireProtocol=true

# Enable bookies health check. Bookies that have more than the configured number of failure within

# the interval will be quarantined for some time. During this period, new ledgers won't be created

# on these bookies

bookkeeperClientHealthCheckEnabled=true

bookkeeperClientHealthCheckIntervalSeconds=60

bookkeeperClientHealthCheckErrorThresholdPerInterval=5

bookkeeperClientHealthCheckQuarantineTimeInSeconds=1800

#bookie quarantine ratio to avoid all clients quarantine the high pressure bookie servers at the same time

bookkeeperClientQuarantineRatio=1.0

# Specify options for the GetBookieInfo check. These settings can be useful

# to help ensure the list of bookies is up to date on the brokers.

bookkeeperClientGetBookieInfoIntervalSeconds=86400

bookkeeperClientGetBookieInfoRetryIntervalSeconds=60

# Enable rack-aware bookie selection policy. BK will chose bookies from different racks when

# forming a new bookie ensemble

# This parameter related to ensemblePlacementPolicy in conf/bookkeeper.conf, if enabled, ensemblePlacementPolicy

# should be set to org.apache.bookkeeper.client.RackawareEnsemblePlacementPolicy

bookkeeperClientRackawarePolicyEnabled=true

# Enable region-aware bookie selection policy. BK will chose bookies from

# different regions and racks when forming a new bookie ensemble

# If enabled, the value of bookkeeperClientRackawarePolicyEnabled is ignored

# This parameter related to ensemblePlacementPolicy in conf/bookkeeper.conf, if enabled, ensemblePlacementPolicy

# should be set to org.apache.bookkeeper.client.RegionAwareEnsemblePlacementPolicy

bookkeeperClientRegionawarePolicyEnabled=false

# Minimum number of racks per write quorum. BK rack-aware bookie selection policy will try to

# get bookies from at least 'bookkeeperClientMinNumRacksPerWriteQuorum' racks for a write quorum.

bookkeeperClientMinNumRacksPerWriteQuorum=2

# Enforces rack-aware bookie selection policy to pick bookies from 'bookkeeperClientMinNumRacksPerWriteQuorum'

# racks for a writeQuorum.

# If BK can't find bookie then it would throw BKNotEnoughBookiesException instead of picking random one.

bookkeeperClientEnforceMinNumRacksPerWriteQuorum=false

# Enable/disable reordering read sequence on reading entries.

bookkeeperClientReorderReadSequenceEnabled=false

# Enable bookie isolation by specifying a list of bookie groups to choose from. Any bookie

# outside the specified groups will not be used by the broker

bookkeeperClientIsolationGroups=

# Enable bookie secondary-isolation group if bookkeeperClientIsolationGroups doesn't

# have enough bookie available.

bookkeeperClientSecondaryIsolationGroups=

# Minimum bookies that should be available as part of bookkeeperClientIsolationGroups

# else broker will include bookkeeperClientSecondaryIsolationGroups bookies in isolated list.

bookkeeperClientMinAvailableBookiesInIsolationGroups=

# Enable/disable having read operations for a ledger to be sticky to a single bookie.

# If this flag is enabled, the client will use one single bookie (by preference) to read

# all entries for a ledger.

bookkeeperEnableStickyReads=true

# Set the client security provider factory class name.

# Default: org.apache.bookkeeper.tls.TLSContextFactory

bookkeeperTLSProviderFactoryClass=org.apache.bookkeeper.tls.TLSContextFactory

# Enable tls authentication with bookie

bookkeeperTLSClientAuthentication=false

# Supported type: PEM, JKS, PKCS12. Default value: PEM

bookkeeperTLSKeyFileType=PEM

#Supported type: PEM, JKS, PKCS12. Default value: PEM

bookkeeperTLSTrustCertTypes=PEM

# Path to file containing keystore password, if the client keystore is password protected.

bookkeeperTLSKeyStorePasswordPath=

# Path to file containing truststore password, if the client truststore is password protected.

bookkeeperTLSTrustStorePasswordPath=

# Path for the TLS private key file

bookkeeperTLSKeyFilePath=

# Path for the TLS certificate file

bookkeeperTLSCertificateFilePath=

# Path for the trusted TLS certificate file

bookkeeperTLSTrustCertsFilePath=

# Tls cert refresh duration at bookKeeper-client in seconds (0 to disable check)

bookkeeperTlsCertFilesRefreshDurationSeconds=300

# Enable/disable disk weight based placement. Default is false

bookkeeperDiskWeightBasedPlacementEnabled=false

# Set the interval to check the need for sending an explicit LAC

# A value of '0' disables sending any explicit LACs. Default is 0.

bookkeeperExplicitLacIntervalInMills=0

# Expose bookkeeper client managed ledger stats to prometheus. default is false

# bookkeeperClientExposeStatsToPrometheus=false

### --- Managed Ledger --- ###

# Number of bookies to use when creating a ledger

managedLedgerDefaultEnsembleSize=2

# Number of copies to store for each message

managedLedgerDefaultWriteQuorum=2

# Number of guaranteed copies (acks to wait before write is complete)

managedLedgerDefaultAckQuorum=2

# with OpportunisticStriping=true the ensembleSize is adapted automatically to writeQuorum

# in case of lack of enough bookies

#bookkeeper_opportunisticStriping=false

# you can add other configuration options for the BookKeeper client

# by prefixing them with bookkeeper_

# How frequently to flush the cursor positions that were accumulated due to rate limiting. (seconds).

# Default is 60 seconds

managedLedgerCursorPositionFlushSeconds=60

# How frequently to refresh the stats. (seconds). Default is 60 seconds

managedLedgerStatsPeriodSeconds=60

# Default type of checksum to use when writing to BookKeeper. Default is "CRC32C"

# Other possible options are "CRC32", "MAC" or "DUMMY" (no checksum).

managedLedgerDigestType=CRC32C

# Number of threads to be used for managed ledger scheduled tasks

managedLedgerNumSchedulerThreads=

# Amount of memory to use for caching data payload in managed ledger. This memory

# is allocated from JVM direct memory and it's shared across all the topics

# running in the same broker. By default, uses 1/5th of available direct memory

managedLedgerCacheSizeMB=

# Whether we should make a copy of the entry payloads when inserting in cache

managedLedgerCacheCopyEntries=false

# Threshold to which bring down the cache level when eviction is triggered

managedLedgerCacheEvictionWatermark=0.9

# Configure the cache eviction frequency for the managed ledger cache (evictions/sec)

managedLedgerCacheEvictionFrequency=100.0

# All entries that have stayed in cache for more than the configured time, will be evicted

managedLedgerCacheEvictionTimeThresholdMillis=1000

# Configure the threshold (in number of entries) from where a cursor should be considered 'backlogged'

# and thus should be set as inactive.

managedLedgerCursorBackloggedThreshold=1000

# Rate limit the amount of writes per second generated by consumer acking the messages

managedLedgerDefaultMarkDeleteRateLimit=1.0

# Max number of entries to append to a ledger before triggering a rollover

# A ledger rollover is triggered after the min rollover time has passed

# and one of the following conditions is true:

# * The max rollover time has been reached

# * The max entries have been written to the ledger

# * The max ledger size has been written to the ledger

managedLedgerMaxEntriesPerLedger=50000

# Minimum time between ledger rollover for a topic

managedLedgerMinLedgerRolloverTimeMinutes=10

# Maximum time before forcing a ledger rollover for a topic

managedLedgerMaxLedgerRolloverTimeMinutes=240

# Time to rollover ledger for inactive topic (duration without any publish on that topic)