Update the upgrades section for PCR for more detailed guidance #18809
Conversation
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Hi @alicia-l2, are these the kind of changes you had in mind for this section? |
|
small thing, could we also get rid of the cluster size on the pages as well? when we discuss what scale we support PCR at |
kathancox
force-pushed
the
pcr-upgrade-details
branch
from
4810f11
to
93a7130
Compare
|
|
||
| When physical cluster replication is enabled, we recommend following this procedure on the standby cluster first, before upgrading the primary cluster. It is preferable to avoid a situation in which the application virtual cluster, which is being replicated, is a version higher than what the standby cluster can serve if you were to cut over. | ||
| The standby cluster must be at the same version as, or one version ahead of, the primary's virtual cluster at the time of [cutover]({% link {{ page.version.version }}/cutover-replication.md %}). |
There was a problem hiding this comment.
We should be more emphatic about this -- you absolutely should not start or do steady state or cutover in PCR when the standby cluster is at a lower version than the primary. I think we'll add guardrails for this soon but as of right now we should really call this out in the docs (maybe like a warning sign box)?
There was a problem hiding this comment.
I've added this to a warning box in this section and in the ## Start clusters section
| @@ -122,11 +122,15 @@ Statement | Action | |||
|
|
|||
| ### Cluster versions and upgrades | |||
|
|
|||
| The standby cluster must be at the same version as, or one version ahead of, the primary's application virtual cluster at the time of cutover. | |||
| When PCR is enabled, we recommend upgrading with the following procedure. This upgrades the standby cluster before the primary cluster. It is preferable to avoid a situation where the virtual cluster, which is being replicated, is a version higher than what the standby cluster can serve if you were to cut over. Within the primary and standby CockroachDB clusters, the system virtual cluster must be at a cluster version greater than or equal to the virtual cluster: | |||
There was a problem hiding this comment.
we should remove "recommend upgrading" and just say "upgrade"
| @@ -122,11 +122,15 @@ Statement | Action | |||
|
|
|||
| ### Cluster versions and upgrades | |||
|
|
|||
| The standby cluster must be at the same version as, or one version ahead of, the primary's application virtual cluster at the time of cutover. | |||
| When PCR is enabled, we recommend upgrading with the following procedure. This upgrades the standby cluster before the primary cluster. It is preferable to avoid a situation where the virtual cluster, which is being replicated, is a version higher than what the standby cluster can serve if you were to cut over. Within the primary and standby CockroachDB clusters, the system virtual cluster must be at a cluster version greater than or equal to the virtual cluster: | |||
There was a problem hiding this comment.
"It is preferable to avoid a situation where the virtual cluster, which is being replicated, is a version higher than what the standby cluster can serve if you were to cut over." not sure if we need this sentence
| @@ -122,11 +122,15 @@ Statement | Action | |||
|
|
|||
| ### Cluster versions and upgrades | |||
There was a problem hiding this comment.
Ordering wise, i wonder if this makes sense to be at the bottom of the "get started" section
There was a problem hiding this comment.
Moved the section!
kathancox
force-pushed
the
pcr-upgrade-details
branch
from
93a7130
to
91eb655
Compare
kathancox
force-pushed
the
pcr-upgrade-details
branch
from
e2a44a7
to
a3104f7
Compare
Fixes DOC-10835
This PR adjusts the upgrade section for PCR to provide an ordered list of the steps between the system vc and vc as well as the primary + standby.