1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00

TELCODOCS-1415: Add information about status field values in Subscription CRs

This commit is contained in:
Alexandra Molnar
2023-08-23 12:57:30 +01:00
committed by openshift-cherrypick-robot
parent 464bb08a07
commit 18bd9008b6
2 changed files with 73 additions and 0 deletions

View File

@@ -0,0 +1,71 @@
// Module included in the following assemblies:
// Epic CNF-2600 (CNF-2133) (4.10), Story TELCODOCS-285
// * scalability_and_performance/cnf-talm-for-cluster-upgrades.adoc
:_content-type: PROCEDURE
[id="talo-about-subscription-crs_{context}"]
= Configuring Operator subscriptions for managed clusters that you install with {cgu-operator}
{cgu-operator} can only approve the install plan for an Operator if the `Subscription` CR of the Operator contains a valid `status` field. You can use the following fields:
* `status.state.AtLatestKnown` for the latest Operator version
* `status.installedCSV` for a specific Operator version
.Procedure
. Add one of the following status fields to the `Subscription` CR of the Operator:
.. Add the `status.state.AtLatestKnown` field for the latest Operator version:
+
.Example Subscription CR
[source,yaml]
----
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: cluster-logging
namespace: openshift-logging
annotations:
ran.openshift.io/ztp-deploy-wave: "2"
spec:
channel: "stable"
name: cluster-logging
source: redhat-operators
sourceNamespace: openshift-marketplace
installPlanApproval: Manual
status:
state: AtLatestKnown <1>
----
<1> The `status.state: AtLatestKnown` field is used for the latest Operator version available from the Operator catalog.
+
[NOTE]
====
When a new version of the Operator is available in the registry, the associated policy becomes non-compliant.
====
.. Add the `status.installedCSV` field for a specific Operator version:
+
.Example Subscription CR
[source,yaml]
----
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: cluster-logging
namespace: openshift-logging
annotations:
ran.openshift.io/ztp-deploy-wave: "2"
spec:
channel: "stable"
name: cluster-logging
source: redhat-operators
sourceNamespace: openshift-marketplace
installPlanApproval: Manual
status:
installedCSV: cluster-logging.v5.7.5 <1>
----
<1> The `status.installedCSV` field with the CSV value is used for a specific version of an Operator, for example, `status.installedCSV: cluster-logging.v5.7.5`.
+
. Apply the changed `Subscription` policy to your managed clusters with a `ClusterGroupUpgrade` CR.

View File

@@ -29,6 +29,8 @@ include::modules/cnf-topology-aware-lifecycle-manager-policies-concept.adoc[leve
For more information about the `PolicyGenTemplate` CRD, see xref:../../scalability_and_performance/ztp_far_edge/ztp-configuring-managed-clusters-policies.adoc#ztp-the-policygentemplate_ztp-configuring-managed-clusters-policies[About the PolicyGenTemplate CRD].
include::modules/cnf-topology-aware-lifecycle-manager-about-subscription-crs.adoc[leveloffset=+2]
include::modules/cnf-topology-aware-lifecycle-manager-apply-policies.adoc[leveloffset=+2]
include::modules/cnf-topology-aware-lifecycle-manager-backup-concept.adoc[leveloffset=+1]