Skip to content

Commit 55fc4f9

Browse files
stevsmitSteven Smith
stevsmit
and
Steven Smith
authored
Adds upgrade info to 3.13 (quay#1135)
Co-authored-by: Steven Smith <[email protected]>
1 parent 3bc1f13 commit 55fc4f9

File tree

5 files changed

+81
-32
lines changed

5 files changed

+81
-32
lines changed

‎modules/attributes.adoc‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
:qbo: Quay Bridge Operator
99
:rhel: Red Hat Enterprise Linux (RHEL)
1010
:rhel-short: RHEL
11-
:ocp-y: 4.14
11+
:ocp-y: 4.17
1212

1313
ifeval::["{productname}" == "Project Quay"]
1414
:upstream:
@@ -19,7 +19,7 @@ ifeval::["{productname}" == "Project Quay"]
1919
:productrepo: quay.io/projectquay
2020
:quayimage: quay
2121
:clairimage: clair
22-
:clairproductminv: 4.7.4
22+
:clairproductminv: 4.8
2323
:builderimage: quay-builder
2424
:builderqemuimage: quay-builder-qemu:main
2525
:postgresimage: centos/postgresql-10-centos7@sha256:de1560cb35e5ec643e7b3a772ebaac8e3a7a2a8e8271d9e91ff023539b4dfb33
@@ -31,13 +31,14 @@ ifeval::["{productname}" == "Red Hat Quay"]
3131
:productname: Red Hat Quay
3232
:productversion: 3
3333
:producty: 3.13
34+
:producty-n1: 3.12
3435
:productmin: 3.13
3536
:productminv: v3.13
3637
:productrepo: registry.redhat.io/quay
37-
:clairnewver: v3.12
38+
:clairnewver: v3.13
3839
:quayimage: quay-rhel8
3940
:clairimage: clair-rhel8
40-
:clairproductminv: 4.7.4
41+
:clairproductminv: 4.8
4142
:builderimage: quay-builder-rhel8
4243
:builderqemuimage: quay-builder-qemu-rhcos
4344
:postgresimage: registry.redhat.io/rhel8/postgresql-13:1-109

‎modules/downgrade-quay-deployment.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[id="downgrade-quay-deployment"]
44
= Downgrading {productname}
55

6-
{productname} only supports rolling back, or downgrading, to previous z-stream versions, for example, 3.7.2 -> 3.7.1. Rolling back to previous y-stream versions (3.7.0 -> 3.6.0) is not supported. This is because {productname} updates might contain database schema upgrades that are applied when upgrading to a new version of {productname}. Database schema upgrades are not considered backwards compatible.
6+
{productname} only supports rolling back, or downgrading, to previous z-stream versions, for example, 3.12.3 -> 3.12.2. Rolling back to previous y-stream versions ({producty} -> {producty-n1}) is not supported. This is because {productname} updates might contain database schema upgrades that are applied when upgrading to a new version of {productname}. Database schema upgrades are not considered backwards compatible.
77

88
[IMPORTANT]
99
====

‎modules/operator-upgrade.adoc‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ This is required to ensure that any necessary database migrations are done corre
3030

3131
In some cases, {productname} supports direct, single-step upgrades from prior (N-2, N-3) minor versions. This simplifies the upgrade procedure for customers on older releases. The following upgrade paths are supported for {productname} {producty}:
3232

33-
* 3.10.z -> 3.12.z
34-
* 3.11.z -> 3.12.z
33+
* 3.11.z -> 3.13.z
34+
* 3.12.z -> 3.13.z
3535

36-
For users on standalone deployments of {productname} wanting to upgrade to 3.12, see the link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#standalone_upgrade[Standalone upgrade] guide.
36+
For users on standalone deployments of {productname} wanting to upgrade to 3.13, see the link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#standalone_upgrade[Standalone upgrade] guide.
3737

3838
[id="upgrading-red-hat-quay"]
39-
=== Upgrading {productname} to version 3.12
39+
=== Upgrading {productname} to version 3.13
4040

41-
To update {productname} from one minor version to the next, for example, 3.11 -> 3.12, you must change the update channel for the {productname} Operator.
41+
To update {productname} from one minor version to the next, for example, 3.12.z -> 3.13, you must change the update channel for the {productname} Operator.
4242

4343
.Procedure
4444

@@ -50,7 +50,7 @@ To update {productname} from one minor version to the next, for example, 3.11 ->
5050

5151
. Under *Subscription details* click *Update channel*.
5252

53-
. Select *stable-3.12* -> *Save*.
53+
. Select *stable-3.13* -> *Save*.
5454

5555
. Check the progress of the new installation under *Upgrade status*. Wait until the upgrade status changes to *1 installed* before proceeding.
5656

@@ -67,7 +67,7 @@ To update {productname} from one minor version to the next, for example, 3.11 ->
6767
[id="upgrading-minor-red-hat-quay"]
6868
=== Upgrading to the next minor release version
6969

70-
For `z` stream upgrades, for example, 3.11.1 -> 3.11.2, updates are released in the major-minor channel that the user initially selected during install. The procedure to perform a `z` stream upgrade depends on the `approvalStrategy` as outlined above. If the approval strategy is set to `Automatic`, the {productname} Operator upgrades automatically to the newest `z` stream. This results in automatic, rolling {productname} updates to newer `z` streams with little to no downtime. Otherwise, the update must be manually approved before installation can begin.
70+
For `z` stream upgrades, for example, 3.12.1 -> 3.12.2, updates are released in the major-minor channel that the user initially selected during install. The procedure to perform a `z` stream upgrade depends on the `approvalStrategy` as outlined above. If the approval strategy is set to `Automatic`, the {productname} Operator upgrades automatically to the newest `z` stream. This results in automatic, rolling {productname} updates to newer `z` streams with little to no downtime. Otherwise, the update must be manually approved before installation can begin.
7171

7272
////
7373
[id="config-editor-removal"]

‎modules/proc_upgrade_standalone.adoc‎

Lines changed: 58 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,43 @@
22
[id="standalone-upgrade"]
33
= Standalone upgrade
44

5-
In general, {productname} supports upgrades from a prior (N-1) minor version only. For example, upgrading directly from {productname} 3.0.5 to the latest version of 3.5 is not supported. Instead, users would have to upgrade as follows:
5+
In general, {productname} supports upgrades from a prior (N-1) minor version only. For example, upgrading directly from {productname} 3.8 to the latest version of {producty} is not supported. Instead, users would have to upgrade as follows:
66

7-
. 3.0.5 -> 3.1.3
8-
. 3.1.3 -> 3.2.2
9-
. 3.2.2 -> 3.3.4
10-
. 3.3.4 -> 3.4.z
11-
. 3.4.z -> 3.5.z
7+
. 3.8.z -> 3.9.z
8+
. 3.9.z -> 3.10.z
9+
. 3.10.z -> 3.11.z
10+
. 3.11.z -> 3.12.z
11+
. 3.12.z -> 3.13
1212

1313
This is required to ensure that any necessary database migrations are done correctly and in the right order during the upgrade.
1414

1515
In some cases, {productname} supports direct, single-step upgrades from prior (N-2, N-3) minor versions. This exception to the normal, prior minor version-only, upgrade simplifies the upgrade procedure for customers on older releases. The following upgrade paths are supported for {productname} {producty}:
1616

17-
* 3.10.z -> 3.12.z
18-
* 3.11.z -> 3.12.z
17+
* 3.10.z -> 3.13.z
18+
* 3.11.z -> 3.13.z
19+
* 3.12.z -> 3.13.z
1920
2021
For users wanting to upgrade the {productname} Operator, see link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#upgrading_quay_by_upgrading_the_quay_operator[Upgrading the {productname} Operator Overview].
2122

2223
This document describes the steps needed to perform each individual upgrade. Determine your current version and then follow the steps in sequential order, starting with your current version and working up to your desired target version.
2324

25+
//3.13
26+
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#upgrade_to_3_13_z_from_3_12_z[Upgrade to 3.13.z from 3.12.z]
27+
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#upgrade_to_3_13_z_from_3_11_z[Upgrade to 3.13.z from 3.11.z]
28+
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#upgrade_to_3_13_z_from_3_10_z[Upgrade to 3.13.z from 3.10.z]
29+
30+
////
31+
2432
//3.12
2533
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#upgrade_to_3_12_z_from_3_11_z[Upgrade to 3.12.z from 3.11.z]
2634
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#upgrade_to_3_12_z_from_3_10_z[Upgrade to 3.12.z from 3.10.z]
2735
36+
2837
//3.11
2938
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#upgrade_to_3_11_z_from_3_10_z[Upgrade to 3.11.z from 3.10.z]
3039
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#upgrade_to_3_11_z_from_3_9_z[Upgrade to 3.11.z from 3.9.z]
3140
32-
////
41+
3342
//3.10
3443
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#upgrade_to_3_10_z_from_3_9_z[Upgrade to 3.10.z from 3.9.z]
3544
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#upgrade_to_3_10_z_from_3_8_z[Upgrade to 3.10.z from 3.8.z]
@@ -70,6 +79,46 @@ The general procedure for a manual upgrade consists of the following steps:
7079
{productname} image from version 3.4.0 and later are available from link:https://registry.redhat.io[registry.redhat.io] and
7180
link:https://registry.access.redhat.com[registry.access.redhat.com], with authentication set up as described in link:https://access.redhat.com/RegistryAuthentication[Red Hat Container Registry Authentication].
7281

82+
== Upgrade to 3.13.z from 3.12.z
83+
84+
=== Target images
85+
* **Quay:** {productrepo}/{quayimage}:{productminv}
86+
ifdef::downstream[]
87+
* **Clair:** {productrepo}/{clairimage}:{productminv}
88+
endif::downstream[]
89+
ifdef::upstream[]
90+
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
91+
endif::upstream[]
92+
* **PostgreSQL:** {postgresimage}
93+
* **Redis:** {redisimage}
94+
95+
== Upgrade to 3.13.z from 3.11.z
96+
97+
=== Target images
98+
* **Quay:** {productrepo}/{quayimage}:{productminv}
99+
ifdef::downstream[]
100+
* **Clair:** {productrepo}/{clairimage}:{productminv}
101+
endif::downstream[]
102+
ifdef::upstream[]
103+
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
104+
endif::upstream[]
105+
* **PostgreSQL:** {postgresimage}
106+
* **Redis:** {redisimage}
107+
108+
== Upgrade to 3.13.z from 3.10.z
109+
110+
=== Target images
111+
* **Quay:** {productrepo}/{quayimage}:{productminv}
112+
ifdef::downstream[]
113+
* **Clair:** {productrepo}/{clairimage}:{productminv}
114+
endif::downstream[]
115+
ifdef::upstream[]
116+
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
117+
endif::upstream[]
118+
* **PostgreSQL:** {postgresimage}
119+
* **Redis:** {redisimage}
120+
121+
////
73122
== Upgrade to 3.12.z from 3.11.z
74123
75124
=== Target images
@@ -124,7 +173,6 @@ endif::upstream[]
124173
* **Redis:** {redisimage}
125174
126175
127-
////
128176
== Upgrade to 3.10.z from 3.9.z
129177
130178
=== Target images

‎modules/upgrading-geo-repl-quay.adoc‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ $ sudo podman ps
4040
[source,terminal]
4141
----
4242
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
43-
ec16ece208c0 registry.redhat.io/quay/quay-rhel8:v3.7.0 registry 6 minutes ago Up 6 minutes ago 0.0.0.0:80->8080/tcp, 0.0.0.0:443->8443/tcp quay01
43+
ec16ece208c0 registry.redhat.io/quay/quay-rhel8:v{producty-n1} registry 6 minutes ago Up 6 minutes ago 0.0.0.0:80->8080/tcp, 0.0.0.0:443->8443/tcp quay01
4444
----
4545

4646
.. Enter the following command on System B to reveal the {productname} instances:
@@ -56,7 +56,7 @@ $ sudo podman ps
5656
+
5757
----
5858
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
59-
7ae0c9a8b37d registry.redhat.io/quay/quay-rhel8:v3.7.0 registry 5 minutes ago Up 2 seconds ago 0.0.0.0:82->8080/tcp, 0.0.0.0:445->8443/tcp quay02
59+
7ae0c9a8b37d registry.redhat.io/quay/quay-rhel8:v{producty-n1} registry 5 minutes ago Up 2 seconds ago 0.0.0.0:82->8080/tcp, 0.0.0.0:445->8443/tcp quay02
6060
----
6161

6262
.. Enter the following command on System C to reveal the {productname} instances:
@@ -72,7 +72,7 @@ $ sudo podman ps
7272
+
7373
----
7474
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
75-
e75c4aebfee9 registry.redhat.io/quay/quay-rhel8:v3.7.0 registry 4 seconds ago Up 4 seconds ago 0.0.0.0:84->8080/tcp, 0.0.0.0:447->8443/tcp quay03
75+
e75c4aebfee9 registry.redhat.io/quay/quay-rhel8:v{producty-n1} registry 4 seconds ago Up 4 seconds ago 0.0.0.0:84->8080/tcp, 0.0.0.0:447->8443/tcp quay03
7676
----
7777

7878
. Temporarily shut down all {productname} instances on each system.
@@ -104,21 +104,21 @@ $ sudo podman stop e75c4aebfee9
104104
+
105105
[source,terminal]
106106
----
107-
$ sudo podman pull registry.redhat.io/quay/quay-rhel8:v3.8.0
107+
$ sudo podman pull registry.redhat.io/quay/quay-rhel8:{productminv}
108108
----
109109

110110
.. Enter the following command on System B to obtain the latest {productname} version:
111111
+
112112
[source,terminal]
113113
----
114-
$ sudo podman pull registry.redhat.io/quay/quay-rhel8:v3.8.0
114+
$ sudo podman pull registry.redhat.io/quay/quay-rhel8:v{producty}
115115
----
116116

117117
.. Enter the following command on System C to obtain the latest {productname} version:
118118
+
119119
[source,terminal]
120120
----
121-
$ sudo podman pull registry.redhat.io/quay/quay-rhel8:v3.8.0
121+
$ sudo podman pull registry.redhat.io/quay/quay-rhel8:{productminv}
122122
----
123123

124124
. On System A of your highly available {productname} deployment, run the new image version, for example, {productname} {producty}:
@@ -130,7 +130,7 @@ $ sudo podman pull registry.redhat.io/quay/quay-rhel8:v3.8.0
130130
--name=quay01 \
131131
-v /mnt/quay/config:/conf/stack:Z \
132132
-v /mnt/quay/storage:/datastorage:Z \
133-
-d registry.redhat.io/quay/quay-rhel8:v3.8.0
133+
-d registry.redhat.io/quay/quay-rhel8:{productminv}
134134
----
135135

136136
. Wait for the new {productname} container to become fully operational on System A. You can check the status of the container by entering the following command:
@@ -145,7 +145,7 @@ $ sudo podman ps
145145
[source,terminal]
146146
----
147147
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
148-
70b9f38c3fb4 registry.redhat.io/quay/quay-rhel8:v3.8.0 registry 2 seconds ago Up 2 seconds ago 0.0.0.0:82->8080/tcp, 0.0.0.0:445->8443/tcp quay01
148+
70b9f38c3fb4 registry.redhat.io/quay/quay-rhel8:v{producty} registry 2 seconds ago Up 2 seconds ago 0.0.0.0:82->8080/tcp, 0.0.0.0:445->8443/tcp quay01
149149
----
150150

151151
. Optional: Ensure that {productname} is fully operation by navigating to the {productname} UI.
@@ -161,7 +161,7 @@ CONTAINER ID IMAGE COMMAND CREATED
161161
--name=quay02 \
162162
-v /mnt/quay/config:/conf/stack:Z \
163163
-v /mnt/quay/storage:/datastorage:Z \
164-
-d registry.redhat.io/quay/quay-rhel8:v3.8.0
164+
-d registry.redhat.io/quay/quay-rhel8:{productminv}
165165
----
166166

167167
.. On System C of your highly available {productname} deployment, run the new image version, for example, {productname} {producty}:
@@ -173,7 +173,7 @@ CONTAINER ID IMAGE COMMAND CREATED
173173
--name=quay03 \
174174
-v /mnt/quay/config:/conf/stack:Z \
175175
-v /mnt/quay/storage:/datastorage:Z \
176-
-d registry.redhat.io/quay/quay-rhel8:v3.8.0
176+
-d registry.redhat.io/quay/quay-rhel8:{productminv}
177177
----
178178

179179
. You can check the status of the containers on System B and on System C by entering the following command:

0 commit comments

Comments
 (0)