Readme updates #5511
Readme updates #5511
Conversation
|
|
||
| ```shell | ||
| $ ./cockroach start --insecure & | ||
| $ ./cockroach start --insecure --store=node2-data --port=26258 --http-port=8081 --join=localhost:26257 & |
There was a problem hiding this comment.
The first node is in cockroach-data. We should either pass --store=node1-data to the first node or use cockroach-data2 and cockroach-data3 for the others.
The binary should be on your path after installation, not in the current directory, so these commands should start with cockroach instead of ./cockroach.
Should the quickstart be three nodes or just one, with the multi-node setup left for the full docs? I'm not sure.
There was a problem hiding this comment.
Good point about the store directories. I'll fix that.
As for using cockroach instead of ./cockroach, it's added to your path only if you do go get (build from source), right? All the other more likely methods (download binary, homebrew) won't automatically add it to the path. So it seems safest to not assume anything about the path and just use ./cockroach, no?
For one vs. three nodes, it feels to me valuable to demonstrate just how easy it is to add nodes on different ports, but I can change if you and others feel strongly about this.
There was a problem hiding this comment.
brew adds it to your path; the other methods we currently document generally don't automatically(make install from source might do it, depending on your setup). However, I think we should encourage people doing a manual install to put the binary on their path instead of running with a data directory underneath where they untarred the binary.
In the future when we offer "real" packages for apt-get or similar, they'll put the binary on the path.
|
LGTM |
|
|
||
| Now let's talk to this node. The easiest way to do that is to use the `cockroach` binary - it comes with a built-in sql client: | ||
| 5. Learn how to [secure a cluster](https://www.cockroachlabs.com/docs/secure-a-cluster.html). |
There was a problem hiding this comment.
How about make this less daunting: "CockroachDB makes it easy to [secure a cluster]"
|
LGTM |
Cleaned up the cockroach readme.md and added links to docs where relevant. I didn't end up doing much with the Design Overview section; I feel like I need more time for that, and would like to revisit once other beta docs are done.
@spencerkimball, @bdarnell, @petermattis
This change is