feat(eks): helm chart support #5390

vlesierse · 2019-12-12T10:05:01Z

Initial commit to support Helm using EKS. It makes use of the version 2.0.0-beta1 version of the aws-lambda-layer-kubectl Lambda Layer which includes Helm 3.0.

Example

new HelmChart(this, 'NginxIngress', {
    cluster,
    release: "nginx-ingress",
    namespace: "kube-system",
    chart: "nginx-ingress",
    repository: "https://helm.nginx.com/stable",
    values: {
        controller: {
            kind: "Deployment"
        }
    }
});
// Release with chart from absolute URL
new HelmChart(this, 'MyNginx', {
    cluster,
    chart: "https://example.com/charts/nginx-1.2.3.tgz"
});

Closes #3748 Deploy Helm chart to EKS via CDK

Include tests
Fix problem with unreachable Helm repository urls within the Lambda
Improve documentation
Changes according feedback

Additional use cases which are not part of this PR:

Support for stable/...and incubator/....
Reference charts or repositories using S3 Buckets which can only be accessed with the right IAM role.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

mergify · 2019-12-12T10:05:36Z

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

PR title type(scope): text
- type: fix, feat, refactor go into CHANGELOG, chore is hidden
- scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
- text: use all lower-case, do not end with a period, do not include issue refs
PR Description
- Rationale: describe rationale of change and approach taken
- Issues: indicate issues fixed via: fixes #xxx or closes #xxx
- Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
Testing
- Unit test added. Prefer to add a new test rather than modify existing tests
- CLI or init templates change? Re-run/add CLI integration tests
Documentation
- README: update module README to describe new features
- API docs: public APIs must be documented. Copy from official AWS docs when possible
- Design: for significant features, follow design process

aws-cdk-automation · 2019-12-12T10:16:43Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2019-12-12T14:23:56Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2019-12-12T14:40:01Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2019-12-12T15:41:35Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

pahud · 2019-12-12T16:42:53Z

Hey, according to this comment #5333 (comment) @eladb may release a new custom-resource design. Just FYI.

vlesierse · 2019-12-13T07:00:45Z

Thanks for the heads up. Missed that one... will wait till the different design and adjust accordingly.

As more people are working on this it might be a good thing to bring it together in some way. I believe that CDK can be a great way of managing Kubernetes resources as code...

eladb

Great start!

packages/@aws-cdk/aws-eks/lib/helm-release.ts

packages/@aws-cdk/aws-eks/lib/helm-release/index.py

aws-cdk-automation · 2019-12-16T06:22:49Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2019-12-16T07:13:18Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2019-12-16T12:32:47Z

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

PR title type(scope): text
- type: fix, feat, refactor go into CHANGELOG, chore is hidden
- scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
- text: use all lower-case, do not end with a period, do not include issue refs
PR Description
- Rationale: describe rationale of change and approach taken
- Issues: indicate issues fixed via: fixes #xxx or closes #xxx
- Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
Testing
- Unit test added. Prefer to add a new test rather than modify existing tests
- CLI or init templates change? Re-run/add CLI integration tests
Documentation
- README: update module README to describe new features
- API docs: public APIs must be documented. Copy from official AWS docs when possible
- Design: for significant features, follow design process

mergify · 2019-12-16T13:00:37Z

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

PR title type(scope): text
- type: fix, feat, refactor go into CHANGELOG, chore is hidden
- scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
- text: use all lower-case, do not end with a period, do not include issue refs
PR Description
- Rationale: describe rationale of change and approach taken
- Issues: indicate issues fixed via: fixes #xxx or closes #xxx
- Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
Testing
- Unit test added. Prefer to add a new test rather than modify existing tests
- CLI or init templates change? Re-run/add CLI integration tests
Documentation
- README: update module README to describe new features
- API docs: public APIs must be documented. Copy from official AWS docs when possible
- Design: for significant features, follow design process

mergify · 2019-12-16T13:52:55Z

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

PR title type(scope): text
- type: fix, feat, refactor go into CHANGELOG, chore is hidden
- scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
- text: use all lower-case, do not end with a period, do not include issue refs
PR Description
- Rationale: describe rationale of change and approach taken
- Issues: indicate issues fixed via: fixes #xxx or closes #xxx
- Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
Testing
- Unit test added. Prefer to add a new test rather than modify existing tests
- CLI or init templates change? Re-run/add CLI integration tests
Documentation
- README: update module README to describe new features
- API docs: public APIs must be documented. Copy from official AWS docs when possible
- Design: for significant features, follow design process

