From ed86f2771359d53c6537a78da59a0275bdc35b1f Mon Sep 17 00:00:00 2001 From: Pan Ousley Date: Thu, 13 Feb 2025 18:34:33 -0500 Subject: [PATCH] CNV#44000: update docs with candidate channel + rework --- modules/virt-early-access-releases.adoc | 18 ++++++++++++++++++ virt/updating/upgrading-virt.adoc | 8 ++++++++ 2 files changed, 26 insertions(+) create mode 100644 modules/virt-early-access-releases.adoc diff --git a/modules/virt-early-access-releases.adoc b/modules/virt-early-access-releases.adoc new file mode 100644 index 0000000000..86feca8f9e --- /dev/null +++ b/modules/virt-early-access-releases.adoc @@ -0,0 +1,18 @@ +// Module included in the following assemblies: +// +// * virt/updating/upgrading-virt.adoc + +:_mod-docs-content-type: CONCEPT +[id="virt-early-access-releases_{context}"] += Early access releases + +You can gain access to builds in development by subscribing to the *candidate* update channel for your version of {VirtProductName}. These releases have not been fully tested by Red{nbsp}Hat and are not supported, but you can use them on non-production clusters to test capabilities and bug fixes being developed for that version. + +The *stable* channel, which matches the underlying {product-title} version and is fully tested, is suitable for production systems. You can switch between the *stable* and *candidate* channels in Operator Hub. However, updating from a *candidate* channel release to a *stable* channel release is not tested by Red{nbsp}Hat. + +Some candidate releases are promoted to the *stable* channel. However, releases present only in *candidate* channels might not contain all features that will be made generally available (GA), and some features in candidate builds might be removed before GA. Additionally, candidate releases might not offer update paths to later GA releases. + +[IMPORTANT] +==== +The candidate channel is only suitable for testing purposes where destroying and recreating a cluster is acceptable. +==== \ No newline at end of file diff --git a/virt/updating/upgrading-virt.adoc b/virt/updating/upgrading-virt.adoc index 5d4321450d..0371585a22 100644 --- a/virt/updating/upgrading-virt.adoc +++ b/virt/updating/upgrading-virt.adoc @@ -47,6 +47,14 @@ include::modules/virt-manual-approval-strategy.adoc[leveloffset=+2] include::modules/olm-approving-pending-upgrade.adoc[leveloffset=+2] +// TODO: Uncomment this section in follow-up PRs against each release branch +// TODO: when the candidate channel is available for that version of OCP-V. +// +//ifndef::openshift-origin[] +//include::modules/virt-early-access-releases.adoc[leveloffset=+1] +//endif::openshift-origin[] +// + [id="additional-resources_upgrading-virt"] [role="_additional-resources"] == Additional resources