Deploy CockroachDB on Microsoft Azure (Insecure)

On this page

Warning:

CockroachDB v22.1 is no longer supported as of November 24, 2023. For more details, refer to the Release Support Policy.

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.

Warning:

The --insecure flag used in this tutorial is intended for non-production testing only. To run CockroachDB in production, use a secure cluster instead.

Tip:

To deploy a free CockroachDB Cloud cluster instead of running CockroachDB yourself, see the Quickstart.

Before you begin

Requirements

You must have SSH access to each machine. This is necessary for distributing and starting CockroachDB binaries.
Your network configuration must allow TCP communication on the following ports:
- 26257 for intra-cluster and client-cluster communication
- 8080 to expose your DB Console
Carefully review the Production Checklist and recommended Topology Patterns.
Run each node on a separate machine. Since CockroachDB replicates across nodes, running more than one node per machine increases the risk of data loss if a machine fails. Likewise, if a machine has multiple disks or SSDs, run one node with multiple --store flags and not one node per disk. For more details about stores, see Start a Node.
When starting each node, use the --locality flag to describe the node's location, for example, --locality=region=west,zone=us-west-1. The key-value pairs should be ordered from most to least inclusive, and the keys and order of key-value pairs must be the same on all nodes.
When deploying in a single availability zone:
- To be able to tolerate the failure of any 1 node, use at least 3 nodes with the default 3-way replication factor. In this case, if 1 node fails, each range retains 2 of its 3 replicas, a majority.
- To be able to tolerate 2 simultaneous node failures, use at least 5 nodes and increase the default replication factor for user data to 5. The replication factor for important internal data is 5 by default, so no adjustments are needed for internal data. In this case, if 2 nodes fail at the same time, each range retains 3 of its 5 replicas, a majority.
When deploying across multiple availability zones:
- To be able to tolerate the failure of 1 entire AZ in a region, use at least 3 AZs per region and set --locality on each node to spread data evenly across regions and AZs. In this case, if 1 AZ goes offline, the 2 remaining AZs retain a majority of replicas.
- To ensure that ranges are split evenly across nodes, use the same number of nodes in each AZ. This is to avoid overloading any nodes with excessive resource consumption.
When deploying across multiple regions:
- To be able to tolerate the failure of 1 entire region, use at least 3 regions.

Recommendations

Consider using a secure cluster instead. Using an insecure cluster comes with risks:
- Your cluster is open to any client that can access any node's IP addresses.
- Any user, even root, can log in without providing a password.
- Any user, connecting as root, can read or write any data in your cluster.
- There is no network encryption or authentication, and thus no confidentiality.

Decide how you want to access your DB Console:

Access Level	Description
Partially open	Set a firewall rule to allow only specific IP addresses to communicate on port `8080`.
Completely open	Set a firewall rule to allow all IP addresses to communicate on port `8080`.
Completely closed	Set a firewall rule to disallow all communication on port `8080`. In this case, a machine with SSH access to a node could use an SSH tunnel to access the DB Console.

Step 1. Configure your network

CockroachDB requires TCP communication on two ports:

26257 (tcp:26257) for inter-node communication (i.e., working as a cluster), for applications to connect to the load balancer, and for routing from the load balancer to nodes
8080 (tcp:8080) for exposing your DB Console

To enable this in Azure, you must create a Resource Group, Virtual Network, and Network Security Group.

Create a Resource Group.
Create a Virtual Network that uses your Resource Group.

Create a Network Security Group that uses your Resource Group, and then add the following inbound rules to it:

DB Console support:

Field	Recommended Value
Name	cockroachadmin
Source	IP Addresses
Source IP addresses/CIDR ranges	Your local network’s IP ranges
Source port ranges	*
Destination	Any
Destination port range	8080
Protocol	TCP
Action	Allow
Priority	Any value > 1000

Application support:

Tip:

If your application is also hosted on the same Azure Virtual Network, you will not need to create a firewall rule for your application to communicate with your load balancer.

Field	Recommended Value
Name	cockroachapp
Source	IP Addresses
Source IP addresses/CIDR ranges	Your local network’s IP ranges
Source port ranges	*
Destination	Any
Destination port range	26257
Protocol	TCP
Action	Allow
Priority	Any value > 1000

