diff --git a/README.md b/README.md index e0ff3a9..e633d16 100644 --- a/README.md +++ b/README.md @@ -12,23 +12,27 @@ ## 1. About VATZ ## -> VATZ is a tool for building, analyzing, and managing block chain Node infrastructure safely and efficiently. You can set up VATZ to manage existing or new blockchain nodes and integrate with popular services PagerDuty, Discord, and more as well as custom in-house solutions. +> **VATZ** is a tool for building, analyzing, and managing blockchain Node infrastructure safely and efficiently. You can set up VATZ to manage existing or new blockchain nodes and integrate with popular services PagerDuty, Discord, and more as well as custom in-house solutions. -The key features of VATZ are: +The key features of **VATZ** are: -- `Multi Protocol Support`: VATZ is NOT limited Protocol Type where it categorizes on chain protocol. Any Protocol can be managed through VATZ with plugins, even unsupported protocols can be integrated through simple plugin development. -- `Infrastructure as Code`: VATZ is described using a high-level configuration syntax. You can divide your plugins into modular components that can then be combined in different ways to behave through automation. -- `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) +- `Multi Protocol Support`: **VATZ** is NOT limited Protocol Type where it categorizes on chain protocol. Any Protocol can be managed through VATZ with plugins, even unsupported protocols can be integrated through simple plugin development. +- `Infrastructure as Code`: **VATZ** is described using a high-level configuration syntax. You can divide your plugins into modular components that can then be combined in different ways to behave through automation. +- `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 about_ **`VATZ Project`** +- [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. +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 blockchain technology. ## 3. Contact -Please, contact [us](mailto:validator@dsrvlabs.com) if you need any further information.
Visit us if you are interested about what we are doing +Please, contact [us](mailto:validator@dsrvlabs.com) if you need any further information about **VATZ**.
Visit [DSRV Labs](https://www.dsrvlabs.com/) if you are interested more about what we are doing [Medium](https://dsrv.medium.com) [Github](https://github.com/dsrvlabs) @@ -38,10 +42,11 @@ Please, contact [us](mailto:validator@dsrvlabs.com) if you need any fu --- + # How can I contribute? We welcome contributions! Many people all over the world have helped make this project better. -* [Contributing](docs/contributing.md) explains what kinds of contributions we welcome and how to contribute +- [Contributing](docs/contributing.md) explains what kinds of contributions we welcome and how to contribute - [Project Workflow Instructions](docs/workflow.md) explains how to build and test diff --git a/docs/design.md b/docs/design.md new file mode 100644 index 0000000..4b31fc5 --- /dev/null +++ b/docs/design.md @@ -0,0 +1,79 @@ +# VATZ Project Design + +![Vatz Project Design](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 the protocol itself. Features for helping node operators such as automation that enable node manage orchestration and controlling VATZ over CLI commands are going to be available in near future. + +3 major services are planned in **VATZ** project as follows:
+(Will be upgraded or added for the future) + + 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 and gRPC protocol from the initial design stage. End-users can develop their own plugins to add new features with their own needs regardless of the programming language by using gRPC protocol. + + +## Protocol Node + +### 1. Manager + +- This is a main service of **VATZ** that executes plugin 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 be declared in default.yaml to get started with **VATZ** properly. + +### 2. Plugins + +Plugins that allow you to perform followings per protocols + - `Check`: Node & Machine status + - `Collect`: Node's metric + more + - `Execute`: Command on machine for certain behaviors (e.g, Restart 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) \ No newline at end of file