Create overview doc

unagex · Feb 9, 2024 · 54a06d6 · 54a06d6
1 parent 2b99232
commit 54a06d6
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/overview.md b/docs/overview.md
@@ -1 +1,10 @@
-# Operator Overview
+# Operator Overview
+The operator watches `Immudb resources`. See the default operator behavior in the diagram below.
+<br></br>
+<p align="center" width="100%">
+<img src="./overview.png" width="500">
+</p>
+
+## **Pro Tips :bulb:**
+1. Deleting the `immudb resource` deletes the database and all its associated resources (services, persistantVolumeClaim, ...).
+2. You can create as much `immudb resources` as you want. The limit is your cluster infrastructure.
diff --git a/docs/overview.png b/docs/overview.png