cdk-lambda-bash
Deploy Bash Lambda Functions with AWS CDK
Why
AWS Lambda has the docker container image support since AWS re:Invent 2020 which allows you to run your Lambda code in a custom container image. Inspired by nikovirtala/cdk-eks-experiment, cdk-lambda-bash allows you to specify a local shell script and bundle it up as a custom resource in your cdk stack. On cdk deployment, your shell script will be executed in a Lambda container environment.
BashExecFunction
At this moment, we are offering BashExecFunction construct class which is a high-level abstraction of lambda.Function. By defining the script property which poins to your local shell script, on cdk deploy, this script will be bundled into a custom docker image and published as a lambda.DockerImageFunction.
If you fn.run(), a custom resource will be created and the lambda.DockerImageFunction will be executed on deployment.
Install
Use the npm dist tag to opt in CDKv1 or CDKv2:
// for CDKv2
npm install cdk-lambda-bash
or
npm install cdk-lambda-bash@latest
// for CDKv1
npm install cdk-lambda-bash@cdkv1
Sample
const app = new cdk.App();
const stack = new cdk.Stack(app, 'my-stack');
// bundle your Lambda function to execute the local demo.sh in container
const fn = new BashExecFunction(stack, 'Demo', {
script: path.join(__dirname, '../demo.sh'),
})
// run it as custom resource on deployment
fn.run();
Re-execution on assets update
By default, if you update your shell script or Dockerfile and re-deploy your CDK application, the BashExecFunction
will not be re-executed. Use runOnUpdate to enable the re-execution on update.
fn.run({ runOnUpdate: true });
Custom Dockerfile
In some cases, you may customize your own Dockerfile, for instances:
- You need extra tools or utilities such as
kubectlorhelm - You need build from your own base image
In these cases, create a custom Dockerfile as below and add extra utilities i.e. kubectl:
click and view custom Dockerfile sample
FROM public.ecr.aws/lambda/provided:al2
RUN yum install -y unzip jq
# install aws-cli v2
RUN curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip" && \
unzip awscliv2.zip && \
./aws/install
# install kubectl
RUN curl -o kubectl https://amazon-eks.s3.us-west-2.amazonaws.com/1.19.6/2021-01-05/bin/linux/amd64/kubectl && \
chmod +x kubectl && \
mv kubectl /usr/local/bin/kubectl
COPY bootstrap /var/runtime/bootstrap
COPY function.sh /var/task/function.sh
COPY main.sh /var/task/main.sh
RUN chmod +x /var/runtime/bootstrap /var/task/function.sh /var/task/main.sh
WORKDIR /var/task
CMD [ "function.sh.handler" ]
Specify your own Dockerfile with the dockerfile property.
new BashExecFunction(stack, 'Demo', {
script: path.join(__dirname, '../demo.sh'),
dockerfile: path.join(__dirname, '../Dockerfile'),
});
Conditional Execution
In the user script(e.g. demo.sh), you are allowed to determine the event type and act accordingly.
For example
const installArgoCD = new BashExecFunction(...)
installArgoCD.run({runOnUpdate: true});
When you run this sample, demo.sh will receive onCreate event and you can run your custom logic to "install ArgoCD" like kubectl apply -f URL. However, if you comment it off and deploy again:
const installArgoCD = new BashExecFunction(...)
//installArgoCD.run({runOnUpdate: true});
Under the hood, demo.sh will receive onDelete event and you can run your custom logic to "uninstall ArgoCD"
like kubectl delete -f URL.
Check the full sample code below:
Click and view the sample code
#!/bin/bash
# implement your business logic below
function onCreate() {
echo "running kubectl apply -f ..."
}
function onUpdate() {
echo "do nothing on update"
}
function onDelete() {
echo "running kubectl delete -f ..."
}
function getRequestType() {
echo $1 | jq -r .RequestType
}
function conditionalExec() {
requestType=$(getRequestType $EVENT_DATA)
# determine the original request type
case $requestType in
'Create') onCreate $1 ;;
'Update') onUpdate $1 ;;
'Delete') onDelete $1 ;;
esac
}
echo "Hello cdk lambda bash!!"
conditionalExec
exit 0
In Action
See this tweet
1 maintainer
Metadata
1 maintainer
Release files for cdk-lambda-bash 2.0.327
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| cdk-lambda-bash-2.0.327.tar.gz | 40.7 kB | Without provenance | Details for cdk-lambda-bash-2.0.327.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| cdk_lambda_bash-2.0.327-py3-none-any.whl | Python 3 | none | any | Details for cdk_lambda_bash-2.0.327-py3-none-any.whl |
Total release size: 80.1 kB
Release files / cdk-lambda-bash-2.0.327.tar.gz
| Download URL | cdk-lambda-bash-2.0.327.tar.gz |
|---|---|
| Size | 40.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c3f9033f81a689c52a23f9f78596d715505d96913919e3f423618bbcf46730a6
|
|
BLAKE2b-256 checksum How to use checksums |
f9922f3c4666851d49c9d9a3c48bf117b4dc172b78fb485d615aa343b852eda2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Release files / cdk_lambda_bash-2.0.327-py3-none-any.whl
| Download URL | cdk_lambda_bash-2.0.327-py3-none-any.whl |
|---|---|
| Size | 39.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
099e33062dff10f48eb9e5b23d4a0c297580ccfe6274628daf314e15c1d6141c
|
|
BLAKE2b-256 checksum How to use checksums |
9cff2cce8f3be0f19d838e16a320ef70091a2b6903d3651cf79f4ec63a18e2ec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Security for cdk-lambda-bash 2.0.327
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
