You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There were several intentional breaking changes in the API
which are now included in v0.18.0 release.
This commit mostly focuses on updating the documentation to
reflect API changes. This includes making sure that snippets
and example outputs match the current state of the project.
Relevant PRs:
* #1439
* #1434
Signed-off-by: Mikalai Radchuk <mradchuk@redhat.com>
Copy file name to clipboardExpand all lines: docs/concepts/upgrade-support.md
+15-13Lines changed: 15 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ It also introduces an API to enable independently verified upgrades and downgrad
15
15
16
16
When determining upgrade edges, also known as upgrade paths or upgrade constraints, for an installed cluster extension, Operator Lifecycle Manager (OLM) v1 supports [legacy OLM semantics](https://olm.operatorframework.io/docs/concepts/olm-architecture/operator-catalog/creating-an-update-graph/) by default. This support follows the behavior from legacy OLM, including `replaces`, `skips`, and `skipRange` directives, with a few noted differences.
17
17
18
-
By supporting legacy OLM semantics, OLM v1 now honors the upgrade graph from catalogs accurately.
18
+
By supporting legacy OLM semantics, OLM v1 honors the upgrade graph from catalogs accurately.
19
19
20
20
If there are multiple possible successors, OLM v1 behavior differs in the following ways:
21
21
@@ -29,7 +29,7 @@ Consider the following set of file-based catalog (FBC) channel entries:
29
29
- name: example.v3.0.0
30
30
skips: ["example.v2.0.0"]
31
31
- name: example.v2.0.0
32
-
skipRange: >=1.0.0 <2.0.0
32
+
skipRange: ">=1.0.0 <2.0.0"
33
33
```
34
34
35
35
If `1.0.0` is installed, OLM v1 behavior differs in the following ways:
@@ -39,18 +39,21 @@ If `1.0.0` is installed, OLM v1 behavior differs in the following ways:
39
39
40
40
You can change the default behavior of the upgrade constraints by setting the `upgradeConstraintPolicy` parameter in your cluster extension's custom resource (CR).
41
41
42
-
``` yaml hl_lines="10"
42
+
``` yaml hl_lines="14"
43
43
apiVersion: olm.operatorframework.io/v1
44
44
kind: ClusterExtension
45
45
metadata:
46
46
name: <extension_name>
47
47
spec:
48
-
installNamespace: <namespace>
49
-
packageName: <package_name>
48
+
namespace: <namespace>
50
49
serviceAccount:
51
50
name: <service_account>
52
-
upgradeConstraintPolicy: SelfCertified
53
-
version: "<version_or_version_range>"
51
+
source:
52
+
sourceType: Catalog
53
+
catalog:
54
+
packageName: <package_name>
55
+
version: "<version_or_version_range>"
56
+
upgradeConstraintPolicy: SelfCertified
54
57
```
55
58
56
59
Setting the `upgradeConstraintPolicy` to:
@@ -82,26 +85,25 @@ You must verify and perform upgrades manually in cases where automatic upgrades
82
85
!!! warning
83
86
If you want to force an upgrade manually, you must thoroughly verify the outcome before applying any changes to production workloads. Failure to test and verify the upgrade might lead to catastrophic consequences such as data loss.
84
87
85
-
As a package admin, if you must upgrade or downgrade to version that might be incompatible with the currently installed version, you can set the `.spec.upgradeConstraintPolicy` field to `SelfCertified` on the relevant `ClusterExtension` resource.
88
+
As a package admin, if you must upgrade or downgrade to version that might be incompatible with the currently installed version, you can set the `.spec.source.catalog.upgradeConstraintPolicy` field to `SelfCertified` on the relevant `ClusterExtension` resource.
86
89
87
90
If you set the field to `SelfCertified`, no upgrade constraints are set on the package. As a result, you can change the version to any version available in the catalogs for a given package.
88
91
89
-
Example `ClusterExtension` with `.spec.upgradeConstraintPolicy` field set to `SelfCertified`:
92
+
Example `ClusterExtension` with `.spec.source.catalog.upgradeConstraintPolicy` field set to `SelfCertified`:
0 commit comments