ugwis / diagram-as-code

Diagram-as-code for AWS architecture.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Diagram-as-code

This command line interface (CLI) tool enables drawing infrastructure diagrams for Amazon Web Services through YAML code. It facilitates diagram-as-code without relying on image libraries.

The CLI tool promotes code reuse, testing, integration, and automating the diagramming process. It allows managing diagrams with Git by writing human-readable YAML.

Example diagram

(generated from example of NAT Gateway)

Features

  • Compliant with AWS architecture guidelines
    Easily generate diagrams that follow AWS diagram guidelines.
  • Flexible
    Automatically adjust the position and size of groups.
  • Lightweight & CI/CD-friendly
    Start quickly on a container; no dependency on headless browser or GUI.
  • Integrate with your Infrastructure as Code
    Generate diagrams to align with your IaC code without managing diagrams manually.
  • As a drawing library
    Use as Golang Library and integrate with other IaC tools, AI, or drawing GUI tools.
  • Extensible
    Add definition files to create non-AWS diagrams as well.

Getting started

for macOS user

In preparing.

for Gopher

# go install github.com/awslabs/diagram-as-code/cmd/awsdac@latest

Resource types

See doc/resource-types.md.

Resource Link

See doc/links.md.

Example usage

See examples templates.

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.

About

Diagram-as-code for AWS architecture.

License:Apache License 2.0


Languages

Language:Go 80.8%Language:Shell 19.2%