Skip to content

Add Helm Chart manifests and GitHub Release Helm Chart for the snapshot-controller component #622

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add Helm Chart manifests and GitHub Release Helm Chart for the snapshot-controller component #622

wants to merge 5 commits into from
+533 −0

Conversation

kaskol10
Copy link

@kaskol10 kaskol10 commented Dec 1, 2021

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind api-change
/kind bug
/kind cleanup
/kind design
/kind documentation
/kind failing-test
/kind feature
/kind flake

/kind design

What this PR does / why we need it:

The changes introduced with this PR allow for better integration snapshot-controller and Helm. Besides, publish the Helm Chart in the GitHub Releases Pages using a GitHub Action.

Which issue(s) this PR fixes:

Fixes #551

Special notes for your reviewer:
A GitHub branch called gh-pages would be needed to store the published charts. It's a pre-requisite for chart-releaser-action
Does this PR introduce a user-facing change?:

Added Helm Chart manifests and Helm Chart GitHub Release for snapshot-controller component

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/design Categorizes issue or PR as related to design. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Dec 1, 2021
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Dec 1, 2021 •
edited
Loading

CLA Signed

The committers are authorized under a signed CLA.

@k8s-ci-robot
Copy link
Contributor

Welcome @kaskol10!

It looks like this is your first PR to kubernetes-csi/external-snapshotter 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-csi/external-snapshotter has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @kaskol10. Thanks for your PR.

I'm waiting for a kubernetes-csi 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.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Dec 1, 2021
@kaskol10
Copy link
Author

kaskol10 commented Dec 1, 2021

/assign @msau42

@z0rc
Copy link

z0rc commented Dec 14, 2021

Please include CRDs into chart as well.

@SamuelBagattin
Copy link

Please include CRDs into chart as well.

According to stevehipwell, is it really a good practice to install CRDs part of a helm chart ?

@z0rc
Copy link

z0rc commented Dec 15, 2021

@SamuelBagattin Helm isn't able to manage full lifecycle of CRDs, that's true, but it is quite capable of installing CRDs if there is none. Which solves initial deployment task. It's common practice on CRDs change to bump major chart version and provide instructions how to update CRDs, check out https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack.

@eumel8
Copy link

eumel8 commented Feb 15, 2022

Great work, @kaskol10 , many thanks!
Any progress here on this PR? In the past we had our own Helm chart for CRDs, before the snapshot controller manager was removed from OpenStack Cinder CSI Chart and it's not available anymore since openstack-cinder-csi-2.0.0. Would be a good idea to have a fast replacements, thx!

@SamuelBagattin
Copy link

Hi @kaskol10 🙌
It's been a while there has been no more commit on this PR, and the helm chart would really help us 😊
Any update ?

@ggriffiths
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 Apr 21, 2022
@ggriffiths
Copy link
Member

My concern with this is continued support of helm charts by the maintainers, I am not sure if that's something the team would have the bandwidth to do for every release. I'll defer to @xing-yang as to if we want to continue maintaining helm charts for the snapshot-controller in this repo.

@xing-yang
Copy link
Collaborator

My concern with this is continued support of helm charts by the maintainers, I am not sure if that's something the team would have the bandwidth to do for every release. I'll defer to @xing-yang as to if we want to continue maintaining helm charts for the snapshot-controller in this repo.

Thanks @kaskol10 for your contribution. As mentioned by @ggriffiths, that's exactly the concern we have.

@KlavsKlavsen
Copy link

We too would really like an easy way to actually install this.. What other way do you recommend, instead of using a Helm Chart?

@ggriffiths
Copy link
Member

We too would really like an easy way to actually install this.. What other way do you recommend, instead of using a Helm Chart?

The deployment files under deploy/kubernetes will work. We maintain those for every release with new flags/RBAC/etc.

If there's enough interest, maybe you can create a separate repo to house and maintain the Helm installation.

@sathieu
Copy link

sathieu commented May 13, 2022

My concern with this is continued support of helm charts by the maintainers,

