[fix](doc): incorrect tls config in java client doc #16315

ericsyh · 2022-07-01T03:33:41Z

(If this PR fixes a github issue, please add Fixes #<xyz>.)

Fixes #

(or if this PR is one task of a github issue, please add Master Issue: #<xyz> to link to the master issue.)

Master Issue: #

Motivation

On the java client loadconf page there is a config useTls on the list but I think this config should be the enableTls and I also check on ClientBuilder there is no method as useTls

Modifications

Replace the incorrect tls config useTls by enableTls on the java client doc.

Verifying this change

Make sure that the change passes the CI checks.

(Please pick either of the following options)

This change is a trivial rework / code cleanup without any test coverage.

(or)

This change is already covered by existing tests, such as (please describe tests).

(or)

This change added tests and can be verified as follows:

(example:)

Added integration tests for end-to-end deployment with large payloads (10MB)
Extended integration test for recovery after broker failure

Does this pull request potentially affect one of the following parts:

If yes was chosen, please highlight the changes

Dependencies (does it add or upgrade a dependency): (no)
The public API: (no)
The schema: (no)
The default values of configurations: (no)
The wire protocol: (no)
The rest endpoints: (no)
The admin cli options: (no)
Anything that affects deployment: (no)

Documentation

Check the box below or label this PR directly.

Need to update docs?

doc-required
(Your PR needs to update docs and you will update later)
doc-not-needed
(Please explain why)
doc
(Your PR contains doc changes)
doc-complete
(Docs have been already added)

Signed-off-by: ericsyh <ericshenyuhao@outlook.com>

dave2wave · 2022-07-07T17:21:31Z

I think that this looks correct, but there are conflicts to resolve

Signed-off-by: ericsyh <ericshenyuhao@outlook.com>

ericsyh · 2022-07-16T09:37:29Z

I think that this looks correct, but there are conflicts to resolve

@michaeljmarshall @dave2wave Conflicts resolved. PTAL again.

ericsyh · 2022-07-19T09:01:23Z

cc @Anonymitaet Could help take a look at this Doc PR or assign a technical review?

Anonymitaet

@gaoran10
could you please review this PR from the technical perspective? Thank you!

Anonymitaet · 2022-07-19T13:05:33Z

site2/docs/client-libraries-java.md

 `numListenerThreads`|int|The number of threads used for handling message listeners. The listener thread pool is shared across all the consumers and readers using the "listener" model to get messages. For a given consumer, the listener is always invoked from the same thread to ensure ordering. If you want multiple threads to process a single topic, you need to create a [`shared`](/concepts-messaging.md#shared) subscription and multiple consumers for this subscription. This does not ensure ordering.| 1 
 `useTcpNoDelay`| boolean| Whether to use TCP no-delay flag on the connection to disable Nagle algorithm |true
-`useTls` |boolean |Whether to use TLS encryption on the connection| false
+`enableTls` |boolean | Whether to use TLS encryption on the connection. **Deprecated**. use "pulsar+ssl://" in serviceUrl to enable | false


what does Deprecated mean? enableTls is deprecated or something else？

There is no need to config enableTls in pulsar client to enable Tls, just use pulsar+ssl:// in the connection address

Anonymitaet · 2022-07-19T13:06:20Z

site2/website/versioned_docs/version-2.1.0-incubating/client-libraries-java.md

 ### TLS Authentication

-To use [TLS](security-tls-authentication), you need to set TLS to `true` using the `setUseTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.
+To use [TLS](security-tls-authentication.md), you need to set TLS to `true` using the `enableTls` method, point your Pulsar client to a TLS cert path, and provide paths to cert and key files.


@momo-jun FYI: here is a missing occurrence (the .md issue)

Thanks for the reminder. I just covered three versions 2.10.0, 2.10.1, and master, but didn't have a chance to fix them in doc versions earlier than 2.10. There are hundreds of them in each version, so I need to implement it by phase to avoid getting dizzy and crazy. Maybe I can file an good-first-issue :)

site2/docs/client-libraries-java.md

Signed-off-by: ericsyh <ericshenyuhao@outlook.com>

site2/docs/client-libraries-java.md

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

…ls-config

…a-client-tls-config

Signed-off-by: ericsyh <ericshenyuhao@outlook.com>

tisonkun

Thanks for your contribution! LGTM.

@ericsyh may you tidy the PR description?

@Anonymitaet it seems this PR needs one more approval from committers to merge, could you help with reviewing?

Anonymitaet · 2022-08-01T01:33:08Z

@tisonkun thanks!

@ericsyh I've merged your PR with modifying the commit message to [fix][doc] fix incorrect tls config in java client doc

…apache#17057

* Sync recent changes from #17030, #17039, #16315, and #17057 * fix #17119 * minor updates * add link of release notes to navigation * fix * update release process as per PIP-190 * minor fix * minor fix * Update release-process.md

ericsyh added 2 commits July 1, 2022 11:22

fix(docs): tls config in Java client doc

d728573

Signed-off-by: ericsyh <ericshenyuhao@outlook.com>

apply for previous versions

6e71e1b

Signed-off-by: ericsyh <ericshenyuhao@outlook.com>

github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Jul 1, 2022

dave2wave requested a review from michaeljmarshall July 7, 2022 17:20

ericsyh added 2 commits July 8, 2022 09:24

resolve conflicts

35ffdf7

Signed-off-by: ericsyh <ericshenyuhao@outlook.com>

apply the change to all versions

8a2609d

Signed-off-by: ericsyh <ericshenyuhao@outlook.com>

Anonymitaet reviewed Jul 19, 2022

View reviewed changes

nodece reviewed Jul 19, 2022

View reviewed changes

site2/docs/client-libraries-java.md Outdated Show resolved Hide resolved

nicoloboschi and others added 3 commits July 21, 2022 14:54

[fix][doc] Fix sidebars.json syntax

213b4c0

apply the review comments

5d5d102

Signed-off-by: ericsyh <ericshenyuhao@outlook.com>

update sample code to remove enableTls config

f7d21fb

Signed-off-by: ericsyh <ericshenyuhao@outlook.com>

Anonymitaet reviewed Jul 25, 2022

View reviewed changes

site2/docs/client-libraries-java.md Outdated Show resolved Hide resolved

nodece approved these changes Jul 25, 2022

View reviewed changes

ericsyh and others added 5 commits July 26, 2022 16:12

Update site2/docs/client-libraries-java.md

ec1de7c

Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>

Merge remote-tracking branch 'pulsar/fix-doc-json' into java-client-t…

ea266f0

…ls-config

Merge remote-tracking branch 'origin/master' into java-client-tls-config

a7dfbd6

Merge remote-tracking branch 'origin/java-client-tls-config' into jav…

a527abe

…a-client-tls-config

apply comments to previous version

9e233c5

Signed-off-by: ericsyh <ericshenyuhao@outlook.com>

tisonkun approved these changes Jul 31, 2022

View reviewed changes

Anonymitaet merged commit e1050e1 into apache:master Aug 1, 2022

Gleiphir2769 pushed a commit to Gleiphir2769/pulsar that referenced this pull request Aug 4, 2022

[fix][doc] fix incorrect tls config in java client doc (apache#16315)

904b2c6

momo-jun added a commit to momo-jun/pulsar that referenced this pull request Aug 17, 2022

Sync recent changes from apache#17030, apache#17039, apache#16315, and …

224ccfb

…apache#17057

momo-jun mentioned this pull request Aug 17, 2022

[fix][doc] Sync recent changes on versioned docs #17130

Merged

1 task

ericsyh deleted the java-client-tls-config branch June 14, 2023 02:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[fix](doc): incorrect tls config in java client doc #16315

[fix](doc): incorrect tls config in java client doc #16315

Uh oh!

ericsyh commented Jul 1, 2022

Uh oh!

dave2wave commented Jul 7, 2022

Uh oh!

ericsyh commented Jul 16, 2022

Uh oh!

ericsyh commented Jul 19, 2022

Uh oh!

Anonymitaet left a comment

Uh oh!

Anonymitaet Jul 19, 2022

Uh oh!

ericsyh Jul 21, 2022

Uh oh!

Anonymitaet Jul 19, 2022

Uh oh!

momo-jun Jul 19, 2022 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

tisonkun left a comment

Uh oh!

Anonymitaet commented Aug 1, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

[fix](doc): incorrect tls config in java client doc #16315

[fix](doc): incorrect tls config in java client doc #16315

Uh oh!

Conversation

ericsyh commented Jul 1, 2022

Motivation

Modifications

Verifying this change

Does this pull request potentially affect one of the following parts:

Documentation

Uh oh!

dave2wave commented Jul 7, 2022

Uh oh!

ericsyh commented Jul 16, 2022

Uh oh!

ericsyh commented Jul 19, 2022

Uh oh!

Anonymitaet left a comment

Choose a reason for hiding this comment

Uh oh!

Anonymitaet Jul 19, 2022

Choose a reason for hiding this comment

Uh oh!

ericsyh Jul 21, 2022

Choose a reason for hiding this comment

Uh oh!

Anonymitaet Jul 19, 2022

Choose a reason for hiding this comment

Uh oh!

momo-jun Jul 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

tisonkun left a comment

Choose a reason for hiding this comment

Uh oh!

Anonymitaet commented Aug 1, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

momo-jun Jul 19, 2022 •

edited

Loading