Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the description about yaml option #79

Merged
merged 1 commit into from
May 12, 2024
Merged

Add the description about yaml option #79

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Flags:
-h, --help help for awsdac
-o, --output string Output file name (default "output.png")
-v, --verbose Enable verbose logging
--yaml [beta] Generate YAML file from CloudFormation template
```

### Example
Expand Down Expand Up @@ -56,9 +57,22 @@ $ awsdac examples/vpc-subnet-ec2-cfn.yaml --cfn-template
<img src="examples/vpc-subnet-ec2-cfn.png" width="500">

There are some patterns where the tool may not work as expected. You can find a list of known issues and their status on the [issue tracker](https://github.com/awslabs/diagram-as-code/labels/cfn-template%20feature).

Your feedback and issue reports are appreciated, as they will help enhance the tool's performance and accuracy.

#### Use "--yaml" option

```
$ awsdac examples/vpc-subnet-ec2-cfn.yaml --cfn-template --yaml
```
CloudFormation templates have various dependencies, and there is no simple parent-child relationship between resources. As a result, generating the desired diagram directly from the existing CloudFormation template formats can be challenging at this stage.
We considered utilizing Metadata or comments within the CloudFormation templates to include additional information. However, this approach would make the templates excessively long, and CloudFormation templates are primarily intended for resource creation and management rather than diagram generation. Additionally, combining different lifecycle components into a single CloudFormation template could make it difficult to manage and maintain.

Therefore, instead of directly generating diagrams from CloudFormation templates, you can create a separate YAML file from CloudFormation template and customize this YAML file.
This customized YAML file can then be used as input for `awsdac` to generate the desired architecture diagrams. By decoupling the diagram generation process from the CloudFormation template structure, this approach offers greater flexibility and customization while leveraging the specialized strengths of `awsdac`.
```
CloudFormation template --[awsdac]--> yaml template --[user custom]--> your desired diagram :)
```

## Features
- **Compliant with AWS architecture guidelines**
Easily generate diagrams that follow [AWS diagram guidelines](https://aws.amazon.com/architecture/icons).
Expand Down
Loading