Step 2. Create VMs

Create Linux VMs for each node you plan to have in your cluster. If you plan to run a sample workload against the cluster, create a separate VM for that workload.

Run at least 3 nodes to ensure survivability.
Use general-purpose Dsv5-series and Dasv5-series or memory-optimized Ev5-series and Easv5-series VMs. For example, Cockroach Labs has used Standard_D8s_v5, Standard_D8as_v5, Standard_E8s_v5, and Standard_e8as_v5 for performance benchmarking.
- Compute-optimized F-series VMs are also acceptable.
Warning:

Do not use "burstable" B-series VMs, which limit the load on CPU resources. 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.
When creating the VMs, make sure to select the Resource Group, Virtual Network, and Network Security Group you created.

For more details, see Hardware Recommendations and Cluster Topology.

Step 3. Synchronize clocks

CockroachDB requires moderate levels of clock synchronization to preserve data consistency. For this reason, when a node detects that its clock is out of sync with at least half of the other nodes in the cluster by 80% of the maximum offset allowed (500ms by default), it spontaneously shuts down. This avoids the risk of consistency anomalies, but it's best to prevent clocks from drifting too far in the first place by running clock synchronization software on each node.

ntpd should keep offsets in the single-digit milliseconds, so that software is featured here. However, to run ntpd properly on Azure VMs, it's necessary to first unbind the Time Synchronization device used by the Hyper-V technology running Azure VMs; this device aims to synchronize time between the VM and its host operating system but has been known to cause problems.

SSH to the first machine.

Find the ID of the Hyper-V Time Synchronization device:

$ curl -O https://raw.githubusercontent.com/torvalds/linux/master/tools/hv/lsvmbus

$ python lsvmbus -vv | grep -w "Time Synchronization" -A 3

VMBUS ID 12: Class_ID = {9527e630-d0ae-497b-adce-e80ab0175caf} - [Time Synchronization]
    Device_ID = {2dd1ce17-079e-403c-b352-a1921ee207ee}
    Sysfs path: /sys/bus/vmbus/devices/2dd1ce17-079e-403c-b352-a1921ee207ee
    Rel_ID=12, target_cpu=0

Unbind the device, using the Device_ID from the previous command's output:
```
$ echo <DEVICE_ID> | sudo tee /sys/bus/vmbus/drivers/hv_utils/unbind
```
Install the ntp package:
```
$ sudo apt-get install ntp
```
Stop the NTP daemon:
```
$ sudo service ntp stop
```
Sync the machine's clock with Google's NTP service:
```
$ sudo ntpd -b time.google.com
```
To make this change permanent, in the /etc/ntp.conf file, remove or comment out any lines starting with server or pool and add the following lines:
```
server time1.google.com iburst
server time2.google.com iburst
server time3.google.com iburst
server time4.google.com iburst
```
Restart the NTP daemon:
```
$ sudo service ntp start
```
Note:

We recommend Google's NTP service because it handles "smearing" the leap second. If you use a different NTP service that doesn't smear the leap second, be sure to configure client-side smearing in the same way on each machine. See the Production Checklist for details.
Verify that the machine is using a Google NTP server:
```
$ sudo ntpq -p
```
The active NTP server will be marked with an asterisk.
Repeat these steps for each machine where a CockroachDB node will run.

Step 4. Set up load balancing

Each CockroachDB node is an equally suitable SQL gateway to your cluster, but to ensure client performance and reliability, it's important to use load balancing:

Performance: Load balancers spread client traffic across nodes. This prevents any one node from being overwhelmed by requests and improves overall cluster performance (queries per second).
Reliability: Load balancers decouple client health from the health of a single CockroachDB node. In cases where a node fails, the load balancer redirects client traffic to available nodes.

Microsoft Azure offers fully-managed load balancing to distribute traffic between instances.

Add Azure load balancing. Be sure to:
- Set forwarding rules to route TCP traffic from the load balancer's port 26257 to port 26257 on the nodes.
- Configure health checks to use HTTP port 8080 and path /health?ready=1. This health endpoint ensures that load balancers do not direct traffic to nodes that are live but not ready to receive requests.
Note the provisioned IP Address for the load balancer. You'll use this later to test load balancing and to connect your application to the cluster.

