Skip to content

Commit

Permalink
Adds known issue to docs regarding an upgrade (#1152)
Browse files Browse the repository at this point in the history
Co-authored-by: Steven Smith <[email protected]>
  • Loading branch information
stevsmit and Steven Smith authored Nov 6, 2024
1 parent c641cab commit 92a8f31
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 2 deletions.
26 changes: 26 additions & 0 deletions modules/operator-upgrade.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,32 @@ To update {productname} from one minor version to the next, for example, 3.12.z

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.

[upgrading-312-to-313]
=== Upgrading from {productname} 3.12 to 3.13

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.

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.

[IMPORTANT]
====
Failure to move `volumeSize` from the `clair` component to the `clairpostgres` component will result in a failed upgrade to version 3.13.
====

For example:

[source,yaml]
----
spec:
components:
- kind: clair
managed: true
- kind: clairpostgres
managed: true
overrides:
volumeSize: <volume_size>
----

////
[id="config-editor-removal"]
== Removing config editor objects on {productname} Operator
Expand Down
35 changes: 33 additions & 2 deletions modules/rn_3_13_0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,34 @@ The following documentation changes have been made with the {productname} {produ

* 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.

[id="upgrading-quay-313"]
== Upgrading to {productname} 3.13

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.

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.

[IMPORTANT]
====
Failure to move `volumeSize` from the `clair` component to the `clairpostgres` component will result in a failed upgrade to version 3.13.
====

For example:

[source,yaml]
----
spec:
components:
- kind: clair
managed: true
- kind: clairpostgres
managed: true
overrides:
volumeSize: <volume_size>
----

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}].

[id="new-features-and-enhancements-313"]
== {productname} new features and enhancements

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

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].

[id="federated-robot-token-api-endpoints"]
=== New federated robot token API endpoints

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

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

[id="upgrading-known-issues"]
=== Upgrading known issue
[id="fips-mode-known-issue"]
=== FIPS mode known issue

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*])

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

The following known issues apply to the auto-pruning feature.

[id="policy-prioritization-known-issue"]
==== Policy prioritization known issue

Expand Down

0 comments on commit 92a8f31

Please sign in to comment.