Gateway API v1.2.0
Release Notes
On behalf of Kubernetes SIG Network, we are excited to announce the release of v1.2! This release includes the graduation of 3 features to the standard channel and the introduction of 4 new features to the experimental channel, along with several improvements in many project areas.
Breaking Changes
GRPCRoute and ReferenceGrant v1alpha2 removal
As per a previous deprecation notice, in this version, both Experimental
and Standard channel CRDs will no longer serve the v1alpha2 versions
of GRPCRoute and ReferenceGrant.
- Disable v1alpha2 versions for GRPCRoute and ReferenceGrant by @youngnick in #3361
Upgrades
Before upgrading to Gateway API v1.2, you'll want to confirm that any
implementations of Gateway API have been upgraded to support the v1 API
version of these resources instead of the v1alpha2 API version. Note that
even if you've been using v1 in your YAML manifests, a controller may still be
using v1alpha2 which would cause it to fail during this upgrade.
Once you've confirmed that the implementations you're relying on have upgraded to v1, it's time to install the v1.2 CRDs. In most cases, this will work without any additional effort.
If you ran into issues installing these CRDs, it likely means that you have
v1alpha2 in the storedVersions of one or both of these CRDs. This field is
used to indicate which API versions have ever been used to persist one of these
resources. Unfortunately, this field is not automatically pruned. To check these
values, you can run the following commands:
kubectl get crd grpcroutes.gateway.networking.k8s.io -ojsonpath="{.status.storedVersions}"
kubectl get crd referencegrants.gateway.networking.k8s.io -ojsonpath="{.status.storedVersions}"
If either of these return a list that includes "v1alpha2", it means that we need
to manually remove that version from storedVersions.
Before doing that, it would be good to ensure that all your ReferenceGrants and GRPCRoutes have been updated to the latest storage version:
crds=("GRPCRoutes" "ReferenceGrants")
for crd in "${crds[@]}"; do
output=$(kubectl get "${crd}" -A -o json)
echo "$output" | jq -c '.items[]' | while IFS= read -r resource; do
namespace=$(echo "$resource" | jq -r '.metadata.namespace')
name=$(echo "$resource" | jq -r '.metadata.name')
kubectl patch "${crd}" "${name}" -n "${namespace}" --type='json' -p='[{"op": "replace", "path": "/metadata/annotations/migration-time", "value": "'"$(date +%Y-%m-%dT%H:%M:%S)"'" }]'
done
done
Now that all your ReferenceGrant and GRPCRoute resources have been updated to use the latest storage version, you can patch the ReferenceGrant and GRPCRoute CRDs:
kubectl patch customresourcedefinitions referencegrants.gateway.networking.k8s.io --subresource='status' --type='merge' -p '{"status":{"storedVersions":["v1beta1"]}}'
kubectl patch customresourcedefinitions grpcroutes.gateway.networking.k8s.io --subresource='status' --type='merge' -p '{"status":{"storedVersions":["v1"]}}'
With these steps complete, upgrading to the latest GRPCRoute and ReferenceGrant should work well now.
Experimental Channel: GatewayClass Supported Features
The Experimental supportedFeatures field in GatewayClass status has changed
from being a list of strings to being a list of objects/structs with a name
field.
This is to allow adding in extra information to each entry at a later date.
Relevant PRs:
- SupportedFeatures field in Gateway Class status are now presented as a list of objects by @LiorLieberman in #3200
Changes since v1.2.0-rc2
There was one small change since RC2 - the Gateway Infrastructure conformance test has been marked as provisional as we're not sure that the same-namespace requirement imposed by this test is necessary. #3373
Release Cycle changes
This was our first release using a new release cycle that is meant to make Gateway API releases more frequent and predictable.
There are now four phases:
- Scoping: 4-6 weeks, where the maintainers and community determine the set of features we want to include in the release. A key deliverable here is ensuring that the Experimental channel does not get any bigger than it already is; we want to ensure that features make their way to Standard or are removed.
- GEP Iteration and Review: 5-7 weeks, where we work to update GEPs, and solidify and meet graduation criteria for in-scope GEPs.
- API Refinement and Documentation: 3-5 weeks, where we translate proposed changes from GEPs into changes to both the API specification and documentation.
- SIG-Network Review and Release Candidates: 2-4 weeks, where we perform our required upstream reviews, get any further required changes in, and release our release candidates so that implementations can get started with work on the new features asap.
For all the detail about this, please see the Release Cycle docs.
Relevant PRs:
- Adding Release Cycle Documentation by @robscott in #3063
Standard Channel Additions and Changes
The Standard channel is Gateway API's set of maximally-stable install files. Only features with the best testing and support are added to the standard channel. This channel should be considered GA or stable, and future changes will be fully backwards compatible.
Infrastructure Labels and Annotations 🎉
GEP-1867 added an
infrastructure stanza to Gateway objects that is intended to c
[truncated]