Skip to content

Commit 91915b6

Browse files
peachdawnleachpeachdawnleach
committed
Updated language
updated pages to have standardized 'system VC' 'app VC' 'reader VC' language
1 parent 7b46171 commit 91915b6

File tree

6 files changed

+63
-63
lines changed

6 files changed

+63
-63
lines changed

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ docs_area: manage
88
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.
99

1010
{{site.data.alerts.callout_info}}
11-
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 (SystemVC)_ must be at a cluster major version greater than or equal to the _app virtual cluster (AppVC)_.
11+
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)_.
1212
{{site.data.alerts.end}}
1313

1414
## Upgrade primary and standby clusters
@@ -19,51 +19,51 @@ To upgrade your primary and standby clusters:
1919

2020
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.
2121

22-
1. [Finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) the upgrade on the standby cluster's SystemVC.
22+
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.
2323

2424
{{site.data.alerts.callout_info}}
2525
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.
2626
{{site.data.alerts.end}}
2727

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

30-
1. [Finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) the upgrade on the primary cluster's SystemVC.
30+
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.
3131

3232
{{site.data.alerts.callout_info}}
3333
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.
3434
{{site.data.alerts.end}}
3535

36-
1. [Finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) the upgrade on the primary cluster's AppVC.
36+
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.
3737

38-
Upgrading the primary cluster's AppVC also upgrades the standby cluster's AppVC, since it replicates from the primary.
38+
Upgrading the primary cluster's app VC also upgrades the standby cluster's app VC, since it replicates from the primary.
3939

40-
## Upgrade ReaderVC
40+
## Upgrade reader VC
4141

42-
If you have a _reader virtual cluster (ReaderVC)_, you must upgrade it independently from the primary and standby clusters, after completing the main upgrade process. Use the following steps to upgrade your ReaderVC by dropping and re-creating it:
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:
4343

44-
1. After upgrading the AppVC on your primary cluster, wait for the replicated time to pass the time at which the upgrade completed.
45-
1. On the standby cluster, stop the ReaderVC service:
44+
1. After upgrading the app VC on your primary cluster, wait for the replicated time to pass the time at which the upgrade completed.
45+
1. On the standby cluster, stop the reader VC service:
4646

4747
{% include_cached copy-clipboard.html %}
4848
~~~ sql
4949
ALTER VIRTUAL CLUSTER <readervc-name> STOP SERVICE;
5050
~~~
5151

52-
1. Drop the ReaderVC:
52+
1. Drop the reader VC:
5353

5454
{% include_cached copy-clipboard.html %}
5555
~~~ sql
5656
DROP VIRTUAL CLUSTER <readervc-name>;
5757
~~~
5858

59-
1. On the standby cluster, re-create the ReaderVC:
59+
1. On the standby cluster, re-create the reader VC:
6060

6161
{% include_cached copy-clipboard.html %}
6262
~~~ sql
6363
ALTER VIRTUAL CLUSTER dest-system SET REPLICATION READ VIRTUAL CLUSTER;
6464
~~~
6565

66-
At this point, the ReaderVC is on the same version as the standby cluster.
66+
At this point, the reader VC is on the same version as the standby cluster.
6767

6868
## Failover and fast failback during upgrade
6969

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ docs_area: manage
88
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.
99

1010
{{site.data.alerts.callout_info}}
11-
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 (SystemVC)_ must be at a cluster major version greater than or equal to the _app virtual cluster (AppVC)_.
11+
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)_.
1212
{{site.data.alerts.end}}
1313

1414
## Upgrade primary and standby clusters
@@ -19,51 +19,51 @@ To upgrade your primary and standby clusters:
1919

2020
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.
2121

22-
1. [Finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) the upgrade on the standby cluster's SystemVC.
22+
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.
2323

2424
{{site.data.alerts.callout_info}}
2525
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.
2626
{{site.data.alerts.end}}
2727

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

30-
1. [Finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) the upgrade on the primary cluster's SystemVC.
30+
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.
3131

