Skip to content

Commit 60d1c39

Browse files
stevsmitSteven Smith
and
Steven Smith
authored
Update docs changes for 3.10 (#841)
Co-authored-by: Steven Smith <stevsmit@stevsmit.remote.csb>
1 parent 2896a9c commit 60d1c39

File tree

2 files changed

+94
-50
lines changed

2 files changed

+94
-50
lines changed

modules/operator-upgrade.adoc

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ When the {productname} Operator is installed by Operator Lifecycle Manager, it m
1414
====
1515

1616
[id="upgrading-quay-operator"]
17-
== Upgrading the Quay Operator
17+
== Upgrading the {productname} Operator
1818

1919
The standard approach for upgrading installed Operators on {ocp} is documented at link:https://docs.openshift.com/container-platform/{ocp-y}/operators/admin/olm-upgrading-operators.html[Upgrading installed Operators].
2020

@@ -28,26 +28,22 @@ In general, {productname} supports upgrades from a prior (N-1) minor version onl
2828

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

31-
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:
31+
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.3.z -> 3.6.z
34-
. 3.4.z -> 3.6.z
35-
. 3.4.z -> 3.7.z
36-
. 3.5.z -> 3.7.z
37-
. 3.7.z -> 3.8.z
38-
. 3.6.z -> 3.9.z
39-
. 3.7.z -> 3.9.z
40-
. 3.8.z -> 3.9.z
33+
* 3.7.z -> 3.10.z
34+
* 3.8.z -> 3.10.z
35+
* 3.9.z -> 3.10.z
4136

4237
For users on standalone deployments of {productname} wanting to upgrade to 3.9, 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.
4338

4439
[id="upgrading-red-hat-quay"]
45-
=== Upgrading Quay
40+
=== Upgrading {productname}
4641

47-
To update {productname} from one minor version to the next, for example, 3.4 -> 3.5, you must change the update channel for the {productname} Operator.
42+
To update {productname} from one minor version to the next, for example, 3.9 -> 3.10, you must change the update channel for the {productname} Operator.
4843

49-
For `z` stream upgrades, for example, 3.4.2 -> 3.4.3, 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 Quay Operator will upgrade automatically to the newest `z` stream. This results in automatic, rolling Quay updates to newer `z` streams with little to no downtime. Otherwise, the update must be manually approved before installation can begin.
44+
For `z` stream upgrades, for example, 3.9.1 -> 3.9.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.
5045

46+
////
5147
[id="upgrading-postgresql-databases"]
5248
=== Updating {productname} from 3.8 -> 3.9
5349
@@ -115,6 +111,7 @@ spec:
115111
116112
. After the `quay-app` pod is marked as *Running*, you can reach your {productname} registry.
117113
114+
118115
[id="upgrade-33-36"]
119116
=== Upgrading directly from 3.3.z or 3.4.z to 3.6
120117
@@ -146,6 +143,7 @@ spec:
146143
database:
147144
...
148145
----
146+
////
149147

150148
[id="upgrading-with-tls-cert-key-pairs-without-san"]
151149
==== Upgrading with custom SSL/TLS certificate/key pairs without Subject Alternative Names
@@ -160,6 +158,8 @@ If possible, you should regenerate your SSL/TLS certificates with the correct ho
160158

161159
The `GODEBUG=x509ignoreCN=0` flag enables the legacy behavior of treating the CommonName field on X.509 certificates as a hostname when no SANs are present. However, this workaround is not recommended, as it will not persist across a redeployment.
162160

161+
////
162+
163163
[id="configuring-clair-v4-upgrading-from-33-34-to-36"]
164164
==== Configuring Clair v4 when upgrading from 3.3.z or 3.4.z to 3.6 using the {productname} Operator
165165
@@ -189,6 +189,7 @@ When upgrading from {productname} 3.3.z to 3.6.z, some users might receive the f
189189
swift_password: *****
190190
swift_user: *****
191191
----
192+
////
192193

193194
[id="changin-update-channel-for-operator"]
194195
=== Changing the update channel for the {productname} Operator
@@ -209,7 +210,7 @@ The list of Installed Operators provides a high-level summary of the current Qua
209210
image:installed-operators-list.png[Installed Operators]
210211

211212
[id="upgrading-quayregistry"]
212-
== Upgrading a QuayRegistry
213+
== Upgrading a QuayRegistry resource
213214

214215
When the {productname} Operator starts, it immediately looks for any `QuayRegistries` it can find in the namespace(s) it is configured to watch. When it finds one, the following logic is used:
215216

modules/proc_upgrade_standalone.adoc

Lines changed: 79 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,22 @@ In general, {productname} supports upgrades from a prior (N-1) minor version onl
1212

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

15-
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:
15+
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.3.z -> 3.6.z
18-
. 3.4.z -> 3.6.z
19-
. 3.4.z -> 3.7.z
20-
. 3.5.z -> 3.7.z
21-
. 3.7.z -> 3.9.z
17+
* 3.7.z -> 3.10.z
18+
* 3.8.z -> 3.10.z
19+
* 3.9.z -> 3.10.z
2220
23-
//link
2421
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].
2522