Note:

If you would prefer to use HAProxy instead of Azure's managed load balancing, see the On-Premises tutorial for guidance.

Step 5. Start nodes

You can start the nodes manually or automate the process using systemd.

For each initial node of your cluster, complete the following steps:

Note:

After completing these steps, nodes will not yet be live. They will complete the startup process and join together to form a cluster as soon as the cluster is initialized in the next step.

SSH to the machine where you want the node to run.
Download the CockroachDB archive for Linux, and extract the binary:
```
$ curl https://binaries.cockroachdb.com/cockroach-v22.1.22.linux-amd64.tgz \
| tar -xz
```
Copy the binary into the PATH:
```
$ cp -i cockroach-v22.1.22.linux-amd64/cockroach /usr/local/bin/
```
If you get a permissions error, prefix the command with sudo.
CockroachDB uses custom-built versions of the GEOS libraries. Copy these libraries to the location where CockroachDB expects to find them:
```
$ mkdir -p /usr/local/lib/cockroach
```
```
$ cp -i cockroach-v22.1.22.linux-amd64/lib/libgeos.so /usr/local/lib/cockroach/
```
```
$ cp -i cockroach-v22.1.22.linux-amd64/lib/libgeos_c.so /usr/local/lib/cockroach/
```
If you get a permissions error, prefix the command with sudo.

Run the cockroach start command:

$ cockroach start \
--insecure \
--advertise-addr=<node1 address> \
--join=<node1 address>,<node2 address>,<node3 address> \
--cache=.25 \
--max-sql-memory=.25 \
--background

This command primes the node to start, using the following flags:

Flag	Description
`--insecure`	Indicates that the cluster is insecure, with no network encryption or authentication.
`--advertise-addr`	Specifies the IP address/hostname and port to tell other nodes to use. The port number can be omitted, in which case it defaults to `26257`. This value must route to an IP address the node is listening on (with `--listen-addr` unspecified, the node listens on all IP addresses). In some networking scenarios, you may need to use `--advertise-addr` and/or `--listen-addr` differently. For more details, see Networking.
`--join`	Identifies the address of 3-5 of the initial nodes of the cluster. These addresses should match the addresses that the target nodes are advertising.
`--cache` `--max-sql-memory`	Increases the node's cache size to 25% of available system memory to improve read performance. The capacity for in-memory SQL processing defaults to 25% of system memory but can be raised, if necessary, to increase the number of simultaneous client connections allowed by the node as well as the node's capacity for in-memory processing of rows when using `ORDER BY`, `GROUP BY`, `DISTINCT`, joins, and window functions. For more details, see Cache and SQL Memory Size.
`--background`	Starts the node in the background so you gain control of the terminal to issue more commands.

When deploying across multiple datacenters, or when there is otherwise high latency between nodes, it is recommended to set --locality as well. It is also required to use certain enterprise features. For more details, see Locality.

For other flags not explicitly set, the command uses default values. For example, the node stores data in --store=cockroach-data and binds DB Console HTTP requests to --http-addr=localhost:8080. To set these options manually, see Start a Node.

Repeat these steps for each additional node that you want in your cluster.

For each initial node of your cluster, complete the following steps:

Note:

After completing these steps, nodes will not yet be live. They will complete the startup process and join together to form a cluster as soon as the cluster is initialized in the next step.

SSH to the machine where you want the node to run. Ensure you are logged in as the root user.
Download the CockroachDB archive for Linux, and extract the binary:
```
$ curl https://binaries.cockroachdb.com/cockroach-v22.1.22.linux-amd64.tgz \
| tar -xz
```
Copy the binary into the PATH:
```
$ cp -i cockroach-v22.1.22.linux-amd64/cockroach /usr/local/bin/
```
If you get a permissions error, prefix the command with sudo.
CockroachDB uses custom-built versions of the GEOS libraries. Copy these libraries to the location where CockroachDB expects to find them:
```
$ mkdir -p /usr/local/lib/cockroach
```
```
$ cp -i cockroach-v22.1.22.linux-amd64/lib/libgeos.so /usr/local/lib/cockroach/
```
```
$ cp -i cockroach-v22.1.22.linux-amd64/lib/libgeos_c.so /usr/local/lib/cockroach/
```
If you get a permissions error, prefix the command with sudo.
Create the Cockroach directory:
```
$ mkdir /var/lib/cockroach
```
Create a Unix user named cockroach:
```
$ useradd cockroach
```
Change the ownership of the cockroach directory to the user cockroach:
```
$ chown cockroach /var/lib/cockroach
```