3232
{{site.data.alerts.callout_info}}
3333
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.
3434
{{site.data.alerts.end}}
3535

36-
1. [Finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) the upgrade on the primary cluster's AppVC.
36+
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.
3737

38-
Upgrading the primary cluster's AppVC also upgrades the standby cluster's AppVC, since it replicates from the primary.
38+
Upgrading the primary cluster's app VC also upgrades the standby cluster's app VC, since it replicates from the primary.
3939

40-
## Upgrade ReaderVC
40+
## Upgrade reader VC
4141

42-
If you have a _reader virtual cluster (ReaderVC)_, you must upgrade it independently from the primary and standby clusters, after completing the main upgrade process. Use the following steps to upgrade your ReaderVC by dropping and re-creating it:
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:
4343

44-
1. After upgrading the AppVC on your primary cluster, wait for the replicated time to pass the time at which the upgrade completed.
45-
1. On the standby cluster, stop the ReaderVC service:
44+
1. After upgrading the app VC on your primary cluster, wait for the replicated time to pass the time at which the upgrade completed.
45+
1. On the standby cluster, stop the reader VC service:
4646

4747
{% include_cached copy-clipboard.html %}
4848
~~~ sql
4949
ALTER VIRTUAL CLUSTER <readervc-name> STOP SERVICE;
5050
~~~
5151

52-
1. Drop the ReaderVC:
52+
1. Drop the reader VC:
5353

5454
{% include_cached copy-clipboard.html %}
5555
~~~ sql
5656
DROP VIRTUAL CLUSTER <readervc-name>;
5757
~~~
5858

59-
1. On the standby cluster, re-create the ReaderVC:
59+
1. On the standby cluster, re-create the reader VC:
6060

6161
{% include_cached copy-clipboard.html %}
6262
~~~ sql
6363
ALTER VIRTUAL CLUSTER dest-system SET REPLICATION READ VIRTUAL CLUSTER;
6464
~~~
6565

66-
At this point, the ReaderVC is on the same version as the standby cluster.
66+
At this point, the reader VC is on the same version as the standby cluster.
6767

6868
## Failover and fast failback during upgrade
6969

‎src/current/v25.3/read-from-standby.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ Use this page to understand how the _read from standby_ feature works and how to
1111

1212
## How the read from standby feature works
1313

14-
PCR utilizes [cluster virtualization]({% link {{ page.version.version }}/cluster-virtualization-overview.md %}) to separate a cluster's control plane from its data plane. A cluster always has one control plane, called a _system virtual cluster (SystemVC)_, and at least one data plane, called an _App Virtual Cluster (AppVC)_. The standby cluster's SystemVC manages the PCR job and other cluster metadata, and is not used for application queries. All data tables, system tables, and cluster settings in the standby cluster's AppVC are identical to the primary cluster's AppVC. The standby cluster's AppVC itself remains offline during replication.
14+
PCR utilizes [cluster virtualization]({% link {{ page.version.version }}/cluster-virtualization-overview.md %}) to separate a cluster's control plane from its data plane. A cluster always has one control plane, called a _system virtual cluster (system VC)_, and at least one data plane, called an _App Virtual Cluster (app VC)_. The standby cluster's system VC manages the PCR job and other cluster metadata, and is not used for application queries. All data tables, system tables, and cluster settings in the standby cluster's app VC are identical to the primary cluster's app VC. The standby cluster's app VC itself remains offline during replication.
1515

16-
When using read from standby, applications can read from the standby cluster, but they do not connect directly to the standby cluster's AppVC. Instead, PCR introduces a _reader virtual cluster (ReaderVC)_. The ReaderVC ensures a clean, isolated environment specifically for serving read queries without interfering with replication or system metadata. It reads continuously from the standby cluster's AppVC using internal pointers, providing access to the replicated data while keeping the AppVC offline. The ReaderVC itself only stores a small amount of metadata and no user data, so it is not expected to take up additional storage space.
16+
When using read from standby, applications can read from the standby cluster, but they do not connect directly to the standby cluster's app VC. Instead, PCR introduces a _reader virtual cluster (reader VC)_. The reader VC ensures a clean, isolated environment specifically for serving read queries without interfering with replication or system metadata. It reads continuously from the standby cluster's app VC using internal pointers, providing access to the replicated data while keeping the app VC offline. The reader VC itself only stores a small amount of metadata and no user data, so it is not expected to take up additional storage space.
1717

