adds diagram

tenable · Aug 16, 2020 · 09d0f6d · 09d0f6d
1 parent 1f7810b
commit 09d0f6d
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 1 deletion.
diff --git a/docs/architecture.diagrams.py b/docs/architecture.diagrams.py
@@ -0,0 +1,7 @@
+from diagrams import Cluster, Diagram
+from diagrams.onprem.iac import Terraform
+
+
+with Diagram("Terrascan architecture"):
+    Terraform("IaC Provider")
+
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -2,5 +2,5 @@
 
 Terrascan's architecture is built to be modular and easy to add IaC languages and policies. At a high level Terrascan is composed of the following architectural components: the command line interface, API server, runtime, pluggable IaC proviers, pluggable policy engine, notifier, and writter.
 
-
+![Terrascan architecture](terrascan_architecture.png)
 
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,3 @@
 mkdocs==1.1.2
 mkdocs-material==5.5.6
+mkdocs-diagrams==0.0.2
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -59,3 +59,8 @@ markdown_extensions:
 google_analytics:
   - UA-XXXXXXXX-X
   - auto
+
+# Plugins
+plugins:
+  - diagrams
+  - search
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,5 +2,5 @@

		Terrascan's architecture is built to be modular and easy to add IaC languages and policies. At a high level Terrascan is composed of the following architectural components: the command line interface, API server, runtime, pluggable IaC proviers, pluggable policy engine, notifier, and writter.


		![Terrascan architecture](terrascan_architecture.png)