Skip to content

Commit 6a77863

Browse files
anarnold97anarnold97
committed
MIG-1453: updating upgrade documentation
1 parent 3711334 commit 6a77863

File tree

5 files changed

+173
-0
lines changed

5 files changed

+173
-0
lines changed

‎migration_toolkit_for_containers/upgrading-mtc.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ If you are upgrading from {mtc-short} version 1.3, you must perform an additiona
1717
====
1818

1919
include::modules/migration-upgrading-mtc-on-ocp-4.adoc[leveloffset=+1]
20+
include::modules/upgrading-mtc-1-8-0.adoc[leveloffset=+1]
21+
include::modules/upgrading-oadp10-to12-in-mtc.adoc[leveloffset=+2]
2022
include::modules/migration-upgrading-mtc-with-legacy-operator.adoc[leveloffset=+1]
2123
include::modules/migration-upgrading-from-mtc-1-3.adoc[leveloffset=+1]
2224
:upgrading-mtc!:

‎modules/migration-upgrading-from-mtc-1-3.adoc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ If you are upgrading {mtc-full} ({mtc-short}) version 1.3.x to {mtc-version}, yo
1111

1212
Because the `indirectImageMigration` and `indirectVolumeMigration` parameters do not exist in {mtc-short} 1.3, their default value in version 1.4 is `false`, which means that direct image migration and direct volume migration are enabled. Because the direct migration requirements are not fulfilled, the migration plan cannot reach a `Ready` state unless these parameter values are changed to `true`.
1313

14+
[IMPORTANT]
15+
16+
====
17+
* Migrating from {product-title} 3 to {product-title} 4 requires a legacy {mtc-short} Operator and {mtc-short} 1.7.x.
18+
* Upgrading MTC 1.7.x to 1.8.x requires manually updating the OADP channel from `stable-1.0` to `stable-1.2` in order to successfully complete the upgrade from 1.7.x to 1.8.x.
19+
====
20+
1421
.Prerequisites
1522

1623
* You must be logged in as a user with `cluster-admin` privileges.

‎modules/migration-upgrading-mtc-on-ocp-4.adoc‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,22 @@
99

1010
You can upgrade the {mtc-full} ({mtc-short}) on {product-title} {product-version} by using the Operator Lifecycle Manager.
1111

12+
[IMPORTANT]
13+
====
14+
When upgrading the {mtc-short} by using the Operator Lifecycle Manager, you must use a supported migration path.
15+
====
16+
17+
.Migration paths
18+
* Migrating from {product-title} 3 to {product-title} 4 requires a legacy {mtc-short} Operator and {mtc-short} 1.7.x.
19+
* Migrating from {mtc-short} 1.7.x to {mtc-short} 1.8.x is not supported.
20+
* You must use {mtc-short} 1.7.x to migrate anything with a source of {product-title} 4.9 or earlier.
21+
** {mtc-short} 1.7.x must be used on both source and destination.
22+
* MTC 1.8.x only supports migrations from {product-title} 4.10 or later to {product-title} 4.10 or later. For migrations only involving cluster versions 4.10 and later, either 1.7.x or 1.8.x may be used. However, it must be the same MTC version on both source & destination.
23+
** Migration from source {mtc-short} 1.7.x to destination {mtc-short} 1.8.x is unsupported.
24+
** Migration from source {mtc-short} 1.8.x to destination {mtc-short} 1.7.x is unsupported.
25+
** Migration from source {mtc-short} 1.7.x to destination {mtc-short} 1.7.x is supported.
26+
** Migration from source {mtc-short} 1.8.x to destination {mtc-short} 1.8.x is supported
27+
1228
.Prerequisites
1329

1430
* You must be logged in as a user with `cluster-admin` privileges.

