cleanup: deprecate Type field in BackendSpec #13071
Open
Conversation
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
The Type field in BackendSpec is now optional and deprecated. The backend type is inferred from the configuration fields. - Mark BackendSpec.Type as optional with deprecation comment - Update CEL validation rules to support missing type field - Add getBackendType() helper to infer type from config - Add E2E test case for backend without explicit type Signed-off-by: devesh <[email protected]>
gateway-bot
added
do-not-merge/release-note-invalid
timflannagan
reviewed
Dec 9, 2025
Member
timflannagan
left a comment
timflannagan
left a comment
There was a problem hiding this comment.
Thanks for the contribution @devc007. A couple quick comments.
Comment on lines
-44
to
-46
| // +kubebuilder:validation:XValidation:message="aws backend must be specified when type is 'AWS'",rule="self.type == 'AWS' ? has(self.aws) : true" | ||
| // +kubebuilder:validation:XValidation:message="static backend must be specified when type is 'Static'",rule="self.type == 'Static' ? has(self.static) : true" | ||
| // +kubebuilder:validation:XValidation:message="dynamicForwardProxy backend must be specified when type is 'DynamicForwardProxy'",rule="self.type == 'DynamicForwardProxy' ? has(self.dynamicForwardProxy) : true" |
Member
There was a problem hiding this comment.
I think we still want these rules in place even if the Type field becomes optional.
| // +kubebuilder:validation:XValidation:message="static backend must be specified when type is 'Static'",rule="self.type == 'Static' ? has(self.static) : true" | ||
| // +kubebuilder:validation:XValidation:message="dynamicForwardProxy backend must be specified when type is 'DynamicForwardProxy'",rule="self.type == 'DynamicForwardProxy' ? has(self.dynamicForwardProxy) : true" | ||
| // +kubebuilder:validation:ExactlyOneOf=aws;static;dynamicForwardProxy | ||
| // +kubebuilder:validation:XValidation:message="exactly one of aws, static, or dynamicForwardProxy must be specified",rule="[has(self.aws), has(self.static), has(self.dynamicForwardProxy)].filter(v, v).size() == 1" |
Member
There was a problem hiding this comment.
Let's revert back to // +kubebuilder:validation:ExactlyOneOf=aws;static;dynamicForwardProxy. That ExactlyOneOf marker is the preferred pattern for these one-of based APIs.
| wantErrors: []string{"exactly one of the fields in [aws static dynamicForwardProxy] must be set"}, | ||
| }, | ||
| { | ||
| name: "Backend: inferred type from configuration", |
Member
There was a problem hiding this comment.
I don't think we need to test this, but if we do, let's migrate it over to the https://github.com/kgateway-dev/kgateway/tree/af11f9bab3cfae7d2d2d9f61df70fc97325c7348/api/tests suite.
| // +required | ||
| Type BackendType `json:"type"` | ||
| // +optional | ||
| Type BackendType `json:"type,omitempty"` |
Member
There was a problem hiding this comment.
Surprised the linter didn't catch this, but this should be a pointer type now. See https://github.com/kgateway-dev/kgateway/pull/12923/files for some inspiration.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
The Type field in BackendSpec is now optional and deprecated. The backend type is inferred from the configuration fields.
close #13029
Change Type
Changelog
Additional Notes