From 69c0e7dbac656199d19c69bd9d2429ebac4cec1c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Roch=C3=A9=20Compaan?= <roche@upfrontsoftware.co.za>
Date: Wed, 2 Aug 2023 14:13:04 +0200
Subject: [PATCH] feat: add mermaid architecture diagram

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/README.md b/README.md
index 20b7268b..2857e63d 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,46 @@ Answer all the questions, and you'll have your new project!
 Inside `[project_destination_directory]/[project_slug]/README.md` you will have more
 documentation explaining how to use and configure your newly created project.
 
+## Architecture
+
+Here is what a cookiecutter deployment looks like in practice:
+
+```mermaid
+flowchart LR
+    PR["PR Merge"] --> CIDCD["CI/CD Pipeline"]
+    CIDCD -->|Build & Push Images| AWSECR["AWS ECR Repo"]
+    CIDCD -->|Update Image Tags| Kustomize
+    CIDCD -->|Build & Push Static Content| S3
+    Kustomize --> ArgoCD
+    Cloudfront
+    S3
+    subgraph ControlPlaneCluster["Control Plane Cluster"]
+        Loki["Grafana Loki"]
+        Prometheus
+        ArgoCD
+    end
+    subgraph K8sCluster["Kubernetes Cluster"]
+        Django
+        NextJS
+        CloudNativePG
+        Redis
+        Celery
+        Mailhog
+    end
+    ArgoCD -->|Deploy| K8sCluster
+    Sentry
+    Django -->|Sends Error Logs| Sentry
+    NextJS -->|Sends Error Logs| Sentry
+    K8sCluster -->|Sends Logs| Loki
+    K8sCluster -->|Sends Metrics| Prometheus
+    Cloudfront -->|Requests for API and Frontend Views| K8sCluster
+    Cloudfront -->|Requests for Static Content and Media| S3
+
+    style K8sCluster fill:#FFC107, stroke:#FFFFFF, stroke-width:1px
+    style ControlPlaneCluster fill:#ff6361, stroke:#FFFFFF, stroke-width:1px
+
+```
+
 ## Terraform and AWS
 
 In order to deploy your project using terraform and AWS you can follow the instructions in `terraform/README.md`.