From 7e093dfd102f94e553aca367c4dcb40a4c4710c7 Mon Sep 17 00:00:00 2001
From: Gabriel Saratura <gabriel.saratura@vshn.ch>
Date: Thu, 6 Oct 2022 15:41:26 +0300
Subject: [PATCH] Add docs

---
 .../assets/images/application-logic.drawio.svg  |  4 ++++
 .../ROOT/pages/explanations/data-usage.adoc     | 17 +++++++++++++++++
 2 files changed, 21 insertions(+)
 create mode 100644 docs/modules/ROOT/assets/images/application-logic.drawio.svg
 create mode 100644 docs/modules/ROOT/pages/explanations/data-usage.adoc

diff --git a/docs/modules/ROOT/assets/images/application-logic.drawio.svg b/docs/modules/ROOT/assets/images/application-logic.drawio.svg
new file mode 100644
index 0000000..ea1633b
--- /dev/null
+++ b/docs/modules/ROOT/assets/images/application-logic.drawio.svg
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Do not edit this file with editors other than diagrams.net -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="721px" height="288px" viewBox="-0.5 -0.5 721 288" content="&lt;mxfile host=&quot;app.diagrams.net&quot; modified=&quot;2022-10-06T12:37:25.903Z&quot; agent=&quot;5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36&quot; etag=&quot;2DJ3OiEgrykd5dCMCGE-&quot; version=&quot;20.2.4&quot; type=&quot;device&quot;&gt;&lt;diagram id=&quot;PKKyh6ijMQEFQAqk458b&quot; name=&quot;Page-1&quot;&gt;1VjbUtswEP2aPMI4di7OI7mUdgoDlOmU9k2xFFtF9qayTJJ+fVeWfHcoU6AMPATpaC1Le85ZKRl4i3h/Lsk2ugTKxMB16H7gLQeuOxtN8FMDBwOMxkMDhJJTA9WAW/6bWdCxaMYpSxuBCkAovm2CASQJC1QDI1LCrhm2AdF865aErAPcBkR00W+cqsig/tip8I+Mh1Hx5qFjR2JSBFsgjQiFXQ3yVgNvIQGUacX7BRM6d0VezHMfjoyWC5MsUU95IFC/Vn58efX1ZjELLgP+Az7LkyLNqToUO2YUE2C7IFUEISRErCp0LiFLKNPTOtirYi4AtggOEfzJlDpYNkmmAKFIxcKO4orl4c4+n3e+687pdFz0l/v66PJgextI1AIESOxTtiGZwK3PzRb0uo+mxkIpZDKwUeuTT3609LPz+zN/NP5yfkPl9UkhMSJDph7LW0kgCp9BzHCV+Jxkgij+0FwHsRIMy7iKJWxYovpJe2yRD0Rk9k2rPaS5Zl1nnQX3TKXY2nFUoOtkqZY47l2z0SFbCHSSJnUXccVutyRPzw693KSMpFtjrw3fa+rnlEsEOCSIYVq12OdH8/7ApGL7GtRNnR2dWEHacuENJ6f+1EC7yn+ly6K69wrwOQnvZXv2JibZc3VXaxuLjG2vMojuFP44Ziz3zY3lvgdjuR1jffbTPk8lJGZp7hVcRULxE2RIEp6S3BEv57KXd9TQc97aTv57sVOKclVn+haBQAIJ+2dP9Gv9qafN9D+Z4rgjG6YYuJO8PFD+0KBx8isDUzZqrVD/vyQq0L5ZH6x5iilwRfksJqyjCyU5ScJcADUqJShiTx7NEhE81G3BNnoSQdZMzElwH+aaKaqapc+MgqRMtka0n3kS6nc4VXcOSkFs39Tn3v7Kmb/mGlJu1xmgOBiGzLVvOR7VF62AmFOa77MIOLO7KgeO+L5HekdLgTtr1QLfOfWGPeXARWN0C4I/0QfJ66hs2lHZFlIVSpbXX44FFKnBrxFEkTVJuxcZvF1vdTM4YCSS6/292K5NSblYl0ApmqtM4TTM4qmpKcPxy7AwabHg9lTkWU9B9qur0MubvOvysxCzHxLF6ndIBdK0SifbY7BFR7Nc/4WIf3XsY5eWZzE08lsMjbzTkdf1idvD0uS1Ts1h93byXs5RltBXPEWferN87tXSPnoNHJdYasWblcWyUMtUq2U0K/9aNdPsyE5T/8LemrlTJ3De1lRm052pcn2VW+yTHHarXx5MePXzjbf6Aw==&lt;/diagram&gt;&lt;/mxfile&gt;"><defs/><g><path d="M 100 236.9 L 165 236.9 L 165 190 L 223.63 190" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 228.88 190 L 221.88 193.5 L 223.63 190 L 221.88 186.5 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><ellipse cx="50" cy="236.87" rx="50" ry="50" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" transform="rotate(90,50,236.87)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 98px; height: 1px; padding-top: 237px; margin-left: 1px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Exoscale buckets with usage size</div></div></div></foreignObject><text x="50" y="240" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">Exoscale buckets...</text></switch></g><path d="M 100 50 L 165 50 L 165 96.9 L 223.63 96.88" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 228.88 96.87 L 221.88 100.38 L 223.63 96.88 L 221.88 93.38 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><ellipse cx="50" cy="50" rx="50" ry="50" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 98px; height: 1px; padding-top: 50px; margin-left: 1px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">K8s buckets with namespace and organisation</div></div></div></foreignObject><text x="50" y="54" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">K8s buckets with...</text></switch></g><path d="M 540 143.43 L 585 143.4 L 623.63 143.49" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 628.88 143.5 L 621.87 146.98 L 623.63 143.49 L 621.89 139.98 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><path d="M 230 50.31 L 332.5 143.43 L 230 236.56 Z" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe flex-start; width: 85px; height: 1px; padding-top: 143px; margin-left: 240px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: left;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><div style="">Match by name</div></div></div></div></foreignObject><text x="240" y="147" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px">Match by name</text></switch></g><path d="M 630 115 C 630 106.72 650.15 100 675 100 C 686.93 100 698.38 101.58 706.82 104.39 C 715.26 107.21 720 111.02 720 115 L 720 171.87 C 720 180.15 699.85 186.87 675 186.87 C 650.15 186.87 630 180.15 630 171.87 Z" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><path d="M 720 115 C 720 123.28 699.85 130 675 130 C 650.15 130 630 123.28 630 115" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 88px; height: 1px; padding-top: 156px; margin-left: 631px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">postgres billing database</div></div></div></foreignObject><text x="675" y="160" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">postgres billin...</text></switch></g><rect x="420" y="113.43" width="120" height="60" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 143px; margin-left: 421px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Aggregate usage storage by namespace</div></div></div></foreignObject><text x="480" y="147" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">Aggregate usage stor...</text></switch></g><path d="M 332.5 143.43 L 420 143.43" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/></g><switch><g requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"/><a transform="translate(0,-5)" xlink:href="https://www.diagrams.net/doc/faq/svg-export-text-problems" target="_blank"><text text-anchor="middle" font-size="10px" x="50%" y="100%">Text is not SVG - cannot display</text></a></switch></svg>
\ No newline at end of file
diff --git a/docs/modules/ROOT/pages/explanations/data-usage.adoc b/docs/modules/ROOT/pages/explanations/data-usage.adoc
new file mode 100644
index 0000000..f4be2c4
--- /dev/null
+++ 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.