Controller gen

[zbb88888]

Pull Request

• Make sure you have followed Kube-OVN Code Style.

What type of this PR

Examples of user facing changes:

• Features

Which issue(s) this PR fixes

Fixes #(issue-number)

[gemini-code-assist]

Summary of Changes

Hello @zbb88888, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

I've introduced changes primarily focused on improving the generation of Custom Resource Definitions (CRDs) for Kube-OVN. This involves adding a new script to automate CRD generation using controller-gen and making necessary adjustments to Go struct tags to ensure proper JSON serialization for the generated CRDs.

Highlights

• CRD Generation Script: I've added a new shell script, hack/update-codegen-crd.sh, which automates the process of generating CRDs using controller-gen. This script ensures that the latest CRDs are always up-to-date with the Go API definitions.
• Gitignore Update: I've updated the .gitignore file to include yamls/crds, preventing generated CRD files from being committed to the repository directly, as they will now be generated on demand.
• API Struct Tagging: I've added json tags to embedded structs within ProviderNetworkCondition, NatOutgoingPolicyRuleStatus, and BigInt types. This ensures that controller-gen correctly processes these fields when generating CRDs, improving their serialization and deserialization.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a script to generate CRDs using controller-gen and updates several type definitions with JSON tags to support this. The changes are generally good, but I have a few suggestions to improve the new script's robustness and flexibility. I've also identified a potential issue with the JSON tag on the BigInt type which could lead to an incorrect CRD schema, and I've proposed a fix.

[gemini-code-assist]

Adding a json tag to the embedded big.Int field might cause issues with CRD generation. The BigInt type has custom MarshalJSON and UnmarshalJSON methods that serialize it to a JSON string. However, controller-gen might interpret this json:"bigInt" tag to mean that the serialized form is an object with a bigInt field, leading to an incorrect OpenAPI schema for the CRD. This will cause schema validation failures for clients.

The recommended way to handle types with custom JSON marshalling is to use // +kubebuilder:validation:Type=string on the fields of type BigInt within your CRD structs (e.g., in IPPoolStatus). This tells controller-gen to treat it as a string in the schema, which matches the behavior of your custom marshaller.

Please remove this tag and apply the +kubebuilder marker on the relevant fields in the CRD definitions.

Suggested change

	big.Int `json:"bigInt"`
	big.Int

[zbb88888]

root@debian:~/f/kube-ovn controller-gen ✔ 3m ⍉
▶ bash ./hack/update-codegen-crd.sh

• export GOPROXY=https://goproxy.cn
• GOPROXY=https://goproxy.cn
• CONTROLLER_TOOLS_VERSION=v0.17.3
• go install sigs.k8s.io/controller-tools/cmd/[email protected]
• go mod tidy
• controller-gen crd:allowDangerousTypes=true paths=./pkg/apis/kubeovn/v1 output:crd:artifacts:config=./yamls/crds
  /root/f/kube-ovn/pkg/internal/big_int.go:9:2: encountered struct field "" without JSON tag in type "BigInt"
  github.com/kubeovn/kube-ovn/pkg/apis/kubeovn/v1:-: conflicting types in allOf branches in schema: object vs string
  github.com/kubeovn/kube-ovn/pkg/apis/kubeovn/v1:-: conflicting types in allOf branches in schema: object vs string
  github.com/kubeovn/kube-ovn/pkg/apis/kubeovn/v1:-: conflicting types in allOf branches in schema: object vs string
  github.com/kubeovn/kube-ovn/pkg/apis/kubeovn/v1:-: conflicting types in allOf branches in schema: object vs string
  Error: not all generators ran successfully

[gemini-code-assist]

To ensure the script runs correctly regardless of the directory from which it is called, it's a good practice to change the directory to the project root at the beginning of the script. This makes the script more robust.

Suggested change

	set -eux
	set -eux
	cd "$(dirname "$0")/.."

[coveralls]

Pull Request Test Coverage Report for Build 18365564626

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• 2 unchanged lines in 1 file lost coverage.
• Overall coverage decreased (-0.004%) to 21.088%

---

Files with Coverage Reduction	New Missed Lines	%
pkg/ovs/ovn-nb-bfd.go	2	61.61%

Totals
Change from base Build 18294244619:	-0.004%
Covered Lines:	10707
Relevant Lines:	50772

---

💛 - Coveralls

[github-actions]

PRs go stale after 60d of inactivity. Please comment or re-open the PR if you are still working on this PR.