|
| 1 | +# entries is a list of entries to include in |
| 2 | +# release notes and/or the migration guide |
| 3 | +entries: |
| 4 | + - description: > |
| 5 | + (go/v3) Fixed a bug in `make test` caused by incorrect envtest asset setup. |
| 6 | +
|
| 7 | + kind: "change" |
| 8 | +
|
| 9 | + # Is this a breaking change? |
| 10 | + breaking: false |
| 11 | +
|
| 12 | + migration: |
| 13 | + header: (go/v3) Export `KUBEBUILDER_ASSETS` in `Makefile` |
| 14 | + body: > |
| 15 | + In `go/v3` projects, after installing `setup-envtest` binary, the path to |
| 16 | + `KUBEBUILDER_ASSETS` needs to be exported. In `Makefile`, add the following: |
| 17 | +
|
| 18 | + ```diff |
| 19 | + +# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary. |
| 20 | + +ENVTEST_K8S_VERSION = 1.21 |
| 21 | +
|
| 22 | + test: manifests generate fmt vet envtest ## Run tests. |
| 23 | + - go test ./... -coverprofile cover.out |
| 24 | + + KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test ./... -coverprofile cover.out |
| 25 | + ``` |
| 26 | + - description: > |
| 27 | + (go/v3, ansible/v1, helm/v1) Added `containerPort` protocol field required for server-side apply in manifests. |
| 28 | +
|
| 29 | + kind: "addition" |
| 30 | +
|
| 31 | + # Is this a breaking change? |
| 32 | + breaking: false |
| 33 | +
|
| 34 | + migration: |
| 35 | + header: (go/v3, ansible/v1, helm/v1) Add `containerPort` protocol field in manifests. |
| 36 | + body: > |
| 37 | + In `go/v3`, `ansible/v1`, `helm/v1` projects, specify the `containerPort` protocol in the following files: |
| 38 | + - `config/default/manager_auth_proxy_patch.yaml` |
| 39 | + - `config/rbac/auth_proxy_service.yaml` |
| 40 | +
|
| 41 | + ```diff |
| 42 | + ports: |
| 43 | + - containerPort: 8443 |
| 44 | + + protocol: TCP |
| 45 | + name: https |
| 46 | + ``` |
| 47 | +
|
| 48 | + Additionally, in `go/v3` projects, add the `containerPort` protocol to `config/webhook/service.yaml`: |
| 49 | +
|
| 50 | + ```diff |
| 51 | + ports: |
| 52 | + - port: 443 |
| 53 | + + protocol: TCP |
| 54 | + targetPort: 9443 |
| 55 | + ``` |
| 56 | +
|
| 57 | + - description: > |
| 58 | + (go/v3, ansible/v1, helm/v1) Increased resource limits for controller manager. |
| 59 | +
|
| 60 | + kind: "change" |
| 61 | +
|
| 62 | + # Is this a breaking change? |
| 63 | + breaking: false |
| 64 | +
|
| 65 | + migration: |
| 66 | + header: (go/v3, ansible/v1, helm/v1) Increase resource limits for controller manager. |
| 67 | + body: > |
| 68 | + In `go/v3`, `ansible/v1`, `helm/v1` projects, increase the `cpu` and `memory` resource limits to `200m` and |
| 69 | + `100Mi` respectively in `config/manager/manager.yaml`. |
| 70 | +
|
| 71 | + ```diff |
| 72 | + resources: |
| 73 | + limits: |
| 74 | + - cpu: 100m |
| 75 | + - memory: 30Mi |
| 76 | + + cpu: 200m |
| 77 | + + memory: 100Mi |
| 78 | + ``` |
0 commit comments