2623
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.
2724

25+
//3.10
26+
* 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]
27+
* 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.9.z]
28+
* 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_7_z[Upgrade to 3.10.z from 3.7.z]
29+
30+
2831
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#upgrade_to_3_9_z_from_3_8_z[Upgrade to 3.9.z from 3.8.z]
2932
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#upgrade_to_3_9_z_from_3_7_z[Upgrade to 3.9.z from 3.7.z]
3033
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/upgrade_red_hat_quay/index#upgrade_to_3_8_z_from_3_7_z[Upgrade to 3.8.z from 3.7.z]
@@ -53,14 +56,52 @@ The general procedure for a manual upgrade consists of the following steps:
5356
. Start Clair using the new version of the image.
5457
. Wait until Clair is ready to accept connections before starting the new version of Quay.
5558

56-
5759
== Accessing images
5860

5961
Images for Quay 3.4.0 and later are available from link:https://registry.redhat.io[registry.redhat.io] and
6062
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].
6163

6264
Images for Quay 3.3.4 and earlier are available from link:https://quay.io[quay.io], with authentication set up as described in link:https://access.redhat.com/solutions/3533201[Accessing {productname} without a CoreOS login].
6365

66+
== Upgrade to 3.10.z from 3.9.z
67+
68+
=== Target images
69+
* **Quay:** {productrepo}/{quayimage}:{productminv}
70+
ifdef::downstream[]
71+
* **Clair:** {productrepo}/{clairimage}:{productminv}
72+
endif::downstream[]
73+
ifdef::upstream[]
74+
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
75+
endif::upstream[]
76+
* **PostgreSQL:** {postgresimage}
77+
* **Redis:** {redisimage}
78+
79+
== Upgrade to 3.10.z from 3.8.z
80+
81+
=== Target images
82+
* **Quay:** {productrepo}/{quayimage}:{productminv}
83+
ifdef::downstream[]
84+
* **Clair:** {productrepo}/{clairimage}:{productminv}
85+
endif::downstream[]
86+
ifdef::upstream[]
87+
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
88+
endif::upstream[]
89+
* **PostgreSQL:** {postgresimage}
90+
* **Redis:** {redisimage}
91+
92+
== Upgrade to 3.10.z from 3.7.z
93+
94+
=== Target images
95+
* **Quay:** {productrepo}/{quayimage}:{productminv}
96+
ifdef::downstream[]
97+
* **Clair:** {productrepo}/{clairimage}:{productminv}
98+
endif::downstream[]
99+
ifdef::upstream[]
100+
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
101+
endif::upstream[]
102+
* **PostgreSQL:** {postgresimage}
103+
* **Redis:** {redisimage}
104+
64105
== Upgrade to 3.9.z from 3.8.z
65106

