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.

Sign up for GitHub

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

Jump to bottom

refactor(eks): exposed chart, repository, version and chartAsset props for HelmChart construct #26852

Merged
merged 4 commits into from
Aug 23, 2023
Merged

refactor(eks): exposed chart, repository, version and chartAsset props for HelmChart construct #26852

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
44911ae
refactor(eks): exposed chart, repository, version chartAsset props fo…
davidcosc Aug 23, 2023
629db3b
refactor(eks): changed type definitions for exposed variables to conf…
davidcosc Aug 23, 2023
f9c0102
Merge branch 'aws:main' into issue-26678
davidcosc Aug 23, 2023
35e60ae
Merge branch 'main' into issue-26678
colifran Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions packages/aws-cdk-lib/aws-eks/lib/helm-chart.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,21 @@ export class HelmChart extends Construct {
* The CloudFormation resource type.
*/
public static readonly RESOURCE_TYPE = 'Custom::AWSCDK-EKS-HelmChart';
public readonly chart?: string;
public readonly repository?: string;
public readonly version?: string;
public readonly chartAsset?: Asset;

constructor(scope: Construct, id: string, props: HelmChartProps) {
super(scope, id);

// Exposing these properties is done for convenience
// For more details see issue #26678
this.chart = props.chart;
this.repository = props.repository;
this.version = props.version;
this.chartAsset = props.chartAsset;

const stack = Stack.of(this);

const provider = KubectlProvider.getOrCreate(this, props.cluster);
Expand All @@ -121,11 +132,11 @@ export class HelmChart extends Construct {
throw new Error('Helm chart timeout cannot be higher than 15 minutes.');
}

if (!props.chart && !props.chartAsset) {
if (!this.chart && !this.chartAsset) {
throw new Error("Either 'chart' or 'chartAsset' must be specified to install a helm chart");
}

if (props.chartAsset && (props.repository || props.version)) {
if (this.chartAsset && (this.repository || this.version)) {
throw new Error(
"Neither 'repository' nor 'version' can be used when configuring 'chartAsset'",
);
Expand All @@ -138,7 +149,7 @@ export class HelmChart extends Construct {
// default to not skip crd installation
const skipCrds = props.skipCrds ?? false;

props.chartAsset?.grantRead(provider.handlerRole);
this.chartAsset?.grantRead(provider.handlerRole);

new CustomResource(this, 'Resource', {
serviceToken: provider.serviceToken,
Expand All @@ -147,14 +158,14 @@ export class HelmChart extends Construct {
ClusterName: props.cluster.clusterName,
RoleArn: provider.roleArn, // TODO: bake into the provider's environment
Release: props.release ?? Names.uniqueId(this).slice(-53).toLowerCase(), // Helm has a 53 character limit for the name
Chart: props.chart,
ChartAssetURL: props.chartAsset?.s3ObjectUrl,
Version: props.version,
Chart: this.chart,
ChartAssetURL: this.chartAsset?.s3ObjectUrl,
Version: this.version,
Wait: wait || undefined, // props are stringified so we encode “false” as undefined
Timeout: timeout ? `${timeout.toString()}s` : undefined, // Helm v3 expects duration instead of integer
Values: (props.values ? stack.toJsonString(props.values) : undefined),
Namespace: props.namespace ?? 'default',
Repository: props.repository,
Repository: this.repository,
CreateNamespace: createNamespace || undefined,
SkipCrds: skipCrds || undefined,
},
Expand Down