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

Improve documentation for Serf WAN port #4073

Closed
sonnysideup opened this issue May 1, 2018 · 3 comments
Closed

Improve documentation for Serf WAN port #4073

sonnysideup opened this issue May 1, 2018 · 3 comments
Labels
type/docs Documentation needs to be created/updated/clarified

Comments

@sonnysideup
Copy link

After reading #3058 and the docs outlining the ports used by Consul, I now suspect that I should set both Serf LAN and WAN ports to 8302 but the docs did not provide me with obvious confirmation.

The documentation currently reads:

Serf WAN (Default 8302). This is used by servers to gossip over the WAN to other servers. TCP and UDP. As of Consul 0.8, it is recommended to enable connection between servers through port 8302 for both TCP and UDP on the LAN interface as well for the WAN Join Flooding feature. See also: Consul 0.8.0 CHANGELOG and GH-3058

Would it not be better to articulate this port like so:

Serf WAN (Default 8302). This is used by servers to gossip over the WAN to other servers. TCP and UDP. As of Consul 0.8, it is recommended that you configure the LAN and WAN interfaces to both use port 8302; the WAN Join Flooding feature leverages LAN membership. See also: Consul 0.8.0 CHANGELOG and GH-3058

This is a minor point but I decided I needed to create this issue after another developer and I agreed that the current wording is mildly confusing.

@pearkes
Copy link
Contributor

pearkes commented May 2, 2018

Agree, we'd definitely appreciate a PR clarifying this!

@pearkes pearkes added the type/docs Documentation needs to be created/updated/clarified label May 2, 2018
@sonnysideup
Copy link
Author

@pearkes Please let me know if you want to me to tweak the language here and/or make other changes.

@hanshasselberg
Copy link
Member

Docs have been updated!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Development

No branches or pull requests

3 participants