Skip to content

Controllerrevisions default#234

Merged
cheyang merged 4 commits intosgl-project:mainfrom
JasonHe-WQ:controllerrevisions-default
Mar 24, 2026
Merged

Controllerrevisions default#234
cheyang merged 4 commits intosgl-project:mainfrom
JasonHe-WQ:controllerrevisions-default

Conversation

@JasonHe-WQ
Copy link
Copy Markdown
Contributor

@JasonHe-WQ JasonHe-WQ commented Mar 23, 2026

Ⅰ. Motivation

Ⅱ. Modifications

fix default controller revisions limit in stateful pattern to avert too many stale revisions and generalize truncate history function

Ⅲ. Does this pull request fix one issue?

fixes #227

Ⅳ. 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
Copy Markdown

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 standardizes the RevisionHistoryLimit behavior for RoleInstanceSet resources. It ensures that a default limit of 10 is consistently applied, both at the API definition level and within the controller's reconciliation logic. This change prevents the accumulation of excessive stale revisions, improving resource management and stability for stateful patterns.

Highlights

  • API Definition Enhancement: Ensured RevisionHistoryLimit in RoleInstanceSetSpec has a default value of 10 and a minimum of 0, improving API robustness and clarity.
  • CRD Update: Updated the Custom Resource Definition (CRD) for RoleInstanceSet to reflect the default and minimum constraints for revisionHistoryLimit.
  • Controller Logic Refinement: Modified the controller logic to explicitly apply a default revisionHistoryLimit of 10 when the field is not specified, preventing an unbounded revision history.

🧠 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.

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.

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
Copy Markdown

@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 a default value for RevisionHistoryLimit in RoleInstanceSet to prevent an excessive number of stale controller revisions. The changes correctly add a default of 10 at the API level via kubebuilder markers and update the controller logic to apply this default for existing resources that may not have this field set. The CRD is also updated accordingly. My feedback includes a suggestion to use a constant for the default value to improve maintainability.

Comment thread pkg/reconciler/roleinstanceset/statefulmode/stateful_instance_set_control.go Outdated
@JasonHe-WQ JasonHe-WQ changed the title Controllerrevisions default [WIP]Controllerrevisions default Mar 23, 2026
@JasonHe-WQ JasonHe-WQ force-pushed the controllerrevisions-default branch from 455afe9 to 898c82d Compare March 23, 2026 12:01
@JasonHe-WQ JasonHe-WQ changed the title [WIP]Controllerrevisions default Controllerrevisions default Mar 23, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Fixes RoleInstanceSet controller revision history truncation when spec.revisionHistoryLimit is omitted (stateful mode), and factors the truncation logic into a shared utility to keep both stateful/stateless implementations consistent.

Changes:

  • Add DefaultRoleInstanceSetRevisionHistoryLimit (10) and apply it in stateful/stateless truncation paths when the field is nil.
  • Introduce pkg/utils/history.TruncateControllerRevisions and refactor both reconcilers to use it.
  • Add CRD/API defaulting + minimum validation for revisionHistoryLimit, plus targeted unit tests.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
pkg/utils/history/truncate_history.go New shared helper to delete oldest non-live ControllerRevisions up to a limit.
pkg/utils/history/truncate_history_test.go Unit tests for the new truncation helper behavior.
pkg/reconciler/roleinstanceset/statefulmode/stateful_instance_set_control.go Fix stateful truncation to apply default limit when nil; use shared helper.
pkg/reconciler/roleinstanceset/statefulmode/stateful_instance_set_control_test.go Adds a unit test around truncation behavior in stateful mode.
pkg/reconciler/roleinstanceset/statelessmode/reconciler.go Refactor stateless truncation to use shared helper + shared default constant.
pkg/reconciler/roleinstanceset/statelessmode/reconciler_test.go Adds a unit test ensuring live short-hash revisions aren’t deleted.
api/workloads/v1alpha2/roleinstanceset_types.go Adds default/validation markers and introduces the default history limit constant.
config/crd/bases/workloads.x-k8s.io_roleinstancesets.yaml CRD schema updated with default: 10 and minimum: 0 for revisionHistoryLimit.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread pkg/utils/history/truncate_history.go
@cheyang
Copy link
Copy Markdown
Collaborator

cheyang commented Mar 24, 2026

Looks good. It’d be nice to add a regression test for the revisionHistoryLimit == nil path, since that’s the key behavior change here.

Copy link
Copy Markdown
Collaborator

@cheyang cheyang left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@cheyang cheyang merged commit 57fe51b into sgl-project:main Mar 24, 2026
9 checks passed
@JasonHe-WQ JasonHe-WQ deleted the controllerrevisions-default branch March 24, 2026 09:48
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.

[Bug] stateful roleinstance RevisionHistoryLimit is not limited by default

3 participants