diff --git a/docs/haha.png b/docs/haha.png new file mode 100644 index 0000000..dd9ba77 Binary files /dev/null and b/docs/haha.png differ diff --git a/docs/overview.md b/docs/overview.md index dd92c8d..7a797b2 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -1 +1,12 @@ -# Operator Overview \ No newline at end of file +# Operator Overview +The operator watches for `Immudb resources` to be created. See the default behavior in the diagram below. +

+ +
+overview +
+

+ +## **Pro Tips :bulb:** +1. Deleting the `immudb resource` deletes the database and all its associated resources (services, persistantVolumeClaim, ...). +2. \ No newline at end of file diff --git a/docs/overview.svg b/docs/overview.svg new file mode 100644 index 0000000..32e341c --- /dev/null +++ b/docs/overview.svg @@ -0,0 +1,18 @@ + + + + Immudb PodImmudb StatefulSetHTTP ServiceGRPC ServiceOperatorImmudb Resource1. Immudb resource is created.2. Operator creates the database and services.3. Database is ready We can connect to it through services.Cluster \ No newline at end of file