Skip to content

Prepare types for CRD generation #11622

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

Closed
radixo wants to merge 4 commits into from
Closed

Prepare types for CRD generation #11622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b68ebcf
Prepare types for CRD generation
radixo Jan 6, 2026
5f8b688
[DROPME] Use custom go-build image for testing
hjiawei Jan 6, 2026
8c47499
Regenerate files
hjiawei Jan 6, 2026
623e3b0
Re-generate the semaphore pipeline file
hjiawei Jan 6, 2026
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
10 changes: 5 additions & 5 deletions .semaphore/semaphore.yml
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions api/pkg/lib/numorstring/port.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ import (
// - For a port range, set MinPort and MaxPort to the (inclusive) port numbers. Set
// PortName to "".
// - For a single port, set MinPort = MaxPort and PortName = "".
//
// +kubebuilder:validation:Type=integer

@hjiawei hjiawei Jan 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this change force the type to be an integer only?

@radixo radixo Jan 6, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, just set type to Integer, and the XIntOrString relax it to accept string as well. I'm using the same for DSCP

// +kubebuilder:validation:XIntOrString
// +kubebuilder:validation:Pattern=`^.*`
Comment on lines +32 to +34

Copilot AI Jan 6, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The kubebuilder markers appear inconsistent. Type=integer conflicts with Pattern=^.*$ which accepts any string. For a Port type that can represent port ranges or named ports, clarify whether these markers should validate the struct fields (MinPort, MaxPort, PortName) or if different markers are needed.

Suggested change
// +kubebuilder:validation:Type=integer
// +kubebuilder:validation:XIntOrString
// +kubebuilder:validation:Pattern=`^.*`

Copilot uses AI. Check for mistakes.
type Port struct {
MinPort uint16 `json:"minPort,omitempty"`
MaxPort uint16 `json:"maxPort,omitempty"`
Expand Down
3 changes: 3 additions & 0 deletions api/pkg/lib/numorstring/protocol.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ var (
}
)

// +kubebuilder:validation:Type=integer
// +kubebuilder:validation:XIntOrString
// +kubebuilder:validation:Pattern=`^.*`

Copilot AI Jan 6, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same marker inconsistency exists here as in Uint8OrString. The combination of Type=integer with Pattern=^.*$ (which matches any string) creates ambiguous validation semantics. Verify these markers correctly represent the type's dual integer/string nature.

Suggested change
// +kubebuilder:validation:Pattern=`^.*`
// +kubebuilder:validation:Pattern=`^(UDP|TCP|ICMP|ICMPv6|SCTP|UDPLite|[0-9]+)$`

Copilot uses AI. Check for mistakes.
type Protocol Uint8OrString

// ProtocolFromInt creates a Protocol struct from an integer value.
Expand Down
4 changes: 4 additions & 0 deletions api/pkg/lib/numorstring/uint8orstring.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ import (
// JSON or YAML marshalling and unmarshalling, it produces or consumes the
// inner type. This allows you to have, for example, a JSON field that can
// accept a name or number.
//
// +kubebuilder:validation:Type=integer
// +kubebuilder:validation:XIntOrString
// +kubebuilder:validation:Pattern=`^.*`
Comment on lines +27 to +29

Copilot AI Jan 6, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The kubebuilder markers seem contradictory. Type=integer suggests only integer values are valid, but Pattern=^.*$ allows any string. Additionally, XIntOrString is typically used for Kubernetes IntOrString types. Please clarify the intended validation behavior and ensure the markers accurately reflect whether this type accepts integers only, strings only, or both.

Suggested change
// +kubebuilder:validation:Type=integer
// +kubebuilder:validation:XIntOrString
// +kubebuilder:validation:Pattern=`^.*`
// +kubebuilder:validation:Type=string
// +kubebuilder:validation:XIntOrString

Copilot uses AI. Check for mistakes.
type Uint8OrString struct {
Type NumOrStringType `json:"type"`
NumVal uint8 `json:"numVal"`
Expand Down
5 changes: 3 additions & 2 deletions felix/bpf/asm/opcode_string.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions felix/docs/config-params.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion lib.Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ endif
# For building, we use the go-build image for the *host* architecture, even if the target is different
# the one for the host should contain all the necessary cross-compilation tools
# we do not need to use the arch since go-build:v0.15 now is multi-arch manifest
GO_BUILD_IMAGE ?= calico/go-build
GO_BUILD_IMAGE ?= jha48/go-build
CALICO_BUILD = $(GO_BUILD_IMAGE):$(GO_BUILD_VER)


Expand Down
4 changes: 2 additions & 2 deletions libcalico-go/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ gen-files: gen-crds
gen-crds:
rm -rf config/crd
# Generate CRDs without descriptions
$(DOCKER_GO_BUILD) sh -c '$(GIT_CONFIG_SSH) controller-gen crd:allowDangerousTypes=true,crdVersions=v1,deprecatedV1beta1CompatibilityPreserveUnknownFields=false,maxDescLen=0 paths=./lib/apis/... output:crd:dir=config/crd/'
$(DOCKER_GO_BUILD) sh -c '$(GIT_CONFIG_SSH) controller-gen crd:allowDangerousTypes=true,crdVersions=v1,deprecatedV1beta1CompatibilityPreserveUnknownFields=false,maxDescLen=0 paths=./lib/apis/crd.projectcalico.org/... output:crd:dir=config/crd/'
# Generate CRDs with descriptions, and place them into a temp directory
$(DOCKER_GO_BUILD) sh -c '$(GIT_CONFIG_SSH) controller-gen crd:allowDangerousTypes=true,crdVersions=v1,deprecatedV1beta1CompatibilityPreserveUnknownFields=false paths=./lib/apis/... output:crd:dir=config/crd/crd-felix'
$(DOCKER_GO_BUILD) sh -c '$(GIT_CONFIG_SSH) controller-gen crd:allowDangerousTypes=true,crdVersions=v1,deprecatedV1beta1CompatibilityPreserveUnknownFields=false paths=./lib/apis/crd.projectcalico.org/... output:crd:dir=config/crd/crd-felix'
# Copy over felix CRD with descriptions
cp config/crd/crd-felix/crd.projectcalico.org_felixconfigurations.yaml config/crd
# Cleanup
Expand Down
2 changes: 1 addition & 1 deletion libcalico-go/config/crd/crd.projectcalico.org_bgpconfigurations.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion libcalico-go/config/crd/crd.projectcalico.org_bgpfilters.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion libcalico-go/config/crd/crd.projectcalico.org_bgppeers.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion libcalico-go/config/crd/crd.projectcalico.org_blockaffinities.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion libcalico-go/config/crd/crd.projectcalico.org_caliconodestatuses.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion libcalico-go/config/crd/crd.projectcalico.org_clusterinformations.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 4 additions & 10 deletions libcalico-go/config/crd/crd.projectcalico.org_felixconfigurations.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

50 changes: 13 additions & 37 deletions libcalico-go/config/crd/crd.projectcalico.org_globalnetworkpolicies.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion libcalico-go/config/crd/crd.projectcalico.org_globalnetworksets.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 2 additions & 4 deletions libcalico-go/config/crd/crd.projectcalico.org_hostendpoints.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion libcalico-go/config/crd/crd.projectcalico.org_ipamblocks.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion libcalico-go/config/crd/crd.projectcalico.org_ipamconfigs.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion libcalico-go/config/crd/crd.projectcalico.org_ipamhandles.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion libcalico-go/config/crd/crd.projectcalico.org_ippools.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading