Specify restrictions on the target of init
#2670
Conversation
|
This change is |
v2.0/initialize-a-cluster.md
Outdated
| @@ -4,7 +4,7 @@ summary: Perform a one-time-only initialization of a CockroachDB cluster. | |||
| toc: false | |||
| --- | |||
|
|
|||
| <span class="version-tag">New in v1.1:</span> This page explains the `cockroach init` [command](cockroach-commands.html), which you use to perform a one-time initialization of a new multi-node cluster. For a full walk-through of the cluster startup and initialization process, see one of the [Manual Deployment](manual-deployment.html) tutorials. | |||
| <span class="version-tag">New in v1.1:</span> This page explains the `cockroach init` [command](cockroach-commands.html), which you use to perform a one-time initialization of a new multi-node cluster. The target of the `cockroach init` command must appear in the `--join` flag of the [`cockroach start`](start-a-cluster.html) command which have been run on the other nodes in the cluster. For a full walk-through of the cluster startup and initialization process, see one of the [Manual Deployment](manual-deployment.html) tutorials. | |||
There was a problem hiding this comment.
See comment for the v1.1 version of the page.
There was a problem hiding this comment.
Which comment are you referring to on the v1.1 version of the page? I'm not seeing any Github comments on that page.
Also I've gone ahead and fixed TC if that is what it was referring to.
v1.1/initialize-a-cluster.md
Outdated
| @@ -4,7 +4,7 @@ summary: Perform a one-time-only initialization of a CockroachDB cluster. | |||
| toc: false | |||
| --- | |||
|
|
|||
| <span class="version-tag">New in v1.1:</span> This page explains the `cockroach init` [command](cockroach-commands.html), which you use to perform a one-time initialization of a new multi-node cluster. For a full walk-through of the cluster startup and initialization process, see one of the [Manual Deployment](manual-deployment.html) tutorials. | |||
| <span class="version-tag">New in v1.1:</span> This page explains the `cockroach init` [command](cockroach-commands.html), which you use to perform a one-time initialization of a new multi-node cluster. The target of the `cockroach init` command must appear in the `--join` flag of the [`cockroach start`](start-a-node.html) command which have been run on the other nodes in the cluster. For a full walk-through of the cluster startup and initialization process, see one of the [Manual Deployment](manual-deployment.html) tutorials. | |||
There was a problem hiding this comment.
Ugh, I seem to have not submitted this comment before. Sorry.
Instead of mentioning this here, I'd suggest updating the --host flag description as follows:
The server host to connect to. This must appear in the
--joinflag of other nodes.
@bdarnell, does the target host address need to appear in the join flag of all or any of the other nodes?
There was a problem hiding this comment.
It's --advertise-host, not --host that must appear in --join and be used from client commands.
We recommend using the same --join arguments on all nodes, and while they may diverge over time they should at least be the same at init time.
Putting this message in the first paragraph of the command seems strange to me; I would put it in the docs for the --host flag. I don't think we need to make this warning too prominent since at the time that you're initializing the cluster you shouldn't have too many nodes or a complex configuration.
There was a problem hiding this comment.
I'm missing something, @bdarnell. --advertise-host isn't even an option on client commands like init... Or are you just saying that, when starting a cluster, if you use --advertise-host on nodes, that's what needs to be used in --join as well?
There was a problem hiding this comment.
Sorry, I got mixed up. I thought you were suggesting that the server-side --host flag should say that this is what should appear in the --join flag.
In retrospect, instead of --advertise-host and --host, we should have had --host and --bind-host. It's the advertised host that matters everywhere but on the node itself.
|
Moved the message from the top of the page to the description |
1 similar comment
…lag of the other nodes in the cluster
Explained that the target of the
cockroach initcommand must be one ofthe nodes which appear in the
--joinflag of thecockroach startcommand.
Fixes #2589