forked from kubernetes-sigs/kubebuilder
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
It introduces a roadmap for 2025 with our main goals for the year
- Loading branch information
1 parent
ce68302
commit d8dc0e1
Showing
1 changed file
with
94 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| # Kubebuilder Project Roadmap 2025 | ||
|
|
||
| ## Ensure Webhook Implementation Stability and Enhance User Experience | ||
|
|
||
| **Status:** WIP | ||
|
|
||
| ### Objective | ||
| Enhance the webhooks implementation and user experience. | ||
|
|
||
| ### Context | ||
| The current implementations for webhook conversion and defaulting are stable and tested through basic end-to-end (E2E) workflows. However, webhook conversion is incomplete, and several bugs need to be addressed. Additionally, the user experience is hindered by limitations such as the inability to add additional webhooks of the same type without using the force flag. | ||
|
|
||
| ### Goals and Needs | ||
| - **CA Injection**: Ensure that CA injection for conversion webhooks is limited to the relevant Custom Resource (CR) conversions. | ||
| - [GitHub Issue](https://github.com/kubernetes-sigs/kubebuilder/issues/4285) | ||
| - [Pull Request](https://github.com/kubernetes-sigs/kubebuilder/pull/4282) | ||
|
|
||
| - **Scaffolding Multiple Webhooks**: Allow adding additional webhooks without requiring forced re-scaffolding. | ||
| - [GitHub Issue](https://github.com/kubernetes-sigs/kubebuilder/issues/4146) | ||
|
|
||
| - **Hub and Spoke Model**: Integrate a hub-and-spoke model for conversion webhooks to streamline implementation. | ||
| - [GitHub Issue](https://github.com/kubernetes-sigs/kubebuilder/issues/2589) | ||
| - [Pull Request](https://github.com/kubernetes-sigs/kubebuilder/pull/4254) | ||
|
|
||
| - **Comprehensive E2E Testing**: Expand end-to-end tests for conversion webhooks to validate not only CA injection but also the conversion process itself. | ||
|
|
||
| - **E2E Test Scaffolding**: Improve the E2E test scaffolds under `test/e2e` to validate conversion behavior beyond CA injection for conversion webhooks. | ||
|
|
||
| - **Enhanced Multiversion Tutorial**: Add E2E tests for conversion webhooks in the multiversion tutorial to support comprehensive user guidance. | ||
|
|
||
| --- | ||
| # Roadmap Document | ||
|
|
||
| ## Enhance the Helm Chart Plugin | ||
|
|
||
| **Status:** WIP | ||
|
|
||
| ### Context | ||
| A new plugin to help users scaffold a Helm chart to distribute their solutions is implemented as an experimental | ||
| feature on the `master` branch and is currently under development. It's initial version will be released in | ||
| the next major version of Kubebuilder. | ||
|
|
||
| ### Objective | ||
| The objective of this effort is to ensure that the Helm chart plugin addresses user needs effectively while | ||
| providing a seamless and intuitive experience. | ||
|
|
||
| ### Goals | ||
| - Prevent exposure of webhooks data in the Helm chart values. | ||
| - Determine whether and how to include sample files and CR configurations in the Helm chart. | ||
| - Enable users to specify the path where the Helm chart will be scaffolded. | ||
|
|
||
| ### References | ||
| - [Milestone Helm](https://github.com/kubernetes-sigs/kubebuilder/milestone/39) | ||
| - [Code Implementation](https://github.com/kubernetes-sigs/kubebuilder/tree/master/pkg/plugins/optional/helm) | ||
| - [Sample Under Testdata](https://github.com/kubernetes-sigs/kubebuilder/tree/master/testdata/project-v4-with-plugins/dist/chart) | ||
|
|
||
| --- | ||
|
|
||
| ## Align Tutorials and Samples with Best Practices Proposed by DeployImage Plugin | ||
|
|
||
| **Status:** WIP | ||
|
|
||
| ### Context | ||
| The existing tutorials lack consistency with best practices and the layout proposed by the DeployImage plugin. | ||
|
|
||
| ### Objective | ||
| Align tutorials and sample projects with best practices to improve quality and usability. | ||
|
|
||
| ### Goals | ||
| - **Controller Logic Consistency**: Standardize tutorial controller logic to match the DeployImage plugin’s scaffolded controller, including conditions, finalizers, and status updates. | ||
|
|
||
| - **Conditional Status in CronJob Spec**: Incorporate conditional status handling in the CronJob spec to reflect best practices. | ||
|
|
||
| - **Test Logic Consistency**: Ensure tutorial test logic mirrors the tests scaffolded by the DeployImage plugin, adapting as needed for specific cases. | ||
|
|
||
| --- | ||
|
|
||
| ## Provide Solutions to Keep Users Updated with the Latest Changes | ||
|
|
||
| **Status:** Proposal in WIP | ||
| [GitHub Proposal](https://github.com/kubernetes-sigs/kubebuilder/pull/4302) | ||
|
|
||
| ### Context | ||
| Kubebuilder currently offers a "Help to Upgrade" feature via the `kubebuilder alpha generate` command, but applying updates requires significant manual effort. | ||
|
|
||
| ### Objective | ||
| Develop an opt-in mechanism to notify users and automate updates, reducing manual effort and ensuring alignment with the latest Kubebuilder versions. | ||
|
|
||
| ### Goals | ||
| - Facilitate keeping repositories updated with minimal manual intervention. | ||
| - Provide automated notifications and updates inspired by Dependabot. | ||
| - Maintain compatibility with new Kubebuilder features, best practices, and bug fixes. | ||
|
|
||
| --- |