|
| 1 | +# entries is a list of entries to include in |
| 2 | +# release notes and/or the migration guide |
| 3 | + |
| 4 | +# TODO(everettraven): update changelog |
| 5 | +entries: |
| 6 | + - description: > |
| 7 | + For Go (go/v3) and Helm Hybrid (hybrid.helm/v1-alpha) language based operators: Upgrade Kubernetes dependencies from `1.23` to `1.24` and controller-gen from `v0.8.0` to `v0.9.0` |
| 8 | +
|
| 9 | + # kind is one of: |
| 10 | + # - addition |
| 11 | + # - change |
| 12 | + # - deprecation |
| 13 | + # - removal |
| 14 | + # - bugfix |
| 15 | + kind: "change" |
| 16 | +
|
| 17 | + # Is this a breaking change? |
| 18 | + breaking: false |
| 19 | +
|
| 20 | + # Migration can be defined to automatically add a section to |
| 21 | + # the migration guide. This is required for breaking changes. |
| 22 | + migration: |
| 23 | + header: Go (go/v3) and Helm Hybrid (hybrid.helm/v1-alpha) language based operators - Upgrade Kubernetes dependencies from `1.23` to `1.24` and controller-gen from `v0.8.0` to `v0.9.0` |
| 24 | + body: | |
| 25 | + To update your project to support Kubernetes 1.24: |
| 26 | + |
| 27 | + 1. In `go.mod`: |
| 28 | +
|
| 29 | + - Replace `k8s.io/api v0.23.5` with `k8s.io/api v0.24.0` |
| 30 | + - Replace `k8s.io/apimachinery v0.23.5` with `k8s.io/apimachinery v0.24.0` |
| 31 | + - Replace `k8s.io/client-go v0.23.5` with `k8s.io/client-go v0.24.0` |
| 32 | + - Replace `sigs.k8s.io/controller-runtime v0.11.2` with `sigs.k8s.io/controller-runtime v0.12.1` |
| 33 | + - Hybrid Helm (hybrid) only: Replace `github.com/operator-framework/helm-operator-plugins v0.0.11` with `github.com/operator-framework/helm-operator-plugins v0.0.12-0.20220608155702-d3967d2ae2ac` |
| 34 | +
|
| 35 | + 2. Run `go mod tidy` to ensure all dependencies are upgraded |
| 36 | + |
| 37 | + 3. In `Makefile`: |
| 38 | + - Replace `CONTROLLER_TOOLS_VERSION ?= 0.8.0` with `CONTROLLER_TOOLS_VERSION ?= 0.9.0` |
| 39 | + - Replace `ENVTEST_K8S_VERSION = 1.23` with `ENVTEST_K8S_VERSION = 1.24` |
| 40 | +
|
| 41 | + 4. Run `make` to run all make targets |
| 42 | +
|
| 43 | + - description: > |
| 44 | + For Go (go/v3) and Hybrid Helm (hybrid.helm/v1-alpha) language based operators: Add support for Go 1.18 |
| 45 | + |
| 46 | + # kind is one of: |
| 47 | + # - addition |
| 48 | + # - change |
| 49 | + # - deprecation |
| 50 | + # - removal |
| 51 | + # - bugfix |
| 52 | + kind: "addition" |
| 53 | +
|
| 54 | + # Is this a breaking change? |
| 55 | + breaking: false |
| 56 | +
|
| 57 | + # Migration can be defined to automatically add a section to |
| 58 | + # the migration guide. This is required for breaking changes. |
| 59 | + migration: |
| 60 | + header: Go (go/v3) and Hybrid Helm (hybrid.helm/v1-alpha) language based operators - Add support for Go 1.18 |
| 61 | + body: | |
| 62 | + To update your project to use Go 1.18: |
| 63 | +
|
| 64 | + 1. In the `go.mod` file: |
| 65 | +
|
| 66 | + - Replace `go 1.17` with `go 1.18` |
| 67 | +
|
| 68 | + 2. Run `go mod tidy` to ensure all dependencies are upgraded |
| 69 | +
|
| 70 | + - description: > |
| 71 | + For `operator-sdk bundle validate` command and GoodPractices validator (`--select-optional name=good-practices`): fix channel naming validation [More info](https://github.com/operator-framework/api/pull/231) |
| 72 | + |
| 73 | + # kind is one of: |
| 74 | + # - addition |
| 75 | + # - change |
| 76 | + # - deprecation |
| 77 | + # - removal |
| 78 | + # - bugfix |
| 79 | + kind: "bugfix" |
| 80 | +
|
| 81 | + # Is this a breaking change? |
| 82 | + breaking: false |
| 83 | +
|
| 84 | + - description: > |
| 85 | + For `operator-sdk bundle validate` command and GoodPractices validator (`--select-optional name=good-practices`): Add CRD description check validation [More info](https://github.com/operator-framework/api/pull/234) |
| 86 | + |
| 87 | + # kind is one of: |
| 88 | + # - addition |
| 89 | + # - change |
| 90 | + # - deprecation |
| 91 | + # - removal |
| 92 | + # - bugfix |
| 93 | + kind: "addition" |
| 94 | +
|
| 95 | + # Is this a breaking change? |
| 96 | + breaking: false |
| 97 | +
|
| 98 | + - description: > |
| 99 | + For `operator-sdk bundle validate` command and GoodPractices validator (`--select-optional name=good-practices`): Add a new check to warn authors when permissions to create CRDs are found [More info](https://github.com/operator-framework/api/pull/241) |
| 100 | + |
| 101 | + # kind is one of: |
| 102 | + # - addition |
| 103 | + # - change |
| 104 | + # - deprecation |
| 105 | + # - removal |
| 106 | + # - bugfix |
| 107 | + kind: "addition" |
| 108 | +
|
| 109 | + # Is this a breaking change? |
| 110 | + breaking: false |
| 111 | +
|
| 112 | + - description: > |
| 113 | + For Helm (helm/v1) and Hybrid Helm (hybrid.helm/v1-alpha) language based operators: Upgrade helm from `v3.6.2` to `v3.9.0` |
| 114 | + kind: "change" |
| 115 | + breaking: false |
| 116 | +
|
| 117 | + - description: > |
| 118 | + For Ansible (ansible/v1) and Helm (helm/v1) language based operators: change the default value for the manager.option LeaderElectionResourceLock from `comfigmaps` to `configmapsleases` to allow a safe transition to use the leases option on the future. [More info](https://github.com/kubernetes-sigs/controller-runtime/pull/1903) |
| 119 | + kind: "change" |
| 120 | + breaking: false |
| 121 | + |
| 122 | + - description: > |
| 123 | + For Quarkus (quarkus/v1-alpha) language based operator: add bundle generation [More info](https://github.com/operator-framework/java-operator-plugins/pull/84) |
| 124 | + kind: "addition" |
| 125 | + breaking: false |
| 126 | + |
| 127 | + - description: > |
| 128 | + For Quarkus (quarkus/v1-alpha) language based operator: upgrade dependency from `v0.0.3` to `v0.5.1` [More info](https://github.com/operator-framework/java-operator-plugins/releases) |
| 129 | + kind: "change" |
| 130 | + breaking: false |
| 131 | + |
| 132 | + - description: > |
| 133 | + For Helm Hybrid (hybrid.helm/v1-alpha) language based operator: Upgrade dependency from `v0.0.10` to `v0.0.11`. [More info](https://github.com/operator-framework/helm-operator-plugins/releases) |
| 134 | + kind: "change" |
| 135 | + breaking: false |
| 136 | +
|
| 137 | + - description: > |
| 138 | + For Go (go/v3, go/v2), Ansible (ansible/v1), Helm (helm/v1), and Helm Hybrid (hybrid.helm/v1-alpha) language based operators: Bump OPM version from `v1.19.1` to `v1.23.0` |
| 139 | + kind: "change" |
| 140 | + breaking: false |
| 141 | + migration: |
| 142 | + header: For Go (go/v3, go/v2), Ansible (ansible/v1), Helm (helm/v1), and Helm Hybrid (hybrid.helm/v1-alpha) language based operators - Bump OPM version from `v1.19.1` to `v1.23.0` [More info](https://github.com/operator-framework/operator-registry/releases) |
| 143 | + body: | |
| 144 | + To update your project to use OPM `v1.23.0`: |
| 145 | +
|
| 146 | + 1. In the `Makefile`: |
| 147 | +
|
| 148 | + - Replace `curl -sSLo $(OPM) https://github.com/operator-framework/operator-registry/releases/download/v1.19.1/$${OS}-$${ARCH}-opm` with `curl -sSLo $(OPM) https://github.com/operator-framework/operator-registry/releases/download/v1.23.0/$${OS}-$${ARCH}-opm` |
| 149 | +
|
| 150 | + 2. Run `make opm` |
| 151 | + - description: > |
| 152 | + For Docker images: Bump Go from 1.17 to 1.18 |
| 153 | + kind: "change" |
| 154 | + breaking: false |
| 155 | + |
| 156 | + - description: > |
| 157 | + Docs: Update Go 1.17 references to Go 1.18 |
| 158 | + kind: "change" |
| 159 | + breaking: false |
| 160 | +
|
| 161 | + - description: > |
| 162 | + For operator-sdk run bundle and bundle-upgrade subcommands: improve message from common scenario faced to add a new bundle [More info](https://github.com/operator-framework/operator-registry/pull/954) |
| 163 | + kind: "addition" |
| 164 | + breaking: false |
| 165 | +
|
| 166 | + - description: > |
| 167 | + For operator-sdk run bundle and bundle-upgrade subcommands: adds some extra text context to sql statement errors [More info](https://github.com/operator-framework/operator-registry/pull/953) |
| 168 | + kind: "addition" |
| 169 | + breaking: false |
0 commit comments