Skip to content

Commit 61b9e72

Browse files
committed
OCPBUGS-36696: Add details about how to remove OADP Operator after IBU
1 parent c47ab29 commit 61b9e72

21 files changed

+143
-87
lines changed

edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ include::modules/cnf-image-based-upgrade-with-backup.adoc[leveloffset=+1]
2525

2626
* 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}]
2727
28+
* xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-cluster[Deleting Operators from a cluster]
29+
2830
include::modules/cnf-image-based-upgrade-rollback.adoc[leveloffset=+1]
2931

3032
include::modules/cnf-image-based-upgrade-troubleshooting.adoc[leveloffset=+1]

edge_computing/image_based_upgrade/cnf-understanding-image-based-upgrade.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ spec:
6565
<2> Defines the target platform version, the seed image to be used, and the secret required to access the image.
6666
<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.
6767
<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.
68-
<5> Specify the list of `ConfigMap` resources that contain the OADP `Backup` and `Restore` CRs.
68+
<5> Specify the list of `ConfigMap` resources that contain the {oadp-short} `Backup` and `Restore` CRs.
6969

7070
include::modules/cnf-image-based-upgrade.adoc[leveloffset=+1]
7171

@@ -119,4 +119,4 @@ include::modules/cnf-image-based-upgrade-extra-manifests-guide.adoc[leveloffset=
119119
120120
* 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}]
121121
122-
* xref:../../backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc#about-installing-oadp[About installing OADP]
122+
* xref:../../backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc#about-installing-oadp[About installing {oadp-short}]

edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-install-operators.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
Prepare your clusters for the upgrade by installing the {lcao} and the OADP Operator.
9+
Prepare your clusters for the upgrade by installing the {lcao} and the {oadp-short} Operator.
1010

11-
To install the OADP Operator with the non-GitOps method, see "Installing the OADP Operator".
11+
To install the {oadp-short} Operator with the non-GitOps method, see "Installing the {oadp-short} Operator".
1212

1313
[role="_additional-resources"]
1414
.Additional resources
1515

16-
* xref:../../../backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc#oadp-installing-operator-doc[Installing the OADP Operator]
16+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/oadp-installing-operator.adoc#oadp-installing-operator-doc[Installing the {oadp-short} Operator]
1717
1818
* 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]
1919

edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-prep-resources.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
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.
9+
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.
1010

1111
include::modules/cnf-image-based-upgrade-prep-oadp.adoc[leveloffset=+1]
1212

@@ -15,7 +15,7 @@ include::modules/cnf-image-based-upgrade-prep-oadp.adoc[leveloffset=+1]
1515

1616
* 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]
1717
18-
* xref:../../../backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc[About installing OADP]
18+
* xref:../../../backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc#about-installing-oadp[About installing {oadp-short}]
1919
2020
include::modules/cnf-image-based-upgrade-prep-extramanifests.adoc[leveloffset=+1]
2121

edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/ztp-image-based-upgrade-prep-resources.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
Create your OADP resources, extra manifests, and custom catalog sources wrapped in a `ConfigMap` object to prepare for the image-based upgrade.
9+
Create your {oadp-short} resources, extra manifests, and custom catalog sources wrapped in a `ConfigMap` object to prepare for the image-based upgrade.
1010

1111
include::modules/ztp-image-based-upgrade-prep-oadp.adoc[leveloffset=+1]
1212

@@ -15,7 +15,7 @@ include::modules/ztp-image-based-upgrade-prep-oadp.adoc[leveloffset=+1]
1515

1616
* 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}]
1717
18-
* 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}]
18+
* 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}]
1919
2020
include::modules/ztp-image-based-upgrade-prep-label-extramanifests.adoc[leveloffset=+1]
2121

edge_computing/image_based_upgrade/ztp-image-based-upgrade.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ include::modules/ztp-image-based-upgrade-upgrade.adoc[leveloffset=+1]
3737

3838
* 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}]
3939
40+
* xref:../../edge_computing/cnf-talm-for-cluster-upgrades.adoc#talo-policies-concept_cnf-topology-aware-lifecycle-manager[Update policies on managed clusters]
41+
4042
include::modules/ztp-image-based-upgrade-rollback.adoc[leveloffset=+1]
4143

4244
include::modules/cnf-image-based-upgrade-troubleshooting.adoc[leveloffset=+1]

modules/cnf-image-based-upgrade-backup-guide.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
// * edge_computing/image-based-upgrade/cnf-understanding-image-based-upgrade.adoc
33

44
[id="ztp-image-based-upgrade-backup-guide_{context}"]
5-
= OADP backup and restore guidelines
5+
= {oadp-short} backup and restore guidelines
66

7-
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.
7+
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.
88
The application must work on the current and the target {product-title} versions so that they can be restored after the upgrade.
99
The backups must include resources that were initially created.
1010

modules/cnf-image-based-upgrade-cluster-validated-software.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Depending on your deployment method, the image-based upgrade requires the follow
1717
|4.16
1818
|Yes
1919

