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

feat(eks): timeout option helm charts #8338

Merged
merged 19 commits into from
Jun 11, 2020
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
3 changes: 2 additions & 1 deletion packages/@aws-cdk/aws-eks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,8 @@ cluster.addChart('NginxIngress', {
});
```

Helm charts will be installed and updated using `helm upgrade --install`.
Helm charts will be installed and updated using `helm upgrade --install`, where a few parameters
are being passed down (such as `repo`, `values`, `version`, `namespace`, `wait`, `timeout`, etc).
This means that if the chart is added to CDK with the same release name, it will try to update
the chart in the cluster. The chart will exists as CloudFormation resource.

Expand Down
11 changes: 9 additions & 2 deletions packages/@aws-cdk/aws-eks/lib/helm-chart.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Construct, CustomResource, Stack } from '@aws-cdk/core';
import { Construct, CustomResource, Duration, Stack } from '@aws-cdk/core';
import { Cluster } from './cluster';

/**
Expand Down Expand Up @@ -47,6 +47,12 @@ export interface HelmChartOptions {
* @default - Helm will not wait before marking release as successful
*/
readonly wait?: boolean;

/**
* Amount of time to wait for any individual Kubernetes operation. Maximum 15 minutes.
* @default Duration.minutes(5)
*/
readonly timeout?: Duration;
}

/**
Expand All @@ -68,7 +74,7 @@ export interface HelmChartProps extends HelmChartOptions {
*/
export class HelmChart extends Construct {
/**
* The CloudFormation reosurce type.
* The CloudFormation resource type.
*/
public static readonly RESOURCE_TYPE = 'Custom::AWSCDK-EKS-HelmChart';

Expand All @@ -89,6 +95,7 @@ export class HelmChart extends Construct {
Chart: props.chart,
Version: props.version,
Wait: props.wait || false,
Timeout: props.timeout && props.timeout.toSeconds(),
Values: (props.values ? stack.toJsonString(props.values) : undefined),
Namespace: props.namespace || 'default',
Repository: props.repository,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ def helm_handler(event, context):
chart = props['Chart']
version = props.get('Version', None)
wait = props.get('Wait', False)
timeout = props.get('Timeout', None)
namespace = props.get('Namespace', None)
repository = props.get('Repository', None)
values_text = props.get('Values', None)
Expand All @@ -45,14 +46,14 @@ def helm_handler(event, context):
f.write(json.dumps(values, indent=2))

if request_type == 'Create' or request_type == 'Update':
helm('upgrade', release, chart, repository, values_file, namespace, version)
helm('upgrade', release, chart, repository, values_file, namespace, version, wait, timeout)
elif request_type == "Delete":
try:
helm('uninstall', release, namespace=namespace)
helm('uninstall', release, namespace=namespace, timeout=timeout)
except Exception as e:
logger.info("delete error: %s" % e)

def helm(verb, release, chart = None, repo = None, file = None, namespace = None, version = None, wait = False):
def helm(verb, release, chart = None, repo = None, file = None, namespace = None, version = None, wait = False, timeout = None):
import subprocess

cmnd = ['helm', verb, release]
Expand All @@ -70,6 +71,8 @@ def helm(verb, release, chart = None, repo = None, file = None, namespace = None
cmnd.extend(['--namespace', namespace])
if wait:
cmnd.append('--wait')
if not timeout is None:
cmnd.extend(['--timeout', timeout])
cmnd.extend(['--kubeconfig', kubeconfig])

retry = 3
Expand Down
20 changes: 10 additions & 10 deletions packages/@aws-cdk/aws-eks/test/integ.eks-cluster.expected.json
Original file line number Diff line number Diff line change
Expand Up @@ -2388,10 +2388,10 @@
"Ref": "AssetParameters01ec3fa8451b6541733a25ec9c0c13a2b7dcee848ddad2edf6cb9c1f40cbc896S3VersionKeyA8C9A018"
},
"referencetoawscdkeksclustertestAssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3BucketC7CBF350Ref": {
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3Bucket663A709C"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3Bucket7E80133A"
},
"referencetoawscdkeksclustertestAssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3VersionKey7E2BE411Ref": {
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3VersionKeyF33697EB"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3VersionKeyBCCB362A"
}
}
}
Expand Down Expand Up @@ -2449,10 +2449,10 @@
"Ref": "AssetParametersa6d508eaaa0d3cddbb47a84123fc878809c8431c5466f360912f70b5b9770afbS3VersionKeyBED95764"
},
"referencetoawscdkeksclustertestAssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3BucketC7CBF350Ref": {
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3Bucket663A709C"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3Bucket7E80133A"
},
"referencetoawscdkeksclustertestAssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3VersionKey7E2BE411Ref": {
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3VersionKeyF33697EB"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3VersionKeyBCCB362A"
}
}
}
Expand Down Expand Up @@ -2719,17 +2719,17 @@
"Type": "String",
"Description": "Artifact hash for asset \"01ec3fa8451b6541733a25ec9c0c13a2b7dcee848ddad2edf6cb9c1f40cbc896\""
},
"AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3Bucket663A709C": {
"AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3Bucket7E80133A": {
"Type": "String",
"Description": "S3 bucket for asset \"5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1\""
"Description": "S3 bucket for asset \"1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7f\""
},
"AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3VersionKeyF33697EB": {
"AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3VersionKeyBCCB362A": {
"Type": "String",
"Description": "S3 key for asset version \"5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1\""
"Description": "S3 key for asset version \"1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7f\""
},
"AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1ArtifactHash251241BC": {
"AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fArtifactHash0C915965": {
"Type": "String",
"Description": "Artifact hash for asset \"5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1\""
"Description": "Artifact hash for asset \"1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7f\""
},
"AssetParametersa6d508eaaa0d3cddbb47a84123fc878809c8431c5466f360912f70b5b9770afbS3Bucket0C3A00C2": {
"Type": "String",
Expand Down
14 changes: 13 additions & 1 deletion packages/@aws-cdk/aws-eks/test/test.helm-chart.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { expect, haveResource } from '@aws-cdk/assert';
import { Duration } from '@aws-cdk/core';
import { Test } from 'nodeunit';
import * as eks from '../lib';
import { testFixtureCluster } from './util';
Expand Down Expand Up @@ -70,7 +71,18 @@ export = {
new eks.HelmChart(stack, 'MyWaitingChart', { cluster, chart: 'chart' });

// THEN
expect(stack).to(haveResource(eks.HelmChart.RESOURCE_TYPE, { Wait: false}));
expect(stack).to(haveResource(eks.HelmChart.RESOURCE_TYPE, { Wait: false }));
test.done();
},
'should timeout only after 10 minutes'(test: Test) {
// GIVEN
const { stack, cluster } = testFixtureCluster();

// WHEN
new eks.HelmChart(stack, 'MyChart', { cluster, chart: 'chart', timeout: Duration.minutes(10) });

// THEN
expect(stack).to(haveResource(eks.HelmChart.RESOURCE_TYPE, { Timeout: 600 }));
test.done();
},
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ export const WAITER_STATE_MACHINE_ARN_ENV = 'WAITER_STATE_MACHINE_ARN';
export const FRAMEWORK_ON_EVENT_HANDLER_NAME = 'onEvent';
export const FRAMEWORK_IS_COMPLETE_HANDLER_NAME = 'isComplete';
export const FRAMEWORK_ON_TIMEOUT_HANDLER_NAME = 'onTimeout';
export const FRAMEWORK_HANDLER_TIMEOUT = 900000; // 15 minutes
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// eslint-disable-next-line import/no-extraneous-dependencies
import * as AWS from 'aws-sdk';
import * as https from 'https';
import * as consts from './consts';

async function defaultHttpRequest(options: https.RequestOptions, responseBody: string) {
return new Promise((resolve, reject) => {
Expand All @@ -24,6 +25,8 @@ async function defaultStartExecution(req: AWS.StepFunctions.StartExecutionInput)
sfn = new AWS.StepFunctions();
}

sfn.config.update({httpOptions: { timeout: consts.FRAMEWORK_HANDLER_TIMEOUT }});

return await sfn.startExecution(req).promise();
}

Expand All @@ -32,6 +35,8 @@ async function defaultInvokeFunction(req: AWS.Lambda.InvocationRequest): Promise
lambda = new AWS.Lambda();
}

lambda.config.update({httpOptions: { timeout: consts.FRAMEWORK_HANDLER_TIMEOUT }});

return await lambda.invoke(req).promise();
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@
"Properties": {
"Code": {
"S3Bucket": {
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3Bucket663A709C"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3Bucket7E80133A"
},
"S3Key": {
"Fn::Join": [
Expand All @@ -213,7 +213,7 @@
"Fn::Split": [
"||",
{
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3VersionKeyF33697EB"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3VersionKeyBCCB362A"
}
]
}
Expand All @@ -226,7 +226,7 @@
"Fn::Split": [
"||",
{
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3VersionKeyF33697EB"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3VersionKeyBCCB362A"
}
]
}
Expand Down Expand Up @@ -579,7 +579,7 @@
"Properties": {
"Code": {
"S3Bucket": {
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3Bucket663A709C"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3Bucket7E80133A"
},
"S3Key": {
"Fn::Join": [
Expand All @@ -592,7 +592,7 @@
"Fn::Split": [
"||",
{
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3VersionKeyF33697EB"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3VersionKeyBCCB362A"
}
]
}
Expand All @@ -605,7 +605,7 @@
"Fn::Split": [
"||",
{
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3VersionKeyF33697EB"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3VersionKeyBCCB362A"
}
]
}
Expand Down Expand Up @@ -721,7 +721,7 @@
"Properties": {
"Code": {
"S3Bucket": {
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3Bucket663A709C"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3Bucket7E80133A"
},
"S3Key": {
"Fn::Join": [
Expand All @@ -734,7 +734,7 @@
"Fn::Split": [
"||",
{
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3VersionKeyF33697EB"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3VersionKeyBCCB362A"
}
]
}
Expand All @@ -747,7 +747,7 @@
"Fn::Split": [
"||",
{
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3VersionKeyF33697EB"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3VersionKeyBCCB362A"
}
]
}
Expand Down Expand Up @@ -860,7 +860,7 @@
"Properties": {
"Code": {
"S3Bucket": {
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3Bucket663A709C"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3Bucket7E80133A"
},
"S3Key": {
"Fn::Join": [
Expand All @@ -873,7 +873,7 @@
"Fn::Split": [
"||",
{
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3VersionKeyF33697EB"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3VersionKeyBCCB362A"
}
]
}
Expand All @@ -886,7 +886,7 @@
"Fn::Split": [
"||",
{
"Ref": "AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3VersionKeyF33697EB"
"Ref": "AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3VersionKeyBCCB362A"
}
]
}
Expand Down Expand Up @@ -1042,17 +1042,17 @@
"Type": "String",
"Description": "Artifact hash for asset \"f465f835a93a93413d7d25f5572670bbb6379304f4cdbad718d4f6a5562d1368\""
},
"AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3Bucket663A709C": {
"AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3Bucket7E80133A": {
"Type": "String",
"Description": "S3 bucket for asset \"5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1\""
"Description": "S3 bucket for asset \"1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7f\""
},
"AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1S3VersionKeyF33697EB": {
"AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fS3VersionKeyBCCB362A": {
"Type": "String",
"Description": "S3 key for asset version \"5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1\""
"Description": "S3 key for asset version \"1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7f\""
},
"AssetParameters5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1ArtifactHash251241BC": {
"AssetParameters1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7fArtifactHash0C915965": {
"Type": "String",
"Description": "Artifact hash for asset \"5e49cf64d8027f48872790f80cdb76c5b836ecf9a70b71be1eb937a5c25a47c1\""
"Description": "Artifact hash for asset \"1ccf508ea8b56094d6465086d71454827a1e79e9993d92e47c2b57aaa3cabe7f\""
},
"AssetParameters4bafad8d010ba693e235b77d2c6decfc2ac79a8208d4477cbb36d31caf7189e8S3Bucket0DB889DF": {
"Type": "String",
Expand Down