Merge pull request #64946 from xenolinux/cert-manager-update

OCPBUGS#16887: Clarify cert-manager upgrade paths for users

Author: snarayan-redhat

modules/cert-manager-operator-update-channels.adoc

@@ -0,0 +1,34 @@
+// Module included in the following assemblies:
+//
+// * security/cert_manager_operator/cert-manager-operator-install.adoc
+
+:_content-type: CONCEPT
+[id="cert-manager-operator-update-channels_{context}"]
+= Understanding update channels of the {cert-manager-operator}
+
+Update channels are the mechanism by which you can declare the version of your {cert-manager-operator} in your cluster. The {cert-manager-operator} offers the following update channels:
+
+* `stable-v1`
+* `stable-v1.y`
+
+[id="stable-v1-channel_{context}"]
+== stable-v1 channel
+
+The `stable-v1` channel is the default and suggested channel while installing the {cert-manager-operator}. The `stable-v1` channel installs and updates the latest release version of the {cert-manager-operator}. Select the `stable-v1` channel if you want to use the latest stable release of the {cert-manager-operator}.
+
+The `stable-v1` channel offers the following update approval strategies:
+
+Automatic:: If you choose automatic updates for an installed {cert-manager-operator}, a new version of the {cert-manager-operator} is available in the `stable-v1` channel. The Operator Lifecycle Manager (OLM) automatically upgrades the running instance of your Operator without human intervention.
+
+Manual:: If you select manual updates, when a newer version of the {cert-manager-operator} is available, OLM creates an update request. As a cluster administrator, you must then manually approve that update request to have the {cert-manager-operator} updated to the new version.
+
+[id="stable-v1-y-channel_{context}"]
+== stable-v1.y channel
+
+The y-stream version of the {cert-manager-operator} installs updates from the `stable-v1.y` channels such as `stable-v1.10`, `stable-v1.11`, and `stable-v1.12`. Select the `stable-v1.y` channel if you want to use the y-stream version and stay updated to the z-stream version of the {cert-manager-operator}.
+
+The `stable-v1.y` channel offers the following update approval strategies:
+
+Automatic:: If you choose automatic updates for an installed {cert-manager-operator}, a new z-stream version of the {cert-manager-operator} is available in the `stable-v1.y` channel. OLM automatically upgrades the running instance of your Operator without human intervention.
+
+Manual:: If you select manual updates, when a newer version of the {cert-manager-operator} is available, OLM creates an update request. As a cluster administrator, you must then manually approve that update request to have the {cert-manager-operator} updated to the new version of the z-stream releases.

modules/olm-preparing-upgrade.adoc

@@ -19,4 +19,4 @@ Red Hat Customer Portal Labs include the following application that helps admini
 
 * link:https://access.redhat.com/labs/ocpouic/[Red Hat OpenShift Container Platform Operator Update Information Checker]
 
-You can use the application to search for Operator Lifecycle Manager-based Operators and verify the available Operator version per update channel across different versions of {product-title}. Cluster Version Operator-based Operators are not included.
+You can use the application to search for Operator Lifecycle Manager-based Operators and verify the available Operator version per update channel across different versions of {product-title}. Cluster Version Operator-based Operators are not included.

security/cert_manager_operator/cert-manager-operator-install.adoc

@@ -11,8 +11,12 @@ The {cert-manager-operator} is not installed in {product-title} by default. You
 // Installing the {cert-manager-operator} using the web console
 include::modules/cert-manager-install-console.adoc[leveloffset=+1]
 
+// Updating paths for the {cert-manager-operator}
+include::modules/cert-manager-operator-update-channels.adoc[leveloffset=+1]
+
 [role="_additional-resources"]
 [id="cert-manager-operator-install_additional-resources"]
 == Additional resources
 
 * xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster]
+* xref:../../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Updating installed Operators]