Improve Input Validation of Networking-related Shoot fields
#12539
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 value is used as part of a label name. Hence, it can only contain certain characters and has a limited length.
The common suffixes used for DNS rewriting should resemble domain names and follow the corresponding rules.
The load balancer source ranges should be valid CIDRs.
Validating the actual content of the config map values is difficult because there are a lot of potential valid values and checking them thoroughly would also cause maintenance effort for each new nginx controller release as they might change. Therefore, this first just checks whether the keys are correct and the size is not too large.
resource. The validation of `ExposureClass` was missing. It is now implemented and forces stricter restrictions on the name of an `ExposureClass`.
ee4b6a7 to
a1f1fe9
Compare
marc1404
reviewed
Jul 16, 2025
Comment on lines
959
to
+961
| if len(ptr.Deref(networking.Type, "")) == 0 { | ||
| allErrs = append(allErrs, field.Required(fldPath.Child("type"), "networking type must be provided")) | ||
| allErrs = append(allErrs, field.Required(path, "networking type must be provided")) | ||
| } else if len(metav1validation.ValidateLabelName(v1beta1constants.LabelExtensionNetworkingTypePrefix+ptr.Deref(networking.Type, ""), path)) > 0 { |
There was a problem hiding this comment.
nit: ptr.Deref(networking.Type, "") could be extracted into a variable before the if-else
|
LGTM label has been added. Git tree hash: 90998fa8a07fd141b2119959bda9f2349c5e1e1e
|
|
/assign |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: marc1404 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Duciwuci
pushed a commit
to stackitcloud/gardener
that referenced
this pull request
Sep 1, 2025
…er#12539) * Validate `spec.networking.type` The value is used as part of a label name. Hence, it can only contain certain characters and has a limited length. * Validate `spec.systemComponents.coreDNS.rewriting.commonSuffixes` The common suffixes used for DNS rewriting should resemble domain names and follow the corresponding rules. * Validate `spec.addons.nginxIngress.loadBalancerSourceRanges` The load balancer source ranges should be valid CIDRs. * Validate `spec.addons.nginxIngress.config` Validating the actual content of the config map values is difficult because there are a lot of potential valid values and checking them thoroughly would also cause maintenance effort for each new nginx controller release as they might change. Therefore, this first just checks whether the keys are correct and the size is not too large. * Validate `spec.exposureClassName` and `ObjectMeta` of ExposureClass resource. The validation of `ExposureClass` was missing. It is now implemented and forces stricter restrictions on the name of an `ExposureClass`.
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.
How to categorize this PR?
/area networking
/area quality
/area robustness
/area security
/kind enhancement
What this PR does / why we need it:
Validating the input provided for
Shootresources and returning errors early helps cluster owners understand the issues better. Some of the networking-relatedShootfields lacked proper validation so that a user received an early error. Most of the issues addressed in this pull request would have led to errors duringShootreconciliation later on, but the error messages might not have been good. Therefore, it is better to check properly during admission and return understandable errors related to the corresponding input.The following
Shootfields have more validation with this change:spec.networking.typespec.systemComponents.coreDNS.rewriting.commonSuffixesspec.addons.nginxIngress.loadBalancerSourceRangesspec.addons.nginxIngress.configspec.exposureClassNameIn addition to that,
ObjectMetaofExposureClassresource is now checked properly.Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
The additional validation of
ExposureClassis potentially more breaking than the other validations. However, it is considered to be very unlikely that it will actually cause any issues as theExposureClassfeature is not widely used.Release note: