kayx23 commented on code in PR #2838: URL: https://github.com/apache/apisix-ingress-controller/pull/2838#discussion_r3757181483
########## releases/v2.2.0.toml: ########## @@ -0,0 +1,268 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# commit to be tagged for new release +commit = "HEAD" + +# project_name is used to refer to the project in the notes +project_name = "apisix-ingress-controller" + +# github_repo is the github project, only github is currently supported +github_repo = "apache/apisix-ingress-controller" + +# match_deps is a pattern to determine which dependencies should be included +# as part of this release. The changelog will also include changes for these +# dependencies based on the change in the dependency's version. +match_deps = "^github.com/(apache/[a-zA-Z0-9-]+)$" + +# previous release of this project for determining changes +previous = "2.1.0" + +# pre_release is whether to include a disclaimer about being a pre-release +pre_release = false + +# preface is the description of the release which precedes the author list +# and changelog. This description could include highlights as well as any +# description of changes. Use markdown formatting. +preface = """\ + +## Highlights + +* **Gateway API 1.6.0** support [#2804](https://github.com/apache/apisix-ingress-controller/pull/2804). `TCPRoute`, `UDPRoute`, `TLSRoute` and `ReferenceGrant` are now read through `gateway.networking.k8s.io/v1` [#2839](https://github.com/apache/apisix-ingress-controller/pull/2839). +* **Downstream mTLS** on `Gateway` listeners, configured at `spec.tls.frontend` [#2792](https://github.com/apache/apisix-ingress-controller/pull/2792). +* **`L4RoutePolicy`**, a new CRD that attaches stream plugins to L4 routes [#2791](https://github.com/apache/apisix-ingress-controller/pull/2791). +* **L4 upstream schemes** `tcp`, `tls` and `udp` for stream backends [#2830](https://github.com/apache/apisix-ingress-controller/pull/2830). +* **Security fixes**: credentials are kept out of the logs, a cross-namespace `Consumer` `secretRef` is gated by a `ReferenceGrant`, and the `Consumer` webhook no longer reveals whether a `Secret` exists in another namespace. + +--- + +## Upgrade Notes + +**Kubernetes 1.31 or newer is recommended.** On an older cluster the controller logs a +warning and keeps running; nothing refuses to start. What needs 1.31 in practice are the +Gateway API 1.6.0 CRDs, whose CEL validation rules use features added in that release. + +**Install the Gateway API CRDs with server-side apply.** The v1.6.0 CRDs exceed the +annotation size limit of client-side apply: + +```shell +kubectl apply --server-side --force-conflicts -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.6.0/experimental-install.yaml +``` + +**`listener_port_match_mode` now covers L4 routes too** +[#2818](https://github.com/apache/apisix-ingress-controller/pull/2818). `TCPRoute` and +`UDPRoute` join `HTTPRoute` and `GRPCRoute` under the `server_port` route-var injection +this option gates. The default `off` keeps the previous behavior: one portless +`StreamRoute` per rule, matching every connection on the stream listener. The other two +modes now apply to L4 as well: + +| mode | when `server_port` is injected | +| ---- | ------------------------------ | +| `off` (default) | never | +| `explicit` | a parentRef pins `sectionName` or `port` | +| `auto` | that, or the `Gateway` has more than one listener port | + +Once injected, the `Gateway` listener port must equal the port APISIX actually accepts +the connection on, or nothing matches: + +```yaml +listeners: + - name: tcp + protocol: TCP + port: 9100 # must equal an APISIX stream_proxy.tcp port +``` + +--- + +## Breaking Changes + +### A cross-namespace `Consumer` `secretRef` now requires a `ReferenceGrant` + +[#2805](https://github.com/apache/apisix-ingress-controller/pull/2805). Without a grant +the `Consumer` stops reconciling and its credential is no longer programmed. Create the +grant in the `Secret`'s namespace before upgrading: + +```yaml +apiVersion: gateway.networking.k8s.io/v1beta1 +kind: ReferenceGrant +metadata: + name: consumer-to-secret + namespace: secret-ns # where the Secret lives +spec: + from: + - group: apisix.apache.org + kind: Consumer + namespace: consumer-ns # where the Consumer lives + to: + - group: "" + kind: Secret Review Comment: Verified on `0fd98043`: the example now scopes `to.name` to `consumer-credentials` and explicitly explains the wildcard effect of omission in both files. This resolves the concern. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