‎modules/upgrading-mtc-1-8-0.adoc‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * migration_toolkit_for_containers/upgrading-mtc.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="migration-upgrading-mtc-18_{context}"]
7+
= Upgrading the {mtc-full} to 1.8.0
8+
9+
To upgrade the {mtc-full} to 1.8.0, complete the following steps.
10+
11+
.Procedure
12+
13+
. Determine subscription names and current channels to work with for upgrading by using one of the following methods:
14+
15+
** Determine the subscription names and channels by running the following command:
16+
+
17+
[source,terminal]
18+
----
19+
$ oc -n openshift-migration get sub
20+
----
21+
+
22+
.Example output
23+
[source,terminal]
24+
----
25+
NAME PACKAGE SOURCE CHANNEL
26+
mtc-operator mtc-operator mtc-operator-catalog release-v1.7
27+
redhat-oadp-operator-stable-1.0-mtc-operator-catalog-openshift-marketplace redhat-oadp-operator mtc-operator-catalog stable-1.0
28+
----
29+
30+
** Or return the subscription names and channels in JSON by running the following command:
31+
+
32+
[source,terminal]
33+
----
34+
$ oc -n openshift-migration get sub -o json | jq -r '.items[] | { name: .metadata.name, package: .spec.name, channel: .spec.channel }'
35+
----
36+
+
37+
.Example output
38+
[source,terminal]
39+
----
40+
{
41+
"name": "mtc-operator",
42+
"package": "mtc-operator",
43+
"channel": "release-v1.7"
44+
}
45+
{
46+
"name": "redhat-oadp-operator-stable-1.0-mtc-operator-catalog-openshift-marketplace",
47+
"package": "redhat-oadp-operator",
48+
"channel": "stable-1.0"
49+
}
50+
----
51+
52+
. For each subscription, patch to move from the {mtc-short} 1.7 channel to the {mtc-short} 1.8 channel by running the following command:
53+
+
54+
[source,terminal]
55+
----
56+
$ oc -n openshift-migration patch subscription mtc-operator --type merge --patch '{"spec": {"channel": "release-v1.8"}}'
57+
----
58+
+
59+
.Example output
60+
[source,terminal]
61+
----
62+
subscription.operators.coreos.com/mtc-operator patched
63+
----
64+

‎modules/upgrading-oadp10-to12-in-mtc.adoc‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * migrating_from_ocp_3_to_4/upgrading-3-4.adoc
4+
// * migration_toolkit_for_containers/upgrading-mtc.adoc
5+
6+
:_content-type: PROCEDURE
7+
[id="migration-upgrading-oadp-for-mtc-18_{context}"]
8+
= Upgrading OADP 1.0 to 1.2 for {mtc-full} 1.8.0
9+
10+
To upgrade OADP 1.0 to 1.2 for {mtc-full} 1.8.0, complete the following steps.
11+
12+
.Procedure
13+
14+
15+
* For each subscription, patch the OADP operator from OADP 1.0 to OADP 1.2 by running the following command:
16+
+
17+
[source,terminal]
18+
----
19+
$ oc -n openshift-migration patch subscription redhat-oadp-operator-stable-1.0-mtc-operator-catalog-openshift-marketplace --type merge --patch '{"spec": {"channel":"stable-1.2"}}'
20+
----
21+
+
22+
[NOTE]
23+
====
24+
Sections indicating the user-specific returned `NAME` values that are used for the installation of MTC & OADP, respectively.
25+
====
26+
+
27+
.Example output
28+
[source,terminal]
29+
----
30+
subscription.operators.coreos.com/redhat-oadp-operator-stable-1.0-mtc-operator-catalog-openshift-marketplace patched
31+
----
32+
+
33+
[NOTE]
34+
====
35+
The returned value will be similar to `redhat-oadp-operator-stable-1.0-mtc-operator-catalog-openshift-marketplace`, which is used in this example.
36+
====
37+
+
38+
--
39+
* If the `installPlanApproval` parameter is set to `Automatic`, the Operator Lifecycle Manager (OLM) begins the upgrade process.
40+
* If the `installPlanApproval` parameter is set to `Manual`, you must approve each `installPlan` before the OLM begins the upgrades.
41+
--
42+
43+
.Verification
44+
. Verify that the OLM has completed the upgrades of OADP and {mtc-short} by running the following command:
45+
+
46+
[source,terminal]
47+
----
48+
$ oc -n openshift-migration get subscriptions.operators.coreos.com mtc-operator -o json | jq '.status | (."state"=="AtLatestKnown")'
49+
----
50+
51+
. When a value of `true` is returned, verify the channel used for each subscription by running the following command:
52+
+
53+
[source,terminal]
54+
----
55+
$ oc -n openshift-migration get sub -o json | jq -r '.items[] | {name: .metadata.name, channel: .spec.channel }'
56+
----
57+
+
58+
.Example output
59+
[source,terminal]
60+
----
61+
{
62+
"name": "mtc-operator",
63+
"channel": "release-v1.8"
64+
}
65+
{
66+
"name": "redhat-oadp-operator-stable-1.0-mtc-operator-catalog-openshift-marketplace",
67+
"channel": "stable-1.2"
68+
}
69+
----
70+
71+
Confirm that the `mtc-operator.v1.8.0` and `oadp-operator.v1.2.x` packages are installed by running the following command:
72+
+
73+
[source,terminal]
74+
----
75+
$ oc -n openshift-migration get csv
76+
----
77+
+
78+
.Example output
79+
[source,terminal]
80+
----
81+
NAME DISPLAY VERSION REPLACES PHASE
82+
mtc-operator.v1.8.0 Migration Toolkit for Containers Operator 1.8.0 mtc-operator.v1.7.13 Succeeded
83+
oadp-operator.v1.2.2 OADP Operator 1.2.2 oadp-operator.v1.0.13 Succeeded
84+
----

0 commit comments

Comments
 (0)