66107
If you are upgrading your standalone {productname} deployment from 3.8.z -> 3.9, it is highly recommended that you upgrade PostgreSQL from version 10 -> 13. To upgrade PostgreSQL from 10 -> 13, you must bring down your PostgreSQL 10 database and run a migration script to initiate the process.
@@ -159,88 +200,90 @@ registry.redhat.io/quay/clair-rhel8:v3.9.0
159200

160201
For more information, see link:https://github.com/sclorg/postgresql-container/tree/master/13#data-migration[Data Migration].
161202

203+
//updating target images is where you left
204+
162205
=== Target images
163-
* **Quay:** {productrepo}/{quayimage}:{productminv}
206+
* **Quay:** {productrepo}/{quayimage}:v3.9.0
164207
ifdef::downstream[]
165-
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
208+
* **Clair:** {productrepo}/{clairimage}:v3.9.0
166209
endif::downstream[]
167210
ifdef::upstream[]
168211
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
169212
endif::upstream[]
170-
* **PostgreSQL:** registry.redhat.io/rhel8/postgresql-13:1-109
171-
* **Redis:** registry.redhat.io/rhel8/redis-6:1-110)
213+
* **PostgreSQL:** {postgresimage}
214+
* **Redis:** {redisimage}
172215

173216
== Upgrade to 3.9.z from 3.7.z
174217

175-
If you are upgrading your standalone {productname} deployment from 3.8.z -> 3.9, it is highly recommended that you upgrade PostgreSQL from version 10 -> 13. To upgrade PostgreSQL from 10 -> 13, you must bring down your PostgreSQL 10 database and run a migration script to initiate the process:
218+
If you are upgrading your standalone {productname} deployment from 3.7.z -> 3.9, it is highly recommended that you upgrade PostgreSQL from version 10 -> 13. To upgrade PostgreSQL from 10 -> 13, you must bring down your PostgreSQL 10 database and run a migration script to initiate the process:
176219

177220
[NOTE]
178221
====
179222
* When upgrading from {productname} 3.7 to 3.9, you might receive the following error: `pg_dumpall: error: query failed: ERROR: xlog flush request 1/B446CCD8 is not satisfied --- flushed only to 1/B0013858`. As a workaround to this issue, you can delete the `quayregistry-clair-postgres-upgrade` job on your {ocp} deployment, which should resolve the issue.
180223
====
181224

182225
=== Target images
183-
* **Quay:** {productrepo}/{quayimage}:{productminv}
226+
* **Quay:** {productrepo}/{quayimage}:v3.9.0
184227
ifdef::downstream[]
185-
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
228+
* **Clair:** {productrepo}/{clairimage}:v3.9.0
186229
endif::downstream[]
187230
ifdef::upstream[]
188231
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
189232
endif::upstream[]
190-
* **PostgreSQL:** registry.redhat.io/rhel8/postgresql-13:1-109
191-
* **Redis:** registry.redhat.io/rhel8/redis-6:1-110)
233+
* **PostgreSQL:** {postgresimage}
234+
* **Redis:** {redisimage}
192235

193236
== Upgrade to 3.8.z from 3.7.z
194237

195238
=== Target images
196239
* **Quay:** {productrepo}/{quayimage}:v3.8.0
197240
ifdef::downstream[]
198-
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
241+
* **Clair:** {productrepo}/{clairimage}:v3.8.0
199242
endif::downstream[]
200243
ifdef::upstream[]
201244
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
202245
endif::upstream[]
203-
* **PostgreSQL:** registry.redhat.io/rhel8/postgresql-13:1-109
204-
* **Redis:** registry.redhat.io/rhel8/redis-6:1-110)
246+
* **PostgreSQL:** {postgresimage}
247+
* **Redis:** {redisimage}
205248

206249
== Upgrade to 3.7.z from 3.6.z
207250

