Skip to content

refactor(rbgs): init rbgs apiVersion v1alpha2#173

Open
Syspretor wants to merge 1 commit intosgl-project:mainfrom
Syspretor:refactor/add-rbgs-apiversion-v1alpha2
Open

refactor(rbgs): init rbgs apiVersion v1alpha2#173
Syspretor wants to merge 1 commit intosgl-project:mainfrom
Syspretor:refactor/add-rbgs-apiversion-v1alpha2

Conversation

@Syspretor
Copy link
Collaborator

Ⅰ. Motivation

Ⅱ. Modifications

Ⅲ. Does this pull request fix one issue?

fixes #XXXX

Ⅳ. List the added test cases (unit test/integration test) if any, please explain if no tests are needed.

Ⅴ. Describe how to verify it

VI. Special notes for reviews

Checklist

  • Format your code make fmt.
  • Add unit tests or integration tests.
  • Update the documentation related to the change.

@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! 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!

This pull request refactors the RoleBasedGroupSet API by introducing a new v1alpha2 version. This update involves defining the new API schema, generating the required deepcopy methods, and updating the client-go libraries to interact with the new API version. The v1alpha1 API is designated as the storage version to manage API compatibility and upgrades effectively.

Highlights

  • New API Version v1alpha2 for RoleBasedGroupSet: A new API definition for RoleBasedGroupSet has been introduced under v1alpha2, providing an updated schema for this resource.
  • API Versioning Strategy: The existing v1alpha1 API for RoleBasedGroupSet has been explicitly marked as the storage version using +kubebuilder:storageversion, ensuring proper migration and compatibility during API evolution.
  • Client-Go Component Generation: All necessary client-go components, including deepcopy functions, apply configurations, fake clients, typed clients, informers, and listers, have been generated or updated to support the new v1alpha2 RoleBasedGroupSet API.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • api/workloads/v1alpha1/rolebasedgroupset_types.go
    • Added +kubebuilder:storageversion marker to the RoleBasedGroupSet type.
  • api/workloads/v1alpha2/rolebasedgroupset_types.go
    • Added the new RoleBasedGroupSet API definition for v1alpha2.
  • api/workloads/v1alpha2/zz_generated.deepcopy.go
    • Added deepcopy methods for RoleBasedGroupSet, RoleBasedGroupSetList, RoleBasedGroupSetSpec, and RoleBasedGroupSetStatus.
  • client-go/applyconfiguration/utils.go
    • Updated ForKind function to include RoleBasedGroupSet, RoleBasedGroupSetSpec, and RoleBasedGroupSetStatus for v1alpha2.
  • client-go/applyconfiguration/workloads/v1alpha2/rolebasedgroupset.go
    • Added apply configuration for RoleBasedGroupSet.
  • client-go/applyconfiguration/workloads/v1alpha2/rolebasedgroupsetspec.go
    • Added apply configuration for RoleBasedGroupSetSpec.
  • client-go/applyconfiguration/workloads/v1alpha2/rolebasedgroupsetstatus.go
    • Added apply configuration for RoleBasedGroupSetStatus.
  • client-go/clientset/versioned/typed/workloads/v1alpha2/fake/fake_rolebasedgroupset.go
    • Added fake client implementation for RoleBasedGroupSet.
  • client-go/clientset/versioned/typed/workloads/v1alpha2/fake/fake_workloads_client.go
    • Updated fake client to include RoleBasedGroupSets.
  • client-go/clientset/versioned/typed/workloads/v1alpha2/generated_expansion.go
    • Added RoleBasedGroupSetExpansion interface.
  • client-go/clientset/versioned/typed/workloads/v1alpha2/rolebasedgroupset.go
    • Added client interface and implementation for RoleBasedGroupSet.
  • client-go/clientset/versioned/typed/workloads/v1alpha2/workloads_client.go
    • Updated client interface to include RoleBasedGroupSetsGetter.
    • Updated client implementation to include RoleBasedGroupSets.
  • client-go/informers/externalversions/generic.go
    • Updated generic informer to include rolebasedgroupsets.
  • client-go/informers/externalversions/workloads/v1alpha2/interface.go
    • Updated informer interface to include RoleBasedGroupSets.
    • Updated informer implementation to include RoleBasedGroupSets.
  • client-go/informers/externalversions/workloads/v1alpha2/rolebasedgroupset.go
    • Added informer for RoleBasedGroupSet.
  • client-go/listers/workloads/v1alpha2/expansion_generated.go
    • Added RoleBasedGroupSetListerExpansion and RoleBasedGroupSetNamespaceListerExpansion.
  • client-go/listers/workloads/v1alpha2/rolebasedgroupset.go
    • Added lister for RoleBasedGroupSet.
Activity
  • The pull request was created by Syspretor.
  • The pull request introduces a new API version for RoleBasedGroupSet, indicating a significant architectural update.
  • Automated code generation tools were likely used to create many of the new client-go files based on the new API definition.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces the v1alpha2 API version for RoleBasedGroupSet and related types. This includes new type definitions, and all the necessary auto-generated client-go code (clientsets, informers, listers, applyconfigurations).

My main concern is that v1alpha1 is marked as the storage version, but there are significant structural differences between v1alpha1 and the new v1alpha2 API, and no conversion logic has been implemented. This is a critical issue that will lead to data loss and prevent the CRD from being correctly updated and used. I've left a detailed comment on this.

Please address this by implementing the required conversion webhooks.

// +kubebuilder:object:root=true
// +kubebuilder:subresource:status
// +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas
// +kubebuilder:storageversion

Choose a reason for hiding this comment

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

critical

By marking v1alpha1 as the storage version, you are establishing it as the hub for API conversions. The newly introduced v1alpha2 version has significant structural differences compared to v1alpha1, particularly in RoleBasedGroupSpec and RoleSpec.

For example:

  • v1alpha1.RoleBasedGroupSpec contains PodGroupPolicy and CoordinationRequirements, which are absent in v1alpha2.RoleBasedGroupSpec.
  • v1alpha1.RoleSpec uses TemplateSource, TemplatePatch, and LeaderWorkerSet directly, while v1alpha2.RoleSpec refactors this into an inlined Pattern struct with StandalonePattern and LeaderWorkerPattern.

Without implementing conversion webhooks, these structural differences will lead to data loss when converting between versions. For example, if a user creates a v1alpha1 resource with PodGroupPolicy and then retrieves it as v1alpha2, that field will be lost.

You need to implement the conversion.Hub and conversion.Convertible interfaces for the v1alpha1 and v1alpha2 types respectively to handle the conversion between these versions. Please add the conversion logic as part of this PR to ensure data integrity across API versions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant