Initial support for Helm release resource #1677

viveklak · 2021-08-12T21:06:32Z

This change adds a new resource - kubernetes:helm.sh/v3:Release. This resource directly utilizes Helm to orchestrate the installation of charts into releases. Users can query the release through Pulumi as well as Helm.

This is heavily inspired by https://github.com/hashicorp/terraform-provider-helm fashioned for Pulumi's kubernetes provider.

Here is an example of the experience so far:

const release = new k8s.helm.v3.Release("release", {
    chart: "redis",
    repositoryOpts: {
        repo: "https://charts.bitnami.com/bitnami",
    },
    version: "13.0.1",
    values: {
        cluster: {
            enabled: true,
            slaveCount: 2,
        },
        metrics: {
            enabled: true,
            service: {
                annotations: {
                    "prometheus.io/port": "9127",
                }
            },
        },
        global: {
            redis: {
                password: redisPassword,
            }
        },
        rbac: {
            create: true,
        }
    },
    timeout: 120,
});


const srv = k8s.core.v1.Service.get("redis-master-svc", pulumi.interpolate`${release.status.namespace}/${release.status.name}-redis-master`);
export const clusterIP = srv.spec.clusterIP;

With the default behavior (skipAwait = false) all resources must be available before the release becomes available and the subsequent get on the service works. Note that underlying resources are not in state (unlike helm chart support).

How to build/use

Checkout branch
make build
export PATH=$PATH:$PWD/bin
Use provided SDK.

Things to do:

