OCPBUGS-36696: Add details about how to remove OADP Operator after IBU

amolnar-rh · amolnar-rh · commit 61b9e72a8204 · 2024-08-14T10:31:28.000+01:00
diff --git a/edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc b/edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc
@@ -25,6 +25,8 @@ include::modules/cnf-image-based-upgrade-with-backup.adoc[leveloffset=+1]
 
 * xref:../../edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc#cnf-image-based-upgrade-rollback_cnf-non-gitops[Moving to the Rollback stage of the image-based upgrade with {lcao}]
 
+* xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-cluster[Deleting Operators from a cluster]
+
 include::modules/cnf-image-based-upgrade-rollback.adoc[leveloffset=+1]
 
 include::modules/cnf-image-based-upgrade-troubleshooting.adoc[leveloffset=+1]
diff --git a/edge_computing/image_based_upgrade/cnf-understanding-image-based-upgrade.adoc b/edge_computing/image_based_upgrade/cnf-understanding-image-based-upgrade.adoc
@@ -65,7 +65,7 @@ spec:
 <2> Defines the target platform version, the seed image to be used, and the secret required to access the image.
 <3> (Optional) Specify the time frame in seconds to roll back when the upgrade does not complete within that time frame after the first reboot. If not defined or set to `0`, the default value of `1800` seconds (30 minutes) is used.
 <4> (Optional) Specify the list of `ConfigMap` resources that contain your custom catalog sources to retain after the upgrade, and your extra manifests to apply to the target cluster that are not part of the seed image.
-<5> Specify the list of `ConfigMap` resources that contain the OADP `Backup` and `Restore` CRs.
+<5> Specify the list of `ConfigMap` resources that contain the {oadp-short} `Backup` and `Restore` CRs.
 
 include::modules/cnf-image-based-upgrade.adoc[leveloffset=+1]
 
