Skip to content

Commit 62b74c5

Browse files
Docs review changes
Changes from docs review- still need to add code snippets
1 parent 91915b6 commit 62b74c5

File tree

8 files changed

+52
-44
lines changed

8 files changed

+52
-44
lines changed

src/current/_includes/v24.3/sidebar-data/cross-cluster-replication.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
]
4848
},
4949
{
50-
"title": "Upgrade with Physical Cluster Replication Enabled",
50+
"title": "Upgrade a Cluster Running PCR",
5151
"urls": [
5252
"/${VERSION}/upgrade-with-pcr.html"
5353
]

src/current/_includes/v25.2/sidebar-data/cross-cluster-replication.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
]
4848
},
4949
{
50-
"title": "Upgrade with Physical Cluster Replication Enabled",
50+
"title": "Upgrade a Cluster Running PCR",
5151
"urls": [
5252
"/${VERSION}/upgrade-with-pcr.html"
5353
]

src/current/_includes/v25.3/sidebar-data/cross-cluster-replication.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
]
4848
},
4949
{
50-
"title": "Upgrade with Physical Cluster Replication Enabled",
50+
"title": "Upgrade a Cluster Running PCR",
5151
"urls": [
5252
"/${VERSION}/upgrade-with-pcr.html"
5353
]

src/current/_includes/v25.4/sidebar-data/cross-cluster-replication.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
]
4848
},
4949
{
50-
"title": "Upgrade with Physical Cluster Replication Enabled",
50+
"title": "Upgrade a Cluster Running PCR",
5151
"urls": [
5252
"/${VERSION}/upgrade-with-pcr.html"
5353
]

src/current/v24.3/upgrade-with-pcr.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
---
2-
title: Upgrade with Physical Cluster Replication Enabled
2+
title: Upgrade a Cluster Running PCR
33
summary: Upgrade your primary and standby clusters when using PCR.
44
toc: true
55
docs_area: manage
66
---
77

8-
When [**physical cluster replication (PCR)**]({% link {{ page.version.version }}/physical-cluster-replication-overview.md %}) is enabled, you must use the process on this page to upgrade your clusters. This process ensures that the standby cluster safely upgrades before the primary cluster, preventing any version incompatibility. You cannot replicate data from a cluster on a newer version to a cluster on an older version.
8+
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.
9+
10+
This page describes the process for safely performing a major version upgrade on a pair of clusters that have PCR enabled.
911

1012
{{site.data.alerts.callout_info}}
1113
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)_.
1214
{{site.data.alerts.end}}
1315

16+
## Minor version upgrades
17+
18+
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.
19+
1420
## Upgrade primary and standby clusters
1521

1622
To upgrade your primary and standby clusters:
1723

18-
1. Ensure that the virtual clusters on both your primary cluster and your standby cluster are finalized on the current version. If their versions have not been finalized, [finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) them before beginning the upgrade process.
24+
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.
1925

2026
1. [Upgrade the binaries]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#perform-a-major-version-upgrade) on the standby cluster. Replace the binary on each node of the cluster and restart the node.
2127

@@ -39,7 +45,7 @@ To upgrade your primary and standby clusters:
3945

4046
## Upgrade reader VC
4147

42-
If you have a _reader virtual cluster (reader VC)_, you must upgrade it independently from the primary and standby clusters, after completing the main upgrade process. Use the following steps to upgrade your reader VC by dropping and re-creating it:
48+
If you have a [_reader virtual cluster (reader VC)_]({% link {{ page.version.version }}/read-from-standby.md %}), 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:
4349

4450
1. After upgrading the app VC on your primary cluster, wait for the replicated time to pass the time at which the upgrade completed.
4551
1. On the standby cluster, stop the reader VC service:
@@ -67,10 +73,6 @@ At this point, the reader VC is on the same version as the standby cluster.
6773

6874
## Failover and fast failback during upgrade
6975

70-
If you need to, you can still perform a [failover]({% link {{ page.version.version }}/failover-replication.md %}) while upgrading your clusters.
71-
72-
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.
73-
74-
## Minor version upgrades
76+
If needed, you can perform a [failover]({% link {{ page.version.version }}/failover-replication.md %}) while upgrading your clusters.
7577

76-
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.
78+
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.

src/current/v25.2/upgrade-with-pcr.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
---
2-
title: Upgrade with Physical Cluster Replication Enabled
2+
title: Upgrade a Cluster Running PCR
33
summary: Upgrade your primary and standby clusters when using PCR.
44
toc: true
55
docs_area: manage
66
---
77

8-
When [**physical cluster replication (PCR)**]({% link {{ page.version.version }}/physical-cluster-replication-overview.md %}) is enabled, you must use the process on this page to upgrade your clusters. This process ensures that the standby cluster safely upgrades before the primary cluster, preventing any version incompatibility. You cannot replicate data from a cluster on a newer version to a cluster on an older version.
8+
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.
9+
10+
This page describes the process for safely performing a major version upgrade on a pair of clusters that have PCR enabled.
911

