Add docs

vshn · Oct 6, 2022 · 69d99d7 · 69d99d7
1 parent 3850f22
commit 69d99d7
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/docs/modules/ROOT/assets/images/application-logic.drawio.svg b/docs/modules/ROOT/assets/images/application-logic.drawio.svg
diff --git a/docs/modules/ROOT/pages/explanations/data-usage.adoc b/docs/modules/ROOT/pages/explanations/data-usage.adoc
@@ -0,0 +1,17 @@
+= Data Usage
+
+This page gives a brief overview how buckets data usage is saved to the postgres billing database.
+
+== Data flow
+
+image::application-logic.drawio.svg[]
+
+== Data source
+- Buckets are fetched from Exoscale Provider and K8s Cluster.
+- The bucket names in Exoscale are unique across organisation which prevents clusters having same bucket names.
+
+== Data saving
+
+- The data is saved in a postgres database.
+- A database must be provided in the postgres URL.
+- The application ensures the initial configuration of specified database in the URL.