Update README.md to add Project design.md

README.md

@@ -21,13 +21,17 @@ The key features of VATZ are:
 - `Data Analysis`: VATZ helps to build datasets for your managing protocols and transfer your data into popular services Prometheus, Kafaka, Google BigQuery and more. Because of this, VATZ aims to set your Node infrastructure as efficiently as possible, and operators get insight into dependencies in their infrastructure. (2023-Q3)
 - `Change automation`: Complex sets of node's operational tasks can be done through VATZ with minimal human interaction. (2023-Q2)
 
+
+To Find more for **Project Design** 
+* [VATZ Project Design](docs/design.md)
+
 ## 2. Our Mission ##
 
 We're on a mission to transform the way people experience blockchain technology and let them contribute and become a part of its technology.
 As Validators, we provide tools to people to manage their own nodes with low cost and less effort for anyone who would like to join future block chain technology.
 
 
-## 3. Contact
+## 4. Contact
 Please, <b>  contact </b> [us](mailto:[email protected]) if you need any further information. <br> Visit us if you are interested about what we are doing
 
 [<img alt="Medium" src="https://user-images.githubusercontent.com/6308023/176984456-f82c5c67-ebf3-455c-8494-c64ebfd66c58.svg" width="50" height="50" />](https://dsrv.medium.com)

docs/design.md

@@ -0,0 +1,78 @@
+# VATZ Project Design
+
+![Vatz Diagram (To be) drawio (2)](https://user-images.githubusercontent.com/6308023/179885451-6d40505b-8b31-41d3-8dff-25220e00be1c.png)
+
+> **VATZ** is mainly designed to check the node status in real time and get the alert notification of all blockchain protocols, including metrics that doesn't supported by protocol itself.
+
+3 major services planned for the VATZ project as follows:
+(Will be added for the futures)
+1. Manager
+2. SDK
+3. Monitoring
+
+---
+
+## Proto Repository (gRPC protocols)
+
+VATZ is a total node management tool that is designed to be customizable and expandable through plug-in from the initial design stage.
+End-users develop their own plugins and add features with their needs regardless of the development language by using gRPC protocol.
+
+## Protocol Node
+
+### 1. Manager
+
+- This is a main service of VATZ that execute plugins APIs based on configs.
+
+```
+SAMPLE DEFAULT YAML
+---
+vatz_protocol_info:
+  protocol_identifier: "VATZ"
+  port: 9090
+  notification_info:
+    discord_secret: "xxxxxxx"
+plugins_infos:
+  default_verify_interval: 15
+  default_execute_interval: 30
+  default_plugin_name: "vatz-plugin"
+  plugins:
+    - plugin_name: "sample1"
+      plugin_address: "localhost"
+      plugin_port: 9091
+      executable_methods:
+        - method_name: "sampleMethod1"
+    - plugin_name: "sample2"
+      plugin_address: "localhost"
+      verify_interval: 7
+      execute_interval: 9
+      plugin_port: 10002
+      executable_methods:
+        - method_name: "sampleMethod2"
+```
+
+`vatz_protocol_info` & `plugins_infos` must declared in default.yaml to get stared VATZ properly. 
+
+### 2. Plugins
+
+- Plugins that allow you to perform in pu 
+   - `Collect` Metric data
+   - `Execute` Command on Node automatically
+   - `Check` Status on Node
+
+
+### 3. Monitoring
+The blockchain protocols have so many unique logs, and it brings a lot of data which causes difficulties in finding meaningful data by standardizing it to make it easier to view.
+The most validator teams have trouble managing logs from running nodes due to log's varieties.
+VATZ's monitoring service is designed to find a way to manage all logs from nodes efficiently with minimum cost.
+
+We are targeting for followings:
+
+> 1. Manage VATZ with Dashboard  (2022-Q3)
+> 2. Unified Log exporter (2023-Q2)
+
+## 3rd Party Applications
+We are trying to provide functions that can be easily integrated with the 3rd party applications most of the Validator teams are currently using now.
+
+> 1. [Grafana](https://grafana.com/)
+> 2. [Kibana](https://www.elastic.co/)
+> 3. (TBD)