Add RoleSet and StormService detail spec

[Jeffwan]

Pull Request Description

API spec for P/D disaggregation

Related Issues

Resolves: part of #1134

Important: Before submitting, please complete the description above and review the checklist below.

---

Contribution Guidelines (Expand for Details)

We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:

Pull Request Title Format

Your PR title should start with one of these prefixes to indicate the nature of the change:

• [Bug]: Corrections to existing functionality
• [CI]: Changes to build process or CI pipeline
• [Docs]: Updates or additions to documentation
• [API]: Modifications to aibrix's API or interface
• [CLI]: Changes or additions to the Command Line Interface
• [Misc]: For changes not covered above (use sparingly)

Note: For changes spanning multiple categories, use multiple prefixes in order of importance.

Submission Checklist

• PR title includes appropriate prefix(es)
• Changes are clearly explained in the PR description
• New and existing tests pass successfully
• Code adheres to project style and best practices
• Documentation updated to reflect changes (if applicable)
• Thorough testing completed, no regressions introduced

By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.

[gemini-code-assist]

Summary of Changes

Hello @Jeffwan, 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!

This pull request introduces comprehensive and detailed specifications for the RoleSet and StormService custom resources, moving them beyond basic scaffolding. It defines intricate structures for managing distributed workloads, including granular control over role definitions, various update strategies, and robust status tracking. A new, generic condition API is also added to provide a standardized mechanism for reporting the health and progress of these custom resources, significantly enhancing their functionality and observability within the Kubernetes ecosystem.

Highlights

• New Condition API: Introduced a generic Kubernetes-style Condition API (ConditionType, Condition, Conditions) in api/orchestration/v1alpha1/condition.go to standardize status reporting for custom resources, including utility functions for managing conditions.
• Enhanced RoleSet Definition: The RoleSetSpec in api/orchestration/v1alpha1/roleset_types.go has been significantly expanded to include detailed Roles (with RoleSpec), UpdateStrategy (Parallel, Sequential, Interleave), and SchedulingStrategy (integrating godel-scheduler-api's PodGroupSpec). The RoleSetStatus now tracks individual role statuses and overall conditions.
• Comprehensive StormService Definition: The StormServiceSpec in api/orchestration/v1alpha1/stormservice_types.go has been updated with fields for replica management, RoleSetTemplateSpec, UpdateStrategy (RollingUpdate, InPlaceUpdate), revision history, and disruption tolerance. The StormServiceStatus now provides detailed insights into replica counts, revisions, and service conditions.
• Dependency Update: Added github.com/kubewharf/godel-scheduler-api as a new indirect dependency in go.mod and go.sum, enabling advanced scheduling capabilities for RoleSet.
• Auto-generated DeepCopy Methods: The zz_generated.deepcopy.go file has been updated with new and modified deepcopy methods for all newly introduced and expanded structs, ensuring proper serialization and deserialization of the custom resources.

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 is currently in preview and 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 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

The code changes introduce API specifications for RoleSet and StormService, including their desired states, update strategies, and status conditions. It also includes deepcopy functions for these new types.

[gemini-code-assist]

Consider adding a comment explaining what this function does and the meaning of its parameters.

[gemini-code-assist]

This comment is useful, but consider expanding it to explain why Godel scheduler's definition is being used temporarily and what the criteria for switching to community definitions would be.