docs: Clarify use of public_cluster_addr
for load balancing
#5974
+37
−5
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.
Description
From a Slack conversation: https://hashicorp.slack.com/archives/C012RTGJR1V/p1753204358604259
A customer misunderstood the way the
public_cluster_addr
parameter worked with regard to load balancing. They thought the setting required the address of the controller node and not the cluster. Jeff Mitchell confirmed that the documentation was correct, but that we could better explain how load balancing worked.This PR updates that parameter description to convey that workers must know the addresses of the controllers to perform load balancing and not just the address of the listener itself. It also provides an example of how someone might use this setting with a load balancer.
View the update in the preview deployment
PCI review checklist
Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.