Feedback: cockroach debug zip - clarify --host option to tell which port to specify

[hand-crdb]

Steven Hand (hand-crdb) commented:

Page: https://cockroachlabs.com/docs/v23.1/cockroach-debug-zip.html

What is the reason for your feedback?

[X] Missing the information I need

[ ] Too complicated

[ ] Out of date

[ ] Something is broken

[ ] Other

Additional details

Please clarify what port should be specified in the --host option. The doc says:

--host The server host and port number to connect to. This can be the address of any node in the cluster.

However, a node in the cluster can use multiple ports, and this doc does not clarify which one to use.

For example, it is not the SQL port, which would be specified with the --sql-addr option to cockroach start. It has to be something else. Please consult with the dev team on what should be specified for --host, especially as it relates to

• the cockroach start options
• any other relevant considerations, like customer network or Kubernetes configuration.

THANK YOU

Jira Issue: DOC-8716