From d69edca8e15a3e75993a73635ed7f2fa4d45e958 Mon Sep 17 00:00:00 2001 From: Ryan Kuo Date: Tue, 5 May 2026 16:44:34 -0400 Subject: [PATCH] document PCR read from standby limitation in all affected versions --- .../physical-cluster-replication.md | 13 +++++++++++++ .../physical-cluster-replication.md | 13 +++++++++++++ .../physical-cluster-replication.md | 13 +++++++++++++ .../physical-cluster-replication.md | 13 +++++++++++++ .../physical-cluster-replication.md | 13 +++++++++++++ 5 files changed, 65 insertions(+) diff --git a/src/current/_includes/v24.3/known-limitations/physical-cluster-replication.md b/src/current/_includes/v24.3/known-limitations/physical-cluster-replication.md index 243dbed8fe5..d6f170da205 100644 --- a/src/current/_includes/v24.3/known-limitations/physical-cluster-replication.md +++ b/src/current/_includes/v24.3/known-limitations/physical-cluster-replication.md @@ -2,4 +2,17 @@ - CockroachDB {{ site.data.products.core }} clusters on v23.2 or later. The primary cluster can be a [new]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#step-1-create-the-primary-cluster) or [existing]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#set-up-pcr-from-an-existing-cluster) cluster. The standby cluster must be a [new cluster started with the `--virtualized-empty` flag]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#step-2-create-the-standby-cluster). - [CockroachDB {{ site.data.products.advanced }} clusters]({% link cockroachcloud/physical-cluster-replication.md %}) on v24.3 or later. - In CockroachDB {{ site.data.products.core }}, the primary and standby clusters must have the same [zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) in order to respect data placement configurations. +- When using the [read from standby]({% link {{ page.version.version }}/physical-cluster-replication-technical-overview.md %}#start-up-sequence-with-read-on-standby) feature, startup of the reader virtual cluster can occasionally stall after the initial scan or after an upgrade, preventing SQL connections to the reader virtual cluster. To mitigate this issue, restart the virtual cluster service on the standby cluster's system virtual cluster: + + {% include_cached copy-clipboard.html %} + ~~~ sql + ALTER VIRTUAL CLUSTER {reader_vc} STOP SERVICE; + ~~~ + + {% include_cached copy-clipboard.html %} + ~~~ sql + ALTER VIRTUAL CLUSTER {reader_vc} START SERVICE SHARED; + ~~~ + + [#169078](https://github.com/cockroachdb/cockroach/issues/169078) diff --git a/src/current/_includes/v25.2/known-limitations/physical-cluster-replication.md b/src/current/_includes/v25.2/known-limitations/physical-cluster-replication.md index bcb768cbc87..47135cd6985 100644 --- a/src/current/_includes/v25.2/known-limitations/physical-cluster-replication.md +++ b/src/current/_includes/v25.2/known-limitations/physical-cluster-replication.md @@ -2,3 +2,16 @@ - CockroachDB {{ site.data.products.core }} clusters on v23.2 or later. The primary cluster can be a [new]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#step-1-create-the-primary-cluster) or [existing]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#set-up-pcr-from-an-existing-cluster) cluster. The standby cluster must be a [new cluster started with the `--virtualized-empty` flag]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#step-2-create-the-standby-cluster). - [CockroachDB {{ site.data.products.advanced }} clusters]({% link cockroachcloud/physical-cluster-replication.md %}) on v24.3 or later. - In CockroachDB {{ site.data.products.core }}, the primary and standby clusters must have the same [zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) in order to respect data placement configurations. +- When using the [read from standby]({% link {{ page.version.version }}/physical-cluster-replication-technical-overview.md %}#start-up-sequence-with-read-on-standby) feature, startup of the reader virtual cluster can occasionally stall after the initial scan or after an upgrade, preventing SQL connections to the reader virtual cluster. To mitigate this issue, restart the virtual cluster service on the standby cluster's system virtual cluster: + + {% include_cached copy-clipboard.html %} + ~~~ sql + ALTER VIRTUAL CLUSTER {reader_vc} STOP SERVICE; + ~~~ + + {% include_cached copy-clipboard.html %} + ~~~ sql + ALTER VIRTUAL CLUSTER {reader_vc} START SERVICE SHARED; + ~~~ + + [#169078](https://github.com/cockroachdb/cockroach/issues/169078) diff --git a/src/current/_includes/v25.4/known-limitations/physical-cluster-replication.md b/src/current/_includes/v25.4/known-limitations/physical-cluster-replication.md index bcb768cbc87..47135cd6985 100644 --- a/src/current/_includes/v25.4/known-limitations/physical-cluster-replication.md +++ b/src/current/_includes/v25.4/known-limitations/physical-cluster-replication.md @@ -2,3 +2,16 @@ - CockroachDB {{ site.data.products.core }} clusters on v23.2 or later. The primary cluster can be a [new]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#step-1-create-the-primary-cluster) or [existing]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#set-up-pcr-from-an-existing-cluster) cluster. The standby cluster must be a [new cluster started with the `--virtualized-empty` flag]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#step-2-create-the-standby-cluster). - [CockroachDB {{ site.data.products.advanced }} clusters]({% link cockroachcloud/physical-cluster-replication.md %}) on v24.3 or later. - In CockroachDB {{ site.data.products.core }}, the primary and standby clusters must have the same [zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) in order to respect data placement configurations. +- When using the [read from standby]({% link {{ page.version.version }}/physical-cluster-replication-technical-overview.md %}#start-up-sequence-with-read-on-standby) feature, startup of the reader virtual cluster can occasionally stall after the initial scan or after an upgrade, preventing SQL connections to the reader virtual cluster. To mitigate this issue, restart the virtual cluster service on the standby cluster's system virtual cluster: + + {% include_cached copy-clipboard.html %} + ~~~ sql + ALTER VIRTUAL CLUSTER {reader_vc} STOP SERVICE; + ~~~ + + {% include_cached copy-clipboard.html %} + ~~~ sql + ALTER VIRTUAL CLUSTER {reader_vc} START SERVICE SHARED; + ~~~ + + [#169078](https://github.com/cockroachdb/cockroach/issues/169078) diff --git a/src/current/_includes/v26.1/known-limitations/physical-cluster-replication.md b/src/current/_includes/v26.1/known-limitations/physical-cluster-replication.md index bcb768cbc87..47135cd6985 100644 --- a/src/current/_includes/v26.1/known-limitations/physical-cluster-replication.md +++ b/src/current/_includes/v26.1/known-limitations/physical-cluster-replication.md @@ -2,3 +2,16 @@ - CockroachDB {{ site.data.products.core }} clusters on v23.2 or later. The primary cluster can be a [new]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#step-1-create-the-primary-cluster) or [existing]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#set-up-pcr-from-an-existing-cluster) cluster. The standby cluster must be a [new cluster started with the `--virtualized-empty` flag]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#step-2-create-the-standby-cluster). - [CockroachDB {{ site.data.products.advanced }} clusters]({% link cockroachcloud/physical-cluster-replication.md %}) on v24.3 or later. - In CockroachDB {{ site.data.products.core }}, the primary and standby clusters must have the same [zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) in order to respect data placement configurations. +- When using the [read from standby]({% link {{ page.version.version }}/physical-cluster-replication-technical-overview.md %}#start-up-sequence-with-read-on-standby) feature, startup of the reader virtual cluster can occasionally stall after the initial scan or after an upgrade, preventing SQL connections to the reader virtual cluster. To mitigate this issue, restart the virtual cluster service on the standby cluster's system virtual cluster: + + {% include_cached copy-clipboard.html %} + ~~~ sql + ALTER VIRTUAL CLUSTER {reader_vc} STOP SERVICE; + ~~~ + + {% include_cached copy-clipboard.html %} + ~~~ sql + ALTER VIRTUAL CLUSTER {reader_vc} START SERVICE SHARED; + ~~~ + + [#169078](https://github.com/cockroachdb/cockroach/issues/169078) diff --git a/src/current/_includes/v26.2/known-limitations/physical-cluster-replication.md b/src/current/_includes/v26.2/known-limitations/physical-cluster-replication.md index bcb768cbc87..47135cd6985 100644 --- a/src/current/_includes/v26.2/known-limitations/physical-cluster-replication.md +++ b/src/current/_includes/v26.2/known-limitations/physical-cluster-replication.md @@ -2,3 +2,16 @@ - CockroachDB {{ site.data.products.core }} clusters on v23.2 or later. The primary cluster can be a [new]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#step-1-create-the-primary-cluster) or [existing]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#set-up-pcr-from-an-existing-cluster) cluster. The standby cluster must be a [new cluster started with the `--virtualized-empty` flag]({% link {{ page.version.version }}/set-up-physical-cluster-replication.md %}#step-2-create-the-standby-cluster). - [CockroachDB {{ site.data.products.advanced }} clusters]({% link cockroachcloud/physical-cluster-replication.md %}) on v24.3 or later. - In CockroachDB {{ site.data.products.core }}, the primary and standby clusters must have the same [zone configurations]({% link {{ page.version.version }}/configure-replication-zones.md %}) in order to respect data placement configurations. +- When using the [read from standby]({% link {{ page.version.version }}/physical-cluster-replication-technical-overview.md %}#start-up-sequence-with-read-on-standby) feature, startup of the reader virtual cluster can occasionally stall after the initial scan or after an upgrade, preventing SQL connections to the reader virtual cluster. To mitigate this issue, restart the virtual cluster service on the standby cluster's system virtual cluster: + + {% include_cached copy-clipboard.html %} + ~~~ sql + ALTER VIRTUAL CLUSTER {reader_vc} STOP SERVICE; + ~~~ + + {% include_cached copy-clipboard.html %} + ~~~ sql + ALTER VIRTUAL CLUSTER {reader_vc} START SERVICE SHARED; + ~~~ + + [#169078](https://github.com/cockroachdb/cockroach/issues/169078)