@@ -119,4 +119,4 @@ include::modules/cnf-image-based-upgrade-extra-manifests-guide.adoc[leveloffset=
 
 * xref:../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/ztp-image-based-upgrade-prep-resources.adoc#ztp-image-based-upgrade-prep-resources[Creating ConfigMap objects for the image-based upgrade with {ztp}]
 
-* xref:../../backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc#about-installing-oadp[About installing OADP]
+* xref:../../backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc#about-installing-oadp[About installing {oadp-short}]
diff --git a/edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-install-operators.adoc b/edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-install-operators.adoc
@@ -6,14 +6,14 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-Prepare your clusters for the upgrade by installing the {lcao} and the OADP Operator.
+Prepare your clusters for the upgrade by installing the {lcao} and the {oadp-short} Operator.
 
-To install the OADP Operator with the non-GitOps method, see "Installing the OADP Operator".
+To install the {oadp-short} Operator with the non-GitOps method, see "Installing the {oadp-short} Operator".
 
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../../backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc#oadp-installing-operator-doc[Installing the OADP Operator]
+* xref:../../../backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc#oadp-installing-operator-doc[Installing the {oadp-short} Operator]
 
 * xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-ocs.adoc#oadp-about-backup-snapshot-locations_installing-oadp-ocs[About backup and snapshot locations and their secrets]
 
diff --git a/edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-prep-resources.adoc b/edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-prep-resources.adoc
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-The {lcao} needs all your OADP resources, extra manifests, and custom catalog sources wrapped in a `ConfigMap` object to process them for the image-based upgrade.
+The {lcao} needs all your {oadp-short} resources, extra manifests, and custom catalog sources wrapped in a `ConfigMap` object to process them for the image-based upgrade.
 
 include::modules/cnf-image-based-upgrade-prep-oadp.adoc[leveloffset=+1]
 
@@ -15,7 +15,7 @@ include::modules/cnf-image-based-upgrade-prep-oadp.adoc[leveloffset=+1]
 
 * xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-partition.adoc#cnf-image-based-upgrade-shared-container-partition_shared-container-partition[Configuring a shared container partition between ostree stateroots]
 
-* xref:../../../backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc[About installing OADP]
+* xref:../../../backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc#about-installing-oadp[About installing {oadp-short}]
 
 include::modules/cnf-image-based-upgrade-prep-extramanifests.adoc[leveloffset=+1]
 
diff --git a/edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/ztp-image-based-upgrade-prep-resources.adoc b/edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/ztp-image-based-upgrade-prep-resources.adoc
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-Create your OADP resources, extra manifests, and custom catalog sources wrapped in a `ConfigMap` object to prepare for the image-based upgrade.
+Create your {oadp-short} resources, extra manifests, and custom catalog sources wrapped in a `ConfigMap` object to prepare for the image-based upgrade.
 
 include::modules/ztp-image-based-upgrade-prep-oadp.adoc[leveloffset=+1]
 
@@ -15,7 +15,7 @@ include::modules/ztp-image-based-upgrade-prep-oadp.adoc[leveloffset=+1]
 
 * xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-partition.adoc#ztp-image-based-upgrade-shared-container-partition_shared-container-partition[Configuring a shared container partition between ostree stateroots when using {ztp}]
 
-* xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-install-operators#ztp-image-based-upgrade-installing-oadp_install-operators[Installing and configuring the OADP Operator with {ztp}]
+* xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-install-operators#ztp-image-based-upgrade-installing-oadp_install-operators[Installing and configuring the {oadp-short} Operator with {ztp}]
 
 include::modules/ztp-image-based-upgrade-prep-label-extramanifests.adoc[leveloffset=+1]
 
diff --git a/edge_computing/image_based_upgrade/ztp-image-based-upgrade.adoc b/edge_computing/image_based_upgrade/ztp-image-based-upgrade.adoc
@@ -37,6 +37,8 @@ include::modules/ztp-image-based-upgrade-upgrade.adoc[leveloffset=+1]
 
 * xref:../../edge_computing/image_based_upgrade/ztp-image-based-upgrade.adoc#ztp-image-based-upgrade-rollback_ztp-gitops[Moving to the Rollback stage of the image-based upgrade with {lcao} and {ztp}]
 
+* xref:../../edge_computing/cnf-talm-for-cluster-upgrades.adoc#talo-policies-concept_cnf-topology-aware-lifecycle-manager[Update policies on managed clusters]
+
 include::modules/ztp-image-based-upgrade-rollback.adoc[leveloffset=+1]
 
 include::modules/cnf-image-based-upgrade-troubleshooting.adoc[leveloffset=+1]
diff --git a/modules/cnf-image-based-upgrade-backup-guide.adoc b/modules/cnf-image-based-upgrade-backup-guide.adoc
@@ -2,9 +2,9 @@
 // * edge_computing/image-based-upgrade/cnf-understanding-image-based-upgrade.adoc
 
 [id="ztp-image-based-upgrade-backup-guide_{context}"]
-= OADP backup and restore guidelines
+= {oadp-short} backup and restore guidelines
 
-With the OADP Operator, you can back up and restore your applications on your target clusters by using `Backup` and `Restore` CRs wrapped in `ConfigMap` objects.
+With the {oadp-short} Operator, you can back up and restore your applications on your target clusters by using `Backup` and `Restore` CRs wrapped in `ConfigMap` objects.
 The application must work on the current and the target {product-title} versions so that they can be restored after the upgrade.
 The backups must include resources that were initially created.
 
diff --git a/modules/cnf-image-based-upgrade-cluster-validated-software.adoc b/modules/cnf-image-based-upgrade-cluster-validated-software.adoc
@@ -17,7 +17,7 @@ Depending on your deployment method, the image-based upgrade requires the follow
 |4.16
 |Yes
 
-|OADP Operator
+|{oadp-short} Operator
 |1.3.1
 |Yes
 
diff --git a/modules/cnf-image-based-upgrade-generate-seed-image.adoc b/modules/cnf-image-based-upgrade-generate-seed-image.adoc
@@ -18,7 +18,7 @@ Use the {lcao} to generate the seed image with the `SeedGenerator` CR. The Opera
 .Prerequisites
 
 * Configure a shared container directory on the seed cluster.
-* Install the OADP Operator and the {lcao} on the seed cluster.
+* Install the {oadp-short} Operator and the {lcao} on the seed cluster.
 
 .Procedure
 
diff --git a/modules/cnf-image-based-upgrade-prep-oadp.adoc b/modules/cnf-image-based-upgrade-prep-oadp.adoc
@@ -3,22 +3,22 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="cnf-image-based-upgrade-prep-oadp_{context}"]
-= Creating OADP ConfigMap objects for the image-based upgrade with {lcao}
+= Creating {oadp-short} ConfigMap objects for the image-based upgrade with {lcao}
 
