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

Clarify docs on --locality-advertise-addr #5941

Open
jseldess opened this issue Nov 26, 2019 · 3 comments
Open

Clarify docs on --locality-advertise-addr #5941

jseldess opened this issue Nov 26, 2019 · 3 comments
Assignees
Labels
C-doc-improvement O-external Origin: Issue comes from external users. P-2 Normal priority; secondary task T-incorrect-or-unclear-info

Comments

@jseldess
Copy link
Contributor

jseldess commented Nov 26, 2019

Jesse Seldess commented:

This flag is used in a cross-cloud or hybrid scenario where you want nodes in the same region/env to use their internal addresses to communication and nodes on other places to use a public address.

Clarify that the flag is a list of rules with first-match-wins, so you only want to specify the locality level that determines access to the private IP (typically region=us-east1). See cockroachdb/cockroach#42741 for more details.

Jira Issue: DOC-377

@jseldess jseldess added A-ops C-doc-improvement O-external Origin: Issue comes from external users. P-2 Normal priority; secondary task T-incorrect-or-unclear-info labels Nov 26, 2019
@jseldess jseldess added this to the 20.1 milestone Nov 26, 2019
@jseldess
Copy link
Contributor Author

https://www.cockroachlabs.com/docs/v19.2/start-a-node.html#networking.

@taroface, no need to act on this right away. Probably need to let the linked issue resolve first. This will be more important once we write guidance/tutorials on multi-cloud deployment.

@daniel-crlabs
Copy link

This came up again today, created a new docs issue since the one from 4 years ago has not been touched: https://cockroachlabs.atlassian.net/browse/DOC-9161

@shralex
Copy link

shralex commented Mar 6, 2024

@mdlinville can we prioritize this or the linked docs changes request ? I think a clarification in the docs is needed because the behavior of this flag isn't intuitive, unless one looks at the code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-doc-improvement O-external Origin: Issue comes from external users. P-2 Normal priority; secondary task T-incorrect-or-unclear-info
Projects
None yet
Development

No branches or pull requests

5 participants