Skip to content

Commit

Permalink
Fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mdlinville committed Nov 6, 2024
1 parent 5f01606 commit ead89d8
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Before beginning a major-version upgrade:

1. **CockroachDB {{ site.data.products.advanced }}**: Verify the overall health of your cluster using the [DB Console]({% link cockroachcloud/tools-page#access-the-db-console.md %}):
1. **CockroachDB {{ site.data.products.advanced }}**: Verify the overall health of your cluster using the [DB Console]({% link cockroachcloud/tools-page.md %}#access-the-db-console.md):
- Under **Node Status**, make sure all nodes that should be live are listed as such. If any nodes are unexpectedly listed as `SUSPECT` or `DEAD`, identify why the nodes are offline and either restart them or [decommission]({% link {{ site.current_cloud_version }}/node-shutdown.md %}?filters=decommission#remove-nodes) them before beginning your upgrade. If there are `DEAD` and non-decommissioned nodes in your cluster, the upgrade cannot be finalized.

If any node is not fully decommissioned, try the following:
Expand Down
2 changes: 1 addition & 1 deletion src/current/_includes/common/upgrade/upgrade-high-level.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ At a high level, a cluster upgrade involves the following steps, which are detai
1. Restart the `cockroach` process and verify that the node has rejoined the cluster.
1. When all nodes have rejoined the cluster:
1. For a patch upgrade within the same major version, the upgrade is complete.
1. For a major-version upgrade, the upgrade is not complete until it is [finalized](#finalize-a-major-version-upgrade). Auto-finalization is enabled by default, and begins as soon as all nodes have rejoined the cluster using the new binary. If you need the ability to [roll back a major-version upgrade](#roll-back-a-major-version-upgrade), you can disable auto-finalization and finalize the upgrade manually. Certain features and performance improvements, such as those that require changes to system schemas or objects, are not available until the upgrade is finalized. Refer to the {% if page.path contains 'cockroachcloud' %} [{{ site.current_cloud_version }} Release Notes]({% link releases/{{ page.version.version }}.md %}) {% else %}[{{ page.version.version }} Release Notes]({% link releases/{{ page.version.version }}.md %}).{% endif %}.
1. For a major-version upgrade, the upgrade is not complete until it is [finalized](#finalize-a-major-version-upgrade). Auto-finalization is enabled by default, and begins as soon as all nodes have rejoined the cluster using the new binary. If you need the ability to [roll back a major-version upgrade](#roll-back-a-major-version-upgrade), you can disable auto-finalization and finalize the upgrade manually. Certain features and performance improvements, such as those that require changes to system schemas or objects, are not available until the upgrade is finalized. Refer to the {% if page.path contains 'cockroachcloud' %} [{{ site.current_cloud_version }} Release Notes]({% link releases/{{ site.current_cloud_version }}.md %}) {% else %}[{{ page.version.version }} Release Notes]({% link releases/{{ page.version.version }}.md %}).{% endif %}.
9 changes: 9 additions & 0 deletions src/current/_includes/v24.2/recommend-backups-for-upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{% if page.path contains "cockroachcloud" %}
[Managed backups]({% link cockroachcloud/managed-backups.md %}) are automated backups of CockroachDB {{ site.data.products.cloud }} clusters that are stored by Cockroach Labs in cloud storage. By default, Cockroach Labs takes and retains managed backups in all Cloud clusters.

When upgrading to a major release, you can optionally [take a self-managed backup]({% link cockroachcloud/take-and-restore-self-managed-backups.md %}) of your cluster to your own cloud storage, as an extra layer of protection in case the upgrade leads to issues.
{% else %}
CockroachDB is designed with high fault tolerance. However, taking regular backups of your data is an operational best practice for [disaster recovery]({% link {{ page.version.version }}/disaster-recovery-planning.md %}) planning.

When upgrading to a new major version, **we recommend [taking a self-managed backup]({% link {{ page.version.version }}/backup-and-restore-overview.md %}) of your cluster** so that you can [restore the cluster to the previous version]({% link {{ page.version.version }}/restoring-backups-across-versions.md %}#support-for-restoring-backups-into-a-newer-version) if the upgrade leads to issues.
{% endif %}
2 changes: 1 addition & 1 deletion src/current/cockroachcloud/upgrade-cockroach-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This page describes how major-version and patch upgrades work and shows how to u

{% include common/upgrade/overview.md %}

{% include_cached {{ site.current_cloud_version }}/upgrade_requirements.md %}
{% include_cached {{ site.current_cloud_version }}/upgrade-requirements.md %}

{% include common/upgrade/upgrade-high-level.md %}

Expand Down

0 comments on commit ead89d8

Please sign in to comment.