Add overview doc

unagex · Feb 15, 2024 · 3b1027a · 3b1027a
1 parent bfe8aa9
commit 3b1027a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/overview.md b/docs/overview.md
@@ -0,0 +1,14 @@
+# Operator Overview
+The operator watches `Metabase 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 `Metabase resource` deletes the Metabase deployment, the PostgreSQL Statefulset and all other associated resources (secret, persistantVolumeClaim, ...).
+2. You can create as much `Metabase resources` as you want. The limit is your cluster infrastructure.
+3. The operator is a `Deployment`. You can debug by checking his pod logs.
+4. Check status.ready of the `Metabase resource` to know when the Metabase is ready to accept connections.
+5. Check status.host of the `Metabase resource` to establish a connection.
diff --git a/docs/overview.png b/docs/overview.png