search

aws / aws-cdk

The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code
https://aws.amazon.com/cdk
Apache License 2.0
11.66k stars 3.92k forks source link

cdk draw: create a visual diagram of a CDK stack #301

Closed eladb closed 5 years ago

eladb commented 6 years ago

Just an idea -- Consider https://cloudcraft.co/

buffovich commented 6 years ago

+1 It's very important to produce high-quality documentation or even dashboards. Besides that it's a lot of fun to have it.

buffovich commented 6 years ago

BTW, do we have a CC-licensed (or close to it) library of SVG icons for AWS services?

PaulMaddox commented 6 years ago

SVG icons available here: https://aws.amazon.com/architecture/icons/

No mention of licensing so would require confirmation from IP if they are going to be added to a Apache2/MIT licensed repository.

webratz commented 6 years ago

Built something similar a while ago for troposphere based templates using graphviz. Not as fancy as cloudcraft but it still gives an good overview of what happens. If you add a grouping by constructs etc it would even be better structured and be easier to understand: https://github.com/glomex/gcdt-kumo/blob/develop/gcdt_kumo/kumo_viz.py

eladb commented 6 years ago

@webratz yes! that's the direction. And obvsiouly we want to also model the construct tree... Would love a contribution if you are inclined 😉. Might require some low-level changes, so ping us if you need some guidance.

webratz commented 6 years ago

we are currently only have some time to evaluate cdk. If we are going to make more use of it I'll probably also have time to look into that, but don't expect any PRs within the next few weeks

hervenivon commented 5 years ago

Having such a capability would be awesome to speed up (or simply enable 😊) documentation process in startups.

PatMyron commented 4 years ago

@miparnisari wrote CloudFormation-level resource dependency graphing if anyone wants to build on that: https://github.com/aws/aws-cdk/issues/6956 https://github.com/aws-cloudformation/cfn-python-lint/pull/1411 https://github.com/aws-cloudformation/aws-cfn-lint-visual-studio-code/pull/106 https://marketplace.visualstudio.com/items?itemName=kddejong.vscode-cfn-lint

another project mapping resource type names to icons: https://github.com/ljacobsson/cfn-diagram/blob/master/resources/IconMap.js

pistazie commented 3 years ago

I've been tinkering with this idea and have a working POC.

please check it out at https://github.com/pistazie/cdk-dia.

obonyojimmy commented 3 years ago

I agree too , we need this ...

nicfix commented 3 years ago

What about integrating this library? https://diagrams.mingrammer.com/

evgenyka commented 1 year ago

https://github.com/megaproaktiv/cdk2d2