Feedback: cockroach start

[fqazi]

Faizan Qazi (fqazi) commented:

Page: https://cockroachlabs.com/docs/v23.2/cockroach-start.html

What is the reason for your feedback?

For clarity we should specify for the --join option which port should be specified. We had a user accidentally use the --sql-addr for the join, so better documentation will help here (its not clear from the documentation which port should be used without reading everything).

[x] Missing the information I need

[ ] Too complicated

[ ] Out of date

[ ] Something is broken

[ ] Other

Additional details

Example thread on our community channel: https://cockroachdb.slack.com/archives/CP4D9LD5F/p1715788175290519

Jira Issue: DOC-10304

[exalate-issue-sync]

Shannon Bradshaw (shannonbradshaw) commented:
Richard Loveland do you mind taking this one? I know it’s not your area.

[exalate-issue-sync]

Richard Loveland (rmloveland) commented:
Shannon Bradshaw no problem!

[exalate-issue-sync]

Douglas Weatherbee (dweatherbee) commented:
Hi Richard Loveland this will impact training content. Training needs to be aligned with the Docs changes.

I see in the slack thread Faizan includes that we need to change:

• --listen-addr= from xxxx:26257 to xxxx:26357
• -join= needs to use the updated --listen-addr ports

Is that correct?

[exalate-issue-sync]

Faizan Qazi (fqazi) commented:
I think we need to highlight if {{--advertise-addr}} is customized then the {{--join}} has to either use that address or they should port forward the default port: https://www.cockroachlabs.com/docs/v24.1/recommended-production-settings#networking . I think stronger language around {{--advertise-addr}} and {{--join}} would help (i..e “nodes will not be able to unless port forward is setup or the advertised port is specified in the join option”).

[exalate-issue-sync]

Richard Loveland (rmloveland) commented:
Thanks for clarifying Faizan Qazi !

Douglas Weatherbee thanks for pointing that out! Once I have the docs PR up and through technical review I'm happy to share the updated content with you or whomever you designate on the training team, please let me know!