Skip to content

Commit

Permalink
Call out CC from more local and production deployment docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jseldess committed Sep 9, 2020
1 parent 7bc729d commit fd8e50e
Show file tree
Hide file tree
Showing 38 changed files with 81 additions and 47 deletions.
4 changes: 3 additions & 1 deletion v20.1/deploy-cockroachdb-on-aws-insecure.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ ssh-link: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html

This page shows you how to manually deploy an insecure multi-node CockroachDB cluster on Amazon's AWS EC2 platform, using AWS's managed load balancing service to distribute client traffic.

{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select <strong>Secure</strong> above for instructions.{{site.data.alerts.end}}
If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select **Secure** above for instructions.

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

Expand Down
2 changes: 2 additions & 0 deletions v20.1/deploy-cockroachdb-on-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust

If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

### Requirements
Expand Down
4 changes: 3 additions & 1 deletion v20.1/deploy-cockroachdb-on-digital-ocean-insecure.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ ssh-link: https://www.digitalocean.com/community/tutorials/how-to-connect-to-you

This page shows you how to deploy an insecure multi-node CockroachDB cluster on Digital Ocean, using Digital Ocean's managed load balancing service to distribute client traffic.

{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select <strong>Secure</strong> above for instructions.{{site.data.alerts.end}}
If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select **Secure** above for instructions.

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

Expand Down
2 changes: 2 additions & 0 deletions v20.1/deploy-cockroachdb-on-digital-ocean.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ This page shows you how to deploy a secure multi-node CockroachDB cluster on Dig

If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

### Requirements
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ ssh-link: https://cloud.google.com/compute/docs/instances/connecting-to-instance

This page shows you how to manually deploy an insecure multi-node CockroachDB cluster on Google Cloud Platform's Compute Engine (GCE), using Google's TCP Proxy Load Balancing service to distribute client traffic.

{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select <strong>Secure</strong> above for instructions.{{site.data.alerts.end}}
If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select **Secure** above for instructions.

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

Expand Down
2 changes: 2 additions & 0 deletions v20.1/deploy-cockroachdb-on-google-cloud-platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust

If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

### Requirements
Expand Down
4 changes: 3 additions & 1 deletion v20.1/deploy-cockroachdb-on-microsoft-azure-insecure.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ ssh-link: https://docs.microsoft.com/en-us/azure/virtual-machines/linux/mac-crea

This page shows you how to manually deploy an insecure multi-node CockroachDB cluster on Microsoft Azure, using Azure's managed load balancing service to distribute client traffic.

{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select <strong>Secure</strong> above for instructions.{{site.data.alerts.end}}
If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select **Secure** above for instructions.

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

Expand Down
4 changes: 3 additions & 1 deletion v20.1/deploy-cockroachdb-on-microsoft-azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust

If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

### Requirements
Expand Down Expand Up @@ -73,7 +75,7 @@ To enable this in Azure, you must create a Resource Group, Virtual Network, and
- Run at least 3 nodes to [ensure survivability](recommended-production-settings.html#topology).

- Use compute-optimized [F-series](https://docs.microsoft.com/en-us/azure/virtual-machines/fsv2-series) VMs with [Premium Storage](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage) or local SSD storage with a Linux filesystem such as `ext4` (not the Windows `ntfs` filesystem). For example, Cockroach Labs has used `Standard_F16s_v2` VMs (16 vCPUs and 32 GiB of RAM per VM) for internal testing.

- If you choose local SSD storage, on reboot, the VM can come back with the `ntfs` filesystem. Be sure your automation monitors for this and reformats the disk to the Linux filesystem you chose initially.

- **Do not** use ["burstable" B-series](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/b-series-burstable) VMs, which limit the load on a single core. Also, Cockroach Labs has experienced data corruption issues on A-series VMs and irregular disk performance on D-series VMs, so we recommend avoiding those as well.
Expand Down
4 changes: 3 additions & 1 deletion v20.1/deploy-cockroachdb-on-premises-insecure.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ redirect_from: manual-deployment-insecure.html

This tutorial shows you how to manually deploy an insecure multi-node CockroachDB cluster on multiple machines, using [HAProxy](http://www.haproxy.org/) load balancers to distribute client traffic.

{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select <strong>Secure</strong> above for instructions.{{site.data.alerts.end}}
If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select **Secure** above for instructions.

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

Expand Down
2 changes: 2 additions & 0 deletions v20.1/deploy-cockroachdb-on-premises.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ This tutorial shows you how to manually deploy a secure multi-node CockroachDB c

If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

### Requirements
Expand Down
2 changes: 1 addition & 1 deletion v20.1/manual-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Use the following guides to deploy CockroachDB manually on-premises or on popula
- [Google Cloud Platform (GCE)](deploy-cockroachdb-on-google-cloud-platform.html)
- [Microsoft Azure](deploy-cockroachdb-on-microsoft-azure.html)

{{site.data.alerts.callout_success}}If you're just getting started with CockroachDB, you might want <a href="start-a-local-cluster.html">use a local cluster</a> to learn the basics of the database.{{site.data.alerts.end}}
{% include cockroachcloud/use-cockroachcloud-instead.md %}

## See also

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ On top of CockroachDB's built-in automation, you can use a third-party [orchestr
This page walks you through a simple demonstration, using the open-source [Kubernetes](http://kubernetes.io/) orchestration system. Using either the CockroachDB [Helm](https://helm.sh/) chart or a few configuration files, you'll quickly create a 3-node local cluster. You'll run some SQL commands against the cluster and then simulate node failure, watching how Kubernetes auto-restarts without the need for any manual intervention. You'll then scale the cluster with a single command before shutting the cluster down, again with a single command.

{{site.data.alerts.callout_info}}
To orchestrate a physically distributed cluster in production, see [Orchestrated Deployments](orchestration.html).
To orchestrate a physically distributed cluster in production, see [Orchestrated Deployments](orchestration.html). To deploy a 30-day free CockroachCloud cluster instead of running CockroachDB yourself, see the [Quickstart](../cockroachcloud/quickstart.html).
{{site.data.alerts.end}}

{% include {{ page.version.version }}/orchestration/local-start-kubernetes.md %}
Expand Down
2 changes: 1 addition & 1 deletion v20.1/orchestrate-a-local-cluster-with-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ On top of CockroachDB's built-in automation, you can use a third-party [orchestr
This page walks you through a simple demonstration, using the open-source [Kubernetes](http://kubernetes.io/) orchestration system. Using either the CockroachDB [Helm](https://helm.sh/) chart or a few configuration files, you'll quickly create a 3-node local cluster. You'll run some SQL commands against the cluster and then simulate node failure, watching how Kubernetes auto-restarts without the need for any manual intervention. You'll then scale the cluster with a single command before shutting the cluster down, again with a single command.

{{site.data.alerts.callout_info}}
To orchestrate a physically distributed cluster in production, see [Orchestrated Deployments](orchestration.html).
To orchestrate a physically distributed cluster in production, see [Orchestrated Deployments](orchestration.html). To deploy a 30-day free CockroachCloud cluster instead of running CockroachDB yourself, see the [Quickstart](../cockroachcloud/quickstart.html).
{{site.data.alerts.end}}

{% include {{ page.version.version }}/orchestration/local-start-kubernetes.md %}
Expand Down
8 changes: 3 additions & 5 deletions v20.1/orchestrate-cockroachdb-with-kubernetes-insecure.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,11 @@ toc_not_nested: true
<button class="filter-button current"><strong>Insecure</strong></button>
</div>

This page shows you how to orchestrate the deployment, management, and monitoring of an insecure 3-node CockroachDB cluster in a single [Kubernetes](http://kubernetes.io/) cluster, using the [StatefulSet](http://kubernetes.io/docs/concepts/abstractions/controllers/statefulsets/) feature directly or via the [Helm](https://helm.sh/) Kubernetes package manager.
This page shows you how to orchestrate the deployment, management, and monitoring of an insecure 3-node CockroachDB cluster in a single [Kubernetes](http://kubernetes.io/) cluster, using the [StatefulSet](http://kubernetes.io/docs/concepts/abstractions/controllers/statefulsets/) feature directly or via the [Helm](https://helm.sh/) Kubernetes package manager. If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select **Secure** above for instructions.

To deploy across multiple Kubernetes clusters in different geographic regions instead, see [Kubernetes Multi-Cluster Deployment](orchestrate-cockroachdb-with-kubernetes-multi-cluster.html). Also, for details about potential performance bottlenecks to be aware of when running CockroachDB in Kubernetes and guidance on how to optimize your deployment for better performance, see [CockroachDB Performance on Kubernetes](kubernetes-performance.html).
To deploy across multiple Kubernetes clusters in different geographic regions, see [Kubernetes Multi-Cluster Deployment](orchestrate-cockroachdb-with-kubernetes-multi-cluster.html) instead. Also, for details about potential performance bottlenecks to be aware of when running CockroachDB in Kubernetes and guidance on how to optimize your deployment for better performance, see [CockroachDB Performance on Kubernetes](kubernetes-performance.html).

{{site.data.alerts.callout_danger}}
If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select **Secure** above for instructions.
{{site.data.alerts.end}}
{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

Expand Down
2 changes: 2 additions & 0 deletions v20.1/orchestrate-cockroachdb-with-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ This page shows you how to orchestrate the deployment, management, and monitorin

To deploy across multiple Kubernetes clusters in different geographic regions instead, see [Kubernetes Multi-Cluster Deployment](orchestrate-cockroachdb-with-kubernetes-multi-cluster.html). Also, for details about potential performance bottlenecks to be aware of when running CockroachDB in Kubernetes and guidance on how to optimize your deployment for better performance, see [CockroachDB Performance on Kubernetes](kubernetes-performance.html).

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

Before getting started, it's helpful to review some Kubernetes-specific terminology and current limitations.
Expand Down
2 changes: 1 addition & 1 deletion v20.1/orchestration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Use the following guides to run CockroachDB with popular open-source orchestrati
- [Docker Swarm Deployment](orchestrate-cockroachdb-with-docker-swarm.html)
- [Mesosphere DC/OS Deployment](orchestrate-cockroachdb-with-mesosphere-insecure.html)

{{site.data.alerts.callout_success}}If you're just getting started with CockroachDB, you might want to <a href="orchestrate-a-local-cluster-with-kubernetes.html">orchestrate a local cluster</a> to learn the basics of the database.{{site.data.alerts.end}}
{% include cockroachcloud/use-cockroachcloud-instead.md %}

## See also

Expand Down
5 changes: 2 additions & 3 deletions v20.1/start-a-local-cluster-in-docker-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,13 @@ asciicast: true

Once you've [installed the official CockroachDB Docker image](install-cockroachdb.html), it's simple to run an insecure multi-node cluster across multiple Docker containers on a single host, using Docker volumes to persist node data.

{{site.data.alerts.callout_danger}}
Running multiple nodes on a single host is useful for testing CockroachDB, but it's not suitable for production. To run a physically distributed cluster in containers, use an orchestration tool like Kubernetes or Docker Swarm. See [Orchestration](orchestration.html) for more details, and review the [Production Checklist](recommended-production-settings.html).
{{site.data.alerts.end}}
{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

- Make sure you have already [installed the official CockroachDB Docker image](install-cockroachdb.html).
- For quick SQL testing or app development, consider [running a single-node cluster](cockroach-start-single-node.html) instead.
- Note that running multiple nodes on a single host is useful for testing CockroachDB, but it's not suitable for production. To run a physically distributed cluster in containers, use an orchestration tool like Kubernetes or Docker Swarm. See [Orchestration](orchestration.html) for more details, and review the [Production Checklist](recommended-production-settings.html).

<!-- TODO: update the asciicast
Also, feel free to watch this process in action before going through the steps yourself. Note that you can copy commands directly from the video, and you can use **<** and **>** to go back and forward.
Expand Down
5 changes: 2 additions & 3 deletions v20.1/start-a-local-cluster-in-docker-mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,13 @@ redirect_from: start-a-local-cluster-in-docker.html

Once you've [installed the official CockroachDB Docker image](install-cockroachdb.html), it's simple to run an insecure multi-node cluster across multiple Docker containers on a single host, using Docker volumes to persist node data.

{{site.data.alerts.callout_danger}}
Running multiple nodes on a single host is useful for testing CockroachDB, but it's not suitable for production. To run a physically distributed cluster in containers, use an orchestration tool like Kubernetes or Docker Swarm. See [Orchestration](orchestration.html) for more details, and review the [Production Checklist](recommended-production-settings.html).
{{site.data.alerts.end}}
{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

- Make sure you have already [installed the official CockroachDB Docker image](install-cockroachdb.html).
- For quick SQL testing or app development, consider [running a single-node cluster](cockroach-start-single-node.html) instead.
- Note that running multiple nodes on a single host is useful for testing CockroachDB, but it's not suitable for production. To run a physically distributed cluster in containers, use an orchestration tool like Kubernetes or Docker Swarm. See [Orchestration](orchestration.html) for more details, and review the [Production Checklist](recommended-production-settings.html).

<!-- TODO: update the asciicast
Also, feel free to watch this process in action before going through the steps yourself. Note that you can copy commands directly from the video, and you can use **<** and **>** to go back and forward.
Expand Down
5 changes: 2 additions & 3 deletions v20.1/start-a-local-cluster-in-docker-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,13 @@ asciicast: true

Once you've [installed the official CockroachDB Docker image](install-cockroachdb.html), it's simple to run an insecure multi-node cluster across multiple Docker containers on a single host, using Docker volumes to persist node data.

{{site.data.alerts.callout_danger}}
Running multiple nodes on a single host is useful for testing CockroachDB, but it's not suitable for production. To run a physically distributed cluster in containers, use an orchestration tool like Kubernetes or Docker Swarm. See [Orchestration](orchestration.html) for more details, and review the [Production Checklist](recommended-production-settings.html).
{{site.data.alerts.end}}
{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

- Make sure you have already [installed the official CockroachDB Docker image](install-cockroachdb.html).
- For quick SQL testing or app development, consider [running a single-node cluster](cockroach-start-single-node.html) instead.
- Note that running multiple nodes on a single host is useful for testing CockroachDB, but it's not suitable for production. To run a physically distributed cluster in containers, use an orchestration tool like Kubernetes or Docker Swarm. See [Orchestration](orchestration.html) for more details, and review the [Production Checklist](recommended-production-settings.html).

## Step 1. Create a bridge network

Expand Down
4 changes: 3 additions & 1 deletion v20.2/deploy-cockroachdb-on-aws-insecure.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ ssh-link: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html

This page shows you how to manually deploy an insecure multi-node CockroachDB cluster on Amazon's AWS EC2 platform, using AWS's managed load balancing service to distribute client traffic.

{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select <strong>Secure</strong> above for instructions.{{site.data.alerts.end}}
If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select **Secure** above for instructions.

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

Expand Down
2 changes: 2 additions & 0 deletions v20.2/deploy-cockroachdb-on-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ This page shows you how to manually deploy a secure multi-node CockroachDB clust

If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

### Requirements
Expand Down
4 changes: 3 additions & 1 deletion v20.2/deploy-cockroachdb-on-digital-ocean-insecure.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ ssh-link: https://www.digitalocean.com/community/tutorials/how-to-connect-to-you

This page shows you how to deploy an insecure multi-node CockroachDB cluster on Digital Ocean, using Digital Ocean's managed load balancing service to distribute client traffic.

{{site.data.alerts.callout_danger}}If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select <strong>Secure</strong> above for instructions.{{site.data.alerts.end}}
If you plan to use CockroachDB in production, we strongly recommend using a secure cluster instead. Select **Secure** above for instructions.

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

Expand Down
2 changes: 2 additions & 0 deletions v20.2/deploy-cockroachdb-on-digital-ocean.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ This page shows you how to deploy a secure multi-node CockroachDB cluster on Dig

If you are only testing CockroachDB, or you are not concerned with protecting network communication with TLS encryption, you can use an insecure cluster instead. Select **Insecure** above for instructions.

{% include cockroachcloud/use-cockroachcloud-instead.md %}

## Before you begin

### Requirements
Expand Down
Loading

0 comments on commit fd8e50e

Please sign in to comment.