20-
|OADP Operator
20+
|{oadp-short} Operator
2121
|1.3.1
2222
|Yes
2323

modules/cnf-image-based-upgrade-generate-seed-image.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Use the {lcao} to generate the seed image with the `SeedGenerator` CR. The Opera
1818
.Prerequisites
1919

2020
* Configure a shared container directory on the seed cluster.
21-
* Install the OADP Operator and the {lcao} on the seed cluster.
21+
* Install the {oadp-short} Operator and the {lcao} on the seed cluster.
2222
2323
.Procedure
2424

modules/cnf-image-based-upgrade-prep-oadp.adoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@
33

44
:_mod-docs-content-type: PROCEDURE
55
[id="cnf-image-based-upgrade-prep-oadp_{context}"]
6-
= Creating OADP ConfigMap objects for the image-based upgrade with {lcao}
6+
= Creating {oadp-short} ConfigMap objects for the image-based upgrade with {lcao}
77

8-
Create your OADP resources that are used to back up and restore your resources during the upgrade.
8+
Create your {oadp-short} resources that are used to back up and restore your resources during the upgrade.
99

1010
.Prerequisites
1111

1212
* Generate a seed image from a compatible seed cluster.
13-
* Create OADP backup and restore resources.
13+
* Create {oadp-short} backup and restore resources.
1414
* 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".
1515
* Deploy a version of {lcao} that is compatible with the version used with the seed image.
16-
* Install the OADP Operator, the `DataProtectionApplication` CR, and its secret on the target cluster.
17-
* Create an S3-compatible storage solution and a ready-to-use bucket with proper credentials configured. For more information, see "About installing OADP".
16+
* Install the {oadp-short} Operator, the `DataProtectionApplication` CR, and its secret on the target cluster.
17+
* Create an S3-compatible storage solution and a ready-to-use bucket with proper credentials configured. For more information, see "About installing {oadp-short}".
1818
1919
.Procedure
2020