Download the sample configuration template and save the file in the /etc/systemd/system/ directory:

$ wget -qO- https://raw.githubusercontent.com/cockroachdb/docs/master/_includes/v22.1/prod-deployment/insecurecockroachdb.service

Alternatively, you can create the file yourself and copy the script into it:

[Unit]
Description=Cockroach Database cluster node
Requires=network.target
[Service]
Type=notify
WorkingDirectory=/var/lib/cockroach
ExecStart=/usr/local/bin/cockroach start --insecure --advertise-addr=<node1 address> --join=<node1 address>,<node2 address>,<node3 address> --cache=.25 --max-sql-memory=.25
TimeoutStopSec=300
Restart=always
RestartSec=10
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=cockroach
User=cockroach
[Install]
WantedBy=default.target

Note:

Previously, the sample configuration file set TimeoutStopSec to 60 seconds. This recommendation has been lengthened to 300 seconds, to give the cockroach process more time to stop gracefully.

In the sample configuration template, specify values for the following flags:

Flag Description

--advertise-addr Specifies the IP address/hostname and port to tell other nodes to use. The port number can be omitted, in which case it defaults to 26257.

This value must route to an IP address the node is listening on (with --listen-addr unspecified, the node listens on all IP addresses).

In some networking scenarios, you may need to use --advertise-addr and/or --listen-addr differently. For more details, see Networking.

--join Identifies the address of 3-5 of the initial nodes of the cluster. These addresses should match the addresses that the target nodes are advertising.

Flag	Description
`--advertise-addr`	Specifies the IP address/hostname and port to tell other nodes to use. The port number can be omitted, in which case it defaults to `26257`. This value must route to an IP address the node is listening on (with `--listen-addr` unspecified, the node listens on all IP addresses). In some networking scenarios, you may need to use `--advertise-addr` and/or `--listen-addr` differently. For more details, see Networking.
`--join`	Identifies the address of 3-5 of the initial nodes of the cluster. These addresses should match the addresses that the target nodes are advertising.

For other flags not explicitly set, the command uses default values. For example, the node stores data in --store=cockroach-data and binds DB Console HTTP requests to --http-port=8080. To set these options manually, see Start a Node.

Start the CockroachDB cluster:
```
$ systemctl start insecurecockroachdb
```
Repeat these steps for each additional node that you want in your cluster.

Note:

systemd handles node restarts in case of node failure. To stop a node without systemd restarting it, run systemctl stop insecurecockroachdb

Step 6. Initialize the cluster

On your local machine, complete the node startup process and have them join together as a cluster:

Install CockroachDB on your local machine, if you haven't already.
Run the cockroach init command, with the --host flag set to the address of any node:
```
$ cockroach init --insecure --host=<address of any node on --join list>
```
Each node then prints helpful details to the standard output, such as the CockroachDB version, the URL for the DB Console, and the SQL URL for clients.

Step 7. Test the cluster

CockroachDB replicates and distributes data behind-the-scenes and uses a Gossip protocol to enable each node to locate data across the cluster. Once a cluster is live, any node can be used as a SQL gateway.

When using a load balancer, you should issue commands directly to the load balancer, which then routes traffic to the nodes.

Use the built-in SQL client locally as follows:

On your local machine, launch the built-in SQL client, with the --host flag set to the address of the load balancer:
```
$ cockroach sql --insecure --host=<address of load balancer>
```
Create an insecurenodetest database:
```
> CREATE DATABASE insecurenodetest;
```

View the cluster's databases, which will include insecurenodetest:

> SHOW DATABASES;

+--------------------+
|      Database      |
+--------------------+
| crdb_internal      |
| information_schema |
| insecurenodetest   |
| pg_catalog         |
| system             |
+--------------------+
(5 rows)

Use \q to exit the SQL shell.

Step 8. Run a sample workload

