Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update WAN publisher description #926

Merged
merged 2 commits into from
Jan 10, 2024
Merged

Update WAN publisher description #926

merged 2 commits into from
Jan 10, 2024

Conversation

ethurma
Copy link

@ethurma ethurma commented Dec 11, 2023

No description provided.

@ethurma ethurma added the documentation Improvements or additions to documentation label Dec 11, 2023
@ethurma ethurma added this to the 5.4 milestone Dec 11, 2023
@devOpsHazelcast
Copy link
Collaborator

devOpsHazelcast commented Dec 11, 2023

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ Serdaro
❌ ethurma
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

netlify bot commented Dec 11, 2023

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
🔨 Latest commit 443f55c
🔍 Latest deploy log https://app.netlify.com/sites/hardcore-allen-f5257d/deploys/658a8ac75c31bf0008e1643c
😎 Deploy Preview https://deploy-preview-926--hardcore-allen-f5257d.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Most often, this is a single, entire target Hazelcast cluster but you can also define custom publishers which
may transmit WAN events to other systems such as messaging queues, Kafka or even persist events on disk.
* WAN publisher: A publisher acts as a sink for local WAN events and pushes them to a target. The target is usually
another Hazelcast cluster, but can be customized to be another system, such as a messaging queue, Kafka or even persisted
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The target is usually another Hazelcast cluster; however, you could also use a different target such as a message queue, Kafka, or saving data to persistent storage.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Questions not related to the update, but as I looked and saw it....

  1. Can we link to any docs on WanReplicationPublisher? If not, what does it add to tell me that this is an implementation of it?
  2. Can we link to any information on using different targets? Possibly the Configuring WAN Replication page, and/or Advanced Features?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @rebekah-lawrence, your tweaks read better.

@JamesHazelcast or @vbekiaris may have some suggestions about informative links.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"different targets" like JMS etc are examples of custom WanPublisher implementations a user can implement, it's not something we support out of the box. To be honest, I have never seen a user/customer implement their own WanPublisher.
The WanReplicationPublisher name is probably outdated - the interface is called WanPublisher and it's what users should implement to provide their custom WAN publisher implementation. Probably the audience here would be a java developer, so I think it would be most appropriate to link to WanPublisher javadoc

and so on.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest recasting the previous two sentences (the second is really only a phrase and the last three words that were deleted and re-added don't make sense in it); something like:

For example, you could use the WAN Publisher ID as follows:
+

  • In combination with the WAN replication scheme name to pause, stop, or resume WAN replication for a specific publisher
  • To trigger synchronization with a specific target cluster

@Serdaro Serdaro added the forwardport to snapshot Forwardport commits from v/* to main label Jan 10, 2024
@Serdaro Serdaro merged commit 716ac6a into v/5.3 Jan 10, 2024
4 of 6 checks passed
@Serdaro Serdaro deleted the ethurma-wan-doc-update branch January 10, 2024 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation forwardport to snapshot Forwardport commits from v/* to main
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants