SpringCloud/spring-cloud-stream
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GH-2884: Docs on Pulsar Binder Config Props

Browse Source 
Adding a brief docs section for the Pulsar binder config properties.

Resolves https://github.com/spring-cloud/spring-cloud-stream/issues/2884
This commit is contained in:
Soby Chacko
2024-03-01 17:19:00 -05:00
parent 432ce8fdd2
commit 5f1611a4aa
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/modules/ROOT/pages/pulsar/pulsar_binder.adoc
View File

@@ -249,6 +249,23 @@ This way, you can have a separate set of Pulsar properties applied for different
The highest precedence is for extended binding properties.
The precedence order of applying the properties in the binder is `extended binding properties -> binder properties -> Spring Boot properties.` (going from highest to lowest).
[[pulsar-properties-links]]
=== Resources for Pulsar Binder Properties
Following are some resources to rely upon for finding more about the properties available through the Pulsar binder.
https://github.com/spring-cloud/spring-cloud-stream/blob/main/binders/pulsar-binder/spring-cloud-stream-binder-pulsar/src/main/java/org/springframework/cloud/stream/binder/pulsar/properties/ProducerConfigProperties.java[Pulsar producer binding configuration].
These properties need the `spring.cloud.stream.bindings.<binding-name>.producer` prefix.
All the Spring Boot provided https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#appendix.application-properties.integration[Pulsar producer properties] are also available through this configuration class.
https://github.com/spring-cloud/spring-cloud-stream/blob/main/binders/pulsar-binder/spring-cloud-stream-binder-pulsar/src/main/java/org/springframework/cloud/stream/binder/pulsar/properties/ConsumerConfigProperties.java[Pulsar consumer binding configuration].
These properties need the `spring.cloud.stream.bindings.<binding-name>.consumer` prefix.
All the Spring Boot provided https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#appendix.application-properties.integration[Pulsar consumer properties] are also available through this configuration class.
For common Pulsar binder specific configuration properties, see https://github.com/spring-cloud/spring-cloud-stream/blob/main/binders/pulsar-binder/spring-cloud-stream-binder-pulsar/src/main/java/org/springframework/cloud/stream/binder/pulsar/properties/PulsarBinderConfigurationProperties.java[this]. These properties require a prefix of `spring.cloud.stream.pulsar.binder`.
The above specified producer and consumer properties (including the Spring Boot ones) can be used at the binder using the `spring.cloud.stream.pulsar.binder.producer` or `spring.cloud.stream.pulsar.binder.consumer` prefix.
[[pulsar-topic-provisioner]]
== Pulsar Topic Provisioner