From 58f0dc330c06d43c03da931aae499c76f2fc4ee5 Mon Sep 17 00:00:00 2001 From: Alexandra Molnar Date: Wed, 8 Jan 2025 15:40:05 +0000 Subject: [PATCH] TELCODOCS-2155: Fix indentation in IBGU examples --- ...f-image-based-upgrade-troubleshooting.adoc | 2 +- modules/ztp-image-based-upgrade-concept.adoc | 6 ++-- ...-image-based-upgrade-procedure-cancel.adoc | 30 ++++++++-------- ...mage-based-upgrade-procedure-rollback.adoc | 30 ++++++++-------- ...p-image-based-upgrade-procedure-steps.adoc | 34 +++++++++---------- snippets/ibu-ImageBasedGroupUpgrade.adoc | 22 ++++++------ 6 files changed, 62 insertions(+), 62 deletions(-) diff --git a/modules/cnf-image-based-upgrade-troubleshooting.adoc b/modules/cnf-image-based-upgrade-troubleshooting.adoc index b48b660625..1691243593 100644 --- a/modules/cnf-image-based-upgrade-troubleshooting.adoc +++ b/modules/cnf-image-based-upgrade-troubleshooting.adoc @@ -10,7 +10,7 @@ Perform troubleshooting steps on the managed clusters that are affected by an is [IMPORTANT] ==== -If you are using the `ImageBasedGroupUpgrade` CR to upgrade your clusters, ensure that the `lcm.openshift.io/ibgu--completed or `lcm.openshift.io/ibgu--failed` cluster labels are updated properly after performing troubleshooting or recovery steps on the managed clusters. +If you are using the `ImageBasedGroupUpgrade` CR to upgrade your clusters, ensure that the `lcm.openshift.io/ibgu--completed` or `lcm.openshift.io/ibgu--failed` cluster labels are updated properly after performing troubleshooting or recovery steps on the managed clusters. This ensures that the {cgu-operator} continues to manage the image-based upgrade for the cluster. ==== diff --git a/modules/ztp-image-based-upgrade-concept.adoc b/modules/ztp-image-based-upgrade-concept.adoc index a90814d31b..21b306e420 100644 --- a/modules/ztp-image-based-upgrade-concept.adoc +++ b/modules/ztp-image-based-upgrade-concept.adoc @@ -3,7 +3,7 @@ :_mod-docs-content-type: CONCEPT [id="ztp-image-based-upgrade-concept_{context}"] -= Managing the image-based upgrade at scale using the `ImageBasedGroupUpgrade` CR on the hub += Managing the image-based upgrade at scale using the ImageBasedGroupUpgrade CR on the hub The `ImageBasedGroupUpgrade` CR combines the `ImageBasedUpgrade` and `ClusterGroupUpgrade` APIs. For example, you can define the cluster selection and rollout strategy with the `ImageBasedGroupUpgrade` API in the same way as the `ClusterGroupUpgrade` API. @@ -131,7 +131,7 @@ This ensures that the {cgu-operator} continues to manage the image-based upgrade ==== For example, if you want to cancel the upgrade for all managed clusters except for clusters that successfully completed the upgrade, you can add an `Abort` action to your plan. -The `Abort` action moves back the `ImageBasedUpgrade` CR to `Idle` stage, which cancels the upgrade on not yet upgraded clusters. +The `Abort` action moves back the `ImageBasedUpgrade` CR to the `Idle` stage, which cancels the upgrade on clusters that are not yet upgraded. Adding a separate `Abort` action ensures that the {cgu-operator} does not perform the `Abort` action on clusters that have the `lcm.openshift.io/ibgu-upgrade-completed` label. The cluster labels are removed after successfully canceling or finalizing the upgrade. @@ -139,7 +139,7 @@ The cluster labels are removed after successfully canceling or finalizing the up [id="ztp-image-based-upgrade-status-monitoring_{context}"] == Status monitoring -The `ImageBasedGroupUpgrade` CR ensures better monitoring experience with a comprehensive status reporting for all clusters that is aggregated in one place. +The `ImageBasedGroupUpgrade` CR ensures a better monitoring experience with a comprehensive status reporting for all clusters that is aggregated in one place. You can monitor the following actions: `status.clusters.completedActions`:: Shows all completed actions defined in the `plan` section. diff --git a/modules/ztp-image-based-upgrade-procedure-cancel.adoc b/modules/ztp-image-based-upgrade-procedure-cancel.adoc index 95d45943aa..ed0c178ce9 100644 --- a/modules/ztp-image-based-upgrade-procedure-cancel.adoc +++ b/modules/ztp-image-based-upgrade-procedure-cancel.adoc @@ -26,28 +26,28 @@ metadata: namespace: default spec: clusterLabelSelectors: - - matchExpressions: - - key: name - operator: In - values: - - spoke4 + - matchExpressions: + - key: name + operator: In + values: + - spoke4 ibuSpec: seedImageRef: image: quay.io/seed/image:4.16.0-rc.1 version: 4.16.0-rc.1 pullSecretRef: name: "" - extraManifests: - - name: example-extra-manifests - namespace: openshift-lifecycle-agent - oadpContent: - - name: oadp-cm - namespace: openshift-adp + extraManifests: + - name: example-extra-manifests + namespace: openshift-lifecycle-agent + oadpContent: + - name: oadp-cm + namespace: openshift-adp plan: - - actions: ["Abort"] - rolloutStrategy: - maxConcurrency: 5 - timeout: 10 + - actions: ["Abort"] + rolloutStrategy: + maxConcurrency: 5 + timeout: 10 ---- + All managed clusters that completed the `Prep` stage are moved back to the `Idle` stage. diff --git a/modules/ztp-image-based-upgrade-procedure-rollback.adoc b/modules/ztp-image-based-upgrade-procedure-rollback.adoc index 0f17c13cf1..e0ed6b945d 100644 --- a/modules/ztp-image-based-upgrade-procedure-rollback.adoc +++ b/modules/ztp-image-based-upgrade-procedure-rollback.adoc @@ -27,28 +27,28 @@ metadata: namespace: default spec: clusterLabelSelectors: - - matchExpressions: - - key: name - operator: In - values: - - spoke4 + - matchExpressions: + - key: name + operator: In + values: + - spoke4 ibuSpec: seedImageRef: image: quay.io/seed/image:4.17.0-rc.1 version: 4.17.0-rc.1 pullSecretRef: name: "" - extraManifests: - - name: example-extra-manifests - namespace: openshift-lifecycle-agent - oadpContent: - - name: oadp-cm - namespace: openshift-adp + extraManifests: + - name: example-extra-manifests + namespace: openshift-lifecycle-agent + oadpContent: + - name: oadp-cm + namespace: openshift-adp plan: - - actions: ["Rollback", "FinalizeRollback"] - rolloutStrategy: - maxConcurrency: 200 - timeout: 2400 + - actions: ["Rollback", "FinalizeRollback"] + rolloutStrategy: + maxConcurrency: 200 + timeout: 2400 ---- . Apply the created file by running the following command on the hub cluster: diff --git a/modules/ztp-image-based-upgrade-procedure-steps.adoc b/modules/ztp-image-based-upgrade-procedure-steps.adoc index 5d96460e04..a5919d0111 100644 --- a/modules/ztp-image-based-upgrade-procedure-steps.adoc +++ b/modules/ztp-image-based-upgrade-procedure-steps.adoc @@ -30,30 +30,30 @@ metadata: namespace: default spec: clusterLabelSelectors: # <1> - - matchExpressions: - - key: name - operator: In - values: - - spoke1 - - spoke4 - - spoke6 + - matchExpressions: + - key: name + operator: In + values: + - spoke1 + - spoke4 + - spoke6 ibuSpec: seedImageRef: # <2> image: quay.io/seed/image:4.16.0-rc.1 version: 4.16.0-rc.1 pullSecretRef: name: "" - extraManifests: # <3> - - name: example-extra-manifests - namespace: openshift-lifecycle-agent - oadpContent: # <4> - - name: oadp-cm - namespace: openshift-adp + extraManifests: # <3> + - name: example-extra-manifests + namespace: openshift-lifecycle-agent + oadpContent: # <4> + - name: oadp-cm + namespace: openshift-adp plan: # <5> - - actions: ["Prep"] - rolloutStrategy: - maxConcurrency: 2 - timeout: 2400 + - actions: ["Prep"] + rolloutStrategy: + maxConcurrency: 2 + timeout: 2400 ---- <1> Clusters to upgrade. <2> Target platform version, the seed image to be used, and the secret required to access the image. diff --git a/snippets/ibu-ImageBasedGroupUpgrade.adoc b/snippets/ibu-ImageBasedGroupUpgrade.adoc index 834fcd61b9..57325cad6d 100644 --- a/snippets/ibu-ImageBasedGroupUpgrade.adoc +++ b/snippets/ibu-ImageBasedGroupUpgrade.adoc @@ -7,13 +7,13 @@ metadata: namespace: default spec: clusterLabelSelectors: # <1> - - matchExpressions: - - key: name - operator: In - values: - - spoke1 - - spoke4 - - spoke6 + - matchExpressions: + - key: name + operator: In + values: + - spoke1 + - spoke4 + - spoke6 ibuSpec: seedImageRef: # <2> image: quay.io/seed/image:4.17.0-rc.1 @@ -27,10 +27,10 @@ spec: - name: oadp-cm namespace: openshift-adp plan: # <5> - - actions: ["Prep", "Upgrade", "FinalizeUpgrade"] - rolloutStrategy: - maxConcurrency: 200 # <6> - timeout: 2400 # <7> + - actions: ["Prep", "Upgrade", "FinalizeUpgrade"] + rolloutStrategy: + maxConcurrency: 200 # <6> + timeout: 2400 # <7> ---- <1> Clusters to upgrade. <2> Target platform version, the seed image to be used, and the secret required to access the image.