cdk-dia 0.7.0 → 0.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -17,53 +17,53 @@ This Diagram was automatically generated from an AWS CDK stack
|
|
|
17
17
|
## Getting started - Typescript / Javascript
|
|
18
18
|
Add cdk-dia to your CDK project
|
|
19
19
|
```sh
|
|
20
|
-
|
|
20
|
+
npm install cdk-dia
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
Install Graphviz
|
|
24
24
|
```sh
|
|
25
|
-
|
|
25
|
+
brew install graphviz
|
|
26
26
|
```
|
|
27
27
|
* If you don't use brew: Graphviz installation in many environments is [well documented](https://graphviz.org/download/).
|
|
28
28
|
* make sure Graphviz's dot binary is available in your PATH.
|
|
29
29
|
|
|
30
30
|
Synthesize your CDK application
|
|
31
31
|
```sh
|
|
32
|
-
|
|
32
|
+
cdk synth
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
Generate a CDK-DIA diagram PNG
|
|
36
36
|
```sh
|
|
37
|
-
|
|
37
|
+
npx cdk-dia
|
|
38
38
|
```
|
|
39
39
|
|
|
40
40
|
Generate a CDK-DIA diagram as an interactive HTML (experimental)
|
|
41
41
|
```sh
|
|
42
|
-
|
|
42
|
+
npx cdk-dia --rendering cytoscape-html
|
|
43
43
|
```
|
|
44
44
|
<br/>
|
|
45
45
|
|
|
46
46
|
## Getting started - any other CDK language
|
|
47
47
|
Globally install cdk-dia
|
|
48
48
|
```sh
|
|
49
|
-
|
|
49
|
+
npm install cdk-dia -g
|
|
50
50
|
```
|
|
51
51
|
|
|
52
52
|
Install Graphviz
|
|
53
53
|
```sh
|
|
54
|
-
|
|
54
|
+
brew install graphviz
|
|
55
55
|
```
|
|
56
56
|
* If you don't use brew: Graphviz installation in many environments is [well documented](https://graphviz.org/download/).
|
|
57
57
|
* make sure Graphviz's dot binary is available in your PATH.
|
|
58
58
|
|
|
59
59
|
Synthesize your CDK application
|
|
60
60
|
```sh
|
|
61
|
-
|
|
61
|
+
cdk synth
|
|
62
62
|
```
|
|
63
63
|
|
|
64
64
|
Generate a CDK-DIA diagram
|
|
65
65
|
```sh
|
|
66
|
-
|
|
66
|
+
cdk-dia
|
|
67
67
|
```
|
|
68
68
|
<br/>
|
|
69
69
|
|
|
@@ -101,4 +101,4 @@ This results in a Diagram where the DB-Tier was not collapsed providing more det
|
|
|
101
101
|
* ```npx cdk-dia --stacks pipelinestack/prod/database``` - choose stacks by path (nested stacks, pipeline stacks)
|
|
102
102
|
|
|
103
103
|
## 🙏🏽 Contributing
|
|
104
|
-
Contribution is covered in the [CONTRIBUTING.md](./CONTRIBUTING.md) markdown.
|
|
104
|
+
Contribution is covered in the [CONTRIBUTING.md](./CONTRIBUTING.md) markdown.
|
|
@@ -94,6 +94,8 @@
|
|
|
94
94
|
"M5N": "icons/aws/Resource/Res_Compute/Res_48_Dark/Res_Amazon-EC2_M5n-Instance_48_Dark.png",
|
|
95
95
|
"M6G": "icons/aws/Resource/Res_Compute/Res_48_Dark/Res_Amazon-EC2_M6g-Instance_48_Dark.png",
|
|
96
96
|
"MAC": "icons/aws/Resource/Res_Compute/Res_48_Dark/Res_Amazon-EC2_Mac-Instance_48_Dark.png",
|
|
97
|
+
"MAC1": "icons/aws/Resource/Res_Compute/Res_48_Dark/Res_Amazon-EC2_Mac-Instance_48_Dark.png",
|
|
98
|
+
"MAC2": "icons/aws/Resource/Res_Compute/Res_48_Dark/Res_Amazon-EC2_Mac-Instance_48_Dark.png",
|
|
97
99
|
"P2": "icons/aws/Resource/Res_Compute/Res_48_Dark/Res_Amazon-EC2_P2-Instance_48_Dark.png",
|
|
98
100
|
"P3": "icons/aws/Resource/Res_Compute/Res_48_Dark/Res_Amazon-EC2_P3-Instance_48_Dark.png",
|
|
99
101
|
"P3DN": "icons/aws/Resource/Res_Compute/Res_48_Dark/Res_Amazon-EC2_P3dn-Instance_48_Dark.png",
|