Skip to content

Commit 92a8f31

Browse files
stevsmitSteven Smith
andauthored
Adds known issue to docs regarding an upgrade (quay#1152)
Co-authored-by: Steven Smith <[email protected]>
1 parent c641cab commit 92a8f31

File tree

2 files changed

+59
-2
lines changed

2 files changed

+59
-2
lines changed

modules/operator-upgrade.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,32 @@ To update {productname} from one minor version to the next, for example, 3.12.z
6969

7070
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

72+
[upgrading-312-to-313]
73+
=== Upgrading from {productname} 3.12 to 3.13
74+
75+
With {productname} 3.13, the `volumeSize` parameter has been implemented for use with the `clairpostgres` component of the `QuayRegistry` custom resource definition (CRD). This replaces the `volumeSize` parameter that was previously used for the `clair` component of the same CRD.
76+
77+
If your {productname} 3.12 `QuayRegistry` custom resource definition (CRD) implemented a volume override for the `clair` component, you must ensure that the `volumeSize` field is included under the `clairpostgres` component of the `QuayRegistry` CRD.
78+
79+
[IMPORTANT]
80+
====
81+
Failure to move `volumeSize` from the `clair` component to the `clairpostgres` component will result in a failed upgrade to version 3.13.
82+
====
83+
84+
For example:
85+
86+
[source,yaml]
87+
----
88+
spec:
89+
components:
90+
- kind: clair
91+
managed: true
92+
- kind: clairpostgres
93+
managed: true
94+
overrides:
95+
volumeSize: <volume_size>
96+
----
97+
7298
////
7399
[id="config-editor-removal"]
74100
== Removing config editor objects on {productname} Operator

modules/rn_3_13_0.adoc

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,34 @@ The following documentation changes have been made with the {productname} {produ
2222

2323
* A new book titled "link:https://docs.redhat.com/en/documentation/red_hat_quay/3.13/html-single/managing_access_and_permissions/index[Managing access and permissions]" has been created. This book covers topics related to access controls, repository visibility, and robot accounts by using the UI and the API. More content will be added to this book in the future.
2424

25+
[id="upgrading-quay-313"]
26+
== Upgrading to {productname} 3.13
27+
28+
With {productname} 3.13, the `volumeSize` parameter has been implemented for use with the `clairpostgres` component of the `QuayRegistry` custom resource definition (CRD). This replaces the `volumeSize` parameter that was previously used for the `clair` component of the same CRD.
29+
30+
If your {productname} 3.12 `QuayRegistry` custom resource definition (CRD) implemented a volume override for the `clair` component, you must ensure that the `volumeSize` field is included under the `clairpostgres` component of the `QuayRegistry` CRD.
31+
32+
[IMPORTANT]
33+
====
34+
Failure to move `volumeSize` from the `clair` component to the `clairpostgres` component will result in a failed upgrade to version 3.13.
35+
====
36+
37+
For example:
38+
39+
[source,yaml]
40+
----
41+
spec:
42+
components:
43+
- kind: clair
44+
managed: true
45+
- kind: clairpostgres
46+
managed: true
47+
overrides:
48+
volumeSize: <volume_size>
49+
----
50+
51+
For more information about upgrading, see link:https://docs.redhat.com/en/documentation/red_hat_quay/{productname}/html/upgrade_red_hat_quay/index[Upgrade {productname}].
52+
2553
[id="new-features-and-enhancements-313"]
2654
== {productname} new features and enhancements
2755

@@ -146,6 +174,7 @@ _optional_|Determine whether pruned tags should or should not match the tagPatte
146174

147175
For example API commands, see link:https://docs.redhat.com/en/documentation/red_hat_quay/3.12/html-single/manage_red_hat_quay/index#red-hat-quay-namespace-auto-pruning-overview[{productname} auto-pruning overview].
148176

177+
[id="federated-robot-token-api-endpoints"]
149178
=== New federated robot token API endpoints
150179

151180
The following API endpoints have been added for the keyless authentication with robot accounts feature:
@@ -166,14 +195,16 @@ For {productname-ocp} deployments, this update is automatically handled by the O
166195

167196
The following sections note known issues and limitations for {productname} {producty}.
168197

169-
[id="upgrading-known-issues"]
170-
=== Upgrading known issue
198+
[id="fips-mode-known-issue"]
199+
=== FIPS mode known issue
171200

172201
If FIPS mode is enabled for your {ocp} cluster and you use Clair, you must not upgrade the {productname} Operator to version {producty} If you upgrade, Clair will not function in your cluster. (link:https://issues.redhat.com/browse/PROJQUAY-8185[*PROJQUAY-8185*])
173202

174203
[id="registry-auto-pruning-known-issue"]
175204
=== Registry auto-pruning known issues
176205

206+
The following known issues apply to the auto-pruning feature.
207+
177208
[id="policy-prioritization-known-issue"]
178209
==== Policy prioritization known issue
179210

0 commit comments

Comments
 (0)