Skip to content

🌱 Add OpenAPI defaulting detection for KubeadmConfig by using forbiddenmarkers #12851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
k8s-ci-robot merged 2 commits into from
Oct 16, 2025
Merged

🌱 Add OpenAPI defaulting detection for KubeadmConfig by using forbiddenmarkers #12851

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a611e06
Add OpenAPI defaulting detection for KubeadmConfig by using forbidden…
nayuta723 Oct 13, 2025
ad27b18
Block defaulting for all fields except those explicitly excluded.
nayuta723 Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion .golangci-kal.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ linters:
- "conditions" # Ensure conditions have the correct json tags and markers.
- "conflictingmarkers"
- "duplicatemarkers" # Ensure there are no exact duplicate markers. for types and fields.
#- "forbiddenmarkers" # Ensure that types and fields do not contain any markers that are forbidden.
- "forbiddenmarkers" # Ensure that types and fields do not contain any markers that are forbidden.
- "integers" # Ensure only int32 and int64 are used for integers.
- "jsontags" # Ensure every field has a json tag.
- "maxlength" # Ensure all strings and arrays have maximum lengths/maximum items.
Expand Down Expand Up @@ -53,6 +53,10 @@ linters:
- ["default", "kubebuilder:default"]
- ["required", "kubebuilder:validation:Required", "k8s:required"]
description: "A field with a default value cannot be required"
forbiddenmarkers:
markers:
- identifier: "kubebuilder:default"
- identifier: "default"
conditions:
isFirstField: Warn # Require conditions to be the first field in the status struct.
usePatchStrategy: Forbid # Forbid patchStrategy markers on the Conditions field.
Expand Down Expand Up @@ -158,6 +162,17 @@ linters:
linters:
- kubeapilinter

# Excludes for existing default markers
# We don't want to use OpenAPI defaulting anymore.
- path: "api/core/v1beta2/clusterclass_types.go"
text: 'forbiddenmarkers: field Reason has forbidden marker "kubebuilder:default=FieldValueInvalid"'
linters:
- kubeapilinter
- path: "api/core/v1beta2/clusterclass_types.go"
text: 'forbiddenmarkers: field Reason has forbidden marker "default=ref\(sigs.k8s.io/cluster-api/api/core/v1beta2.FieldValueInvalid\)"'
linters:
- kubeapilinter

# TODO: Excludes that should be removed once the corresponding issues in KAL are fixed
# KAL incorrectly reports that the Taints field doesn't have to be a pointer (it has to be to preserve []).
# See: https://github.com/kubernetes-sigs/kube-api-linter/issues/116
Expand Down