21-
. Create the OADP `Backup` and `Restore` CRs for platform artifacts in the same namespace where the OADP Operator is installed, which is `openshift-adp`.
21+
. 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`.
2222

2323
.. If the target cluster is managed by {rh-rhacm}, add the following YAML file for backing up and restoring {rh-rhacm} artifacts:
2424
+
@@ -32,20 +32,20 @@ include::snippets/ibu-PlatformBackupRestore.adoc[]
3232
.PlatformBackupRestoreLvms.yaml for {lvms}
3333
include::snippets/ibu-PlatformBackupRestoreLvms.adoc[]
3434

35-
. If you need to restore applications after the upgrade, create the OADP `Backup` and `Restore` CRs for your application in the `openshift-adp` namespace.
35+
. 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.
3636

37-
.. Create the OADP CRs for cluster-scoped application artifacts in the `openshift-adp` namespace.
37+
.. Create the {oadp-short} CRs for cluster-scoped application artifacts in the `openshift-adp` namespace.
3838
+
39-
.Example OADP CRs for cluster-scoped application artifacts for LSO and {LVMS}
39+
.Example {oadp-short} CRs for cluster-scoped application artifacts for LSO and {LVMS}
4040
include::snippets/ibu-ApplicationClusterScopedBackupRestore.adoc[]
4141

42-
.. Create the OADP CRs for your namespace-scoped application artifacts.
42+
.. Create the {oadp-short} CRs for your namespace-scoped application artifacts.
4343
+
4444
--
45-
.Example OADP CRs namespace-scoped application artifacts when LSO is used
45+
.Example {oadp-short} CRs namespace-scoped application artifacts when LSO is used
4646
include::snippets/ibu-ApplicationBackupRestoreLso.adoc[]
4747

48-
.Example OADP CRs namespace-scoped application artifacts when {lvms} is used
48+
.Example {oadp-short} CRs namespace-scoped application artifacts when {lvms} is used
4949
include::snippets/ibu-ApplicationBackupRestoreLvms.adoc[]
5050

5151
[IMPORTANT]
@@ -54,7 +54,7 @@ The same version of the applications must function on both the current and the t
5454
====
5555
--
5656

57-
. Create the `ConfigMap` object for your OADP CRs by running the following command:
57+
. Create the `ConfigMap` object for your {oadp-short} CRs by running the following command:
5858
+
5959
[source,terminal]
6060
----

modules/cnf-image-based-upgrade-prep.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ spec:
4646
<3> Specify the reference to a secret with credentials to pull container images if the images are in a private registry.
4747
<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.
4848
<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.
49-
<6> Add the `oadpContent` section with the OADP `ConfigMap` information.
49+
<6> Add the `oadpContent` section with the {oadp-short} `ConfigMap` information.
5050

5151
. To start the `Prep` stage, change the value of the `stage` field to `Prep` in the `ImageBasedUpgrade` CR by running the following command:
5252
+
@@ -56,7 +56,7 @@ spec:
5656
$ oc patch imagebasedupgrades.lca.openshift.io upgrade -p='{"spec": {"stage": "Prep"}}' --type=merge -n openshift-lifecycle-agent
5757
----
5858

59-
If you provide `ConfigMap` objects for OADP resources and extra manifests, {lcao} validates the specified `ConfigMap` objects during the `Prep` stage.
59+
If you provide `ConfigMap` objects for {oadp-short} resources and extra manifests, {lcao} validates the specified `ConfigMap` objects during the `Prep` stage.
6060
You might encounter the following issues:
6161

6262
* Validation warnings or errors if the {lcao} detects any issues with the `extraManifests` parameters.

modules/cnf-image-based-upgrade-seed-image-config.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The following table lists the components, resources, and configurations that you
2626
|IP version ^[1]^
2727
|Yes
2828

29-
|Set of Day 2 Operators, including the {lcao} and the OADP Operator
29+
|Set of Day 2 Operators, including the {lcao} and the {oadp-short} Operator
3030
|Yes
3131

3232
|Disconnected registry configuration ^[2]^
@@ -48,7 +48,7 @@ a|Local volumes
4848
* `LVMCluster` CR for LVMS
4949
|No
5050
51-
|OADP `DataProtectionApplication` CR
51+
|{oadp-short} `DataProtectionApplication` CR
5252
|No
5353
|====
5454
. Dual-stack networking is not supported in this release.

modules/cnf-image-based-upgrade-seed-image-guide.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This means that the seed cluster must match the configuration of the target clus
1818
Dual-stack networking is not supported in this release.
1919
====
2020

21-
* Set of Day 2 Operators, including the {lcao} and the OADP Operator
21+
* Set of Day 2 Operators, including the {lcao} and the {oadp-short} Operator
2222
* Disconnected registry
2323
* FIPS configuration
2424
* 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.

modules/cnf-image-based-upgrade-troubleshooting.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ $ oc adm must-gather \
2525
--image=quay.io/konveyor/oadp-must-gather:latest \// <1>
2626
--image=quay.io/openshift/origin-must-gather:latest <2>
2727
----
28-
<1> (Optional) You can add this options if you need to gather more information from the OADP Operator.
28+
<1> (Optional) You can add this options if you need to gather more information from the {oadp-short} Operator.
2929
<2> (Optional) You can add this options if you need to gather more information from the SR-IOV Operator.
3030

3131
[id="cnf-image-based-upgrade-troubleshooting-manual-cleanup_{context}"]
@@ -37,7 +37,8 @@ Issue::
3737
During the finalize stage or when you stop the process at the `Prep` stage, {lcao} cleans up the following resources:
3838

3939
* Stateroot that is no longer required
40-
* OADP CRs
40+
* Precaching resources
41+
* {oadp-short} CRs
4142
* `ImageBasedUpgrade` CR
4243

4344
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/
115116
--
116117

117118
[id="cnf-image-based-upgrade-troubleshooting-oadp-resources_{context}"]
118-
=== Cleaning up OADP resources manually
119+
=== Cleaning up {oadp-short} resources manually
119120

120121
Issue::
121122

122-
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.
123+
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.
123124

124125
Resolution::
125126
--

modules/cnf-image-based-upgrade-with-backup.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
= Moving to the Upgrade stage of the image-based upgrade with {lcao}
77

88
After you generate the seed image and complete the `Prep` stage, you can upgrade the target cluster.
9-
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.
9+
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.
1010

1111
If the upgrade fails or stops, an automatic rollback is initiated.
1212
If you have an issue after the upgrade, you can initiate a manual rollback.
@@ -72,7 +72,7 @@ status:
7272
- Rollback
7373
----
7474

75-
The OADP Operator creates a backup of the data specified in the OADP `Backup` and `Restore` CRs and the target cluster reboots.
75+
The {oadp-short} Operator creates a backup of the data specified in the {oadp-short} `Backup` and `Restore` CRs and the target cluster reboots.
7676
--
7777

7878
. 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
9898
The {lcao} deletes all resources created during the upgrade process.
9999
--
100100

101+
. You can remove the {oadp-short} Operator and its configuration files after a successful upgrade. For more information, see "Deleting Operators from a cluster".
102+
101103
.Verification
102104

103105
. Check the status of the `ImageBasedUpgrade` CR by running the following command:

modules/cnf-image-based-upgrade.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ For the `Prep` stage, you specify the following upgrade details in the `ImageBas
5858
Then, based on what you specify, the {lcao} prepares for the upgrade without impacting the current running version.
5959
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.
6060

61-
You also prepare backup resources with the OADP Operator's `Backup` and `Restore` CRs.
61+
You also prepare backup resources with the {oadp-short} Operator's `Backup` and `Restore` CRs.
6262
These CRs are used in the `Upgrade` stage to reconfigure the cluster, register the cluster with {rh-rhacm}, and restore application artifacts.
6363

64-
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.
64+
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.
6565

6666
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.
6767
If you cancel the upgrade, the Operator performs cleanup operations.

0 commit comments

Comments
 (0)