معرفی شرکت ها
aws-prototyping-sdk.cdk-graph-plugin-diagram-0.12.26
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
@aws-prototyping-sdk/cdk-graph-plugin-diagram
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | aws-prototyping-sdk.cdk-graph-plugin-diagram-0.12.26 |
| نام | aws-prototyping-sdk.cdk-graph-plugin-diagram |
| نسخه کتابخانه | 0.12.26 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | AWS APJ COPE<apj-cope@amazon.com> |
| ایمیل نویسنده | - |
| آدرس صفحه اصلی | https://github.com/aws/aws-prototyping-sdk |
| آدرس اینترنتی | https://pypi.org/project/aws-prototyping-sdk.cdk-graph-plugin-diagram/ |
| مجوز | Apache-2.0 |
## Diagram Plugin - Cdk Graph
`@aws-prototyping-skd/cdk-graph-plugin-diagram`
 \
[](https://aws.github.io/aws-prototyping-sdk/typescript/cdk-graph-plugin-diagram/index.html)
[](https://github.com/aws/aws-prototyping-sdk/tree/mainline/packages/cdk-graph-plugin-diagram)
This plugin generates diagrams utilizing the [cdk-graph](https://aws.github.io/aws-prototyping-sdk/typescript/cdk-graph/index.html) framework.
> More comprehensive documentation to come as this package stabilizes.
> **Disclaimer:** This is the first **cdk graph** plugin, it is highly *experimental*, and subject to major refactors as we gain feedback from the community.
| | |
| --- | --- |
| <img src="docs/examples/default.png" width="300" /> | <img src="docs/examples/dark.png" width="300" /> |
### Quick Start
```python
// bin/app.ts
// Must wrap cdk app with async IIFE function to enable async cdk-graph report
(async () => {
const app = new App();
// ... add stacks, etc
const graph = new CdkGraph(app, {
plugins: [new CdkGraphDiagramPlugin()],
});
app.synth();
// async cdk-graph reporting hook
await graph.report();
})
// => cdk.out/diagram.dot
// => cdk.out/diagram.svg
// => cdk.out/diagram.png
```
> This plugin currently only supports `async report()` generation following the above example. **Make sure to wrap the cdk app with *async IIFE*.**
### Supported Formats
| Format | Status | Extends | Provider |
| --- | --- | --- | --- |
| [DOT](https://graphviz.org/docs/outputs/canon/) |  | - | [Graphviz](docs/graphviz/README.md)
| [SVG](https://graphviz.org/docs/outputs/svg/) |  | [DOT](https://graphviz.org/docs/outputs/canon/) | [Graphviz](docs/graphviz/README.md)
| [PNG](https://graphviz.org/docs/outputs/png/) |  | [SVG](https://graphviz.org/docs/outputs/canon/) | [Graphviz](docs/graphviz/README.md)
---
### Diagram Providers
| Provider | Status | Formats |
| --- | --- | --- |
| [Graphviz](docs/graphviz/README.md) |  | [DOT](https://graphviz.org/docs/outputs/canon/), [SVG](https://graphviz.org/docs/outputs/svg/), [PNG](https://graphviz.org/docs/outputs/png/) |
| [Drawio](docs/drawio/README.md) |  | *TBD: very early stage design and development* |
---
### Configuration
See [API Documentation](https://aws.github.io/aws-prototyping-sdk/typescript/cdk-graph-plugin-diagram/index.html) for details, and look in [unit tests](https://github.com/aws/aws-prototyping-sdk/tree/mainline/packages/cdk-graph-plugin-diagram/test/graphviz) for more examples.
#### Example Configurations (expand below)
##### **Presets**
<details>
<summary>Preset: compact</summary>
[<img src="docs/examples/compact.png" height="200" />](docs/examples/compact.png)
```python
{
name: "compact",
title: "Compact Diagram",
filterPlan: {
preset: FilterPreset.COMPACT,
},
},
```
</details><details>
<summary>Preset: verbose</summary>
[<img src="docs/examples/verbose.png" height="200" />](docs/examples/verbose.png)
```python
{
name: "verbose",
title: "Verbose Diagram",
format: DiagramFormat.PNG,
ignoreDefaults: true,
},
```
</details>
##### **Focus**
<details>
<summary>Focus: hoist</summary>
[<img src="docs/examples/focus.png" height="200" />](docs/examples/focus.png)
```python
{
name: "focus",
title: "Focus Lambda Diagram (non-extraneous)",
filterPlan: {
focus: (store) =>
store.getNode(getConstructUUID(app.stack.lambda)),
preset: FilterPreset.NON_EXTRANEOUS,
},
ignoreDefaults: true,
},
```
</details><details>
<summary>Focus: no hoist</summary>
[<img src="docs/examples/focus-nohoist.png" height="200" />](docs/examples/focus-nohoist.png)
```python
{
name: "focus-nohoist",
title: "Focus WebServer Diagram (noHoist, verbose)",
filterPlan: {
focus: {
node: (store) =>
store.getNode(getConstructUUID(app.stack.webServer)),
noHoist: true,
},
},
ignoreDefaults: true,
},
```
</details>
##### **Filters**
<details>
<summary>Filter: Include specific cfn resource types</summary>
[<img src="docs/examples/filter-cfntype-include.png" height="200" />](docs/examples/filter-cfntype-include.png)
```python
{
name: "includeCfnType",
title: "Include CfnType Diagram (filter)",
filterPlan: {
filters: [
Filters.includeCfnType([
aws_arch.CfnSpec.ServiceResourceDictionary.EC2.Instance,
/AWS::Lambda::Function.*/,
"AWS::IAM::Role",
]),
Filters.compact(),
],
},
},
```
</details><details>
<summary>Filter: Exclude specific cfn resource types</summary>
[<img src="docs/examples/filter-cfntype-exclude.png" height="200" />](docs/examples/filter-cfntype-exclude.png)
```python
{
name: "excludeCfnType",
title: "Exclude CfnType Diagram (filter)",
filterPlan: {
filters: [
Filters.excludeCfnType([
/AWS::EC2::VPC.*/,
aws_arch.CfnSpec.ServiceResourceDictionary.IAM.Role,
]),
Filters.compact(),
],
},
},
```
</details><details>
<summary>Filter: Include specific graph node types</summary>
[<img src="docs/examples/filter-nodetype-include.png" height="200" />](docs/examples/filter-nodetype-include.png)
```python
{
name: "includeNodeType",
title: "Include NodeType Diagram (filter)",
filterPlan: {
filters: [
Filters.includeNodeType([
NodeTypeEnum.STACK,
NodeTypeEnum.RESOURCE,
]),
Filters.compact(),
],
},
},
```
</details><details>
<summary>Filter: Include specific graph node types</summary>
[<img src="docs/examples/filter-nodetype-include.png" height="200" />](docs/examples/filter-nodetype-include.png)
```python
{
name: "includeNodeType",
title: "Include NodeType Diagram (filter)",
filterPlan: {
filters: [
Filters.includeNodeType([
NodeTypeEnum.STACK,
NodeTypeEnum.RESOURCE,
]),
Filters.compact(),
],
},
},
```
</details><details>
<summary>Filter: Exclude specific graph node types</summary>
[<img src="docs/examples/filter-nodetype-exclude.png" height="200" />](docs/examples/filter-nodetype-exclude.png)
```python
{
name: "excludeNodeType",
title: "Exclude NodeType Diagram (filter)",
filterPlan: {
filters: [
Filters.excludeNodeType([
NodeTypeEnum.NESTED_STACK,
NodeTypeEnum.CFN_RESOURCE,
NodeTypeEnum.OUTPUT,
NodeTypeEnum.PARAMETER,
]),
Filters.compact(),
],
},
},
```
</details>
##### **Themes**
<details>
<summary>Theme: Dark</summary>
[<img src="docs/examples/dark.png" height="200" />](docs/examples/dark.png)
```python
{
name: "Dark",
title: "Dark Theme Diagram",
theme: theme,
},
```
</details><details>
<summary>Theme: Dark - render service icons</summary>
[<img src="docs/examples/dark-services.png" height="200" />](docs/examples/dark-services.png)
```python
{
name: "dark-services",
title: "Dark Theme Custom Diagram",
theme: {
theme: theme,
rendering: {
resourceIconMin: GraphThemeRenderingIconTarget.SERVICE,
resourceIconMax: GraphThemeRenderingIconTarget.CATEGORY,
cfnResourceIconMin: GraphThemeRenderingIconTarget.DATA,
cfnResourceIconMax: GraphThemeRenderingIconTarget.RESOURCE,
},
},
},
```
</details>
<details>
<summary>Theme: Dark - verbose</summary>
[<img src="docs/examples/dark-verbose.png" height="200" />](docs/examples/dark-verbose.png)
```python
{
name: "dark-verbose",
title: "Dark Theme Verbose Diagram",
ignoreDefaults: true,
theme: theme,
},
```
</details>---
### Next Steps
* [ ] Battle test in the wild and get community feedback
* [ ] Improve image coverage and non-image node rendering
* [ ] Add drawio support
* [ ] Add common filter patterns and helpers
* [ ] Enable generating diagrams outside of synthesis process (maybe CLI)
* [ ] Implement interactive diagram, with potential for dynamic filtering and config generation
* [ ] Support using interactive diagram as config generator for other plugins (or as separate plugin that depends on this)
---
Inspired by [cdk-dia](https://github.com/pistazie/cdk-dia) and [cfn-dia](https://github.com/mhlabs/cfn-diagram) with ❤️
نیازمندی
| مقدار | نام |
|---|---|
| <3.0.0,>=2.53.0 | aws-cdk-lib |
| <1.0.0 | aws-prototyping-sdk.aws-arch |
| <1.0.0 | aws-prototyping-sdk.cdk-graph |
| <11.0.0,>=10.1.162 | constructs |
| <2.0.0,>=1.71.0 | jsii |
| <0.66.0,>=0.65.26 | projen |
| >=0.0.3 | publication |
| ~=2.13.3 | typeguard |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| ~=3.7 | Python |
نحوه نصب
نصب پکیج whl aws-prototyping-sdk.cdk-graph-plugin-diagram-0.12.26:
pip install aws-prototyping-sdk.cdk-graph-plugin-diagram-0.12.26.whl
نصب پکیج tar.gz aws-prototyping-sdk.cdk-graph-plugin-diagram-0.12.26:
pip install aws-prototyping-sdk.cdk-graph-plugin-diagram-0.12.26.tar.gz