-Create your OADP resources that are used to back up and restore your resources during the upgrade.
+Create your {oadp-short} resources that are used to back up and restore your resources during the upgrade.
 
 .Prerequisites
 
 * Generate a seed image from a compatible seed cluster.
-* Create OADP backup and restore resources.
+* Create {oadp-short} backup and restore resources.
 * Create a separate partition on the target cluster for the container images that is shared between stateroots. For more information about, see "Configuring a shared container partition for the image-based upgrade".
 * Deploy a version of {lcao} that is compatible with the version used with the seed image.
-* Install the OADP Operator, the `DataProtectionApplication` CR, and its secret on the target cluster.
-* Create an S3-compatible storage solution and a ready-to-use bucket with proper credentials configured. For more information, see "About installing OADP".
+* Install the {oadp-short} Operator, the `DataProtectionApplication` CR, and its secret on the target cluster.
+* Create an S3-compatible storage solution and a ready-to-use bucket with proper credentials configured. For more information, see "About installing {oadp-short}".
 
 .Procedure
 
-. Create the OADP `Backup` and `Restore` CRs for platform artifacts in the same namespace where the OADP Operator is installed, which is `openshift-adp`.
+. Create the {oadp-short} `Backup` and `Restore` CRs for platform artifacts in the same namespace where the {oadp-short} Operator is installed, which is `openshift-adp`.
 
 .. If the target cluster is managed by {rh-rhacm}, add the following YAML file for backing up and restoring {rh-rhacm} artifacts:
 +
@@ -32,20 +32,20 @@ include::snippets/ibu-PlatformBackupRestore.adoc[]
 .PlatformBackupRestoreLvms.yaml for {lvms}
 include::snippets/ibu-PlatformBackupRestoreLvms.adoc[]
 
-. If you need to restore applications after the upgrade, create the OADP `Backup` and `Restore` CRs for your application in the `openshift-adp` namespace.
+. If you need to restore applications after the upgrade, create the {oadp-short} `Backup` and `Restore` CRs for your application in the `openshift-adp` namespace.
 
-.. Create the OADP CRs for cluster-scoped application artifacts in the `openshift-adp` namespace.
+.. Create the {oadp-short} CRs for cluster-scoped application artifacts in the `openshift-adp` namespace.
 +
-.Example OADP CRs for cluster-scoped application artifacts for LSO and {LVMS}
+.Example {oadp-short} CRs for cluster-scoped application artifacts for LSO and {LVMS}
 include::snippets/ibu-ApplicationClusterScopedBackupRestore.adoc[]
 
-.. Create the OADP CRs for your namespace-scoped application artifacts.
+.. Create the {oadp-short} CRs for your namespace-scoped application artifacts.
 +
 --
-.Example OADP CRs namespace-scoped application artifacts when LSO is used
+.Example {oadp-short} CRs namespace-scoped application artifacts when LSO is used
 include::snippets/ibu-ApplicationBackupRestoreLso.adoc[]
 
-.Example OADP CRs namespace-scoped application artifacts when {lvms} is used
+.Example {oadp-short} CRs namespace-scoped application artifacts when {lvms} is used
 include::snippets/ibu-ApplicationBackupRestoreLvms.adoc[]
 
 [IMPORTANT]
@@ -54,7 +54,7 @@ The same version of the applications must function on both the current and the t
 ====
 --
 
-. Create the `ConfigMap` object for your OADP CRs by running the following command:
+. Create the `ConfigMap` object for your {oadp-short} CRs by running the following command:
 +
 [source,terminal]
 ----
diff --git a/modules/cnf-image-based-upgrade-prep.adoc b/modules/cnf-image-based-upgrade-prep.adoc
@@ -46,7 +46,7 @@ spec:
 <3> Specify the reference to a secret with credentials to pull container images if the images are in a private registry.
 <4> (Optional) Specify the time frame in seconds to roll back if the upgrade does not complete within that time frame after the first reboot. If not defined or set to `0`, the default value of `1800` seconds (30 minutes) is used.
 <5> (Optional) Specify the list of `ConfigMap` resources that contain your custom catalog sources to retain after the upgrade and your extra manifests to apply to the target cluster that are not part of the seed image.
