A commandline tool that generate High Level microservice & serverless Architecture diagrams using a declarative syntax defined in a YAML file.

• Works on linux, macOS, windows
• Just a single portable binary file
• Input data in flat YAML text files
• Usable with shell scripts

I prefer to think in terms of capabilities rather than specific vendor services.

• "do we need a DNS?" instead of "do we need Route 53?"
• "do we need a CDN?" instead of "do we need Cloudfront?"
• "do we need a database? if yes? what type? Relational? No SQL" instead of "do we need Google Cloud Datastore?"_
• "do we need some serverless function?" instead of "do we need an Azure Function"

...and so on.

draft takes in input a declarative YAML file and generates a dot script for Graphviz

draft backend-for-frontend.yml | dot -Tpng -Gdpi=200 > backend-for-frontend.png 

Piping the draft output to GraphViz dot you can generate different output formats:

To install GraphViz to your favorite OS, please, follow this link https://graphviz.gitlab.io/download/.

To build the binaries by yourself, assuming that you have Go installed, here the steps:

Clone the repo,

git clone https://github.com/lucasepe/draft.git

Move to the 'cmd' directory:

cd draft/cmd

Generate the static assets

go generate ../...

Build the binary tool

go build -o draft

The basic unit of each draft design is the component, has these attributes:

• you can define your component id explicitly (i.e. id: MY_SERVICE_A)
• or you can omit the component id attribute and it will be autogenerated

An auto-generated component id has a prefix and a sequential number

• the prefix is related to the component kind
  • examples waf1, ..., wafN or ser1, ..., serN etc.

Draft uses a set of symbols independent from the different providers (AWS, Microsoft Azure, GCP).

Below is a list of all the components currently implemented.

Sample YAML file examples/clients.yml.

draft -impl -verbose examples/clients.yml | dot -Gdpi=110 -Tpng > examples/clients.png

Sample YAML file examples/networking.yml.

draft -impl -verbose examples/networking.yml | dot -Gdpi=110 -Tpng > examples/networking.png

Sample YAML file examples/compute.yml.

draft -impl -verbose examples/compute.yml | dot -Gdpi=110 -Tpng > examples/compute.png

Sample YAML file examples/database.yml.

draft -impl -verbose examples/database.yml | dot -Gdpi=110 -Tpng > examples/database.png

Sample YAML file examples/storage.yml.

draft -impl -verbose examples/storage.yml | dot -Gdpi=110 -Tpng > examples/storage.png

Sample YAML file examples/security.yml.

draft -impl -verbose examples/security.yml | dot -Gdpi=110 -Tpng > examples/security.png

Here how to render components with specific aws, google and azure icons.

1. Download the PNG icons of your cloud provider AWS, GCP, Azure

2. Take only the icons related to the components supported by draft

3. Make a directory with the provider name (i.e. /draft/icons/aws, /draft/icons/google, /draft/icons/azure)

4. Rename each icon as draft components kind (i.e. dns.png, cdn.png and so on...)

5. Run draft specifyng the icons folder using the environment variable DRAFT_ICONS_PATH

• example: DRAFT_ICONS_PATH=/draft/icons draft my-file.yml | dot > ark-aws.png

👉 I have already done all the work for points 1 to 4. So you can avoid it by copying the directory icons 👈

The arrows that join the components.

To connect an origin component with one or more targets component you need to specify at least each id.

A connection has the following properties:

Each target has the following properties:

Sample YAML file examples/connections.yml.

draft examples/connections.yml | dot -Gdpi=110 -Tpng > examples/connections.png

👉 Record of all notable changes made to a project

👉 Collection of draft architecture descriptor YAML files

(c) 2020 Luca Sepe http://lucasepe.it. MIT License