diff --git a/start-a-local-cluster-in-docker.md b/start-a-local-cluster-in-docker.md index 9435ab66ef1..6163e8f4a58 100644 --- a/start-a-local-cluster-in-docker.md +++ b/start-a-local-cluster-in-docker.md @@ -22,6 +22,8 @@ toc: false Once you've [installed the official CockroachDB Docker image](install-cockroachdb.html), it's simple to run a multi-node cluster across multiple Docker containers on a single host, using Docker volumes to persist node data. +{{site.data.alerts.callout_info}}Running multiple nodes on a single host is useful for testing out CockroachDB, but it's not recommended for production deployments. To run a physically distributed cluster in production, see Manual Deployment or Cloud Deployment.{{site.data.alerts.end}} +
## Before You Begin @@ -62,6 +64,8 @@ This command creates a container and starts the first CockroachDB node inside it - `-v ${PWD}/cockroach-data/roach1:/cockroach/cockroach-data`: This flag mounts a host directory as a data volume. This means that data and logs for this node will be stored in `${PWD}/cockroach-data/roach1` on the host and will persist after the container is stopped or deleted. For more details about volumes, see Docker's Manage data in containers topic. - `cockroachdb/cockroach:{{site.data.strings.version}} start --insecure`: The CockroachDB command to [start a node](start-a-node.html) in the container in insecure mode. + {{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 container/node per host. When running multiple containers/nodes on a single host, however, it may lead to out of memory errors, especially when testing against the cluster in a serious way. To avoid such errors, you can manually limit each node's cache size by setting the--cache
flag in the start
command.{{site.data.alerts.end}}
+
## Step 3. Start additional containers/nodes
~~~ shell
diff --git a/start-a-local-cluster.md b/start-a-local-cluster.md
index 8ec52e87467..5c00378925d 100644
--- a/start-a-local-cluster.md
+++ b/start-a-local-cluster.md
@@ -20,7 +20,9 @@ toc: false
-Once you've [installed the CockroachDB binary](install-cockroachdb.html), it's simple to start a multi-node cluster locally with each node listening on a different port.
+Once you've [installed the CockroachDB binary](install-cockroachdb.html), it's simple to start a multi-node cluster locally with each node listening on a different port.
+
+{{site.data.alerts.callout_info}}Running multiple nodes on a single host is useful for testing out CockroachDB, but it's not recommended for production deployments. To run a physically distributed cluster in production, see Manual Deployment or Cloud Deployment.{{site.data.alerts.end}}
@@ -54,7 +56,9 @@ This command starts a node, accepting all [`cockroach start`](start-a-node.html)
- The `--background` flag runs the node in the background so you can continue the next steps in the same shell.
-- The standard output gives you a helpful summary of the CockroachDB version, the URL for the admin UI, the SQL URL for your client code, and the storage locations for node and debug log data.
+- The [standard output](start-a-node.html#standard-output) gives you a helpful summary of the CockroachDB version, the URL for the admin UI, the SQL URL for your client code, and the storage locations for node and debug log data.
+
+{{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 running multiple nodes on a single host, however, it may lead to out of memory errors, especially when testing against the cluster in a serious way. To avoid such errors, you can manually limit each node's cache size by setting the --cache
flag in the start
command.{{site.data.alerts.end}}
## Step 2. Join additional nodes to the cluster