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

Promote HelmRelease API to v2 (GA) #963

Merged
merged 10 commits into from
May 6, 2024
Merged

Promote HelmRelease API to v2 (GA) #963

merged 10 commits into from
May 6, 2024

Conversation

stefanprodan
Copy link
Member

@stefanprodan stefanprodan commented May 3, 2024

This PR promotes the HelmRelease API from v2beta2 to v2 and deprecates the v2beta2 API (to be removed after a period of 6 months).

⚠️ Removed Fields

In the helm.toolkit.fluxcd.io/v2 API the following fields (deprecated since v2beta1) are removed:

  • .spec.chart.spec.valuesFile replaced by .spec.chart.spec.valuesFiles
  • .spec.postRenderers.kustomize.patchesJson6902 replaced by .spec.postRenderers.kustomize.patches
  • .spec.postRenderers.kustomize.patchesStrategicMerge replaced by .spec.postRenderers.kustomize.patches
  • .status.lastAppliedRevision replaced by .status.history.chartVersion

🏷️ New Fields

  • .spec.chartRef allows referencing chart artifacts from OCIRepository and HelmChart objects.
  • .spec.chart.spec.ignoreMissingValuesFiles allows ignoring missing values files instead of failing to reconcile.

📦 Helm OCI Artifacts

Starting with this version, the recommend way of using Helm OCI, is by referencing an OCIRepository object.

Helm OCI example:

apiVersion: source.toolkit.fluxcd.io/v1beta2
kind: OCIRepository
metadata:
  name: podinfo
  namespace: default
spec:
  interval: 10m
  layerSelector:
    mediaType: "application/vnd.cncf.helm.chart.content.v1.tar+gzip"
    operation: copy
  url: oci://ghcr.io/stefanprodan/charts/podinfo
  ref:
    semver: "*"
---
apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
metadata:
  name: podinfo
  namespace: default
spec:
  interval: 10m
  chartRef:
    kind: OCIRepository
    name: podinfo

Part of: fluxcd/flux2#4712

@stefanprodan stefanprodan added the area/api API related issues and pull requests label May 3, 2024
@stefanprodan stefanprodan force-pushed the helm-ga branch 3 times, most recently from ae977fa to b1e207e Compare May 3, 2024 14:07
Signed-off-by: Stefan Prodan <[email protected]>
@stefanprodan stefanprodan force-pushed the helm-ga branch 2 times, most recently from 7c8a586 to 9abf639 Compare May 3, 2024 14:27
Signed-off-by: Stefan Prodan <[email protected]>
@stefanprodan stefanprodan marked this pull request as ready for review May 3, 2024 14:45
@stefanprodan stefanprodan requested a review from a team May 4, 2024 09:58
@stefanprodan stefanprodan added this to the Helm GA milestone May 4, 2024
docs/spec/v2/README.md Show resolved Hide resolved
internal/action/install.go Show resolved Hide resolved
internal/action/rollback.go Show resolved Hide resolved
Copy link
Member

@souleb souleb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@stefanprodan stefanprodan merged commit f8aa5b4 into main May 6, 2024
6 checks passed
@stefanprodan stefanprodan deleted the helm-ga branch May 6, 2024 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api API related issues and pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants