-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
📖 Proposal : New Plugin to allow project distribution via helm charts #3632
📖 Proposal : New Plugin to allow project distribution via helm charts #3632
Conversation
Hi @dashanji. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
3509296
to
1a677d2
Compare
This comment was marked as outdated.
This comment was marked as outdated.
This PR introduces an optional Helm plugin, enabling users to scaffold Helm charts for Kubebuilder projects. - **Helm Chart Scaffolding**: Allows generation of a Helm chart under the `dist/chart` directory, providing an alternative for distributing and managing projects via Helm. - **Usage**: - **Initialize**: `kubebuilder init --plugins=helm/v1-alpha` for new projects. - **Update**: `kubebuilder edit --plugins=helm/v1-alpha` to add or update Helm charts for existing projects. - **Auto-sync Helm Chart**: Syncs the Helm chart with project manifests using the `edit` command, with `--force` required for updates after webhook or `DeployImage` plugin changes. - **Examples**: Usage samples can be found in `testdata/project-v4-with-plugins`. - **Testing**: Adds GitHub Actions workflows to validate Helm integration, including linting, installation, and e2e checks. **Note**: For details on the original proposal, see [PR kubernetes-sigs#3632](kubernetes-sigs#3632).
This PR introduces an optional Helm plugin, enabling users to scaffold Helm charts for Kubebuilder projects. - **Helm Chart Scaffolding**: Allows generation of a Helm chart under the `dist/chart` directory, providing an alternative for distributing and managing projects via Helm. - **Usage**: - **Initialize**: `kubebuilder init --plugins=helm/v1-alpha` for new projects. - **Update**: `kubebuilder edit --plugins=helm/v1-alpha` to add or update Helm charts for existing projects. - **Auto-sync Helm Chart**: Syncs the Helm chart with project manifests using the `edit` command, with `--force` required for updates after webhook or `DeployImage` plugin changes. - **Examples**: Usage samples can be found in `testdata/project-v4-with-plugins`. - **Testing**: Adds GitHub Actions workflows to validate Helm integration, including linting, installation, and e2e checks. **Note**: For details on the original proposal, see [PR kubernetes-sigs#3632](kubernetes-sigs#3632).
This PR introduces an optional Helm plugin, enabling users to scaffold Helm charts for Kubebuilder projects. - **Helm Chart Scaffolding**: Allows generation of a Helm chart under the `dist/chart` directory, providing an alternative for distributing and managing projects via Helm. - **Usage**: - **Initialize**: `kubebuilder init --plugins=helm/v1-alpha` for new projects. - **Update**: `kubebuilder edit --plugins=helm/v1-alpha` to add or update Helm charts for existing projects. - **Auto-sync Helm Chart**: Syncs the Helm chart with project manifests using the `edit` command, with `--force` required for updates after webhook or `DeployImage` plugin changes. - **Examples**: Usage samples can be found in `testdata/project-v4-with-plugins`. - **Testing**: Adds GitHub Actions workflows to validate Helm integration, including linting, installation, and e2e checks. **Note**: For details on the original proposal, see [PR kubernetes-sigs#3632](kubernetes-sigs#3632).
This PR introduces an optional Helm plugin, enabling users to scaffold Helm charts for Kubebuilder projects. - **Helm Chart Scaffolding**: Allows generation of a Helm chart under the `dist/chart` directory, providing an alternative for distributing and managing projects via Helm. - **Usage**: - **To add when init the project**: `kubebuilder init --plugins=helm/v1-alpha` for new projects. - **To Init/Update in a project previously scaffolded**: `kubebuilder edit --plugins=helm/v1-alpha` to add or update Helm charts for existing projects. - **Sync Helm Chart**: Syncs the Helm chart with project manifests using the `edit` command, with `--force` required for updates after webhook or `DeployImage` plugin changes in order to overwritten the values.yaml and manager.yaml files. - **Examples**: Usage samples can be found in `testdata/project-v4-with-plugins`. - **Testing**: Adds GitHub Actions workflows to validate Helm integration, including linting, installation, and e2e checks. **Note**: For details on the original proposal, see [PR kubernetes-sigs#3632](kubernetes-sigs#3632).
This PR introduces an optional Helm plugin, enabling users to scaffold Helm charts for Kubebuilder projects. - **Helm Chart Scaffolding**: Allows generation of a Helm chart under the `dist/chart` directory, providing an alternative for distributing and managing projects via Helm. - **Usage**: - **To add when init the project**: `kubebuilder init --plugins=helm/v1-alpha` for new projects. - **To Init/Update in a project previously scaffolded**: `kubebuilder edit --plugins=helm/v1-alpha` to add or update Helm charts for existing projects. - **Sync Helm Chart**: Syncs the Helm chart with project manifests using the `edit` command, with `--force` required for updates after webhook or `DeployImage` plugin changes in order to overwritten the values.yaml and manager.yaml files. - **Examples**: Usage samples can be found in `testdata/project-v4-with-plugins`. - **Testing**: Adds GitHub Actions workflows to validate Helm integration, including linting, installation, and e2e checks. **Note**: For details on the original proposal, see [PR kubernetes-sigs#3632](kubernetes-sigs#3632).
This PR introduces an optional Helm plugin, enabling users to scaffold Helm charts for Kubebuilder projects. - **Helm Chart Scaffolding**: Allows generation of a Helm chart under the `dist/chart` directory, providing an alternative for distributing and managing projects via Helm. - **Usage**: - **To add when init the project**: `kubebuilder init --plugins=helm/v1-alpha` for new projects. - **To Init/Update in a project previously scaffolded**: `kubebuilder edit --plugins=helm/v1-alpha` to add or update Helm charts for existing projects. - **Sync Helm Chart**: Syncs the Helm chart with project manifests using the `edit` command, with `--force` required for updates after webhook or `DeployImage` plugin changes in order to overwritten the values.yaml and manager.yaml files. - **Examples**: Usage samples can be found in `testdata/project-v4-with-plugins`. - **Testing**: Adds GitHub Actions workflows to validate Helm integration, including linting, installation, and e2e checks. **Note**: For details on the original proposal, see [PR kubernetes-sigs#3632](kubernetes-sigs#3632).
This PR introduces an optional Helm plugin, enabling users to scaffold Helm charts for Kubebuilder projects. - **Helm Chart Scaffolding**: Allows generation of a Helm chart under the `dist/chart` directory, providing an alternative for distributing and managing projects via Helm. - **Usage**: - **To add when init the project**: `kubebuilder init --plugins=helm/v1-alpha` for new projects. - **To Init/Update in a project previously scaffolded**: `kubebuilder edit --plugins=helm/v1-alpha` to add or update Helm charts for existing projects. - **Sync Helm Chart**: Syncs the Helm chart with project manifests using the `edit` command, with `--force` required for updates after webhook or `DeployImage` plugin changes in order to overwritten the values.yaml and manager.yaml files. - **Examples**: Usage samples can be found in `testdata/project-v4-with-plugins`. - **Testing**: Adds GitHub Actions workflows to validate Helm integration, including linting, installation, and e2e checks. **Note**: For details on the original proposal, see [PR kubernetes-sigs#3632](kubernetes-sigs#3632).
This PR introduces an optional Helm plugin, enabling users to scaffold Helm charts for Kubebuilder projects. - **Helm Chart Scaffolding**: Allows generation of a Helm chart under the `dist/chart` directory, providing an alternative for distributing and managing projects via Helm. - **Usage**: - **To add when init the project**: `kubebuilder init --plugins=helm/v1-alpha` for new projects. - **To Init/Update in a project previously scaffolded**: `kubebuilder edit --plugins=helm/v1-alpha` to add or update Helm charts for existing projects. - **Sync Helm Chart**: Syncs the Helm chart with project manifests using the `edit` command, with `--force` required for updates after webhook or `DeployImage` plugin changes in order to overwritten the values.yaml and manager.yaml files. - **Examples**: Usage samples can be found in `testdata/project-v4-with-plugins`. - **Testing**: Adds GitHub Actions workflows to validate Helm integration, including linting, installation, and e2e checks. **Note**: For details on the original proposal, see [PR kubernetes-sigs#3632](kubernetes-sigs#3632).
This PR introduces an optional Helm plugin, enabling users to scaffold Helm charts for Kubebuilder projects. - **Helm Chart Scaffolding**: Allows generation of a Helm chart under the `dist/chart` directory, providing an alternative for distributing and managing projects via Helm. - **Usage**: - **To add when init the project**: `kubebuilder init --plugins=helm/v1-alpha` for new projects. - **To Init/Update in a project previously scaffolded**: `kubebuilder edit --plugins=helm/v1-alpha` to add or update Helm charts for existing projects. - **Sync Helm Chart**: Syncs the Helm chart with project manifests using the `edit` command, with `--force` required for updates after webhook or `DeployImage` plugin changes in order to overwritten the values.yaml and manager.yaml files. - **Examples**: Usage samples can be found in `testdata/project-v4-with-plugins`. - **Testing**: Adds GitHub Actions workflows to validate Helm integration, including linting, installation, and e2e checks. **Note**: For details on the original proposal, see [PR kubernetes-sigs#3632](kubernetes-sigs#3632).
16c31de
to
d90adaa
Compare
Co-Author: Ye Cao <caoye.cao@alibaba-inc.com>
d90adaa
to
70225f9
Compare
/ok-to-test |
/lgtm |
/approved |
Latest StatusWe have implemented the initial version of the plugin in PR #4227. I'm moving forward to get this documentation merged, as it captures our motivations and the discussions we've had so far. However, if anyone finds issues or inaccuracies, please feel free to open a pull request to ensure the information remains accurate. Additionally, we’d appreciate any help in validating the plugin in PR #4227, as it has been merged into the master branch. If you encounter any issues or have suggestions for improvement, please feel free to open issues or contribute with pull requests in the repository. Your input and collaboration are invaluable to us. Thank you! |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, dashanji The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
As titled.
This document is currently in RFC status, and corrections and additions are welcomed.