[fix][doc]: add the primary auth config on cluster failover example #620
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: ericsyh <[email protected]>
Signed-off-by: ericsyh <[email protected]>
|
@hangc0276 |
|
Ping @hangc0276 to review, thanks! |
|
Ping @hangc0276 to review, thanks! |
hangc0276
reviewed
Jul 7, 2023
| String secondaryTlsTrustCertsFilePath = "secondary/path"; | ||
| Authentication primaryAuthentication = AuthenticationFactory.create( |
There was a problem hiding this comment.
The primaryAuthentication is in pulsarClient initiation and we need to add a configuration for pulsar client creation. Otherwise, users will be confused by primaryAuthentication and primaryTlsTrustCertsFilePath initiated without use.
PulsarClient pulsarClient = PulsarClient.builder()
.authentication(primaryAuthentication)
.tlsTrustCertsFilePath(primaryTlsTrustCertsFilePath)
.serviceUrl("pulsar://localhost:6650")
.build();
Signed-off-by: ericsyh <[email protected]>
hangc0276
reviewed
Jul 14, 2023
| @@ -76,6 +83,8 @@ Parameter|Default value|Required?|Description | |||
| `failoverDelay`|N/A|Yes|The delay before the Pulsar client switches from the primary cluster to the backup cluster.<br /><br />Automatic failover is controlled by a probe task: <br />1) The probe task first checks the health status of the primary cluster. <br /> 2) If the probe task finds the continuous failure time of the primary cluster exceeds `failoverDelayMs`, it switches the Pulsar client to the backup cluster. | |||
| `switchBackDelay`|N/A|Yes|The delay before the Pulsar client switches from the backup cluster to the primary cluster.<br /><br />Automatic failover switchover is controlled by a probe task: <br /> 1) After the Pulsar client switches from the primary cluster to the backup cluster, the probe task continues to check the status of the primary cluster. <br /> 2) If the primary cluster functions well and continuously remains active longer than `switchBackDelay`, the Pulsar client switches back to the primary cluster. | |||
| `checkInterval`|30s|No|Frequency of performing a probe task (in seconds). | |||
| `primaryTlsTrustCertsFilePath` |N/A|No|Path to the trusted TLS certificate file of the primary cluster. | |||
There was a problem hiding this comment.
This is not the AutoClusterFailover's configuration, they are PulsarClient's configuration. I think we do not need to add here
There was a problem hiding this comment.
@hangc0276 fix in bf4a0be
Signed-off-by: ericsyh <[email protected]>
hangc0276
approved these changes
Jul 24, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
It's quite weird that on the https://pulsar.apache.org/docs/3.0.x/client-libraries-cluster-level-failover/#automatic-failover code example only includes the secondary cluster auth config without the primary cluster auth.
And as my check on test code https://github.com/apache/pulsar/blob/2b01f83ea4f3ab7b22f4ea2b0290cc183e79bbb8/pulsar-client/src/test/java/org/apache/pulsar/client/impl/AutoClusterFailoverTest.java#L73 it has the
primaryAuthenticationconfig creation.This PR adds doc for #xyz
This PR fixes #xyz
docdoc-requireddoc-not-neededdoc-complete