https://github.com/pistazie/cdk-dia
Automated diagrams of CDK provisioned infrastructure
https://github.com/pistazie/cdk-dia
Last synced: 4 months ago
JSON representation
Automated diagrams of CDK provisioned infrastructure
- Host: GitHub
- URL: https://github.com/pistazie/cdk-dia
- Owner: pistazie
- License: mit
- Created: 2021-02-06T19:36:16.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-04T17:57:35.000Z (7 months ago)
- Last Synced: 2024-10-02T07:40:05.285Z (5 months ago)
- Language: JavaScript
- Size: 13.3 MB
- Stars: 884
- Watchers: 9
- Forks: 38
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-cdk - CDK-Dia - Automatic infrastructure diagrams for AWS CDK. (Tools / Multi-accounts setup)
- awesome-cdk - CDK-Dia - Automatic infrastructure diagrams for AWS CDK. (Tools / Multi-accounts setup)
README
[](https://github.com/kolomied/awesome-cdk)
[](https://badge.fury.io/js/cdk-dia)
[](code_of_conduct.md)
# 🎡 CDK-Dia - Automated diagrams for CDK infrastructure
_Cdk-dia diagrams your CDK provisioned infrastructure using the Graphviz dot language._
## Example
This Diagram was automatically generated from an AWS CDK stack
## Getting started - Typescript / Javascript
Add cdk-dia to your CDK project
```sh
npm install cdk-dia
```
Install Graphviz
```sh
brew install graphviz
```
* If you don't use brew: Graphviz installation in many environments is [well documented](https://graphviz.org/download/).
* make sure Graphviz's dot binary is available in your PATH.
Synthesize your CDK application
```sh
cdk synth
```
Generate a CDK-DIA diagram PNG
```sh
npx cdk-dia
```
Generate a CDK-DIA diagram as an interactive HTML (experimental)
```sh
npx cdk-dia --rendering cytoscape-html
```
## Getting started - any other CDK language
Globally install cdk-dia
```sh
npm install cdk-dia -g
```
Install Graphviz
```sh
brew install graphviz
```
* If you don't use brew: Graphviz installation in many environments is [well documented](https://graphviz.org/download/).
* make sure Graphviz's dot binary is available in your PATH.
Synthesize your CDK application
```sh
cdk synth
```
Generate a CDK-DIA diagram
```sh
cdk-dia
```
## Customize diagrams
In some cases it is useful to be able to tweak a diagram. For this purpose CDK-DIA includes customizers/decorators
you can use with your CDK constructs in order to tweak the diagram.
### Limitations:
* Customization and decorators are currently only support for Typescript/Javascript CDK projects.
* In order to customize you have to add cdk-dia as a npm project dependency (globally installing it using `npm i -g` won't allow you to use the `CdkDiaDecorator` class)
### Example:
Consider the following diagram of a 3-Tier CDK Stack:
In this diagram CDK-DIA collapsed the DBTier (done automatically to any CDK Level 2 (L2) construct) in order to
create a diagram which contains the most important details.
One can use a decorator in order to customize the diagram and prevent CDK-DIA from collapsing the Construct.
This is done by implementing CDK's IInpectable's interface and using CDK-DIA's decorator. example:
This results in a Diagram where the DB-Tier was not collapsed providing more details:
* a full example or the above can be found at [examples/decoration-example](examples/decoration-example)
## CLI arguments
* ```npx cdk-dia --help``` - Get possible arguments
* ```npx cdk-dia --include stackOne stackFour``` - only diagram chosen aws-cdk stacks
* ```npx cdk-dia --include pipelinestack/prod/database``` - choose stacks by path (nested stacks, pipeline stacks)
* ```npx cdk-dia --exclude stackOne``` - exclude chosen aws-cdk stacks from the diagram
## 🙏🏽 Contributing
Contribution is covered in the [CONTRIBUTING.md](./CONTRIBUTING.md) markdown.