-
Notifications
You must be signed in to change notification settings - Fork 476
Add page for updated PCR upgrade info #20729
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 14 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
6020673
Added pcr upgrade page
peachdawnleach 9071e7d
summary length
peachdawnleach 1d98a00
Merge branch 'main' into 20251014-DOC-14967-reader-vc-upgrade
peachdawnleach 0594686
Quick changes from review
peachdawnleach 8a2903c
More changes from review
peachdawnleach a58a053
More changes from review
peachdawnleach eb0cf17
Back/forward port
peachdawnleach 7b46171
Removed broken links
peachdawnleach 91915b6
Updated language
peachdawnleach 62b74c5
Docs review changes
peachdawnleach 0cf55c9
Added code snippets
peachdawnleach bd9b578
Merge branch 'main' into 20251014-DOC-14967-reader-vc-upgrade
peachdawnleach 824bc5a
Fixed terminology
peachdawnleach 937c049
Merge branch '20251014-DOC-14967-reader-vc-upgrade' of github.com:coc…
peachdawnleach c129f84
Final small changes
peachdawnleach 9b38a8c
Broken link
peachdawnleach File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| --- | ||
| title: Upgrade a Cluster Running PCR | ||
| summary: Upgrade your primary and standby clusters when using PCR. | ||
| toc: true | ||
| docs_area: manage | ||
| --- | ||
|
|
||
| To safely perform a major version upgrade on a cluster with [**physical cluster replication (PCR)**]({% link {{ page.version.version }}/physical-cluster-replication-overview.md %}), you must upgrade the standby cluster before the primary cluster to avoid version incompatibility. You cannot replicate data from a cluster on a newer version to a cluster on an older version. | ||
|
|
||
| This page describes the process for safely performing a major version upgrade on a pair of clusters that have PCR enabled. | ||
|
|
||
| {{site.data.alerts.callout_info}} | ||
| The entire standby cluster must be on the same major version as the primary cluster or a major version the primary cluster [can directly upgrade to]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#compatible-versions). Within the primary and standby CockroachDB clusters, the _system virtual cluster (system VC)_ must be at a cluster major version greater than or equal to the _application virtual cluster (app VC)_. | ||
| {{site.data.alerts.end}} | ||
|
|
||
| ## Minor version upgrades | ||
|
|
||
| Minor versions are not relevant when determining PCR compatibility. There is no need to consider PCR compatibility when upgrading to a specific minor version within a major version. | ||
peachdawnleach marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Upgrade primary and standby clusters | ||
|
|
||
| To upgrade your primary and standby clusters: | ||
|
|
||
| 1. Ensure that the virtual clusters on both your primary cluster and your standby cluster are [finalized]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) on the current version before beginning the upgrade process. | ||
|
|
||
| 1. [Upgrade the binaries]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#perform-a-major-version-upgrade) on the standby cluster. On each node of the cluster, replace the binary and restart the node. | ||
|
|
||
| 1. [Connect]({% link {{ page.version.version }}/work-with-virtual-clusters.md %}#connect-to-the-system-virtual-cluster) to the standby cluster's system VC: | ||
|
|
||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ shell | ||
| cockroach sql --url \ | ||
| "postgresql://root@{standby node IP or hostname}:26257?options=-ccluster=system&sslmode=verify-full" \ | ||
| --certs-dir "certs" | ||
| ~~~ | ||
|
|
||
| 1. [Finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) the upgrade on the standby cluster's system VC: | ||
|
|
||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| SET CLUSTER SETTING version '{VERSION}'; | ||
| ~~~ | ||
|
|
||
| {{site.data.alerts.callout_info}} | ||
| If you need to [roll back]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#roll-back-a-major-version-upgrade) an upgrade, you must do so before the upgrade has been finalized. | ||
| {{site.data.alerts.end}} | ||
|
|
||
| 1. Confirm that finalization is complete on the standby cluster's system VC: | ||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| > SHOW CLUSTER SETTING version; | ||
| ~~~ | ||
| 1. [Upgrade the binaries]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#perform-a-major-version-upgrade) on the primary cluster. On each node of the cluster, replace the binary and restart the node. | ||
| 1. [Connect]({% link {{ page.version.version }}/work-with-virtual-clusters.md %}#connect-to-the-system-virtual-cluster) to the primary cluster's system VC: | ||
|
|
||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ shell | ||
| cockroach sql --url \ | ||
| "postgresql://root@{primary node IP or hostname}:26257?options=-ccluster=system&sslmode=verify-full" \ | ||
| --certs-dir "certs" | ||
| ~~~ | ||
|
|
||
| 1. [Finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) the upgrade on the primary cluster's system VC: | ||
|
|
||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| SET CLUSTER SETTING version '{VERSION}'; | ||
| ~~~ | ||
|
|
||
| {{site.data.alerts.callout_info}} | ||
| If you need to [roll back]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#roll-back-a-major-version-upgrade) an upgrade, you must do so before the upgrade has been finalized. Rolling back the upgrade on the primary cluster does not roll back the standby cluster. | ||
| {{site.data.alerts.end}} | ||
|
|
||
| 1. Confirm that finalization is complete on the primary cluster's system VC: | ||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| > SHOW CLUSTER SETTING version; | ||
| ~~~ | ||
| 1. [Connect]({% link {{ page.version.version }}/work-with-virtual-clusters.md %}#connect-to-the-system-virtual-cluster) to the primary cluster's app VC: | ||
|
|
||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ shell | ||
| cockroach sql --url \ | ||
| "postgresql://root@{primary node IP or hostname}:26257?options=-ccluster={app_virtual_cluster_name}&sslmode=verify-full" \ | ||
| --certs-dir "certs" | ||
| ~~~ | ||
|
|
||
| 1. [Finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) the upgrade on the primary cluster's app VC: | ||
|
|
||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| SET CLUSTER SETTING version '{VERSION}'; | ||
| ~~~ | ||
|
|
||
| Upgrading the primary cluster's app VC also upgrades the standby cluster's app VC, since it replicates from the primary. | ||
|
|
||
| 1. Confirm that finalization is complete on the primary cluster's app VC: | ||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| > SHOW CLUSTER SETTING version; | ||
| ~~~ | ||
| ## Upgrade reader VC | ||
| If you have a _reader virtual cluster (reader VC)_, you must drop and recreate it to upgrade after completing the main upgrade process on the primary and standby clusters. Follow these steps to upgrade your reader VC: | ||
| 1. After upgrading the app VC on your primary cluster, wait for the replicated time to pass the time at which the upgrade completed. | ||
| 1. On the standby cluster, stop the reader VC service: | ||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| ALTER VIRTUAL CLUSTER <readervc-name> STOP SERVICE; | ||
| ~~~ | ||
| 1. Drop the reader VC: | ||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| DROP VIRTUAL CLUSTER <readervc-name>; | ||
| ~~~ | ||
| 1. On the standby cluster, re-create the reader VC: | ||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| ALTER VIRTUAL CLUSTER dest-system SET REPLICATION READ VIRTUAL CLUSTER; | ||
| ~~~ | ||
| At this point, the reader VC is on the same version as the standby cluster. | ||
| ## Failover and fast failback during upgrade | ||
| If needed, you can perform a [failover]({% link {{ page.version.version }}/failover-replication.md %}) while upgrading your clusters. | ||
| However, after performing a failover you cannot perform a [fast failback]({% link {{ page.version.version }}/failover-replication.md %}#failback) to the original primary cluster while the standby cluster version is newer than the primary cluster version. This is because you cannot replicate data from a cluster on a newer version to a cluster on an older version. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| --- | ||
| title: Upgrade a Cluster Running PCR | ||
| summary: Upgrade your primary and standby clusters when using PCR. | ||
| toc: true | ||
| docs_area: manage | ||
| --- | ||
|
|
||
| To safely perform a major version upgrade on a cluster with [**physical cluster replication (PCR)**]({% link {{ page.version.version }}/physical-cluster-replication-overview.md %}), you must upgrade the standby cluster before the primary cluster to avoid version incompatibility. You cannot replicate data from a cluster on a newer version to a cluster on an older version. | ||
|
|
||
| This page describes the process for safely performing a major version upgrade on a pair of clusters that have PCR enabled. | ||
|
|
||
| {{site.data.alerts.callout_info}} | ||
| The entire standby cluster must be on the same major version as the primary cluster or a major version the primary cluster [can directly upgrade to]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#compatible-versions). Within the primary and standby CockroachDB clusters, the _system virtual cluster (system VC)_ must be at a cluster major version greater than or equal to the _application virtual cluster (app VC)_. | ||
| {{site.data.alerts.end}} | ||
|
|
||
| ## Minor version upgrades | ||
|
|
||
| Minor versions are not relevant when determining PCR compatibility. There is no need to consider PCR compatibility when upgrading to a specific minor version within a major version. | ||
|
|
||
| ## Upgrade primary and standby clusters | ||
|
|
||
| To upgrade your primary and standby clusters: | ||
|
|
||
| 1. Ensure that the virtual clusters on both your primary cluster and your standby cluster are [finalized]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) on the current version before beginning the upgrade process. | ||
|
|
||
| 1. [Upgrade the binaries]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#perform-a-major-version-upgrade) on the standby cluster. On each node of the cluster, replace the binary and restart the node. | ||
|
|
||
| 1. [Connect]({% link {{ page.version.version }}/work-with-virtual-clusters.md %}#connect-to-the-system-virtual-cluster) to the standby cluster's system VC: | ||
|
|
||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ shell | ||
| cockroach sql --url \ | ||
| "postgresql://root@{standby node IP or hostname}:26257?options=-ccluster=system&sslmode=verify-full" \ | ||
| --certs-dir "certs" | ||
| ~~~ | ||
|
|
||
| 1. [Finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) the upgrade on the standby cluster's system VC: | ||
|
|
||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| SET CLUSTER SETTING version '{VERSION}'; | ||
| ~~~ | ||
|
|
||
| {{site.data.alerts.callout_info}} | ||
| If you need to [roll back]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#roll-back-a-major-version-upgrade) an upgrade, you must do so before the upgrade has been finalized. | ||
| {{site.data.alerts.end}} | ||
|
|
||
| 1. Confirm that finalization is complete on the standby cluster's system VC: | ||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| > SHOW CLUSTER SETTING version; | ||
| ~~~ | ||
| 1. [Upgrade the binaries]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#perform-a-major-version-upgrade) on the primary cluster. On each node of the cluster, replace the binary and restart the node. | ||
| 1. [Connect]({% link {{ page.version.version }}/work-with-virtual-clusters.md %}#connect-to-the-system-virtual-cluster) to the primary cluster's system VC: | ||
|
|
||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ shell | ||
| cockroach sql --url \ | ||
| "postgresql://root@{primary node IP or hostname}:26257?options=-ccluster=system&sslmode=verify-full" \ | ||
| --certs-dir "certs" | ||
| ~~~ | ||
|
|
||
| 1. [Finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) the upgrade on the primary cluster's system VC: | ||
|
|
||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| SET CLUSTER SETTING version '{VERSION}'; | ||
| ~~~ | ||
|
|
||
| {{site.data.alerts.callout_info}} | ||
| If you need to [roll back]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#roll-back-a-major-version-upgrade) an upgrade, you must do so before the upgrade has been finalized. Rolling back the upgrade on the primary cluster does not roll back the standby cluster. | ||
| {{site.data.alerts.end}} | ||
|
|
||
| 1. Confirm that finalization is complete on the primary cluster's system VC: | ||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| > SHOW CLUSTER SETTING version; | ||
| ~~~ | ||
| 1. [Connect]({% link {{ page.version.version }}/work-with-virtual-clusters.md %}#connect-to-the-system-virtual-cluster) to the primary cluster's app VC: | ||
|
|
||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ shell | ||
| cockroach sql --url \ | ||
| "postgresql://root@{primary node IP or hostname}:26257?options=-ccluster={app_virtual_cluster_name}&sslmode=verify-full" \ | ||
| --certs-dir "certs" | ||
| ~~~ | ||
|
|
||
| 1. [Finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) the upgrade on the primary cluster's app VC: | ||
|
|
||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| SET CLUSTER SETTING version '{VERSION}'; | ||
| ~~~ | ||
|
|
||
| Upgrading the primary cluster's app VC also upgrades the standby cluster's app VC, since it replicates from the primary. | ||
|
|
||
| 1. Confirm that finalization is complete on the primary cluster's app VC: | ||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| > SHOW CLUSTER SETTING version; | ||
| ~~~ | ||
| ## Upgrade reader VC | ||
| If you have a _reader virtual cluster (reader VC)_, you must drop and recreate it to upgrade after completing the main upgrade process on the primary and standby clusters. Follow these steps to upgrade your reader VC: | ||
| 1. After upgrading the app VC on your primary cluster, wait for the replicated time to pass the time at which the upgrade completed. | ||
| 1. On the standby cluster, stop the reader VC service: | ||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| ALTER VIRTUAL CLUSTER <readervc-name> STOP SERVICE; | ||
| ~~~ | ||
| 1. Drop the reader VC: | ||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| DROP VIRTUAL CLUSTER <readervc-name>; | ||
| ~~~ | ||
| 1. On the standby cluster, re-create the reader VC: | ||
| {% include_cached copy-clipboard.html %} | ||
| ~~~ sql | ||
| ALTER VIRTUAL CLUSTER dest-system SET REPLICATION READ VIRTUAL CLUSTER; | ||
| ~~~ | ||
| At this point, the reader VC is on the same version as the standby cluster. | ||
| ## Failover and fast failback during upgrade | ||
| If needed, you can perform a [failover]({% link {{ page.version.version }}/failover-replication.md %}) while upgrading your clusters. | ||
| However, after performing a failover you cannot perform a [fast failback]({% link {{ page.version.version }}/failover-replication.md %}#failback) to the original primary cluster while the standby cluster version is newer than the primary cluster version. This is because you cannot replicate data from a cluster on a newer version to a cluster on an older version. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.