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

Move official Helm-Chart to this repo #140

Closed
5 of 6 tasks
ckotzbauer opened this issue May 1, 2020 · 12 comments
Closed
5 of 6 tasks

Move official Helm-Chart to this repo #140

ckotzbauer opened this issue May 1, 2020 · 12 comments
Assignees

Comments

@ckotzbauer
Copy link
Member

ckotzbauer commented May 1, 2020

The official Helm-Chart of Kured is currently hosted on the "stable" repository of https://github.com/helm/charts.
When Helm 3 was released in last november, the maintainers also deprecated the "stable" and "incubator" repository. So all charts have to move to own repos in a transition phase. See for more details: https://github.com/helm/charts#status-of-the-project

My suggestion is to move the chart to this repo and host it with github-pages. This is very simple and all sources are in one place for maintaining.

The following things have to be done for the migration:

  • Move the chart-sources to this repo.
  • Create CI-Jobs (e.g. Github Actions) to lint, test and release new chart versions
  • Maybe integrate into the release-process of kured itself.
  • Document the min-k8s version which is required in the Chart-Readme (should be 1.9 now)
  • List this chart-repo at Helm-Hub.
  • Deprecate the old chart at the stable-repo. (Add a link to its new home) https://github.com/helm/charts/blob/master/PROCESSES.md#deprecating-a-chart

ETA: Aug 13, 2020 (stable-repo will be de-listed from Helm-Hub then)

@dholbach
Copy link
Member

dholbach commented May 4, 2020

Do we need to get the approval of the charts authors/contributors to be able to move the code? Any guidance from the Helm team on moving charts elsewhere?

@ckotzbauer
Copy link
Member Author

Technically we don't need their approval. We should add a deprecation notice to the readme and publish a last chart version with that info, that everybody is aware of the migration. Then it's up to each user when to switch their installation to the new chart-repository.
I'm not aware of any further guidenace for moving. But you can look at several charts in the stable-folder, which are already moved to other repos.

General notice for deprecations: https://github.com/helm/charts/blob/master/PROCESSES.md#deprecating-a-chart

@dholbach
Copy link
Member

Added to the agenda of the next meeting (Wednesday May 27th, 16:00 UTC).

@dholbach
Copy link
Member

dholbach commented May 27, 2020

Actions from the meeting:

@ckotzbauer
Copy link
Member Author

Quickly reconsidered the question, if integrating the charts in this repo or making a new repo under weaveworks-org. The GH-Actions create a GH-Release for each new chart version and that's not possible without creating a git-tag. This would lead to noise, as discussed in the meeting...

@dholbach
Copy link
Member

dholbach commented Jun 2, 2020

@dholbach
Copy link
Member

@ckotzbauer and I brief call and discussed this issue. Here are our notes: https://docs.google.com/document/d/1xDvASO9gyp_O6o0xw71CK0_0GpueijpcToozx4T-Yrs/edit#

Thanks a lot for the thorough review @ckotzbauer and your offer of help - much appreciated!

@dholbach
Copy link
Member

dholbach commented Jun 17, 2020

Next steps as discussed in the call are:

Moving the chart

  • create initial PR which includes the original chart in verbatim
  • add all placeholders
  • remove autolock feature, document how to upgrade

Tracking and comms

  • file relevant issues for other TODO items
  • @dholbach: create helm-chart issue label
  • @dholbach: reach out to helm chart contributors to review PR (and potentially join the effort)

Release mechanics

Release & follow-up

@dholbach
Copy link
Member

@ckotzbauer ^ LMK if I captured this right.

@ckotzbauer
Copy link
Member Author

@dholbach Yes, you did!

@dholbach
Copy link
Member

dholbach commented Jun 30, 2020

We're almost there.

  • Fix wrong indent in the new ServiceMonitor resource
  • All cli-parameters are quoted now from the chart and it seems that kured cannot handle this in all cases. (time-zone, start-time, end-time, ...) have to be set without quotes
  • Fill out README.md in gh-pages branch to be like e.g. https://github.com/fluxcd/charts/blob/gh-pages/index.md
  • do another release
  • test
  • deprecate chart in /helm/charts/stable

@dholbach
Copy link
Member

#160

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants