Skip to content

Commit

Permalink
Add details about latest release to install and upgrade pages, use a …
Browse files Browse the repository at this point in the history
…common include, copyedits
  • Loading branch information
mdlinville committed Aug 11, 2024
1 parent b5f910c commit d603d1b
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 64 deletions.
21 changes: 21 additions & 0 deletions src/current/_includes/latest-release-details.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{% comment %}
This is included by v24.2+ install-cockroachdb-*.md upgrade-cockroach-version.md
{% endcomment %}

{% assign rd = site.data.versions | where_exp: "rd", "rd.major_version == page.version.version" | first %}
{% assign latest = site.data.releases | where_exp: "latest", "latest.major_version == page.version.version" | sort: "release_date" | last %}

{% assign released = false %}
{% assign skippable = false %}
{% if rd.release_date != "N/A" and rd.maint_supp_exp_date != "N/A" %}
{% assign released = true %}
{% if rd.asst_supp_exp_date == "N/A" %}
{% assign skippable = true %}
{% endif %}
{% endif %}

CockroachDB {{ latest.major_version }} is the latest [supported]({% link releases/release-support-policy.md %}) production release.{% if skippable == true %} It is an [Innovation release]({% link releases/release-support-policy.md %}#innovation-releases) that is optional for CockroachDB {{ site.data.products.dedicated }} and CockroachDB {{ site.data.products.core }} but required for CockroachDB {{ site.data.products.serverless }}.{% else %} It is a required [Regular release]({% link releases/release-support-policy.md %}#regular-releases).{% endif %} To learn more, refer to [CockroachDB {{ latest.major_version }} Release Notes](https://cockroachlabs.com/docs/releases/{{ latest.major_version }}.html).

{% if page.version.version != blank and page.version.version != latest.major_version %}
**This page refers to CockroachDB {{ page.version.version }}, not {{ latest.major_version }}.**
{% endif %}
27 changes: 0 additions & 27 deletions src/current/_includes/v24.2/release-terminology.md

This file was deleted.

2 changes: 1 addition & 1 deletion src/current/_includes/windows_warning.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{{site.data.alerts.callout_danger}}
The CockroachDB executable for Windows is experimental and not suitable for production deployments. Windows 8 or higher is required.
CockroachDB executable for Windows is experimental and not suitable for production deployments. Windows 8 or higher is required.
{{site.data.alerts.end}}
10 changes: 4 additions & 6 deletions src/current/releases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,13 +177,11 @@ The following releases and their descriptions represent proposed plans that are
v.major_version: {{ v.major_version }}<br />
has_lts_releases: {{ has_lts_releases }}<br />
v.release_date: {{ v.release_date }}<br />
v.initial_lts_release_date: {{ v.initial_lts_release_date }}<br />{% endif %}

{% if skippable == true %}
CockroachDB {{ v.major_version }} is an [Innovation release](#major-releases), which is optional for CockroachDB {{ site.data.products.dedicated }} and CockroachDB {{ site.data.products.core }} cluster upgrades.
{% else %}
CockroachDB {{ v.major_version }} is a [Regular release](#major-releases) for all clusters, which is required for all CockroachDB cluster upgrades.
v.initial_lts_release_date: {{ v.initial_lts_release_date }}<br />
{% endif %}

{% include {{ page.version.version }}/latest-release-details.md %}

Refer to [Major release types](#major-releases) before installing or upgrading for release support details.
{% comment %}Some old pages don't have feature highlights and won't get LTS{% endcomment %}
{% unless v.major_version == 'v1.0' or
Expand Down
8 changes: 2 additions & 6 deletions src/current/v24.2/install-cockroachdb-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ key: install-cockroachdb.html
docs_area: deploy
---

## Overview

{% include {{ page.version.version }}/release-terminology.md %}

<div id="os-tabs" class="clearfix">
<a href="install-cockroachdb-mac.html"><button id="mac" data-eventcategory="buttonClick-doc-os" data-eventaction="mac">Mac</button></a>
<button id="linux" class="current" data-eventcategory="buttonClick-doc-os" data-eventaction="linux">Linux</button>
Expand All @@ -19,9 +15,9 @@ docs_area: deploy

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

See [Release Notes](https://www.cockroachlabs.com/docs/releases/{{page.version.version}}) for what's new in the latest release, {{ page.release_info.version }}. To upgrade to this release from an older version, see [Cluster Upgrade](https://www.cockroachlabs.com/docs/releases/{{page.version.version}}/upgrade-cockroach-version).
{% include latest-release-details.md %}

Use one of the options below to install CockroachDB.
Use one of the options below to install CockroachDB. To upgrade an existing cluster, refer to [Upgrade to {{ page.version.version }}]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}).

To install a FIPS-compliant CockroachDB binary, refer to [Install a FIPS-compliant build of CockroachDB]({% link {{ page.version.version }}/fips.md %}).

Expand Down
23 changes: 12 additions & 11 deletions src/current/v24.2/install-cockroachdb-mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ key: install-cockroachdb.html
docs_area: deploy
---

## Overview

{% include {{ page.version.version }}/release-terminology.md %}

<div id="os-tabs" class="clearfix">
<button id="mac" class="current" data-eventcategory="buttonClick-doc-os" data-eventaction="mac">Mac</button>
<a href="install-cockroachdb-linux.html"><button id="linux" data-eventcategory="buttonClick-doc-os" data-eventaction="linux">Linux</button></a>
Expand All @@ -19,20 +15,19 @@ docs_area: deploy

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

See [Release Notes](https://www.cockroachlabs.com/docs/releases/{{page.version.version}}) for what's new in the latest release, {{ page.release_info.version }}. To upgrade to this release from an older version, see [Cluster Upgrade](https://www.cockroachlabs.com/docs/releases/{{page.version.version}}/upgrade-cockroach-version).

{% comment %}v22.2.0+{% endcomment %}
{{site.data.alerts.callout_danger}}
<p>On macOS ARM systems, <a href="{% link {{ page.version.version }}/spatial-data-overview.md %}">spatial features</a> are disabled due to an issue with macOS code signing for the <a href="https://libgeos.org/">GEOS</a> libraries. Users needing spatial features on an ARM Mac may instead <a href="https://developer.apple.com/documentation/virtualization/running_intel_binaries_in_linux_vms_with_rosetta">use Rosetta</a> to <a href="#install-binary">run the Intel binary</a> or use the <a href="#use-docker">Docker image</a> distribution. Refer to <a href="https://github.com/cockroachdb/cockroach/issues/93161">GitHub tracking issue</a> for more information.</p>
{{site.data.alerts.end}}
{% include latest-release-details.md %}

{% capture arch_note_homebrew %}<p>For CockroachDB v22.2.x and above, Homebrew installs binaries for your system architecture, either Intel or ARM (<a href="https://support.apple.com/HT211814">Apple Silicon</a>).</p><p>For previous releases, Homebrew installs Intel binaries. Intel binaries can run on ARM systems, but with a significant reduction in performance. CockroachDB on ARM for macOS is <b>experimental</b> and is not yet qualified for production use and not eligible for support or uptime SLA commitments.</p>{% endcapture %}

{% capture arch_note_binaries %}<p>For CockroachDB v22.2.x and above, download the binaries for your system architecture, either Intel or ARM (<a href="https://support.apple.com/en-us/HT211814">Apple Silicon</a>).</p><p>For previous releases, download Intel binaries. Intel binaries can run on ARM systems, but with a significant reduction in performance. CockroachDB on ARM for macOS is <b>experimental</b> and is not yet qualified for production use and not eligible for support or uptime SLA commitments.</p>{% endcapture %}

{% capture arch_note_docker %}<p>For CockroachDB v22.2.beta-5 and above, Docker images are <a href="https://docs.docker.com/build/building/multi-platform/">multi-platform images</a> that contain binaries for both Intel and ARM (<a href="https://support.apple.com/HT211814">Apple Silicon</a>). Multi-platform images do not take up additional space on your Docker host.</p><p>Docker images for previous releases contain Intel binaries only. Intel binaries can run on ARM systems, but with a significant reduction in performance.</p><p>CockroachDB on ARM for macOS is <b>experimental</b> and is not yet qualified for production use and not eligible for support or uptime SLA commitments.</p>{% endcapture %}

Use one of the options below to install CockroachDB.
{{site.data.alerts.callout_info}}
CockroachDB on macOS is experimental and not suitable for production deployments.
{{site.data.alerts.end}}

Use one of the options below to install CockroachDB. To upgrade an existing cluster, refer to [Upgrade to {{ page.version.version }}]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}). For limitations specific to geospatial features, refer to [Limitations](#limitations).

<div id="use-homebrew" markdown="1" class="install-option">

Expand Down Expand Up @@ -234,3 +229,9 @@ CockroachDB runtimes built for the ARM architecture have the following limitatio
{% include {{ page.version.version }}/misc/install-next-steps.html %}

{% include {{ page.version.version }}/misc/diagnostics-callout.html %}

## Limitations

{% comment %}v22.2.0+{% endcomment %}

On macOS ARM systems, [spatial features]{% link {{ page.version.version }}/spatial-data-overview.md %}) are disabled due to an issue with macOS code signing for the <a href="https://libgeos.org/">GEOS</a> libraries. Users needing spatial features on an ARM Mac may instead [run the Intel binary](#install-the-binary) or use the[Docker container image](#use-docker). Refer to [GitHub issue #93161](https://github.com/cockroachdb/cockroach/issues/93161)</a> for more information.
12 changes: 4 additions & 8 deletions src/current/v24.2/install-cockroachdb-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ key: install-cockroachdb.html
docs_area: deploy
---

## Overview

{% include {{ page.version.version }}/release-terminology.md %}

<div id="os-tabs" class="clearfix">
<a href="install-cockroachdb-mac.html"><button id="mac" data-eventcategory="buttonClick-doc-os" data-eventaction="mac">Mac</button></a>
<a href="install-cockroachdb-linux.html"><button id="linux" data-eventcategory="buttonClick-doc-os" data-eventaction="linux">Linux</button></a>
Expand All @@ -19,15 +15,15 @@ docs_area: deploy

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

See [Release Notes](https://www.cockroachlabs.com/docs/releases/{{page.version.version}}) for what's new in the latest release, {{ page.release_info.version }}. To upgrade to this release from an older version, see [Cluster Upgrade](https://www.cockroachlabs.com/docs/releases/{{page.version.version}}/upgrade-cockroach-version).
{% include latest-release-details.md %}

Use one of the options below to install CockroachDB.
{% include windows_warning.md %}

Use one of the options below to install CockroachDB. To upgrade an existing cluster, refer to [Upgrade to {{ page.version.version }}]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}).

<section id="download-the-binary-windows" markdown="1" class="install-option">
<h2 id="install-binary">Download the executable</h2>

{% include windows_warning.md %}

1. Using PowerShell, run the following script to download the [CockroachDB {{ page.release_info.version }} archive for Windows](https://binaries.cockroachdb.com/cockroach-{{ page.release_info.version }}.windows-6.2-amd64.zip) and copy the binary into your `PATH`:

{% include_cached copy-clipboard.html %}
Expand Down
8 changes: 3 additions & 5 deletions src/current/v24.2/upgrade-cockroach-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,11 @@ docs_area: manage

Because of CockroachDB's [multi-active availability]({% link {{ page.version.version }}/multi-active-availability.md %}) design, you can perform a "rolling upgrade" of your CockroachDB cluster. This means that you can upgrade nodes one at a time without interrupting the cluster's overall health and operations.

This page describes how to upgrade to the latest **{{ page.version.version }}** release, **{{ latest.release_name }}**{% if latest.lts == true %}&nbsp;([LTS]({% link releases/release-support-policy.md %}#support-types)){% endif %}. To upgrade CockroachDB on Kubernetes, refer to [single-cluster]({% link {{ page.version.version }}/upgrade-cockroachdb-kubernetes.md %}) or [multi-cluster]({% link {{ page.version.version }}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.md %}#upgrade-the-cluster) instead.
This page describes how to upgrade to the latest **{{ page.version.version }}** release, **{{ latest.release_name }}**{% if latest.lts == true %}&nbsp;([LTS]({% link releases/release-support-policy.md %}#support-types)){% endif %}.

## Terminology
{% include latest-release-details.md %}

Before upgrading, review the CockroachDB [release](../releases/) terminology:

{% include release-terminology.md %}
To upgrade CockroachDB on Kubernetes, refer to [single-cluster]({% link {{ page.version.version }}/upgrade-cockroachdb-kubernetes.md %}) or [multi-cluster]({% link {{ page.version.version }}/orchestrate-cockroachdb-with-kubernetes-multi-cluster.md %}#upgrade-the-cluster) instead.

## Step 1. Verify that you can upgrade

Expand Down

0 comments on commit d603d1b

Please sign in to comment.