root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Add SSL section to Pulsar docs 

- Add link to Spring Pulsar TLS docs
- Update usage of 'Spring Pulsar' to 'Spring for Apache Pulsar'

See gh-37375
This commit is contained in:
Chris Bono 2023-09-13 15:03:13 -05:00 committed by Moritz Halbritter
parent f94693a251
commit b81d78f324
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/documentation/messaging.adoc
View File

@ -5,6 +5,6 @@ If your application uses any messaging protocol, see one or more of the followin
* *JMS:* <<messaging#messaging.jms, Auto-configuration for ActiveMQ and Artemis, Sending and Receiving messages through JMS>>
* *AMQP:* <<messaging#messaging.amqp, Auto-configuration for RabbitMQ>>
* *Kafka:* <<messaging#messaging.kafka, Auto-configuration for Spring Kafka>>
* *Pulsar:* <<messaging#messaging.pulsar, Auto-configuration for Spring Pulsar>>
* *Pulsar:* <<messaging#messaging.pulsar, Auto-configuration for Spring for Apache Pulsar>>
* *RSocket:* <<messaging#messaging.rsocket, Auto-configuration for Spring Framework's RSocket Support>>
* *Spring Integration:* <<messaging#messaging.spring-integration, Auto-configuration for Spring Integration>>

13
spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/pulsar.adoc
View File

@ -2,7 +2,7 @@
== Apache Pulsar Support
https://pulsar.apache.org/[Apache Pulsar] is supported by providing auto-configuration of the {spring-pulsar-docs}[Spring for Apache Pulsar] project.
Spring Boot will auto-configure and register the classic (imperative) Spring Pulsar components when `org.springframework.pulsar:spring-pulsar` is on the classpath.
Spring Boot will auto-configure and register the classic (imperative) Spring for Apache Pulsar components when `org.springframework.pulsar:spring-pulsar` is on the classpath.
It will do the same for the reactive components when `org.springframework.pulsar:spring-pulsar-reactive` is on the classpath.
There are `spring-boot-starter-pulsar` and `spring-boot-starter-pulsar-reactive` "`Starters`" for conveniently collecting the dependencies for imperative and reactive use, respectively.
@ -26,7 +26,7 @@ If you need more control over the configuration, consider registering one or mor
[[messaging.pulsar.connecting.auth]]
==== Authentication
To connect to a Pulsar cluster that requires authentication, you need to specify which authentication plugin to use by setting the `authPluginClassName` and any parameters required by the plugin.
To connect to a Pulsar cluster that requires authentication, you need to specify which authentication plugin to use by setting the `pluginClassName` and any parameters required by the plugin.
You can set the parameters as a map of parameter names to parameter values.
The following example shows how to configure the `AuthenticationOAuth2` plugin.
@ -52,7 +52,12 @@ For example, if you want to configure the issuer url for the `AuthenticationOAut
If you use other forms, such as `issuerurl` or `issuer-url`, the setting will not be applied to the plugin.
====
For complete details on the client and authentication see the Spring Pulsar {spring-pulsar-docs}#pulsar-client[reference documentation].
[[messaging.pulsar.connecting.ssl]]
==== SSL
By default, Pulsar clients communicate with Pulsar services in plain text.
You can follow {spring-pulsar-docs}#tls-encryption[these steps] in the Spring for Apache Pulsar reference documentation to enable TLS encryption.
For complete details on the client and authentication see the Spring for Apache Pulsar {spring-pulsar-docs}#pulsar-client[reference documentation].
@ -67,7 +72,7 @@ Therefore, follow the previous section to configure the `PulsarClient` used by t
[[messaging.pulsar.admin]]
=== Connecting to Pulsar Administration
Spring Pulsar's `PulsarAdministration` client is also auto-configured.
Spring for Apache Pulsar's `PulsarAdministration` client is also auto-configured.
By default, the application tries to connect to a local Pulsar instance at `\http://localhost:8080`.
This can be adjusted by setting the configprop:spring.pulsar.admin.service-url[] property to a different value in the form `(http|https)://<host>:<port>`.