CockroachDB comes with a number of built-in workloads for simulating client traffic. This step features CockroachDB's version of the TPC-C workload.

Note:

Be sure that you have configured your network to allow traffic from the application to the load balancer. In this case, you will run the sample workload on one of your machines. The traffic source should therefore be the internal (private) IP address of that machine.

Tip:

For comprehensive guidance on benchmarking CockroachDB with TPC-C, see Performance Benchmarking.

SSH to the machine where you want the run the sample TPC-C workload.

This should be a machine that is not running a CockroachDB node.
Download the CockroachDB archive for Linux, and extract the binary:
```
$ curl https://binaries.cockroachdb.com/cockroach-v22.1.22.linux-amd64.tgz \
| tar -xz
```
Copy the binary into the PATH:
```
$ cp -i cockroach-v22.1.22.linux-amd64/cockroach /usr/local/bin/
```
If you get a permissions error, prefix the command with sudo.
Use the cockroach workload command to load the initial schema and data, pointing it at the IP address of the load balancer:
```
$ cockroach workload init tpcc \
'postgresql://root@<IP ADDRESS OF LOAD BALANCER>:26257/tpcc?sslmode=disable'
```

Use the cockroach workload command to run the workload for 10 minutes:

$ cockroach workload run tpcc \
--duration=10m \
'postgresql://root@<IP ADDRESS OF LOAD BALANCER>:26257/tpcc?sslmode=disable'

You'll see per-operation statistics print to standard output every second:

_elapsed___errors__ops/sec(inst)___ops/sec(cum)__p50(ms)__p95(ms)__p99(ms)_pMax(ms)
      1s        0         1443.4         1494.8      4.7      9.4     27.3     67.1 transfer
      2s        0         1686.5         1590.9      4.7      8.1     15.2     28.3 transfer
      3s        0         1735.7         1639.0      4.7      7.3     11.5     28.3 transfer
      4s        0         1542.6         1614.9      5.0      8.9     12.1     21.0 transfer
      5s        0         1695.9         1631.1      4.7      7.3     11.5     22.0 transfer
      6s        0         1569.2         1620.8      5.0      8.4     11.5     15.7 transfer
      7s        0         1614.6         1619.9      4.7      8.1     12.1     16.8 transfer
      8s        0         1344.4         1585.6      5.8     10.0     15.2     31.5 transfer
      9s        0         1351.9         1559.5      5.8     10.0     16.8     54.5 transfer
     10s        0         1514.8         1555.0      5.2      8.1     12.1     16.8 transfer
...

After the specified duration (10 minutes in this case), the workload will stop and you'll see totals printed to standard output:

_elapsed___errors_____ops(total)___ops/sec(cum)__avg(ms)__p50(ms)__p95(ms)__p99(ms)_pMax(ms)__result
  600.0s        0         823902         1373.2      5.8      5.5     10.0     15.2    209.7

Tip:

For more tpcc options, use cockroach workload run tpcc --help. For details about other workloads built into the cockroach binary, use cockroach workload --help.

To monitor the load generator's progress, open the DB Console by pointing a browser to the address in the admin field in the standard output of any node on startup.

Since the load generator is pointed at the load balancer, the connections will be evenly distributed across nodes. To verify this, click Metrics on the left, select the SQL dashboard, and then check the SQL Connections graph. You can use the Graph menu to filter the graph for specific nodes.

Step 9. Monitor the cluster

Despite CockroachDB's various built-in safeguards against failure, it is critical to actively monitor the overall health and performance of a cluster running in production and to create alerting rules that promptly send notifications when there are events that require investigation or intervention.

For details about available monitoring options and the most important events and metrics to alert on, see Monitoring and Alerting.

Step 10. Scale the cluster

You can start the nodes manually or automate the process using systemd.

For each additional node you want to add to the cluster, complete the following steps:

SSH to the machine where you want the node to run.
Download the CockroachDB archive for Linux, and extract the binary:
```
$ curl https://binaries.cockroachdb.com/cockroach-v22.1.22.linux-amd64.tgz \
| tar -xz
```
Copy the binary into the PATH:
```
$ cp -i cockroach-v22.1.22.linux-amd64/cockroach /usr/local/bin/
```
If you get a permissions error, prefix the command with sudo.
Run the cockroach start command, passing the new node's address as the --advertise-addr flag and pointing --join to the three existing nodes (also include --locality if you set it earlier).
```
$ cockroach start \
--insecure \
--advertise-addr=<node4 address> \
--join=<node1 address>,<node2 address>,<node3 address> \
--cache=.25 \
--max-sql-memory=.25 \
--background
```
Update your load balancer to recognize the new node.