208251
=== Target images
209252
* **Quay:** {productrepo}/{quayimage}:v3.7.0
210253
ifdef::downstream[]
211-
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
254+
* **Clair:** {productrepo}/{clairimage}:v3.7.0
212255
endif::downstream[]
213256
ifdef::upstream[]
214257
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
215258
endif::upstream[]
216-
* **PostgreSQL:** registry.redhat.io/rhel8/postgresql-13:1-109
217-
* **Redis:** registry.redhat.io/rhel8/redis-6:1-110)
259+
* **PostgreSQL:** {postgresimage}
260+
* **Redis:** {redisimage}
218261

219262
== Upgrade to 3.7.z from 3.5.z
220263

221264
=== Target images
222265
* **Quay:** {productrepo}/{quayimage}:v3.7.0
223266
ifdef::downstream[]
224-
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
267+
* **Clair:** {productrepo}/{clairimage}:v3.7.0
225268
endif::downstream[]
226269
ifdef::upstream[]
227270
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
228271
endif::upstream[]
229-
* **PostgreSQL:** registry.redhat.io/rhel8/postgresql-13:1-109
230-
* **Redis:** registry.redhat.io/rhel8/redis-6:1-110)
272+
* **PostgreSQL:** {postgresimage}
273+
* **Redis:** {redisimage}
231274

232275
== Upgrade to 3.7.z from 3.4.z
233276

234277
=== Target images
235278
* **Quay:** {productrepo}/{quayimage}:v3.7.0
236279
ifdef::downstream[]
237-
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
280+
* **Clair:** {productrepo}/{clairimage}:v3.7.0
238281
endif::downstream[]
239282
ifdef::upstream[]
240283
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
241284
endif::upstream[]
242-
* **PostgreSQL:** registry.redhat.io/rhel8/postgresql-13:1-109
243-
* **Redis:** registry.redhat.io/rhel8/redis-6:1-110)
285+
* **PostgreSQL:** {postgresimage}
286+
* **Redis:** {redisimage}
244287

245288
== Upgrade to 3.7.z from 3.3.z
246289

@@ -251,13 +294,13 @@ Upgrading to {productname} 3.7 from 3.3. is unsupported. Users must first upgrad
251294
=== Target images
252295
* **Quay:** {productrepo}/{quayimage}:v3.6.0
253296
ifdef::downstream[]
254-
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
297+
* **Clair:** {productrepo}/{clairimage}:v3.6.0
255298
endif::downstream[]
256299
ifdef::upstream[]
257300
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
258301
endif::upstream[]
259-
* **PostgreSQL:** registry.redhat.io/rhel8/postgresql-13:1-109
260-
* **Redis:** registry.redhat.io/rhel8/redis-6:1-110)
302+
* **PostgreSQL:** {postgresimage}
303+
* **Redis:** {redisimage}
261304

262305
== Upgrade to 3.6.z from 3.4.z
263306

@@ -278,8 +321,8 @@ endif::downstream[]
278321
ifdef::upstream[]
279322
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
280323
endif::upstream[]
281-
* **PostgreSQL:** registry.redhat.io/rhel8/postgresql-13:1-109
282-
* **Redis:** registry.redhat.io/rhel8/redis-6:1-110)
324+
* **PostgreSQL:** {postgresimage}
325+
* **Redis:** {redisimage}
283326

284327
== Upgrade to 3.6.z from 3.3.z
285328

@@ -300,8 +343,8 @@ endif::downstream[]
300343
ifdef::upstream[]
301344
* **Clair:** {productrepo}/{clairimage}:{clairproductminv}
302345
endif::upstream[]
303-
* **PostgreSQL:** registry.redhat.io/rhel8/postgresql-13:1-109
304-
* **Redis:** registry.redhat.io/rhel8/redis-6:1-110)
346+
* **PostgreSQL:** {postgresimage}
347+
* **Redis:** {redisimage}
305348

306349
=== Swift configuration when upgrading from 3.3.z to 3.6
307350

0 commit comments

Comments
 (0)