Skip to content

Commit 8cabc90

Browse files
committed
Merge pull request #37375 from onobc
* pr/37375: Add SSL section to Pulsar docs Closes gh-37375
2 parents f94693a + b81d78f commit 8cabc90

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ If your application uses any messaging protocol, see one or more of the followin
55
* *JMS:* <<messaging#messaging.jms, Auto-configuration for ActiveMQ and Artemis, Sending and Receiving messages through JMS>>
66
* *AMQP:* <<messaging#messaging.amqp, Auto-configuration for RabbitMQ>>
77
* *Kafka:* <<messaging#messaging.kafka, Auto-configuration for Spring Kafka>>
8-
* *Pulsar:* <<messaging#messaging.pulsar, Auto-configuration for Spring Pulsar>>
8+
* *Pulsar:* <<messaging#messaging.pulsar, Auto-configuration for Spring for Apache Pulsar>>
99
* *RSocket:* <<messaging#messaging.rsocket, Auto-configuration for Spring Framework's RSocket Support>>
1010
* *Spring Integration:* <<messaging#messaging.spring-integration, Auto-configuration for Spring Integration>>

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

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
== Apache Pulsar Support
33
https://pulsar.apache.org/[Apache Pulsar] is supported by providing auto-configuration of the {spring-pulsar-docs}[Spring for Apache Pulsar] project.
44

5-
Spring Boot will auto-configure and register the classic (imperative) Spring Pulsar components when `org.springframework.pulsar:spring-pulsar` is on the classpath.
5+
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.
66
It will do the same for the reactive components when `org.springframework.pulsar:spring-pulsar-reactive` is on the classpath.
77

88
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
2626

2727
[[messaging.pulsar.connecting.auth]]
2828
==== Authentication
29-
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.
29+
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.
3030
You can set the parameters as a map of parameter names to parameter values.
3131
The following example shows how to configure the `AuthenticationOAuth2` plugin.
3232

@@ -52,7 +52,12 @@ For example, if you want to configure the issuer url for the `AuthenticationOAut
5252
If you use other forms, such as `issuerurl` or `issuer-url`, the setting will not be applied to the plugin.
5353
====
5454

55-
For complete details on the client and authentication see the Spring Pulsar {spring-pulsar-docs}#pulsar-client[reference documentation].
55+
[[messaging.pulsar.connecting.ssl]]
56+
==== SSL
57+
By default, Pulsar clients communicate with Pulsar services in plain text.
58+
You can follow {spring-pulsar-docs}#tls-encryption[these steps] in the Spring for Apache Pulsar reference documentation to enable TLS encryption.
59+
60+
For complete details on the client and authentication see the Spring for Apache Pulsar {spring-pulsar-docs}#pulsar-client[reference documentation].
5661

5762

5863

@@ -67,7 +72,7 @@ Therefore, follow the previous section to configure the `PulsarClient` used by t
6772

6873
[[messaging.pulsar.admin]]
6974
=== Connecting to Pulsar Administration
70-
Spring Pulsar's `PulsarAdministration` client is also auto-configured.
75+
Spring for Apache Pulsar's `PulsarAdministration` client is also auto-configured.
7176

7277
By default, the application tries to connect to a local Pulsar instance at `\http://localhost:8080`.
7378
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>`.

0 commit comments

Comments
 (0)