-<6> Add the `oadpContent` section with the OADP `ConfigMap` information.
+<6> Add the `oadpContent` section with the {oadp-short} `ConfigMap` information.
 
 . To start the `Prep` stage, change the value of the `stage` field to `Prep` in the `ImageBasedUpgrade` CR by running the following command:
 +
@@ -56,7 +56,7 @@ spec:
 $ oc patch imagebasedupgrades.lca.openshift.io upgrade -p='{"spec": {"stage": "Prep"}}' --type=merge -n openshift-lifecycle-agent
 ----
 
-If you provide `ConfigMap` objects for OADP resources and extra manifests, {lcao} validates the specified `ConfigMap` objects during the `Prep` stage.
+If you provide `ConfigMap` objects for {oadp-short} resources and extra manifests, {lcao} validates the specified `ConfigMap` objects during the `Prep` stage.
 You might encounter the following issues: 
 
 * Validation warnings or errors if the {lcao} detects any issues with the `extraManifests` parameters.
diff --git a/modules/cnf-image-based-upgrade-seed-image-config.adoc b/modules/cnf-image-based-upgrade-seed-image-config.adoc
@@ -26,7 +26,7 @@ The following table lists the components, resources, and configurations that you
 |IP version ^[1]^
 |Yes
 
-|Set of Day 2 Operators, including the {lcao} and the OADP Operator
+|Set of Day 2 Operators, including the {lcao} and the {oadp-short} Operator
 |Yes
 
 |Disconnected registry configuration ^[2]^
@@ -48,7 +48,7 @@ a|Local volumes
 * `LVMCluster` CR for LVMS
 |No
 
-|OADP `DataProtectionApplication` CR
+|{oadp-short} `DataProtectionApplication` CR
 |No
 |====
 . Dual-stack networking is not supported in this release.
diff --git a/modules/cnf-image-based-upgrade-seed-image-guide.adoc b/modules/cnf-image-based-upgrade-seed-image-guide.adoc
@@ -18,7 +18,7 @@ This means that the seed cluster must match the configuration of the target clus
 Dual-stack networking is not supported in this release.
 ====
 
-* Set of Day 2 Operators, including the {lcao} and the OADP Operator
+* Set of Day 2 Operators, including the {lcao} and the {oadp-short} Operator
 * Disconnected registry
 * FIPS configuration
 * If the target cluster has multiple IPs and one of them belongs to the subnet that was used for creating the seed image, the upgrade fails if the target cluster's node IP does not belong to that subnet.
diff --git a/modules/cnf-image-based-upgrade-troubleshooting.adoc b/modules/cnf-image-based-upgrade-troubleshooting.adoc
@@ -25,7 +25,7 @@ $  oc adm must-gather \
   --image=quay.io/konveyor/oadp-must-gather:latest \// <1>
   --image=quay.io/openshift/origin-must-gather:latest <2>
 ----
-<1> (Optional) You can add this options if you need to gather more information from the OADP Operator.
+<1> (Optional) You can add this options if you need to gather more information from the {oadp-short} Operator.
 <2> (Optional) You can add this options if you need to gather more information from the SR-IOV Operator.
 
 [id="cnf-image-based-upgrade-troubleshooting-manual-cleanup_{context}"]
@@ -37,7 +37,8 @@ Issue::
 During the finalize stage or when you stop the process at the `Prep` stage, {lcao} cleans up the following resources:
 
 * Stateroot that is no longer required
-* OADP CRs
+* Precaching resources
+* {oadp-short} CRs
 * `ImageBasedUpgrade` CR
 
 If the {lcao} fails to perform the above steps, it transitions to the `AbortFailed` or `FinalizeFailed` states.
@@ -115,11 +116,11 @@ $ unshare -m /bin/sh -c "mount -o remount,rw /sysroot && rm -rf /sysroot/ostree/
 --
 
 [id="cnf-image-based-upgrade-troubleshooting-oadp-resources_{context}"]
-=== Cleaning up OADP resources manually
+=== Cleaning up {oadp-short} resources manually
 
 Issue::
 