18-
The standby cluster's ReaderVC has its own system tables and [cluster settings]({% link {{ page.version.version }}/cluster-settings.md %}). The ReaderVC replicates a subset of system tables, including **Users** and **Roles**, from the AppVC, so that existing primary users can authenticate using the same [users and roles]({% link {{ page.version.version }}/security-reference/authorization.md %}) as on the primary cluster's AppVC. Other system tables and cluster settings are set to defaults in the ReaderVC. For more information, consult [Physical Cluster Replication Technical Overview]({% link {{ page.version.version }}/physical-cluster-replication-technical-overview.md %}).
18+
The standby cluster's reader VC has its own system tables and [cluster settings]({% link {{ page.version.version }}/cluster-settings.md %}). The reader VC replicates a subset of system tables, including **Users** and **Roles**, from the app VC, so that existing primary users can authenticate using the same [users and roles]({% link {{ page.version.version }}/security-reference/authorization.md %}) as on the primary cluster's app VC. Other system tables and cluster settings are set to defaults in the reader VC. For more information, consult [Physical Cluster Replication Technical Overview]({% link {{ page.version.version }}/physical-cluster-replication-technical-overview.md %}).
1919

20-
In the event of failover, the ReaderVC's response depends on the type of failover. After failover to the latest timestamp, the ReaderVC continues pointing to the AppVC but stops receiving updates. After failover to a point-in-time timestamp, the ReaderVC is destroyed.
20+
In the event of failover, the reader VC's response depends on the type of failover. After failover to the latest timestamp, the reader VC continues pointing to the app VC but stops receiving updates. After failover to a point-in-time timestamp, the reader VC is destroyed.
2121

2222
## Use the read from standby feature
2323
### Before you begin
@@ -46,7 +46,7 @@ ALTER VIRTUAL CLUSTER main SET REPLICATION READ VIRTUAL CLUSTER;
4646
~~~
4747

4848
{{site.data.alerts.callout_info}}
49-
The standby cluster's AppVC must have a status of `replicating` before you can create your ReaderVC. Use the [`SHOW VIRTUAL CLUSTERS`]({% link {{ page.version.version }}/show-virtual-cluster.md %}) command to check the status of the AppVC.
49+
The standby cluster's app VC must have a status of `replicating` before you can create your reader VC. Use the [`SHOW VIRTUAL CLUSTERS`]({% link {{ page.version.version }}/show-virtual-cluster.md %}) command to check the status of the app VC.
5050
{{site.data.alerts.end}}
5151

5252
### Check the status of your reader virtual cluster
@@ -58,7 +58,7 @@ To confirm that your reader virtual cluster is active:
5858
SHOW VIRTUAL CLUSTERS;
5959
~~~
6060

61-
The output shows a `standby-readonly` virtual cluster in addition to the systemVC and AppVC:
61+
The output shows a `standby-readonly` virtual cluster in addition to the system VC and app VC:
6262

6363
~~~
6464
id | name | data_state | service_mode
@@ -69,7 +69,7 @@ The output shows a `standby-readonly` virtual cluster in addition to the systemV
6969
~~~
7070

7171
{{site.data.alerts.callout_info}}
72-
The ReaderVC cannot serve reads until after the PCR initial scan is complete. After completing the initial scan, wait until the ReaderVC's `service_mode` is `shared`, then wait about one minute before connecting to the ReaderVC.
72+
The reader VC cannot serve reads until after the PCR initial scan is complete. After completing the initial scan, wait until the reader VC's `service_mode` is `shared`, then wait about one minute before connecting to the reader VC.
7373
{{site.data.alerts.end}}
7474

7575
### Run read-only queries on the standby cluster

0 commit comments

Comments
 (0)