Support Renovating HelmRelease CRD

[adusumillipraveen]

What would you like Renovate to be able to do?
Raise Pull Requests for updates to HelmRelease CRDs with latest helm charts versions.

Describe the solution you'd like
Extend the solution of Helm requirements.yaml to renovate HelmRelease CRD. For example, actual version that needs to be updated is here

Describe alternatives you've considered
No other alternatives available at the moment.

Additional context
Reuse as described in #3414 (comment)

[rarkins]

• Is there a specification for this file format?
• Are these referencing helm charts, or do we need a new datasource for something else?

[adusumillipraveen]

• Is there a specification for this file format?
  https://github.com/fluxcd/helm-operator/blob/master/deploy/crds.yaml is the specification. It is a Kubernetes CRD.
• Are these referencing helm charts, or do we need a new datasource for something else?
  These are referencing Helm charts, so this shouldn't need a new data source. These are the lines that are of importance in this case https://github.com/hmcts/cnp-flux-config/blob/master/k8s/admin/traefik/traefik.yaml#L11-L13

[rarkins]

The spec is a little overwhelming for me to be sure, but is this possibly very simple? e.g. is there a 1:1 mapping between the HelmRelease CRD and a Helm chart?And then just look in spec.chart?

[adusumillipraveen]

The spec is a little overwhelming for me to be sure, but is this possibly very simple? e.g. is there a 1:1 mapping between the HelmRelease CRD and a Helm chart?And then just look in spec.chart?

Yes, you could probably try and make sense using schema. But in simple terms, 3 fields that we need to be worried are here :

• Chart repository / Registry : Registry where chart is published (data source)

  • CRD reference
  • yaml example
  • Mapping to Requirements

• Chart Name : (Name of the Helm Chart )

  • CRD reference
  • yaml example
  • Mapping to Requirements

• Chart Version : (Published verison of helm chart - which needs to be renovated)

  • CRD reference
  • yaml example
  • Mapping to Requirements

Not sure if this is of any help.

[rarkins]

Can you create a demo public repo that contains an example HelmRelease CRD that you know can be updated? i.e. to test any solution against

[adusumillipraveen]

Also, see if this helps : https://docs.fluxcd.io/projects/helm-operator/en/stable/references/helmrelease-custom-resource/#helm.fluxcd.io/v1.RepoChartSource

[adusumillipraveen]

And here is the repo setup for test : https://github.com/adusumillipraveen/demo-flux-config/blob/master/demo-flux.yaml

[ChipWolf]

It's probably worth emphasising here; with the HelmRelease CRD, it's possible to specify either a chart registry, or a git repo with a path to a chart.

[ChipWolf]

With the help of @rarkins, I've managed to do this (albeit not in the cleanest way), with the existing version of Renovate. See #6130

[adusumillipraveen]

Thanks @ChipWolf , will give it a try now and let you know how it goes.

[adusumillipraveen]

That works perfect, Thanks @ChipWolf . Appreciate your time on this.

[RichiCoder1]

Per #7415, would love to see both Helm Operator and Helm Controller support.

Helm Controller is the eventual successor of Helm Operator. It has additional complexity as it breaks the Helm Repository/Git Repository portion into it's own CRD. So an implementation would need to a two-pass approach to accumulate repository urls and their labels/name, and then accumulate HelmReleases.

[onedr0p]

For those interested, I and @bjw-s created a Github action (and standalone script) to update the Helm Release files with a renovate annotation (comment). It expects your HelmRepository and HelmRelease files to be found anywhere under a certain directory.

See here: https://github.com/k8s-at-home/renovate-helm-releases

[danports]

I've taken a crack at implementing a proper Flux package manager that can renovate HelmRelease manifests by parsing both HelmRelease and HelmRepository manifests and stitching the two together. It is very basic at the moment, but is passing one test. Will do some further testing and then open a PR.

[danports]

Feel free to give my branch a try on your Flux repositories. The local development instructions make it fairly simple. I've tested my changes on my main Flux repository and it is working well so far. Note that you will need to define fileMatch for the flux manager as described in the docs.

[onedr0p]

@danports This is awesome! I'll try to get some time in to test against my repository as well. Also, there's a whole bunch of repos you could pull down and test this on over at https://github.com/k8s-at-home/awesome-home-kubernetes

[onedr0p]

To sum up the testing steps from the docs...

git clone [email protected]:danports/renovate.git
cd renovate
git checkout flux-manager
yarn install
yarn build
yarn test # optional
RENOVATE_TOKEN=ghp_... LOG_LEVEL=debug yarn start owner/repository

[danports]

@onedr0p Yep - you can omit yarn test, but you'll need to add something like "flux": { "fileMatch": ["\\.yaml$"] } to your Renovate configuration for the new package manager to do anything.

[onedr0p]

It worked fine for me, this is amazing. Can't wait to see it merged, thanks @danports

[renovate-release]

🎉 This issue has been resolved in version 31.35.0 🎉

The release is available on:

• GitHub release
• 31.35.0

Your semantic-release bot 📦🚀