From f42ceb15b915bcd1d5d63fc2353a6201d56c923d Mon Sep 17 00:00:00 2001 From: Rich Loveland Date: Wed, 21 May 2025 14:01:18 -0400 Subject: [PATCH 1/3] Direct users to official Linux install instruction ... not bespoke `curl` commands that can break. Fixes DOC-13739 --- .../v25.2/performance/scale-cluster.md | 10 ++++---- .../v25.2/performance/start-cluster.md | 10 ++++---- .../prod-deployment/insecure-scale-cluster.md | 5 ++-- .../prod-deployment/insecure-start-nodes.md | 5 ++-- .../insecure-test-load-balancing.md | 5 ++-- .../prod-deployment/secure-scale-cluster.md | 5 ++-- .../prod-deployment/secure-start-nodes.md | 5 ++-- .../secure-test-load-balancing.md | 5 ++-- ...deploy-cockroachdb-on-premises-insecure.md | 23 +++++++++---------- ...erformance-benchmarking-with-tpcc-large.md | 5 ++-- ...rformance-benchmarking-with-tpcc-medium.md | 5 ++-- ...erformance-benchmarking-with-tpcc-small.md | 5 ++-- 12 files changed, 37 insertions(+), 51 deletions(-) diff --git a/src/current/_includes/v25.2/performance/scale-cluster.md b/src/current/_includes/v25.2/performance/scale-cluster.md index 3575d31e374..3b4da0882e6 100644 --- a/src/current/_includes/v25.2/performance/scale-cluster.md +++ b/src/current/_includes/v25.2/performance/scale-cluster.md @@ -1,11 +1,10 @@ 1. SSH to one of the `n2-standard-4` instances in the `us-west1-a` zone. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, extract the binary, and copy it into the `PATH`: +1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz \ - | tar -xz + tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz ~~~ {% include_cached copy-clipboard.html %} @@ -31,12 +30,11 @@ 1. SSH to one of the `n2-standard-4` instances in the `us-west2-a` zone. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, extract the binary, and copy it into the `PATH`: +1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz \ - | tar -xz + tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz ~~~ {% include_cached copy-clipboard.html %} diff --git a/src/current/_includes/v25.2/performance/start-cluster.md b/src/current/_includes/v25.2/performance/start-cluster.md index 516aca418f1..478cb9af345 100644 --- a/src/current/_includes/v25.2/performance/start-cluster.md +++ b/src/current/_includes/v25.2/performance/start-cluster.md @@ -2,12 +2,11 @@ 1. SSH to the first `n2-standard-4` instance. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, extract the binary, and copy it into the `PATH`: +1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz \ - | tar -xz + tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz ~~~ {% include_cached copy-clipboard.html %} @@ -35,12 +34,11 @@ 1. SSH to the fourth instance, the one not running a CockroachDB node. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, and extract the binary: +1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz \ - | tar -xz + tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz ~~~ 1. Copy the binary into the `PATH`: diff --git a/src/current/_includes/v25.2/prod-deployment/insecure-scale-cluster.md b/src/current/_includes/v25.2/prod-deployment/insecure-scale-cluster.md index aaf0e5f7688..d2fb8b044c9 100644 --- a/src/current/_includes/v25.2/prod-deployment/insecure-scale-cluster.md +++ b/src/current/_includes/v25.2/prod-deployment/insecure-scale-cluster.md @@ -12,12 +12,11 @@ For each additional node you want to add to the cluster, complete the following 1. SSH to the machine where you want the node to run. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, and extract the binary: +1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz \ - | tar -xz + tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz ~~~ 1. Copy the binary into the `PATH`: diff --git a/src/current/_includes/v25.2/prod-deployment/insecure-start-nodes.md b/src/current/_includes/v25.2/prod-deployment/insecure-start-nodes.md index 75d0de816b5..8175dbe47ca 100644 --- a/src/current/_includes/v25.2/prod-deployment/insecure-start-nodes.md +++ b/src/current/_includes/v25.2/prod-deployment/insecure-start-nodes.md @@ -59,12 +59,11 @@ After completing these steps, nodes will not yet be live. They will complete the 1. SSH to the machine where you want the node to run. Ensure you are logged in as the `root` user. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, and extract the binary: +1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz \ - | tar -xz + tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz ~~~ 1. Copy the binary into the `PATH`: diff --git a/src/current/_includes/v25.2/prod-deployment/insecure-test-load-balancing.md b/src/current/_includes/v25.2/prod-deployment/insecure-test-load-balancing.md index aaa2873a2ba..a4e104dda4e 100644 --- a/src/current/_includes/v25.2/prod-deployment/insecure-test-load-balancing.md +++ b/src/current/_includes/v25.2/prod-deployment/insecure-test-load-balancing.md @@ -12,12 +12,11 @@ For comprehensive guidance on benchmarking CockroachDB with TPC-C, see [Performa This should be a machine that is not running a CockroachDB node. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, and extract the binary: +1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz \ - | tar -xz + tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz ~~~ 1. Copy the binary into the `PATH`: diff --git a/src/current/_includes/v25.2/prod-deployment/secure-scale-cluster.md b/src/current/_includes/v25.2/prod-deployment/secure-scale-cluster.md index 8c980b018a3..997d809020a 100644 --- a/src/current/_includes/v25.2/prod-deployment/secure-scale-cluster.md +++ b/src/current/_includes/v25.2/prod-deployment/secure-scale-cluster.md @@ -12,12 +12,11 @@ For each additional node you want to add to the cluster, complete the following 1. SSH to the machine where you want the node to run. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, and extract the binary: +1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz \ - | tar -xz + tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz ~~~ 1. Copy the binary into the `PATH`: diff --git a/src/current/_includes/v25.2/prod-deployment/secure-start-nodes.md b/src/current/_includes/v25.2/prod-deployment/secure-start-nodes.md index f3c554f4f19..2706ec0d236 100644 --- a/src/current/_includes/v25.2/prod-deployment/secure-start-nodes.md +++ b/src/current/_includes/v25.2/prod-deployment/secure-start-nodes.md @@ -59,12 +59,11 @@ After completing these steps, nodes will not yet be live. They will complete the 1. SSH to the machine where you want the node to run. Ensure you are logged in as the `root` user. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, and extract the binary: +1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz \ - | tar -xz + tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz ~~~ 1. Copy the binary into the `PATH`: diff --git a/src/current/_includes/v25.2/prod-deployment/secure-test-load-balancing.md b/src/current/_includes/v25.2/prod-deployment/secure-test-load-balancing.md index ba1ecd90919..3c8036fecf5 100644 --- a/src/current/_includes/v25.2/prod-deployment/secure-test-load-balancing.md +++ b/src/current/_includes/v25.2/prod-deployment/secure-test-load-balancing.md @@ -10,12 +10,11 @@ For comprehensive guidance on benchmarking CockroachDB with TPC-C, refer to [Per This should be a machine that is not running a CockroachDB node, and it should already have a `certs` directory containing `ca.crt`, `client.root.crt`, and `client.root.key` files. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, and extract the binary: +1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz \ - | tar -xz + tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz ~~~ 1. Copy the binary into the `PATH`: diff --git a/src/current/v25.2/deploy-cockroachdb-on-premises-insecure.md b/src/current/v25.2/deploy-cockroachdb-on-premises-insecure.md index 6892a2852b4..b7f93adfaa4 100644 --- a/src/current/v25.2/deploy-cockroachdb-on-premises-insecure.md +++ b/src/current/v25.2/deploy-cockroachdb-on-premises-insecure.md @@ -55,17 +55,16 @@ Each CockroachDB node is an equally suitable SQL gateway to your cluster, but to 1. Install HAProxy: - {% include_cached copy-clipboard.html %} - ~~~ shell - $ apt-get install haproxy - ~~~ + {% include_cached copy-clipboard.html %} + ~~~ shell + $ apt-get install haproxy + ~~~ -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, and extract the binary: +1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), and extract the binary: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz \ - | tar -xz + tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz ~~~ 1. Copy the binary into the `PATH`: @@ -75,7 +74,7 @@ Each CockroachDB node is an equally suitable SQL gateway to your cluster, but to $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ ~~~ - If you get a permissions error, prefix the command with `sudo`. + If you get a permissions error, prefix the command with `sudo`. 1. Run the [`cockroach gen haproxy`]({% link {{ page.version.version }}/cockroach-gen.md %}) command, specifying the address of any CockroachDB node: @@ -90,10 +89,10 @@ Each CockroachDB node is an equally suitable SQL gateway to your cluster, but to 1. Start HAProxy, with the `-f` flag pointing to the `haproxy.cfg` file: - {% include_cached copy-clipboard.html %} - ~~~ shell - $ haproxy -f haproxy.cfg - ~~~ + {% include_cached copy-clipboard.html %} + ~~~ shell + $ haproxy -f haproxy.cfg + ~~~ 1. Repeat these steps for each additional instance of HAProxy you want to run. diff --git a/src/current/v25.2/performance-benchmarking-with-tpcc-large.md b/src/current/v25.2/performance-benchmarking-with-tpcc-large.md index ce50a82f39b..a7ae948a92a 100644 --- a/src/current/v25.2/performance-benchmarking-with-tpcc-large.md +++ b/src/current/v25.2/performance-benchmarking-with-tpcc-large.md @@ -173,12 +173,11 @@ CockroachDB comes with a number of [built-in workloads]({% link {{ page.version. 1. SSH to the VM where you want to run TPC-C. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, extract the binary, and copy it into the `PATH`: +1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz \ - | tar -xz + tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz ~~~ {% include_cached copy-clipboard.html %} diff --git a/src/current/v25.2/performance-benchmarking-with-tpcc-medium.md b/src/current/v25.2/performance-benchmarking-with-tpcc-medium.md index 9aaffb03dc3..f854ee7e730 100644 --- a/src/current/v25.2/performance-benchmarking-with-tpcc-medium.md +++ b/src/current/v25.2/performance-benchmarking-with-tpcc-medium.md @@ -165,12 +165,11 @@ CockroachDB comes with a number of [built-in workloads]({% link {{ page.version. 1. SSH to the VM where you want to run TPC-C. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, extract the binary, and copy it into the `PATH`: +1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz \ - | tar -xz + tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz ~~~ {% include_cached copy-clipboard.html %} diff --git a/src/current/v25.2/performance-benchmarking-with-tpcc-small.md b/src/current/v25.2/performance-benchmarking-with-tpcc-small.md index c256f568ece..8762ce72d55 100644 --- a/src/current/v25.2/performance-benchmarking-with-tpcc-small.md +++ b/src/current/v25.2/performance-benchmarking-with-tpcc-small.md @@ -106,12 +106,11 @@ CockroachDB comes with a number of [built-in workloads]({% link {{ page.version. 1. SSH to the VM where you want to run TPC-C. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, extract the binary, and copy it into the `PATH`: +1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: {% include_cached copy-clipboard.html %} ~~~ shell - $ curl https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz \ - | tar -xz + tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz ~~~ {% include_cached copy-clipboard.html %} From a22b9f6a6cd16970470e8f6f80adb24ae156045f Mon Sep 17 00:00:00 2001 From: Rich Loveland Date: Wed, 28 May 2025 16:50:53 -0400 Subject: [PATCH 2/3] Update with feedback from taroface & jhlodin --- .../v25.2/misc/linux-binary-prereqs.md | 1 - .../v25.2/performance/scale-cluster.md | 24 ++----------- .../v25.2/performance/start-cluster.md | 26 ++------------ .../prod-deployment/insecure-scale-cluster.md | 32 ++--------------- .../prod-deployment/insecure-start-nodes.md | 35 +------------------ .../prod-deployment/secure-scale-cluster.md | 16 +-------- .../v25.2/install-cockroachdb-linux.md | 19 +++++++--- ...erformance-benchmarking-with-tpcc-large.md | 14 +------- 8 files changed, 24 insertions(+), 143 deletions(-) delete mode 100644 src/current/_includes/v25.2/misc/linux-binary-prereqs.md diff --git a/src/current/_includes/v25.2/misc/linux-binary-prereqs.md b/src/current/_includes/v25.2/misc/linux-binary-prereqs.md deleted file mode 100644 index 541183fe71b..00000000000 --- a/src/current/_includes/v25.2/misc/linux-binary-prereqs.md +++ /dev/null @@ -1 +0,0 @@ -

The CockroachDB binary for Linux requires glibc, libncurses, and tzdata, which are found by default on nearly all Linux distributions, with Alpine as the notable exception.

diff --git a/src/current/_includes/v25.2/performance/scale-cluster.md b/src/current/_includes/v25.2/performance/scale-cluster.md index 3b4da0882e6..b776c7e60f9 100644 --- a/src/current/_includes/v25.2/performance/scale-cluster.md +++ b/src/current/_includes/v25.2/performance/scale-cluster.md @@ -1,16 +1,6 @@ 1. SSH to one of the `n2-standard-4` instances in the `us-west1-a` zone. -1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ sudo cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Run the [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) command: @@ -30,17 +20,7 @@ 1. SSH to one of the `n2-standard-4` instances in the `us-west2-a` zone. -1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ sudo cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Run the [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) command: diff --git a/src/current/_includes/v25.2/performance/start-cluster.md b/src/current/_includes/v25.2/performance/start-cluster.md index 478cb9af345..8478a1b5911 100644 --- a/src/current/_includes/v25.2/performance/start-cluster.md +++ b/src/current/_includes/v25.2/performance/start-cluster.md @@ -2,17 +2,7 @@ 1. SSH to the first `n2-standard-4` instance. -1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ sudo cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Run the [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) command: @@ -34,19 +24,7 @@ 1. SSH to the fourth instance, the one not running a CockroachDB node. -1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - -1. Copy the binary into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ sudo cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Run the [`cockroach init`]({% link {{ page.version.version }}/cockroach-init.md %}) command: diff --git a/src/current/_includes/v25.2/prod-deployment/insecure-scale-cluster.md b/src/current/_includes/v25.2/prod-deployment/insecure-scale-cluster.md index d2fb8b044c9..f325eb10261 100644 --- a/src/current/_includes/v25.2/prod-deployment/insecure-scale-cluster.md +++ b/src/current/_includes/v25.2/prod-deployment/insecure-scale-cluster.md @@ -12,21 +12,7 @@ For each additional node you want to add to the cluster, complete the following 1. SSH to the machine where you want the node to run. -1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - -1. Copy the binary into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ - - If you get a permissions error, prefix the command with `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Run the [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) 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). @@ -51,21 +37,7 @@ For each additional node you want to add to the cluster, complete the following 1. SSH to the machine where you want the node to run. Ensure you are logged in as the `root` user. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, and extract the binary: - - {% include_cached copy-clipboard.html %} - ~~~ shell - curl -o cockroach-{{ page.release_info.version }}.linux-amd64.tgz; tar xzvf cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - -1. Copy the binary into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ - - If you get a permissions error, prefix the command with `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Create the Cockroach directory: diff --git a/src/current/_includes/v25.2/prod-deployment/insecure-start-nodes.md b/src/current/_includes/v25.2/prod-deployment/insecure-start-nodes.md index 8175dbe47ca..6ba82c4a768 100644 --- a/src/current/_includes/v25.2/prod-deployment/insecure-start-nodes.md +++ b/src/current/_includes/v25.2/prod-deployment/insecure-start-nodes.md @@ -59,40 +59,7 @@ After completing these steps, nodes will not yet be live. They will complete the 1. SSH to the machine where you want the node to run. Ensure you are logged in as the `root` user. -1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - -1. Copy the binary into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ - - If you get a permissions error, prefix the command with `sudo`. - -1. CockroachDB uses custom-built versions of the [GEOS]({% link {{ page.version.version }}/architecture/glossary.md %}#geos) libraries. Copy these libraries to the location where CockroachDB expects to find them: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ mkdir -p /usr/local/lib/cockroach - ~~~ - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/lib/libgeos.so /usr/local/lib/cockroach/ - ~~~ - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/lib/libgeos_c.so /usr/local/lib/cockroach/ - ~~~ - - If you get a permissions error, prefix the command with `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Create the Cockroach directory: diff --git a/src/current/_includes/v25.2/prod-deployment/secure-scale-cluster.md b/src/current/_includes/v25.2/prod-deployment/secure-scale-cluster.md index 997d809020a..249fca13cca 100644 --- a/src/current/_includes/v25.2/prod-deployment/secure-scale-cluster.md +++ b/src/current/_includes/v25.2/prod-deployment/secure-scale-cluster.md @@ -51,21 +51,7 @@ For each additional node you want to add to the cluster, complete the following 1. SSH to the machine where you want the node to run. Ensure you are logged in as the `root` user. -1. Download the [CockroachDB archive](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz) for Linux, and extract the binary: - - {% include_cached copy-clipboard.html %} - ~~~ shell - curl -o cockroach-{{ page.release_info.version }}.linux-amd64.tgz https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.linux-amd64.tgz; tar xzvf cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - -1. Copy the binary into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ - - If you get a permissions error, prefix the command with `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Create the Cockroach directory: diff --git a/src/current/v25.2/install-cockroachdb-linux.md b/src/current/v25.2/install-cockroachdb-linux.md index 2954fd4b31a..dd09bce443a 100644 --- a/src/current/v25.2/install-cockroachdb-linux.md +++ b/src/current/v25.2/install-cockroachdb-linux.md @@ -25,10 +25,21 @@ Use one of the options below to install CockroachDB. To upgrade an existing clus

Download the binary

- {% include {{ page.version.version }}/misc/linux-binary-prereqs.md %} +

The CockroachDB binary for Linux requires glibc, libncurses, and tzdata, which are found by default on nearly all Linux distributions.

  1. -

    Visit Releases to download the CockroachDB archive for the architecture of your Linux host. The archive contains the cockroach binary and the supporting libraries that are used to provide spatial features. Extract the archive and optionally copy the cockroach binary into your PATH so you can execute cockroach commands from any shell. If you get a permission error, use sudo.

    +

    Visit Releases to download the CockroachDB archive for the architecture of your Linux host. The archive contains the cockroach binary and the supporting libraries that are used to provide spatial features. Follow the steps shown below to install the cockroach binary into your PATH so you can execute cockroach commands from any shell.

    +
      +
    1. + Download the binary you want from the Releases page. +
      2. +
    2. Extract the archive: + 
      tar-xz cockroach-{VERSION}.linux-{ARCHITECTURE}.tgz
      +
      3. +
    3. Copy the cockroach binary into your PATH: + 
      cp -i cockroach-{VERSION}.linux-{ARCHITECTURE}/cockroach /usr/local/bin/
      +
      4. +
    2. Note:

    If you plan to use CockroachDB's spatial features, you must complete the following steps. Otherwise, your installation is now complete.

    @@ -49,12 +60,12 @@ Use one of the options below to install CockroachDB. To upgrade an existing clus icon/buttons/copy
    - 
    cp -i cockroach-{{ page.release_info.version }}.linux-{ARCHITECTURE}/lib/libgeos.so /usr/local/lib/cockroach/
    + 
    cp -i cockroach-{VERSION}.linux-{ARCHITECTURE}/lib/libgeos.so /usr/local/lib/cockroach/
    icon/buttons/copy
    - 
    cp -i cockroach-{{ page.release_info.version }}.linux-{ARCHITECTURE}/lib/libgeos_c.so /usr/local/lib/cockroach/
    + 
    cp -i cockroach-{VERSION}.linux-{ARCHITECTURE}/lib/libgeos_c.so /usr/local/lib/cockroach/

    If you get a permissions error, prefix the command with sudo.

diff --git a/src/current/v25.2/performance-benchmarking-with-tpcc-large.md b/src/current/v25.2/performance-benchmarking-with-tpcc-large.md index a7ae948a92a..f8156443070 100644 --- a/src/current/v25.2/performance-benchmarking-with-tpcc-large.md +++ b/src/current/v25.2/performance-benchmarking-with-tpcc-large.md @@ -173,19 +173,7 @@ CockroachDB comes with a number of [built-in workloads]({% link {{ page.version. 1. SSH to the VM where you want to run TPC-C. -1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ - - If you get a permissions error, prefix the command with `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Import the TPC-C dataset: From 21231a6265d40a292e00a331610425d67fe06482 Mon Sep 17 00:00:00 2001 From: Rich Loveland Date: Wed, 4 Jun 2025 10:31:45 -0400 Subject: [PATCH 3/3] Make the changes everywhere else in v25.2 docs --- .../insecure-test-load-balancing.md | 16 +-------- .../prod-deployment/secure-scale-cluster.md | 16 +-------- .../prod-deployment/secure-start-nodes.md | 35 +------------------ .../secure-test-load-balancing.md | 16 +-------- ...deploy-cockroachdb-on-premises-insecure.md | 16 +-------- ...erformance-benchmarking-with-tpcc-large.md | 4 +-- ...rformance-benchmarking-with-tpcc-medium.md | 18 ++-------- ...erformance-benchmarking-with-tpcc-small.md | 18 ++-------- 8 files changed, 10 insertions(+), 129 deletions(-) diff --git a/src/current/_includes/v25.2/prod-deployment/insecure-test-load-balancing.md b/src/current/_includes/v25.2/prod-deployment/insecure-test-load-balancing.md index a4e104dda4e..130e032cae0 100644 --- a/src/current/_includes/v25.2/prod-deployment/insecure-test-load-balancing.md +++ b/src/current/_includes/v25.2/prod-deployment/insecure-test-load-balancing.md @@ -12,21 +12,7 @@ For comprehensive guidance on benchmarking CockroachDB with TPC-C, see [Performa This should be a machine that is not running a CockroachDB node. -1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - -1. Copy the binary into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ - - If you get a permissions error, prefix the command with `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Use the [`cockroach workload`]({% link {{ page.version.version }}/cockroach-workload.md %}) command to load the initial schema and data, pointing it at the IP address of the load balancer: diff --git a/src/current/_includes/v25.2/prod-deployment/secure-scale-cluster.md b/src/current/_includes/v25.2/prod-deployment/secure-scale-cluster.md index 249fca13cca..6e5a8a4e24d 100644 --- a/src/current/_includes/v25.2/prod-deployment/secure-scale-cluster.md +++ b/src/current/_includes/v25.2/prod-deployment/secure-scale-cluster.md @@ -12,21 +12,7 @@ For each additional node you want to add to the cluster, complete the following 1. SSH to the machine where you want the node to run. -1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - -1. Copy the binary into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ - - If you get a permissions error, prefix the command with `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Run the [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) 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). diff --git a/src/current/_includes/v25.2/prod-deployment/secure-start-nodes.md b/src/current/_includes/v25.2/prod-deployment/secure-start-nodes.md index 2706ec0d236..287d07850bd 100644 --- a/src/current/_includes/v25.2/prod-deployment/secure-start-nodes.md +++ b/src/current/_includes/v25.2/prod-deployment/secure-start-nodes.md @@ -59,40 +59,7 @@ After completing these steps, nodes will not yet be live. They will complete the 1. SSH to the machine where you want the node to run. Ensure you are logged in as the `root` user. -1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - -1. Copy the binary into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ - - If you get a permissions error, prefix the command with `sudo`. - -1. CockroachDB uses custom-built versions of the [GEOS]({% link {{ page.version.version }}/architecture/glossary.md %}#geos) libraries. Copy these libraries to the location where CockroachDB expects to find them: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ mkdir -p /usr/local/lib/cockroach - ~~~ - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/lib/libgeos.so /usr/local/lib/cockroach/ - ~~~ - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/lib/libgeos_c.so /usr/local/lib/cockroach/ - ~~~ - - If you get a permissions error, prefix the command with `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Create the Cockroach directory: diff --git a/src/current/_includes/v25.2/prod-deployment/secure-test-load-balancing.md b/src/current/_includes/v25.2/prod-deployment/secure-test-load-balancing.md index 3c8036fecf5..26d2cc17e2d 100644 --- a/src/current/_includes/v25.2/prod-deployment/secure-test-load-balancing.md +++ b/src/current/_includes/v25.2/prod-deployment/secure-test-load-balancing.md @@ -10,21 +10,7 @@ For comprehensive guidance on benchmarking CockroachDB with TPC-C, refer to [Per This should be a machine that is not running a CockroachDB node, and it should already have a `certs` directory containing `ca.crt`, `client.root.crt`, and `client.root.key` files. -1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - -1. Copy the binary into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ - - If you get a permissions error, prefix the command with `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Use the [`cockroach workload`]({% link {{ page.version.version }}/cockroach-workload.md %}) command to load the initial schema and data, pointing it at the IP address of the load balancer: diff --git a/src/current/v25.2/deploy-cockroachdb-on-premises-insecure.md b/src/current/v25.2/deploy-cockroachdb-on-premises-insecure.md index b7f93adfaa4..6579266a03c 100644 --- a/src/current/v25.2/deploy-cockroachdb-on-premises-insecure.md +++ b/src/current/v25.2/deploy-cockroachdb-on-premises-insecure.md @@ -60,21 +60,7 @@ Each CockroachDB node is an equally suitable SQL gateway to your cluster, but to $ apt-get install haproxy ~~~ -1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), and extract the binary: - - {% include_cached copy-clipboard.html %} - ~~~ shell - tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - -1. Copy the binary into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ - - If you get a permissions error, prefix the command with `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Run the [`cockroach gen haproxy`]({% link {{ page.version.version }}/cockroach-gen.md %}) command, specifying the address of any CockroachDB node: diff --git a/src/current/v25.2/performance-benchmarking-with-tpcc-large.md b/src/current/v25.2/performance-benchmarking-with-tpcc-large.md index f8156443070..daa4accbb6b 100644 --- a/src/current/v25.2/performance-benchmarking-with-tpcc-large.md +++ b/src/current/v25.2/performance-benchmarking-with-tpcc-large.md @@ -87,9 +87,7 @@ CockroachDB requires TCP communication on two ports: 1. SSH to the first VM where you want to run a CockroachDB node. -1. Visit [Releases]({% link releases/index.md %}?filters=windows) to download and CockroachDB for Linux. Select the architecture of the VM, either Intel or ARM. Releases are rolled out gradually, so the latest version may not yet be available. - -1. Extract the binary you downloaded, then optionally copy it into a location in your `PATH`. If you choose to copy it into a system directory, you may need to use `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Start CockroachDB using the [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) command: diff --git a/src/current/v25.2/performance-benchmarking-with-tpcc-medium.md b/src/current/v25.2/performance-benchmarking-with-tpcc-medium.md index f854ee7e730..17433899aba 100644 --- a/src/current/v25.2/performance-benchmarking-with-tpcc-medium.md +++ b/src/current/v25.2/performance-benchmarking-with-tpcc-medium.md @@ -87,9 +87,7 @@ CockroachDB requires TCP communication on two ports: 1. SSH to the first VM where you want to run a CockroachDB node. -1. Visit [Releases]({% link releases/index.md %}?filters=windows) to download and CockroachDB for Linux. Select the architecture of the VM, either Intel or ARM. Releases are rolled out gradually, so the latest version may not yet be available. - -1. Extract the binary you downloaded, then optionally copy it into a location in your `PATH`. If you choose to copy it into a system directory, you may need to use `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Run the [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) command: @@ -165,19 +163,7 @@ CockroachDB comes with a number of [built-in workloads]({% link {{ page.version. 1. SSH to the VM where you want to run TPC-C. -1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ - - If you get a permissions error, prefix the command with `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Import the TPC-C dataset: diff --git a/src/current/v25.2/performance-benchmarking-with-tpcc-small.md b/src/current/v25.2/performance-benchmarking-with-tpcc-small.md index 8762ce72d55..a6c32eef6a4 100644 --- a/src/current/v25.2/performance-benchmarking-with-tpcc-small.md +++ b/src/current/v25.2/performance-benchmarking-with-tpcc-small.md @@ -76,9 +76,7 @@ CockroachDB requires TCP communication on two ports: 1. SSH to the first VM where you want to run a CockroachDB node. -1. Visit [Releases]({% link releases/index.md %}?filters=windows) to download and CockroachDB for Linux. Select the architecture of the VM, either Intel or ARM. Releases are rolled out gradually, so the latest version may not yet be available. - -1. Extract the binary you downloaded, then optionally copy it into a location in your `PATH`. If you choose to copy it into a system directory, you may need to use `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Run the [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) command: @@ -106,19 +104,7 @@ CockroachDB comes with a number of [built-in workloads]({% link {{ page.version. 1. SSH to the VM where you want to run TPC-C. -1. Download [CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}), extract the binary, and copy it into the `PATH`: - - {% include_cached copy-clipboard.html %} - ~~~ shell - tar -xz cockroach-{{ page.release_info.version }}.linux-amd64.tgz - ~~~ - - {% include_cached copy-clipboard.html %} - ~~~ shell - $ cp -i cockroach-{{ page.release_info.version }}.linux-amd64/cockroach /usr/local/bin/ - ~~~ - - If you get a permissions error, prefix the command with `sudo`. +1. [Install CockroachDB for Linux]({% link {{ page.version.version }}/install-cockroachdb-linux.md %}). 1. Import the TPC-C dataset: