diff --git a/src/current/_includes/latest-release-details.md b/src/current/_includes/latest-release-details.md new file mode 100644 index 00000000000..47c2a8c0f1a --- /dev/null +++ b/src/current/_includes/latest-release-details.md @@ -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 %} diff --git a/src/current/_includes/v24.2/release-terminology.md b/src/current/_includes/v24.2/release-terminology.md deleted file mode 100644 index 36a67e6588c..00000000000 --- a/src/current/_includes/v24.2/release-terminology.md +++ /dev/null @@ -1,27 +0,0 @@ -{% comment %} - This is included by install-cockroachdb.md and 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 %} - -- A new [major release]({% link releases/release-support-policy.md %}) is performed multiple times per year. The major version number indicates the year of release followed by the release number, starting with 1. For example, the latest major release is {{ actual_latest_prod.major_version }}. Releases are classified by their [support type]({% link releases/release-support-policy.md %}#support-types), which determines the duration of each [support phase]({% link releases/release-support-policy.md %}#support-phases). **CockroachDB {{ latest.major_version }} is {% if released == false %}currently designated as {% endif %}{% if skippable == true %}an optional Innovation release{% else %}a required Regular release{% endif %}{% if released == false %} that is still in development and not yet supported. This designation is subject to change{% endif %}.** - - - [Regular releases]({% link releases/index.md %}#regular-releases) are released twice a year and are required upgrades for all clusters. Initially, a Regular release series has GA Support. After the series demonstrates a continuously high level of stability and performance, new patch releases are designated as LTS releases, which have an extended support window for each support phase. An LTS release is supported for 3 years from its release date. All major versions prior to v24.2 are Regular releases. - - [Innovation releases]({% link releases/release-support-policy.md %}#innovation-releases) are released twice a year, in between Regular releases. v24.2 is the first innovation release. Innovation releases are optional and can be skipped in favor of the next Regular release. An Innovation release is supported for 6 months and have no [Assistance support]({% link releases/release-support-policy.md %}#support-types) phase. A cluster running an Innovation release must be upgraded to the next Regular release at the end of its support period. -- Each [supported](https://www.cockroachlabs.com/docs/releases/release-support-policy) major release is maintained across *patch releases* that contain improvements including performance or security enhancements and bug fixes. Each patch release increments the major version number with its corresponding patch number. For example, patch releases of {{ actual_latest_prod.major_version }} use the format {{ actual_latest_prod.major_version }}.x. -- All major and patch releases are suitable for production environments, and are therefore considered "production releases". For example, the latest production release is {{ actual_latest_prod.release_name }}. -- Prior to an upcoming major release, alpha, beta, and release candidate (RC) binaries are made available for users who need early access to a feature before it is available in a production release. These releases append the terms `alpha`, `beta`, or `rc` to the version number. These "testing releases" are not suitable for production environments and are not eligible for support or uptime SLA commitments. For more information, refer to the [Release Support Policy](https://www.cockroachlabs.com/docs/releases/release-support-policy). - -{{site.data.alerts.callout_info}} -There are no "minor releases" of CockroachDB. -{{site.data.alerts.end}} diff --git a/src/current/_includes/windows_warning.md b/src/current/_includes/windows_warning.md index 4b43e8e336c..5217edd8b71 100644 --- a/src/current/_includes/windows_warning.md +++ b/src/current/_includes/windows_warning.md @@ -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}} diff --git a/src/current/releases/index.md b/src/current/releases/index.md index ead62f8c4a2..d235f9cadfb 100644 --- a/src/current/releases/index.md +++ b/src/current/releases/index.md @@ -177,13 +177,11 @@ The following releases and their descriptions represent proposed plans that are v.major_version: {{ v.major_version }}
has_lts_releases: {{ has_lts_releases }}
v.release_date: {{ v.release_date }}
- v.initial_lts_release_date: {{ v.initial_lts_release_date }}
{% 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 }}
{% 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 diff --git a/src/current/v24.2/install-cockroachdb-linux.md b/src/current/v24.2/install-cockroachdb-linux.md index 7ad82a75d9f..2dff4e3ad46 100644 --- a/src/current/v24.2/install-cockroachdb-linux.md +++ b/src/current/v24.2/install-cockroachdb-linux.md @@ -7,10 +7,6 @@ key: install-cockroachdb.html docs_area: deploy --- -## Overview - -{% include {{ page.version.version }}/release-terminology.md %} -
@@ -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 %}). diff --git a/src/current/v24.2/install-cockroachdb-mac.md b/src/current/v24.2/install-cockroachdb-mac.md index 96b0cd93f85..4884695b23a 100644 --- a/src/current/v24.2/install-cockroachdb-mac.md +++ b/src/current/v24.2/install-cockroachdb-mac.md @@ -7,10 +7,6 @@ key: install-cockroachdb.html docs_area: deploy --- -## Overview - -{% include {{ page.version.version }}/release-terminology.md %} -
@@ -19,12 +15,7 @@ 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}} -

On macOS ARM systems, spatial features are disabled due to an issue with macOS code signing for the GEOS libraries. Users needing spatial features on an ARM Mac may instead use Rosetta to run the Intel binary or use the Docker image distribution. Refer to GitHub tracking issue for more information.

-{{site.data.alerts.end}} +{% include latest-release-details.md %} {% capture arch_note_homebrew %}

For CockroachDB v22.2.x and above, Homebrew installs binaries for your system architecture, either Intel or ARM (Apple Silicon).

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 experimental and is not yet qualified for production use and not eligible for support or uptime SLA commitments.

{% endcapture %} @@ -32,7 +23,11 @@ See [Release Notes](https://www.cockroachlabs.com/docs/releases/{{page.version.v {% capture arch_note_docker %}

For CockroachDB v22.2.beta-5 and above, Docker images are multi-platform images that contain binaries for both Intel and ARM (Apple Silicon). Multi-platform images do not take up additional space on your Docker host.

Docker images for previous releases contain Intel binaries only. Intel binaries can run on ARM systems, but with a significant reduction in performance.

CockroachDB on ARM for macOS is experimental and is not yet qualified for production use and not eligible for support or uptime SLA commitments.

{% 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).
@@ -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 GEOS 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) for more information. diff --git a/src/current/v24.2/install-cockroachdb-windows.md b/src/current/v24.2/install-cockroachdb-windows.md index 3e0bdae4323..9a9af4693bc 100644 --- a/src/current/v24.2/install-cockroachdb-windows.md +++ b/src/current/v24.2/install-cockroachdb-windows.md @@ -7,10 +7,6 @@ key: install-cockroachdb.html docs_area: deploy --- -## Overview - -{% include {{ page.version.version }}/release-terminology.md %} -
@@ -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 %}).

Download the executable

- {% 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 %} diff --git a/src/current/v24.2/upgrade-cockroach-version.md b/src/current/v24.2/upgrade-cockroach-version.md index 025ed42bcff..b51d10c5027 100644 --- a/src/current/v24.2/upgrade-cockroach-version.md +++ b/src/current/v24.2/upgrade-cockroach-version.md @@ -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 %} ([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 %} ([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