-Automatic cleanup of OADP resources can fail due to connection issues between {lcao} and the S3 backend. By restoring the connection and adding the `lca.openshift.io/manual-cleanup-done` annotation, the {lcao} can successfully cleanup backup resources.
+Automatic cleanup of {oadp-short} resources can fail due to connection issues between {lcao} and the S3 backend. By restoring the connection and adding the `lca.openshift.io/manual-cleanup-done` annotation, the {lcao} can successfully cleanup backup resources.
 
 Resolution::
 --
diff --git a/modules/cnf-image-based-upgrade-with-backup.adoc b/modules/cnf-image-based-upgrade-with-backup.adoc
@@ -6,7 +6,7 @@
 = Moving to the Upgrade stage of the image-based upgrade with {lcao}
 
 After you generate the seed image and complete the `Prep` stage, you can upgrade the target cluster.
-During the upgrade process, the OADP Operator creates a backup of the artifacts specified in the OADP custom resources (CRs), then the {lcao} upgrades the cluster.
+During the upgrade process, the {oadp-short} Operator creates a backup of the artifacts specified in the {oadp-short} custom resources (CRs), then the {lcao} upgrades the cluster.
 
 If the upgrade fails or stops, an automatic rollback is initiated.
 If you have an issue after the upgrade, you can initiate a manual rollback.
@@ -72,7 +72,7 @@ status:
   - Rollback
 ----
 
-The OADP Operator creates a backup of the data specified in the OADP `Backup` and `Restore` CRs and the target cluster reboots.
+The {oadp-short} Operator creates a backup of the data specified in the {oadp-short} `Backup` and `Restore` CRs and the target cluster reboots.
 --
 
 . Monitor the status of the CR by running the following command:
@@ -98,6 +98,8 @@ You cannot roll back the changes once you move to the `Idle` stage after an upgr
 The {lcao} deletes all resources created during the upgrade process.
 --
 
+. You can remove the {oadp-short} Operator and its configuration files after a successful upgrade. For more information, see "Deleting Operators from a cluster".
+
 .Verification
 
 . Check the status of the `ImageBasedUpgrade` CR by running the following command:
diff --git a/modules/cnf-image-based-upgrade.adoc b/modules/cnf-image-based-upgrade.adoc
@@ -58,10 +58,10 @@ For the `Prep` stage, you specify the following upgrade details in the `ImageBas
 Then, based on what you specify, the {lcao} prepares for the upgrade without impacting the current running version.
 During this stage, the {lcao} ensures that the target cluster is ready to proceed to the `Upgrade` stage by checking if it meets certain conditions and pulls the seed image to the target cluster with additional container images specified in the seed image.
 
-You also prepare backup resources with the OADP Operator's `Backup` and `Restore` CRs.
+You also prepare backup resources with the {oadp-short} Operator's `Backup` and `Restore` CRs.
 These CRs are used in the `Upgrade` stage to reconfigure the cluster, register the cluster with {rh-rhacm}, and restore application artifacts.
 
-In addition to the OADP Operator, the {lcao} uses the `ostree` versioning system to install the new version as an `ostree` stateroot, which allows complete cluster reconfiguration after both upgrade and rollback.
+In addition to the {oadp-short} Operator, the {lcao} uses the `ostree` versioning system to create a backup, which allows complete cluster reconfiguration after both upgrade and rollback.
 
 After the `Prep` stage finishes, you can cancel the upgrade process by moving to the `Idle` stage or you can start the upgrade by moving to the `Upgrade` stage in the `ImageBasedUpgrade` CR.
 If you cancel the upgrade, the Operator performs cleanup operations.
diff --git a/modules/ztp-image-based-upgrade-installing-lca.adoc b/modules/ztp-image-based-upgrade-installing-lca.adoc
diff --git a/modules/ztp-image-based-upgrade-installing-oadp.adoc b/modules/ztp-image-based-upgrade-installing-oadp.adoc
diff --git a/modules/ztp-image-based-upgrade-prep-oadp.adoc b/modules/ztp-image-based-upgrade-prep-oadp.adoc
diff --git a/modules/ztp-image-based-upgrade-prep.adoc b/modules/ztp-image-based-upgrade-prep.adoc
diff --git a/modules/ztp-image-based-upgrade-upgrade.adoc b/modules/ztp-image-based-upgrade-upgrade.adoc
