Skip to content

Conversation

jseldess
Copy link
Contributor

@jseldess jseldess commented Apr 6, 2017

These changes attempt to keep the Start a Cluster tutorial
quick and easy while introducing new users to what makes
CockroachDB unique, not just ease of deployment, but also
automated replication and survival.

I've also stripped out some details that I think are not
important to the majority of users getting up and running
for the first time, e.g., how to customize start flags
and the fact that you can use third-party monitoring.

Finally, I've update the Stop the Cluster step to account
for the fact that cockroach quit can't be used to stop
nodes once quorum is lost.


This change is Reviewable

@jseldess
Copy link
Contributor Author

jseldess commented Apr 6, 2017

@bdarnell, @spencerkimball, would appreciate your feedback, too.

@dianasaur323
Copy link
Contributor

:lgtm:


Review status: 0 of 6 files reviewed at latest revision, all discussions resolved.


Comments from Reviewable

@jseldess jseldess changed the title Surface core value props in start a cluster [WIP] Surface core value props in start a cluster Apr 6, 2017
@jseldess
Copy link
Contributor Author

jseldess commented Apr 6, 2017

@asubiotto, can you please check the Stop the cluster step?

@jseldess jseldess force-pushed the get-started-improvements branch from 302c837 to 129a842 Compare April 6, 2017 16:03
@sploiselle
Copy link
Contributor

:lgtm: Really, really wonderful.


Reviewed 6 of 6 files at r1.
Review status: 5 of 6 files reviewed at latest revision, 2 unresolved discussions.


start-a-local-cluster.md, line 48 at r1 (raw file):

- The [standard output](start-a-node.html#standard-output) gives you helpful details such as the CockroachDB version, the URL for the admin UI, and the SQL URL for clients.

{{site.data.alerts.callout_success}}By default, each node's cache is limited to 25% of available memory. This default is reasonable when running one node per host. When you run multiple nodes on a single host, however, this default may lead to out of memory errors, especially if you test in a serious way. To avoid such errors, you can limit each node's cache size by setting the <code>--cache</code> flag in the <code>start</code> command.{{site.data.alerts.end}}

nit: maybe "out of memory" or out-of-memory


Comments from Reviewable

@bdarnell
Copy link
Contributor

bdarnell commented Apr 6, 2017

:lgtm:


Review status: 5 of 6 files reviewed at latest revision, 4 unresolved discussions.


start-a-local-cluster.md, line 76 at r2 (raw file):

## Step 3. Test the cluster

Now that you've scaled to 3 nodes, you can use any node as a SQL gateway to the cluster. To demonstrate this, start the [built-in SQL cleint](use-the-built-in-sql-client.html) on node 1 and run some basic [CockroachDB SQL statements](learn-cockroachdb-sql.html):

Typo: cleint


start-a-local-cluster.md, line 81 at r2 (raw file):

~~~ shell
$ cockroach sql --port=26257

Should we mention that the --port flag is normally optional (and we're just using it here to demonstrate a point?)


start-a-local-cluster.md, line 192 at r2 (raw file):

~~~

With only 1 node online, a majority of replicas are no longer available, and so the cluster is not operational. As a result, you can't use `cockroach quit` to stop the last node, but instead must get the node's process ID and then force kill it:

As an alternative to this slightly complicated process, we could recommend that they run all three nodes without --background in three different terminals. Then you can kill the first two nodes with ctrl-c, and the third node by typing ctrl-c twice.


Comments from Reviewable

Copy link

@kuanluo kuanluo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So so great. Thank you, @jseldess !

@jseldess
Copy link
Contributor Author

jseldess commented Apr 6, 2017

Review status: 5 of 6 files reviewed at latest revision, 4 unresolved discussions.


start-a-local-cluster.md, line 48 at r1 (raw file):

Previously, sploiselle (Sean Loiselle) wrote…

nit: maybe "out of memory" or out-of-memory

Done.


start-a-local-cluster.md, line 76 at r2 (raw file):

Previously, bdarnell (Ben Darnell) wrote…

Typo: cleint

Done.


start-a-local-cluster.md, line 81 at r2 (raw file):

Previously, bdarnell (Ben Darnell) wrote…

Should we mention that the --port flag is normally optional (and we're just using it here to demonstrate a point?)

Done.


start-a-local-cluster.md, line 192 at r2 (raw file):

Previously, bdarnell (Ben Darnell) wrote…

As an alternative to this slightly complicated process, we could recommend that they run all three nodes without --background in three different terminals. Then you can kill the first two nodes with ctrl-c, and the third node by typing ctrl-c twice.

Running each node in a separate terminal does make this particular step a lot easier, I agree, but I think it complicates the process overall. All other steps feel a lot quicker in the same terminal. Also, I don't know whether I can get an asciicast to work across terminal windows...


Comments from Reviewable

@jseldess jseldess force-pushed the get-started-improvements branch from 129a842 to baccec1 Compare April 7, 2017 13:57
@kuanluo
Copy link

kuanluo commented Apr 7, 2017

Love the called-out admin ui replication graph. 👍

@jseldess jseldess force-pushed the get-started-improvements branch from baccec1 to bdff823 Compare April 7, 2017 14:35
@jseldess jseldess force-pushed the get-started-improvements branch from bdff823 to 41ae4b6 Compare April 7, 2017 16:23
@jseldess jseldess changed the title [WIP] Surface core value props in start a cluster Surface core value props in start a cluster Apr 7, 2017
Jesse Seldess added 2 commits April 7, 2017 12:44
These changes attempt to keep the Start a Cluster tutorial
quick and easy while introducing new users to what makes
CockroachDB unique, not just ease of deployment, but also
automated replication and survival.

I've also stripped out some details that I think are not
important to the majority of users getting up and running
for the first time, e.g., how to customize `start` flags
and the fact that you can use third-party monitoring.

Finally, I've update the Stop the Cluster step to account
for the fact that `cockroach quit` can't be used to stop
nodes once quorum is lost.

Fixes #1191
Fixes #1252
@jseldess jseldess force-pushed the get-started-improvements branch from 41ae4b6 to 933e26f Compare April 7, 2017 16:44
@jseldess jseldess force-pushed the get-started-improvements branch from fe2be66 to 1c84a40 Compare April 7, 2017 17:08
@cockroach-teamcity
Copy link
Member

@jseldess jseldess merged commit 4239882 into gh-pages Apr 7, 2017
@jseldess jseldess deleted the get-started-improvements branch April 7, 2017 17:28
Simran-B pushed a commit to Simran-B/docs that referenced this pull request Aug 21, 2025
* Create 'release/arangodb-3.9.8_23012715583603' for 3.9.8 release of ArangoDB

* Update examples for 3.9 in release/arangodb-3.9.8_23012715583603 at 2023-01-27T16:25:33+00:00

---------

Co-authored-by: arangodb-release-bot <>
Co-authored-by: arangodb-release-bot <vadim@arangodb.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants