ndiag
ndiag is a "high-level architecture" diagramming/documentation tool.
Key features of ndiag are:
- N-diagrams: Generate multiple "diagrams and documents" (views) from a single configuration.
- Nested-clusters: Nodes and components can be clustered in nested layers
- Provides the ability to check the difference between the architecture and the actual system.
Usage
$ ndiag doc -c ndiag.yml --rm-distGetting Started
Generate architecture documents
Add ndiag.yml (Full version is here).
---
name: 3-Tier Architecture
docPath: docs/arch
views:
-
name: overview
layers: ["consul", "vip_group"]
-
name: http-lb
layers: ["vip_group"]
labels: ["http"]
nodes:
-
name: lb
match: lb-*
components:
- NGINX?icon=lb-l7
clusters:
- 'Consul:dc1'
- 'vip_group:lb'
-
name: app
match: app-*
components:
- NGINX?icon=proxy
- Rails App?icon=cube4&label=lang:ruby
clusters:
- 'Consul:dc1'
-
name: db
match: db-*
components:
- PostgreSQL?icon=db
clusters:
[...]Run ndiag doc to generate documents in GitHub Friendly Markdown format.
$ ndiag doc -c ndiag.ymlCommit ndiag.yml and documents.
$ git add ndiag.yml doc/arch ndiag.description
$ git commit -m 'Add architecture document'
$ git push origin mainView the document on GitHub.
Tutorial
Install
deb:
$ export NDIAG_VERSION=X.X.X
$ curl -o ndiag.deb -L https://github.com/k1LoW/ndiag/releases/download/v$NDIAG_VERSION/ndiag_$NDIAG_VERSION-1_amd64.deb
$ dpkg -i ndiag.debRPM:
$ export NDIAG_VERSION=X.X.X
$ yum install https://github.com/k1LoW/ndiag/releases/download/v$NDIAG_VERSION/ndiag_$NDIAG_VERSION-1_amd64.rpmapk:
$ export NDIAG_VERSION=X.X.X
$ curl -o ndiag.apk -L https://github.com/k1LoW/ndiag/releases/download/v$NDIAG_VERSION/ndiag_$NDIAG_VERSION-1_amd64.apk
$ apk add ndiag.apkhomebrew tap:
$ brew install k1LoW/tap/ndiagmanually:
Download binary from releases page
go install:
$ go install github.com/k1LoW/ndiag@latestdocker:
$ docker pull ghcr.io/k1low/ndiag:latesttemporary:
$ source <(curl https://git.io/ndiag)$ curl -sL https://git.io/ndiag > /tmp/ndiag.tmp && . /tmp/ndiag.tmp