1012
{{site.data.alerts.callout_info}}
1113
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)_.
1214
{{site.data.alerts.end}}
1315

16+
## Minor version upgrades
17+
18+
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.
19+
1420
## Upgrade primary and standby clusters
1521

1622
To upgrade your primary and standby clusters:
1723

18-
1. Ensure that the virtual clusters on both your primary cluster and your standby cluster are finalized on the current version. If their versions have not been finalized, [finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) them before beginning the upgrade process.
24+
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.
1925

2026
1. [Upgrade the binaries]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#perform-a-major-version-upgrade) on the standby cluster. Replace the binary on each node of the cluster and restart the node.
2127

@@ -39,7 +45,7 @@ To upgrade your primary and standby clusters:
3945

4046
## Upgrade reader VC
4147

42-
If you have a _reader virtual cluster (reader VC)_, you must upgrade it independently from the primary and standby clusters, after completing the main upgrade process. Use the following steps to upgrade your reader VC by dropping and re-creating it:
48+
If you have a [_reader virtual cluster (reader VC)_]({% link {{ page.version.version }}/read-from-standby.md %}), 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:
4349

4450
1. After upgrading the app VC on your primary cluster, wait for the replicated time to pass the time at which the upgrade completed.
4551
1. On the standby cluster, stop the reader VC service:
@@ -67,10 +73,6 @@ At this point, the reader VC is on the same version as the standby cluster.
6773

6874
## Failover and fast failback during upgrade
6975

70-
If you need to, you can still perform a [failover]({% link {{ page.version.version }}/failover-replication.md %}) while upgrading your clusters.
71-
72-
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.
73-
74-
## Minor version upgrades
76+
If needed, you can perform a [failover]({% link {{ page.version.version }}/failover-replication.md %}) while upgrading your clusters.
7577

76-
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.
78+
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.

src/current/v25.3/upgrade-with-pcr.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,27 @@
11
---
2-
title: Upgrade with Physical Cluster Replication Enabled
2+
title: Upgrade a Cluster Running PCR
33
summary: Upgrade your primary and standby clusters when using PCR.
44
toc: true
55
docs_area: manage
66
---
77

8-
When [**physical cluster replication (PCR)**]({% link {{ page.version.version }}/physical-cluster-replication-overview.md %}) is enabled, you must use the process on this page to upgrade your clusters. This process ensures that the standby cluster safely upgrades before the primary cluster, preventing any version incompatibility. You cannot replicate data from a cluster on a newer version to a cluster on an older version.
8+
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.
9+
10+
This page describes the process for safely performing a major version upgrade on a pair of clusters that have PCR enabled.
911

1012
{{site.data.alerts.callout_info}}
1113
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)_.
1214
{{site.data.alerts.end}}
1315

16+
## Minor version upgrades
17+
18+
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.
19+
1420
## Upgrade primary and standby clusters
1521

1622
To upgrade your primary and standby clusters:
1723

18-
1. Ensure that the virtual clusters on both your primary cluster and your standby cluster are finalized on the current version. If their versions have not been finalized, [finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) them before beginning the upgrade process.
24+
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.
1925

2026
1. [Upgrade the binaries]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#perform-a-major-version-upgrade) on the standby cluster. Replace the binary on each node of the cluster and restart the node.
2127

@@ -39,7 +45,7 @@ To upgrade your primary and standby clusters:
3945

4046
## Upgrade reader VC
4147

42-
If you have a [_reader virtual cluster (reader VC)_]({% link {{ page.version.version }}/read-from-standby.md %}), you must upgrade it independently from the primary and standby clusters, after completing the main upgrade process. Use the following steps to upgrade your reader VC by dropping and re-creating it:
48+
If you have a [_reader virtual cluster (reader VC)_]({% link {{ page.version.version }}/read-from-standby.md %}), 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:
4349

4450
1. After upgrading the app VC on your primary cluster, wait for the replicated time to pass the time at which the upgrade completed.
4551
1. On the standby cluster, stop the reader VC service:
@@ -67,10 +73,6 @@ At this point, the reader VC is on the same version as the standby cluster.
6773

6874
## Failover and fast failback during upgrade
6975

70-
If you need to, you can still perform a [failover]({% link {{ page.version.version }}/failover-replication.md %}) while upgrading your clusters.
71-
72-
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.
73-
74-
## Minor version upgrades
76+
If needed, you can perform a [failover]({% link {{ page.version.version }}/failover-replication.md %}) while upgrading your clusters.
7577

76-
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.
78+
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.

0 commit comments

Comments
 (0)