Skip to content
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

Merged

Conversation

dashanji
Copy link
Contributor

As titled.

This document is currently in RFC status, and corrections and additions are welcomed.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 24, 2023
@k8s-ci-robot
Copy link
Contributor

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

camilamacedo86

This comment was marked as outdated.

@camilamacedo86

This comment was marked as outdated.

camilamacedo86 added a commit to camilamacedo86/kubebuilder that referenced this pull request Oct 25, 2024
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).
camilamacedo86 added a commit to camilamacedo86/kubebuilder that referenced this pull request Oct 25, 2024
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).
camilamacedo86 added a commit to camilamacedo86/kubebuilder that referenced this pull request Oct 25, 2024
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).
camilamacedo86 added a commit to camilamacedo86/kubebuilder that referenced this pull request Oct 25, 2024
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).
camilamacedo86 added a commit to camilamacedo86/kubebuilder that referenced this pull request Oct 25, 2024
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).
camilamacedo86 added a commit to camilamacedo86/kubebuilder that referenced this pull request Oct 31, 2024
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).
camilamacedo86 added a commit to camilamacedo86/kubebuilder that referenced this pull request Oct 31, 2024
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).
camilamacedo86 added a commit to camilamacedo86/kubebuilder that referenced this pull request Oct 31, 2024
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).
camilamacedo86 added a commit to camilamacedo86/kubebuilder that referenced this pull request Oct 31, 2024
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).
@camilamacedo86 camilamacedo86 force-pushed the add-helm-chart-proposal branch 2 times, most recently from 16c31de to d90adaa Compare November 10, 2024 07:22
Co-Author: Ye Cao <caoye.cao@alibaba-inc.com>
@camilamacedo86
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 10, 2024
@camilamacedo86
Copy link
Member

/lgtm

@camilamacedo86
Copy link
Member

/approved

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 10, 2024
@camilamacedo86
Copy link
Member

Latest Status

We 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!

@camilamacedo86 camilamacedo86 added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 10, 2024
@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 6bf7566 into kubernetes-sigs:master Nov 10, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.