Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/biomapas/b.awscdkparallel
Enables parallel stack deployments for AWS CDK tool.
https://github.com/biomapas/b.awscdkparallel
aws aws-cdk aws-cdk-python cloudformation python3
Last synced: about 24 hours ago
JSON representation
Enables parallel stack deployments for AWS CDK tool.
- Host: GitHub
- URL: https://github.com/biomapas/b.awscdkparallel
- Owner: Biomapas
- License: apache-2.0
- Created: 2021-03-27T19:12:28.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-12-02T11:54:43.000Z (almost 2 years ago)
- Last Synced: 2024-10-05T06:59:09.917Z (about 1 month ago)
- Topics: aws, aws-cdk, aws-cdk-python, cloudformation, python3
- Language: Python
- Homepage:
- Size: 80.1 KB
- Stars: 15
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
Awesome Lists containing this project
README
# B.AwsCdkParallel
A python based package that enables AWS CDK parallel stack deployments.
### Description
One of the biggest downsides of AWS CDK IaC tool is the sequential deployments.
If you have many stacks within your project - it can take hours and hours till
everything gets deployed. Wouldn't it be cool to parallelize them? According to
AWS CDK tool maintainers - they are not even thinking right now to include such
functionality. Hence, this project was built. This project allows you to run
traditional `cdk deploy *` and `cdk destroy * -f`. But the main trick is that it
can do it in parallel - massively increasing the speed of your deployments.
### Remarks
[Biomapas](https://biomapas.com) aims to modernise life-science
industry by sharing its IT knowledge with other companies and
the community. This is an open source library intended to be used
by anyone. Improvements and pull requests are welcome.
Some techniques and inspirations were taken from this blog post:
https://taimos.de/blog/deploying-your-cdk-app-to-different-stages-and-environments
General issue is being discussed on github:
https://github.com/aws/aws-cdk/issues/1973
### Related technology
- Python 3
- AWS CDK
- AWS CloudFormation
### Assumptions
The project assumes the following:
- You have basic-good knowledge in python programming.
- You have basic-good knowledge in AWS.
- You have very good knowledge in AWS CDK.
### Useful sources
- Read more AWS CDK:
https://github.com/aws/aws-cdk
- Read more about parallel AWS CDK deployments:
https://taimos.de/blog/deploying-your-cdk-app-to-different-stages-and-environments
### Install
The project is built and uploaded to PyPi. Install it by using pip.
```
pip install b_aws_cdk_parallel
```
Or directly install it through source.
```
pip install .
```
### Usage & Examples
#### Programmatic usage
The quickest and easiest example:
```python
from b_aws_cdk_parallel.deployment_executor import DeploymentExecutor
from b_aws_cdk_parallel.deployment_type import DeploymentType
executor = DeploymentExecutor(type=DeploymentType.DEPLOY)
executor.run()
executor = DeploymentExecutor(type=DeploymentType.DESTROY)
executor.run()
```
The more advanced example to deploy/destroy:
```python
from b_aws_cdk_parallel.deployment_executor import DeploymentExecutor
from b_aws_cdk_parallel.deployment_type import DeploymentType
from b_aws_cdk_parallel.cdk_arguments import CdkArguments
executor = DeploymentExecutor(
type=DeploymentType.DEPLOY, # Or DESTROY
# You can specify a full path to your CDK app.
path='/optional/path/to/cdk/app',
# You can specify OS-level global parameters.
env={
'optional': 'os-level environment variables'
},
# You can specify AWS-CDK-specific arguments.
cdk_arguments=CdkArguments(
aws_cdk_app_stacks_to_deploy=['MyCoolStack'],
aws_cdk_app_parameters=['Test1=Test1'],
aws_cdk_app_context=['Context1=Context1']
)
)
executor.run()
```
The library generates beautiful stack dependency outputs for easier debugging:
```
----- Stack dependency graph: -----
» Stack1: []
× Stack2: [Stack1]
× Stack3: [Stack1]
× Stack4: [Stack1, Stack2, Stack3]
× Stack5: [Stack1, Stack4]
» Stack8: []
× Stack7: [Stack1, Stack2, Stack3, Stack4, Stack5]
× Stack6: [Stack1, Stack7]
× Stack10: [Stack1, Stack6, Stack7]
× Stack9: [Stack1, Stack8]
» B-Aws-Cdk-Parallel-MainStack-3: []
[Stack2] Doing stuff...
[Stack2] Doing stuff...
[Stack4] Doing stuff...
[Stack3] Doing stuff...
```
#### CLI usage
The library also exposes CLI access.
To get usage help, simply run:
```
acdk -h
```
To deploy infrastructure, run:
```
acdk deploy --path /project/app/
```
To destroy infrastructure, run:
```
acdk destroy --path /project/app/
```
### Testing
This project has integration tests based on pytest. To run tests, simply run:
```
pytest b_aws_cdk_parallel_test/integration/tests
```
### Contribution
Found a bug? Want to add or suggest a new feature?
Contributions of any kind are gladly welcome. You may contact us
directly, create a pull-request or an issue in github platform.
Lets modernize the world together.