For each additional node you want to add to the cluster, complete the following steps:

SSH to the machine where you want the node to run. Ensure you are logged in as the root user.
Download the CockroachDB archive for Linux, and extract the binary:
```
$ curl https://binaries.cockroachdb.com/cockroach-v22.1.22.linux-amd64.tgz \
| tar -xz
```
Copy the binary into the PATH:
```
$ cp -i cockroach-v22.1.22.linux-amd64/cockroach /usr/local/bin/
```
If you get a permissions error, prefix the command with sudo.
Create the Cockroach directory:
```
$ mkdir /var/lib/cockroach
```
Create a Unix user named cockroach:
```
$ useradd cockroach
```
Change the ownership of the cockroach directory to the user cockroach:
```
$ chown cockroach /var/lib/cockroach
```

Download the sample configuration template:

$ wget -qO- https://raw.githubusercontent.com/cockroachdb/docs/master/_includes/v22.1/prod-deployment/insecurecockroachdb.service

Alternatively, you can create the file yourself and copy the script into it:

[Unit]
Description=Cockroach Database cluster node
Requires=network.target
[Service]
Type=notify
WorkingDirectory=/var/lib/cockroach
ExecStart=/usr/local/bin/cockroach start --insecure --advertise-addr=<node1 address> --join=<node1 address>,<node2 address>,<node3 address> --cache=.25 --max-sql-memory=.25
TimeoutStopSec=300
Restart=always
RestartSec=10
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=cockroach
User=cockroach
[Install]
WantedBy=default.target

Note:

Previously, the sample configuration file set TimeoutStopSec to 60 seconds. This recommendation has been lengthened to 300 seconds, to give the cockroach process more time to stop gracefully.

Save the file in the /etc/systemd/system/ directory

Customize the sample configuration template for your deployment:

Specify values for the following flags in the sample configuration template:

Flag Description

--join Identifies the address of 3-5 of the initial nodes of the cluster. These addresses should match the addresses that the target nodes are advertising.

Repeat these steps for each additional node that you want in your cluster.

Flag	Description
`--advertise-addr`	Specifies the IP address/hostname and port to tell other nodes to use. The port number can be omitted, in which case it defaults to `26257`. This value must route to an IP address the node is listening on (with `--listen-addr` unspecified, the node listens on all IP addresses). In some networking scenarios, you may need to use `--advertise-addr` and/or `--listen-addr` differently. For more details, see Networking.
`--join`	Identifies the address of 3-5 of the initial nodes of the cluster. These addresses should match the addresses that the target nodes are advertising.

Step 11. Use the cluster

Now that your deployment is working, you can:

Implement your data model.
Create users and grant them privileges.
Connect your application. Be sure to connect your application to the Azure load balancer, not to a CockroachDB node.

Cockroach
University

Docs Hub

Deploy CockroachDB on Microsoft Azure (Insecure)

Before you begin

Requirements

Recommendations

Step 1. Configure your network

Step 2. Create VMs

Step 3. Synchronize clocks

Step 4. Set up load balancing

Step 5. Start nodes

Step 6. Initialize the cluster

Step 7. Test the cluster

Step 8. Run a sample workload

Step 9. Monitor the cluster

Step 10. Scale the cluster

Step 11. Use the cluster

See also

Cockroach University

Docs Hub

Cockroach University

Docs Hub

Deploy CockroachDB on Microsoft Azure (Insecure)

Before you begin

Requirements

Recommendations

Step 1. Configure your network

Step 2. Create VMs

Step 3. Synchronize clocks

Step 4. Set up load balancing

Step 5. Start nodes

Step 6. Initialize the cluster

Step 7. Test the cluster

Step 8. Run a sample workload

Step 9. Monitor the cluster

Step 10. Scale the cluster

Step 11. Use the cluster

See also

Cockroach
University

Cockroach
University