Helm Chart v4 (Component)

[EronWright]

Proposed changes

This PR implements an MLC-based Chart resource as per design doc.

Notable improvements over v3:Chart:

• Input schema more closely resembles v3:Release.
• Performs templating in an online mode.
• More control over resource ordering via annotation: config.kubernetes.io/depends-on
• Uses Pulumi Assets for supplemental files (keyring, repository opts).
• Use assets as values files (--values) and as individual values (--set-file).
• Use multiple values files.
• Support for post-rendering w/ arguments.
• OCI registry support.

Detailed changes:

• [pkg/helm] introduce a reusable Helm tool wrapper
• [pkg/gen] define helm.sh/v4:Chart resource plus v4:PostRenderer,v4:RepositoryOpts
• [provider] initialize the Helm EnvSettings based on provider configuration
• [provider/helmv4] implement Chart resource provider
• [provider/yamlv2] add PreRegisterF hook to be able to mutate child resource options, specifically RetainOnDelete
• [provider/yamlv2] new gomega matcher: HaveSkipAwaitAnnotation()
• [tests/testdata] new 'reference' chart for testing purposes
• [misc] bugfix for kube client settings

Tests:

• New suite for Chart provider w/ coverage of all in-scope features
• Extended tests for provider Construct RPC to cover namespacing, kube client settings, helm release settings

Examples

See the examples in the API docs:
https://github.com/pulumi/pulumi-kubernetes/blob/47a6ae4fceb8339c49d4f13b5f765af798c0308b/provider/pkg/gen/examples/overlays/chartV4.md#example-usage

Local Chart:

type: kubernetes:helm.sh/v4:Chart
properties:
  namespace: cert-manager
  chart: ./cert-manager

Repository Chart:

# helm repo add bitnami https://charts.bitnami.com/bitnami
type: kubernetes:helm.sh/v4:Chart
properties:
  namespace: cert-manager
  chart: bitnami/cert-manager
  version: "1.1.0"

Remote Chart:

type: kubernetes:helm.sh/v4:Chart
properties:
  namespace: cert-manager
  chart: cert-manager
  version: "1.1.0"
  repositoryOpts:
    repo: https://charts.bitnami.com/bitnami

OCI Chart:

type: kubernetes:helm.sh/v4:Chart
properties:
  namespace: cert-manager
  chart: oci://registry-1.docker.io/bitnamicharts/cert-manager
  version: "1.1.0"

Custom Values:

type: kubernetes:helm.sh/v4:Chart
properties:
  namespace: cert-manager
  chart: oci://registry-1.docker.io/bitnamicharts/cert-manager
  version: "1.1.0"
  values:
    installCRDs: false
    notes:
      fn::fileAsset: notes.txt
  valueYamlFiles:
  - fn::fileAsset: values.yaml

Chart Verification w/ Keyring:

type: kubernetes:helm.sh/v4:Chart
properties:
  namespace: cert-manager
  chart: oci://registry-1.docker.io/eronwrightpulumi/cert-manager
  version: "1.1.0"
  verify: true
  keyring:
    fn::fileAsset: "public.pgp"

Post-Rendering:

type: kubernetes:helm.sh/v4:Chart
properties:
  namespace: cert-manager
  chart: oci://registry-1.docker.io/bitnamicharts/cert-manager
  version: "1.1.0"
  postRenderer:
    command: ./kustomize
    args: []

Related issues (optional)

Fixes #2847

[github-actions]

Does the PR have any schema changes?

Looking good! No breaking changes found.

New resources:

• helm.sh/v4.Chart

[codecov]

Codecov Report

Attention: Patch coverage is 61.04746% with 238 lines in your changes are missing coverage. Please review.

Project coverage is 32.29%. Comparing base (ad58732) to head (a27f402).

Files	Patch %	Lines
provider/pkg/helm/tool.go	48.51%	113 Missing and 26 partials ⚠️
provider/pkg/provider/helm/v4/chart.go	74.04%	23 Missing and 11 partials ⚠️
provider/pkg/logging/log_writer.go	25.00%	27 Missing ⚠️
provider/pkg/helm/values.go	68.96%	10 Missing and 8 partials ⚠️
provider/pkg/helm/fake.go	80.00%	8 Missing and 4 partials ⚠️
provider/pkg/gen/schema.go	0.00%	4 Missing ⚠️
provider/pkg/provider/provider.go	92.85%	1 Missing and 1 partial ⚠️
provider/pkg/provider/util.go	66.66%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2947      +/-   ##
==========================================
+ Coverage   29.99%   32.29%   +2.29%     
==========================================
  Files          63       69       +6     
  Lines        8338     8947     +609     
==========================================
+ Hits         2501     2889     +388     
- Misses       5615     5791     +176     
- Partials      222      267      +45     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[blampe]

Crazy thought experiment, partly out of curiosity and partly to help me better understand our wrapping:

Let's pretend newRootCmd is public, so we have a NewRootCmd that gives us a cobra.Command encapsulating all of helm's functionality.

We can feed that cobra.Command raw arguments with something like cmd.SetArgs([]string{"install", "--values", ...})), and we can execute it like any other command.

I'm curious what functionality we would lose, or what would no longer be expressible, if we reduced everything to parsing Pulumi's inputs → mapping those to CLI args → feeding that to the CLI command?

Obviously the command's outputs would be awkward to work with, but there's also the really appealing upside of always matching upstream...

[rquitales]

Wondering what our maintenance strategy is for this vendored fork? Are we going to try and track upstream changes closely? If so, maybe a quick doc.go that describes how this code was vendored and the releavant changes made, if any?

[rquitales]

Also it appears that we have our own code within the vendored code in this file? If so, should we also include a Pulumi license to this file? Not sure what the correct procedure here is.

[EronWright]

I too was wondering about that but I'm pretty sure we've done enough with the headers. The vendoring was done simply by copy-paste of certain functions. I think we'll keep iterating on the tool soon, e.g. for a Release v4 resource.

[blampe]

+1 to headers being sufficient.

Part of the motivation behind my suggestion here was to help reduce non-upstream code, because otherwise things will start to get intermingled and harder to keep in sync.

It might make sense to break out our pulumi-specific stuff into its own package (pulumihelm or something) to make tracking upstream easier, but we don't need to do that now.

[blampe]

I'm still really curious if we can remove the custom MergeValues but that doesn't need to block. Let's do it!