Make await default
Golang SDK fixes (currently package name doesn't match the expected package)
Fix linting issues because of ^
Values should be hierarchical (existing chart semantics)
Add E2E tests (Need dotnet example)

The following are known follow-up items which have corresponding issues being tracked:

github-actions · 2021-08-12T21:14:20Z

Does the PR have any schema changes?

Looking good! No breaking changes found.

New resources:

kubernetes:helm.sh/v3:Release

lblackstone · 2021-08-23T15:35:44Z

Passerby here awaiting this before deploying some helm charts that utilize hooks. Does anyone have an intuition about the timeframe for this to land? I'm trying to evaluate waiting or implementing a workaround. Thanks in advance! :)

We're expecting to have it available as a beta/dev preview resource soon. I'll say end of September conservatively, but likely sooner than that.

joeduffy · 2021-08-26T04:22:19Z

I'll say end of September conservatively, but likely sooner than that.

Levi, my understanding is that this should be available by early September. Is that right? cc @lukehoban

lblackstone · 2021-08-26T17:18:54Z

I'll say end of September conservatively, but likely sooner than that.

Levi, my understanding is that this should be available by early September. Is that right? cc @lukehoban

@joeduffy Yes, AFAIK. I need to confirm with Vivek, but I believe we're just about ready to ship initial support (minus the list of followup items in the description).

github-actions · 2021-08-30T17:58:54Z

Does the PR have any schema changes?

Looking good! No breaking changes found.

New resources:

kubernetes:helm.sh/v3:Release

github-actions · 2021-08-31T21:21:53Z

Does the PR have any schema changes?

Looking good! No breaking changes found.

New resources:

kubernetes:helm.sh/v3:Release

provider/pkg/gen/overlays.go

lblackstone · 2021-08-31T21:42:41Z

provider/pkg/gen/schema.go

@@ -70,6 +70,30 @@ func PulumiSchema(swagger map[string]interface{}) pschema.PackageSpec {
 					Description: "If present and set to true, suppress apiVersion deprecation warnings from the CLI.\n\nThis config can be specified in the following ways, using this precedence:\n1. This `suppressDeprecationWarnings` parameter.\n2. The `PULUMI_K8S_SUPPRESS_DEPRECATION_WARNINGS` environment variable.",
 					TypeSpec:    pschema.TypeSpec{Type: "boolean"},
 				},
+				"suppressHelmReleaseBetaWarning": {


I wonder if it would make sense to nest these helm-specific configs under a top-level config to avoid cluttering the docs + auto-complete suggestions?

I will play with this. I can follow up for this in a separate PR?

provider/pkg/provider/helm_release.go

provider/pkg/provider/manifest_json.go

lblackstone · 2021-08-31T22:02:04Z

provider/pkg/provider/provider.go

+			if k.defaultNamespace != "" {
+				namespace = k.defaultNamespace
+			}
+			k.helmReleaseProvider, err = newHelmReleaseProvider(


I'm not sure how much overhead this causes, but we might want to make this conditional on the program using a helm Release resource.

Agreed. Though this should be fairly lightweight for the moment. Happy to revisit later.

lblackstone · 2021-08-31T22:03:29Z

provider/pkg/provider/provider.go

+		if !k.clusterUnreachable {
+			return k.helmReleaseProvider.Check(ctx, req, !k.suppressHelmReleaseBetaWarning)
+		}
+		return nil, fmt.Errorf("can't use Helm Release with unreachable cluster. Reason: %q", k.clusterUnreachableReason)


Perhaps we should print some sort of placeholder value rather than erroring in this case?

I think it is desirable to render the manifests and resource names from the helm release but they would only render if I emitted them from Check (and not from Create/Update etc.). As a result Check is an "online"-only operation at the moment. I am happy to open an issue to revisit this. Perhaps we can mark those fields as computed instead when the cluster is unreachable.

Yeah, it seems like we should be able to fall back to showing some minimal info rather than erroring. Two things to check here would be YAML render mode, which generally doesn't require an active cluster, and the case where the cluster hasn't been created yet, but is a parent in the stack via the Provider.

github-actions · 2021-08-31T22:17:14Z

Does the PR have any schema changes?

Looking good! No breaking changes found.

New resources:

kubernetes:helm.sh/v3:Release

github-actions · 2021-09-01T00:18:55Z

Does the PR have any schema changes?

Looking good! No breaking changes found.

New resources:

kubernetes:helm.sh/v3:Release

github-actions · 2021-09-01T00:54:42Z

Does the PR have any schema changes?

Looking good! No breaking changes found.

New resources:

kubernetes:helm.sh/v3:Release

lblackstone

I think this looks good as a starting point for the beta. 👍

github-actions · 2021-09-03T01:21:34Z

Does the PR have any schema changes?

Looking good! No breaking changes found.

New resources:

kubernetes:helm.sh/v3:Release

github-actions · 2021-09-03T05:07:11Z

Does the PR have any schema changes?

Looking good! No breaking changes found.

New resources:

kubernetes:helm.sh/v3:Release

viveklak · 2021-09-03T05:26:30Z

The latest changes remove the inputs under ReleaseSpec and flatten them
Rename repositorySpec to repositoryOpts

muhlba91 · 2021-09-03T06:39:31Z

hi, as this was blocking us to use pulumi for our helm releases and it got merged now for beta, how am i able to use and test this version? what version tag do i have to specify in my package.json and are there any other requirements i have to adjust in my NodeJS project? :)

viveklak · 2021-09-03T16:46:24Z

@muhlba91 I am planning to cut a release today and will update this issue with directions. Thanks for your patience!

viveklak · 2021-09-04T21:52:59Z

@muhlba91 I am planning to cut a release today and will update this issue with directions. Thanks for your patience!

This is now included in v3.7.0 release. We are still getting docs etc. ready but the resource is now available to play around with. Some known issues are tracked here.

JoaRiski · 2021-09-18T22:10:20Z

@viveklak does the current implementation support installing charts from local files like the Chart resource does? Haven't figured how that works

viveklak added 17 commits August 10, 2021 16:34

Initial spec

f401997

More schema gen changes

0da7ff0

Nodejs SDK

a966745

Python SDK

6d7d692

Dotnet SDK

4be512f

WIP Golang SDK

f39dc86

Reorder the build targets

a97e8c6

More schema fixes

416206b

Add provider config args

723552f

More provider config

6a721be

WIP provider

c0de4e4

Codegen changes

9143bd2

Schema

4279f5f

Dotnet

0e557f9

Nodejs

3409dac

Python

0be00ff

Go

73612f7

viveklak changed the title ~~Helm release support~~ Helm release support [WIP] Aug 12, 2021

viveklak marked this pull request as draft August 12, 2021 21:07

viveklak requested a review from lblackstone August 12, 2021 21:07

viveklak added 9 commits August 13, 2021 11:05

Add diff support

64a9508

Adding delete and read support

067bbdf

Checkpoint

581e133

Update support

6dd5148

Provider config

972d3fa

Bunch of bug fixes

40738e4

Fix preview handling for release::Create

0555667

Merge branch 'vl/HelmReleaseProc' into vl/HelmRelease

709f7e2

Gofmt

dc01943

lblackstone mentioned this pull request Aug 24, 2021

Support helm v3 chart releases and helm v3 CLI #1092

Closed

Merge remote-tracking branch 'origin/master' into vl/HelmRelease

4c709ec

Merge remote-tracking branch 'origin/master' into vl/HelmRelease

78dd222

Remove unnecessary resourceType constant from schema

baec323

lblackstone requested changes Aug 31, 2021

View reviewed changes

Address PR comments

e243442

SDK updates

bf40c21

lblackstone approved these changes Sep 1, 2021

View reviewed changes

viveklak added 2 commits September 2, 2021 15:45

Remove ReleaseSpec and flatten inputs

bf34ece

Fix tests

f1cc874

Rename repositorySpec

3369a90

viveklak merged commit 876eaea into master Sep 3, 2021

pulumi-bot deleted the vl/HelmRelease branch September 3, 2021 05:35

viveklak mentioned this pull request Sep 3, 2021

[Helm/Release] Add examples for helm/release to pulumi/examples pulumi/examples#1068

Open

blampe mentioned this pull request Oct 28, 2021

[Helm/Release] Panic after changing values #1780

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial support for Helm release resource #1677

Initial support for Helm release resource #1677

viveklak commented Aug 12, 2021 •

edited

Loading

github-actions bot commented Aug 12, 2021

lblackstone commented Aug 23, 2021

joeduffy commented Aug 26, 2021

lblackstone commented Aug 26, 2021

github-actions bot commented Aug 30, 2021

github-actions bot commented Aug 31, 2021

lblackstone Aug 31, 2021

viveklak Sep 1, 2021

lblackstone Aug 31, 2021

viveklak Sep 1, 2021

lblackstone Aug 31, 2021

viveklak Sep 1, 2021

lblackstone Sep 1, 2021

github-actions bot commented Aug 31, 2021

github-actions bot commented Sep 1, 2021

github-actions bot commented Sep 1, 2021

lblackstone left a comment

github-actions bot commented Sep 3, 2021

github-actions bot commented Sep 3, 2021

viveklak commented Sep 3, 2021

muhlba91 commented Sep 3, 2021

viveklak commented Sep 3, 2021

viveklak commented Sep 4, 2021

JoaRiski commented Sep 18, 2021

Initial support for Helm release resource #1677

Initial support for Helm release resource #1677

Conversation

viveklak commented Aug 12, 2021 • edited Loading

github-actions bot commented Aug 12, 2021

Does the PR have any schema changes?

New resources:

lblackstone commented Aug 23, 2021

joeduffy commented Aug 26, 2021

lblackstone commented Aug 26, 2021

github-actions bot commented Aug 30, 2021

Does the PR have any schema changes?

New resources:

github-actions bot commented Aug 31, 2021

Does the PR have any schema changes?

New resources:

lblackstone Aug 31, 2021

Choose a reason for hiding this comment

viveklak Sep 1, 2021

Choose a reason for hiding this comment

lblackstone Aug 31, 2021

Choose a reason for hiding this comment

viveklak Sep 1, 2021

Choose a reason for hiding this comment

lblackstone Aug 31, 2021

Choose a reason for hiding this comment

viveklak Sep 1, 2021

Choose a reason for hiding this comment

lblackstone Sep 1, 2021

Choose a reason for hiding this comment

github-actions bot commented Aug 31, 2021

Does the PR have any schema changes?

New resources:

github-actions bot commented Sep 1, 2021

Does the PR have any schema changes?

New resources:

github-actions bot commented Sep 1, 2021

Does the PR have any schema changes?

New resources:

lblackstone left a comment

Choose a reason for hiding this comment

github-actions bot commented Sep 3, 2021

Does the PR have any schema changes?

New resources:

github-actions bot commented Sep 3, 2021

Does the PR have any schema changes?

New resources:

viveklak commented Sep 3, 2021

muhlba91 commented Sep 3, 2021

viveklak commented Sep 3, 2021

viveklak commented Sep 4, 2021

JoaRiski commented Sep 18, 2021

viveklak commented Aug 12, 2021 •

edited

Loading