mergify · 2019-12-16T14:38:34Z

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

PR title type(scope): text
- type: fix, feat, refactor go into CHANGELOG, chore is hidden
- scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
- text: use all lower-case, do not end with a period, do not include issue refs
PR Description
- Rationale: describe rationale of change and approach taken
- Issues: indicate issues fixed via: fixes #xxx or closes #xxx
- Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
Testing
- Unit test added. Prefer to add a new test rather than modify existing tests
- CLI or init templates change? Re-run/add CLI integration tests
Documentation
- README: update module README to describe new features
- API docs: public APIs must be documented. Copy from official AWS docs when possible
- Design: for significant features, follow design process

mergify · 2019-12-16T14:51:52Z

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

PR title type(scope): text
- type: fix, feat, refactor go into CHANGELOG, chore is hidden
- scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
- text: use all lower-case, do not end with a period, do not include issue refs
PR Description
- Rationale: describe rationale of change and approach taken
- Issues: indicate issues fixed via: fixes #xxx or closes #xxx
- Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
Testing
- Unit test added. Prefer to add a new test rather than modify existing tests
- CLI or init templates change? Re-run/add CLI integration tests
Documentation
- README: update module README to describe new features
- API docs: public APIs must be documented. Copy from official AWS docs when possible
- Design: for significant features, follow design process

mergify · 2019-12-16T15:16:59Z

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

PR title type(scope): text
- type: fix, feat, refactor go into CHANGELOG, chore is hidden
- scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
- text: use all lower-case, do not end with a period, do not include issue refs
PR Description
- Rationale: describe rationale of change and approach taken
- Issues: indicate issues fixed via: fixes #xxx or closes #xxx
- Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
Testing
- Unit test added. Prefer to add a new test rather than modify existing tests
- CLI or init templates change? Re-run/add CLI integration tests
Documentation
- README: update module README to describe new features
- API docs: public APIs must be documented. Copy from official AWS docs when possible
- Design: for significant features, follow design process

aws-cdk-automation · 2019-12-17T08:08:11Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2019-12-22T20:56:57Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

eladb

Looks good. A couple of minor changes.

packages/@aws-cdk/aws-eks/lib/helm-chart.ts

Pull request has been modified.

aws-cdk-automation · 2019-12-23T13:10:49Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

eladb

Can you please add a README entry?

aws-cdk-automation · 2019-12-23T14:06:04Z

AWS CodeBuild CI Report

Result: FAILED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Pull request has been modified.

aws-cdk-automation · 2019-12-23T14:50:27Z

AWS CodeBuild CI Report

Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

aws-cdk-automation · 2019-12-23T15:09:45Z

AWS CodeBuild CI Report

Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

eladb

Nice! Thanks so much for this great contribution. I know many people would love this!

aws-cdk-automation · 2019-12-23T16:01:58Z

AWS CodeBuild CI Report

Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2019-12-23T16:02:19Z

Thank you for contributing! Your pull request is now being automatically merged.

aws-cdk-automation · 2019-12-23T16:53:56Z

AWS CodeBuild CI Report

Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2019-12-23T16:54:20Z

Thank you for contributing! Your pull request is now being automatically merged.

pahud · 2019-12-24T00:16:20Z

@vlesierse Thanks for the awesome work!

@default

* Added HelmRelease construct * feat(eks): Add HelmRelease construct * Fix some linting problems * Remove trailing whitespace * Add the possibility to specify the chart version * Changes after code review * Add shell=True to command execution * Execute helm command in /tmp * Write a correct values.yaml * Add resources to integration tests * Change require to import * Lazy add HelmChartHandler * Add integration tests for Helm * Added convenience addChart to Cluster * Fix integration test. * Change addChart method to use options pattern * Added @default and truncate default chart name * Added the Helm entry to the README.md Co-authored-by: Elad Ben-Israel <benisrae@amazon.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

itajaja · 2020-01-13T14:52:44Z

