Add page for updated PCR upgrade info #20729
Conversation
Added new page on the upgrade process with pcr enabled, including more detailed and accurate info than we had previously
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
Files changed:
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
Fixed summary to be the right length
|
Changes to 25.4 aren't in this PR yet, but will be added as identical to 25.3 once the changes are finalized- easier to make adjustments in just the one version |
A few small adjustments based on tech review
Removed cloud only components and adjusting steps to match source of truth doc
| 1. [Finalize]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#finalize-a-major-version-upgrade-manually) the upgrade on the primary cluster's SystemVC. | ||
|
|
||
| {{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 also roll back the standby cluster. |
There was a problem hiding this comment.
for readability should we say "primary cluster does not roll backup" instead of "does not also"
Some rewordings
Ported to 24.3, 25.2, 25.4
Removed broken links
There was a problem hiding this comment.
Left comments and suggestions.
It's not clear to me whether SystemVC/AppVC/ReaderVC is the correct terminology versus system virtual cluster/app virtual cluster/reader virtual cluster because both are used throughout the docs.
My 2c is that virtual clusters are a generic CRDB technical term not specific to PCR, so unless the product itself uses the "SystemVC" shortening I think we are best off with the longer name. Or at least not capitalizing System/App/Reader so it doesn't look like a Brand ™️
src/current/_includes/v25.4/sidebar-data/cross-cluster-replication.json
Outdated
Show resolved
Hide resolved
good point @jhlodin . I think we should keep the VC shortening, see doc here: https://docs.google.com/document/d/1nZApVf2NX3-BV_D6FJTsAGWpiNBhJVhDwsepKzttoVA/edit?tab=t.0#heading=h.1iolcwo8w939 but , we should probably not capitalize Reader or App and should have a space in between Reader and VC, so it's like reader VC. |
updated pages to have standardized 'system VC' 'app VC' 'reader VC' language
Changes from docs review- still need to add code snippets
Added code snippets to entire upgrade process
Two instances of readervc didn't get changed
…kroachdb/docs into 20251014-DOC-14967-reader-vc-upgrade
Added some links
whoops broken link
4 participants
Addresses: DOC-15034 and DOC-14967
Added new page on the upgrade process with pcr enabled, including more detailed and accurate info than we had previously.