Docs jwt release note example#772
Open
anvithagowda098 wants to merge 1 commit into
Open
Conversation
Signed-off-by: Anvitha <anvitha.gowda098@gmail.com>
f701c51 to
e00ee00
Compare
kristin-kronstain-brown
requested changes
Jun 5, 2026
| - name: my-api-key-provider | ||
| ``` | ||
|
|
||
| **After (v2.2+):** |
Contributor
There was a problem hiding this comment.
The callout makes sense and the jwt → jwtAuth and apiKeyAuthentication → apiKeyAuth are correct. But the YAML is not accurate.
- JWTAuth (the type of jwtAuth) has only two fields: extensionRef and disable. The providers (NamedJWTProvider array) field belongs to the JWT type, which appears in GatewayExtensionSpec, not in TrafficPolicy. So in v2.2 you wire JWT providers via jwtAuth.extensionRef → a GatewayExtension whose spec.jwt.providers holds the list. jwtAuth.providers is invalid.
- APIKeyAuth has no providers field at all — it uses keySources, secretRef/secretSelector, forwardCredential, clientIdHeader, disable. So apiKeyAuth.providers (and the "before" apiKeyAuthentication.providers) is not correct.
| * The `apiKeyAuthentication` field is renamed to `apiKeyAuth` | ||
|
|
||
| Update your TrafficPolicy resources accordingly when upgrading. | ||
| {{< callout type="warning" >}} |
Contributor
There was a problem hiding this comment.
Callouts need a blank line before them.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the upgrade guidance for the
TrafficPolicyAPI in the v2.2 release notes by adding a clear migration example for renamed authentication fields.The current release notes mention that:
jwt→jwtAuthapiKeyAuthentication→apiKeyAuthHowever, they do not include an actionable example showing how to update existing
TrafficPolicyresources.This PR addresses that gap by adding:
Motivation
Users upgrading from v2.1 → v2.2 may not realize they need to manually update existing
TrafficPolicyresources. Without migration examples, the change is easy to miss and can lead to misconfigured authentication policies after upgrade.Change Type
/ kind documentation
Changelog