Hi, I just updated to cdk@1.20 and I see a very big diff, mostly role changes, is it due to this change? I see some helm-related assets, even if I am not doing anything with helm. is there a way to opt out? is this going to deploy helm?

here's an example of asset in the cdk.out folder:

eladb · 2020-01-13T15:15:36Z

Please see #5544 for details

itajaja · 2020-01-13T15:16:53Z

perfect, thanks!

itajaja · 2020-01-13T15:20:03Z

@eladb still, I will see helm assets, even though I am not using helm. is that expected?

eladb · 2020-01-13T15:40:57Z

Yes, the kubectl custom resource provider serves both helm and kubectl. Feel free to ignore.

itajaja · 2020-01-13T15:49:09Z

thanks for the clarification 🙏

vlesierse added 3 commits December 12, 2019 10:50

Added HelmRelease construct

c94a6cc

feat(eks): Add HelmRelease construct

8409275

Merge branch 'eks-helm' of github.com:vlesierse/aws-cdk into eks-helm

aeb1ed1

Fix some linting problems

b3c0674

Remove trailing whitespace

3a3b6b9

Add the possibility to specify the chart version

6c60136

SomayaB assigned eladb Dec 13, 2019

eladb reviewed Dec 15, 2019

View reviewed changes

Changes after code review

43fd60b

Add shell=True to command execution

b449bf0

vlesierse changed the title ~~feat(eks): Add HelmRelease construct~~ feat(eks): Add HelmChart construct Dec 16, 2019

eladb changed the title ~~feat(eks): Add HelmChart construct~~ feat(eks): helm chart support Dec 16, 2019

Execute helm command in /tmp

cf5e7b7

Write a correct values.yaml

0111ea7

eladb previously approved these changes Dec 23, 2019

View reviewed changes

packages/@aws-cdk/aws-eks/lib/helm-chart.ts Show resolved Hide resolved

packages/@aws-cdk/aws-eks/lib/helm-chart.ts Outdated Show resolved Hide resolved

Added @default and truncate default chart name

679b1cb

Merge branch 'master' into eks-helm

484e197

eladb approved these changes Dec 23, 2019

View reviewed changes

eladb previously requested changes Dec 23, 2019

View reviewed changes

Merge branch 'master' into eks-helm

58d863b

Added the Helm entry to the README.md

7880041

Merge branch 'master' into eks-helm

5712c1d

eladb approved these changes Dec 23, 2019

View reviewed changes

Merge branch 'master' into eks-helm

deee84e

mergify bot merged commit 394313e into aws:master Dec 23, 2019

feat(eks): helm chart support #5390

feat(eks): helm chart support #5390

Conversation

vlesierse commented Dec 12, 2019 • edited Loading

mergify bot commented Dec 12, 2019

aws-cdk-automation commented Dec 12, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Dec 12, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Dec 12, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Dec 12, 2019

AWS CodeBuild CI Report

pahud commented Dec 12, 2019

vlesierse commented Dec 13, 2019

eladb left a comment

Choose a reason for hiding this comment

aws-cdk-automation commented Dec 16, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Dec 16, 2019

AWS CodeBuild CI Report

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

mergify bot commented Dec 16, 2019

aws-cdk-automation commented Dec 17, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Dec 22, 2019

AWS CodeBuild CI Report

eladb left a comment

Choose a reason for hiding this comment

aws-cdk-automation commented Dec 23, 2019

AWS CodeBuild CI Report

eladb left a comment

Choose a reason for hiding this comment

aws-cdk-automation commented Dec 23, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Dec 23, 2019

AWS CodeBuild CI Report

aws-cdk-automation commented Dec 23, 2019

AWS CodeBuild CI Report

eladb left a comment

Choose a reason for hiding this comment

aws-cdk-automation commented Dec 23, 2019

AWS CodeBuild CI Report

mergify bot commented Dec 23, 2019

aws-cdk-automation commented Dec 23, 2019

AWS CodeBuild CI Report

mergify bot commented Dec 23, 2019

pahud commented Dec 24, 2019

itajaja commented Jan 13, 2020

eladb commented Jan 13, 2020

itajaja commented Jan 13, 2020

itajaja commented Jan 13, 2020

eladb commented Jan 13, 2020

itajaja commented Jan 13, 2020

vlesierse commented Dec 12, 2019 •

edited

Loading