Maybe the solution is to generate the plain manifests from the helm chart (and add a pipeline to ensure. WDYT?

NB: there is also helmify to create charts from plain manifests.

@xing-yang xing-yang mentioned this pull request Dec 18, 2023
Open
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 10, 2024
@kahirokunn
Copy link

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 11, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 9, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle rotten
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jul 9, 2024
@Nuru
Copy link

Nuru commented Jul 9, 2024

/remove-lifecycle rotten

I'd still like to see this and would use it if it were available

@k8s-ci-robot k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Jul 9, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 4, 2024
@pschichtel
Copy link

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 4, 2024
@M0NsTeRRR
Copy link

I recently encountered an issue where I updated the file https://raw.githubusercontent.com/kubernetes-csi/external-snapshotter/v8.2.0/deploy/kubernetes/snapshot-controller/setup-snapshot-controller.yaml in my kustomization.yaml to the new tag v8.2.0. However, it turned out that it was using the wrong image (registry.k8s.io/sig-storage/snapshot-controller:v8.0.1). This issue was fixed in a later commit, but that fix is not included in the v8.2.0 tag.

The root cause seems to be that, when a new tag is released, there are many files to update (e.g., deployments, CRDs, etc.), which increases the chances of such issues occurring. In contrast, Helm charts only require bumping the appVersion, which helps to avoid this kind of problem.

I understand your concern about maintaining the Helm chart, but given how widely used this project is, I really don't think that neglecting maintenance will become an issue.

hswong3i added a commit to alvistack/kubernetes-csi-external-snapshotter that referenced this pull request Mar 24, 2025
@hswong3i
Create Helm Chart from Static Manifests
f540b1b 
**What type of PR is this?**
/kind feature

**What this PR does / why we need it**:
This PR convert our static deployment manifests from `deploy/kubernetes/*` into Helm Charts under `charts/*`, by running a convert script under `deploy/util/chart-releaser.sh`.

Moreover, it handle the chart release with branch `gh-pages`, by integrate with https://github.com/helm/chart-releaser-action.

Before each stable tag release, maintainers only required to:
1. Run the `./deploy/util/chart-releaser.sh` and update templates under `charts/*/templates/*`
2. Double confirm `charts/*/values.yml` with correct values, e.g. image tags
3. `git add --all --force charts/* && git commit`

**Which issue(s) this PR fixes**:
Fixes kubernetes-csi#551
Fixes kubernetes-csi#622
Fixes kubernetes-csi#751

Signed-off-by: Wong Hoi Sing Edison <hswong3i@pantarei-design.com>
@hswong3i hswong3i mentioned this pull request Mar 24, 2025
Open
hswong3i added a commit to alvistack/kubernetes-csi-external-snapshotter that referenced this pull request Mar 24, 2025
@hswong3i
Create Helm Chart from Static Manifests
bf540c3 
**What type of PR is this?**
/kind feature

**What this PR does / why we need it**:
This PR convert our static deployment manifests from `deploy/kubernetes/*` into Helm Charts under `charts/*`, by running a convert script under `deploy/util/chart-releaser.sh`.

Moreover, it handle the chart release with branch `gh-pages`, by integrate with https://github.com/helm/chart-releaser-action.

Before each stable tag release, maintainers only required to:
1. Run the `./deploy/util/chart-releaser.sh` and update templates under `charts/*/templates/*`
2. Double confirm `charts/*/values.yml` with correct values, e.g. image tags
3. `git add --all --force charts/* && git commit`

**Which issue(s) this PR fixes**:
Fixes kubernetes-csi#551
Fixes kubernetes-csi#622
Fixes kubernetes-csi#751

Signed-off-by: Wong Hoi Sing Edison <hswong3i@pantarei-design.com>
hswong3i added a commit to alvistack/kubernetes-csi-external-snapshotter that referenced this pull request Mar 24, 2025
@hswong3i
Create Helm Chart from Static Manifests
7f28507 
**What type of PR is this?**
/kind feature

**What this PR does / why we need it**:
This PR convert our static deployment manifests from `deploy/kubernetes/*` into Helm Charts under `charts/*`, by running a convert script under `deploy/util/chart-releaser.sh`.

Moreover, it handle the chart release with branch `gh-pages`, by integrate with https://github.com/helm/chart-releaser-action.

The sample helm repo could find from https://alvistack.github.io/kubernetes-csi-external-snapshotter/index.yaml, by:

    helm repo add external-snapshotter https://alvistack.github.io/kubernetes-csi-external-snapshotter
    helm repo update
    helm search repo external-snapshotter

Before each stable tag release, maintainers only required to:
1. Run the `./deploy/util/chart-releaser.sh` and update templates under `charts/*/templates/*`
2. Double confirm `charts/*/values.yml` with correct values, e.g. image tags
3. `git add --all --force charts/* && git commit`

**Which issue(s) this PR fixes**:
Fixes kubernetes-csi#551
Fixes kubernetes-csi#622
Fixes kubernetes-csi#751

Signed-off-by: Wong Hoi Sing Edison <hswong3i@pantarei-design.com>
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 5, 2025
@druchoo
Copy link

druchoo commented Apr 7, 2025

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 7, 2025
@haiwu
Copy link

haiwu commented Apr 7, 2025

any luck to move forward with this?

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 6, 2025
@druchoo
Copy link

druchoo commented Jul 9, 2025

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ggriffiths ggriffiths ggriffiths requested changes

@gnufied gnufied Awaiting requested review from gnufied

Assignees

@msau42 msau42

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/design Categorizes issue or PR as related to design. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Helm chart for CRDs and snapshot controller?