Skip to content

Commit

Permalink
Dan's feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
mdlinville committed Nov 7, 2024
1 parent 4802228 commit 63a02f8
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 8 deletions.
10 changes: 8 additions & 2 deletions src/current/_includes/common/upgrade/finalize-cloud.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
To finalize a major-version upgrade manually,
To finalize a major-version upgrade of CockroachDB {{ site.data.products.advanced }} or CockroachDB {{ site.data.products.standard }} manually,

1. Click the cluster's name to open the **Cluster Details** page.
1. At the top of the page, click **Finalize**.

When finalization begins, a series of migration jobs run to enable certain types of features and changes in the new major version that cannot be rolled back. These include changes to system schemas, indexes, and descriptors, and enabling certain types of improvements and new features. These temporary limitations are listed in the release notes for the new major version. Until the upgrade is finalized, these features and functions will not be available and the command `SHOW CLUSTER SETTING version` will continue to report the previous major version.
When finalization begins, a series of migration jobs run to enable certain types of features and changes in the new major version that cannot be rolled back. These include changes to system schemas, indexes, and descriptors, and enabling certain types of improvements and new features.

Until the upgrade is finalized, these features and functions will not be available, and the command `SHOW CLUSTER SETTING version` will continue to report the previous major version. Features that are available only after finalization are listed in the release notes for the new major version.

You can monitor the process of finalization in the CockroachDB {{ site.data.products.cloud }} [Jobs page]({% link cockroachcloud/jobs-page.md %}). Migration jobs have names in the format `{major-version}-{migration-id}`. If a migration job fails or stalls, Cockroach Labs can use the migration ID to help diagnose and troubleshoot the problem. Each major version has a unique set of migration jobs and IDs.

When finalization is complete, the **Cluster List** and **Cluster Details** page report the new version, and you can no longer roll back to the previous major version.

{{site.data.alerts.callout_info}}
CockroachDB {{ site.data.products.basic }} clusters are upgraded automatically and finalization is not required.
{{site.data.alerts.end}}
Original file line number Diff line number Diff line change
@@ -1 +1 @@
To roll back a patch upgrade, repeat the steps in [Perform a patch upgrade](#perform-a-patch-upgrade), but replace the newer binary with the older version.
To roll back a patch upgrade, repeat the steps in [Perform a patch upgrade](#perform-a-patch-upgrade), but replace the newer binary with the older binary.
10 changes: 7 additions & 3 deletions src/current/_includes/common/upgrade/rollback-cloud.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
To roll back to the previous major version before the upgrade is finalized automatically:
To roll back an CockroachDB {{ site.data.products.advanced }} cluster to the previous major version before the upgrade is finalized automatically:

1. Click the cluster's name to open the **Cluster Details** page.
1. At the top of the page, click **Roll back**.

A CockroachDB {{ site.data.products.standard }} or {{ site.data.products.basic }} cluster remains fully available while it is rolled back. For a multi-node CockroachDB {{ site.data.products.advanced }} cluster, nodes are rolled back one at a time in a rolling fashion so the cluster remains available, with one node unavailable at a time. A single-node CockroachDB {{ site.data.products.advanced }} cluster will be unavailable while the cluster is rolled back and restarted. Like an upgrade, a rollback must be finalized.
1. Like a major-version upgrade, a rollback must be [finalized](#finalize-a-major-version-upgrade-manually). When the rollback is finalized, the rollback is complete.
A CockroachDB {{ site.data.products.standard }} cluster remains fully available while it is rolled back. For a multi-node CockroachDB {{ site.data.products.advanced }} cluster, nodes are rolled back one at a time in a rolling fashion so the cluster remains available, with one node unavailable at a time. A single-node CockroachDB {{ site.data.products.advanced }} cluster will be unavailable while the cluster is rolled back and restarted. Like an upgrade, a rollback must be finalized.
1. Finalization of a rollback is not required on CockroachDB {{ site.data.products.advanced }} or CockroachDB {{ site.data.products.standard }} clusters.

{{site.data.alerts.callout_info}}
Rolling back a major-version upgrade is not supported on {{ site.data.products.basic }}.
{{site.data.alerts.end}}
8 changes: 6 additions & 2 deletions src/current/cockroachcloud/upgrade-cockroach-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,13 @@ This page describes how major-version and patch upgrades work and shows how to u

### Availability during an upgrade

For CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }}, a cluster's resources are not impacted by an ongoing upgrade.
For CockroachDB {{ site.data.products.standard }} and {{ site.data.products.basic }}, a cluster remains available during an upgrade.

For CockroachDB {{ site.data.products.advanced }}, nodes are upgraded one at a time in a rolling fashion, and the cluster's resources are reduced as each node is upgraded. If you have [configured a maintenance window]({% link cockroachcloud/advanced-cluster-management.md %}) for a CockroachDB {{ site.data.products.advanced }} cluster, automatic patch upgrades are applied during the maintenance window. Major-version upgrades must be initiated manually.
For CockroachDB {{ site.data.products.advanced }}, nodes are upgraded one at a time in a rolling fashion. Multi-node clusters will remain available during the upgrade, but will have reduced capacity as each node restarts. Single-node clusters will be unavailable while the node restarts.

### Upgrades and maintenance windows

If you have [configured a maintenance window]({% link cockroachcloud/advanced-cluster-management.md %}) for a CockroachDB {{ site.data.products.advanced }} cluster, automatic patch upgrades are applied during the maintenance window. Major-version upgrades must be initiated manually.

{{site.data.alerts.callout_info}}
Maintenance operations that are critical for cluster security or stability may be applied outside of the maintenance window, and upgrades that begin in a maintenance window may not always be completed by the end of the window.
Expand Down

0 comments on commit 63a02f8

Please sign in to comment.