zoobc/zoobc-core#159 add auth and getNodeHardware service (#44)

* zoobc/zoobc-core#159 add auth and getNodeHardware service

Author: andy-shi88

documentation.swagger.json

@@ -632,6 +632,46 @@
         }
       }
     },
+    "modelCPUInformation": {
+      "type": "object",
+      "properties": {
+        "CPUIndex": {
+          "type": "integer",
+          "format": "int32"
+        },
+        "CacheSize": {
+          "type": "integer",
+          "format": "int32"
+        },
+        "CoreID": {
+          "type": "string"
+        },
+        "Cores": {
+          "type": "integer",
+          "format": "int32"
+        },
+        "Family": {
+          "type": "string"
+        },
+        "Mhz": {
+          "type": "number",
+          "format": "double"
+        },
+        "Model": {
+          "type": "string"
+        },
+        "ModelName": {
+          "type": "string"
+        },
+        "UsedPercent": {
+          "type": "number",
+          "format": "double"
+        },
+        "VendorId": {
+          "type": "string"
+        }
+      }
+    },
     "modelChainStatus": {
       "type": "object",
       "properties": {
@@ -770,6 +810,14 @@
         }
       }
     },
+    "modelGetNodeHardwareResponse": {
+      "type": "object",
+      "properties": {
+        "NodeHardware": {
+          "$ref": "#/definitions/modelNodeHardware"
+        }
+      }
+    },
     "modelGetNodeRegistrationsResponse": {
       "type": "object",
       "properties": {
@@ -877,6 +925,64 @@
         }
       }
     },
+    "modelHostInformation": {
+      "type": "object",
+      "properties": {
+        "HostID": {
+          "type": "string"
+        },
+        "HostName": {
+          "type": "string"
+        },
+        "NumberOfRunningProcess": {
+          "type": "string",
+          "format": "uint64"
+        },
+        "OS": {
+          "type": "string"
+        },
+        "Platform": {
+          "type": "string"
+        },
+        "PlatformFamily": {
+          "type": "string"
+        },
+        "PlatformVersion": {
+          "type": "string"
+        },
+        "Uptime": {
+          "type": "string",
+          "format": "uint64"
+        }
+      }
+    },
+    "modelMemoryInformation": {
+      "type": "object",
+      "properties": {
+        "Available": {
+          "type": "string",
+          "format": "uint64",
+          "title": "RAM available for programs to allocate"
+        },
+        "Free": {
+          "description": "This is the kernel's notion of free memory; RAM chips whose bits nobody\ncares about the value of right now. For a human consumable number,\nAvailable is what you really want.",
+          "type": "string",
+          "format": "uint64"
+        },
+        "Total": {
+          "type": "string",
+          "format": "uint64"
+        },
+        "Used": {
+          "type": "string",
+          "format": "uint64"
+        },
+        "UsedPercent": {
+          "type": "number",
+          "format": "double"
+        }
+      }
+    },
     "modelMempoolTransaction": {
       "type": "object",
       "title": "Mempool represent the mempool data structure stored in the database",
@@ -921,6 +1027,26 @@
         }
       }
     },
+    "modelNodeHardware": {
+      "type": "object",
+      "properties": {
+        "CPUInformation": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/modelCPUInformation"
+          }
+        },
+        "HostInformation": {
+          "$ref": "#/definitions/modelHostInformation"
+        },
+        "MemoryInformation": {
+          "$ref": "#/definitions/modelMemoryInformation"
+        },
+        "StorageInformation": {
+          "$ref": "#/definitions/modelStorageInformation"
+        }
+      }
+    },
     "modelNodeRegistration": {
       "type": "object",
       "properties": {
@@ -1074,6 +1200,30 @@
         }
       }
     },
+    "modelStorageInformation": {
+      "type": "object",
+      "properties": {
+        "Free": {
+          "type": "string",
+          "format": "uint64"
+        },
+        "FsType": {
+          "type": "string"
+        },
+        "Total": {
+          "type": "string",
+          "format": "uint64"
+        },
+        "Used": {
+          "type": "string",
+          "format": "uint64"
+        },
+        "UsedPercent": {
+          "type": "number",
+          "format": "double"
+        }
+      }
+    },
     "modelTransaction": {
       "type": "object",
       "title": "Transaction represent the transaction data structure stored in the database",
@@ -1166,6 +1316,43 @@
           "$ref": "#/definitions/modelProofOfOwnership"
         }
       }
+    },
+    "protobufAny": {
+      "type": "object",
+      "properties": {
+        "type_url": {
+          "type": "string"
+        },
+        "value": {
+          "type": "string",
+          "format": "byte"
+        }
+      }
+    },
+    "runtimeStreamError": {
+      "type": "object",
+      "properties": {
+        "details": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/protobufAny"
+          }
+        },
+        "grpc_code": {
+          "type": "integer",
+          "format": "int32"
+        },
+        "http_code": {
+          "type": "integer",
+          "format": "int32"
+        },
+        "http_status": {
+          "type": "string"
+        },
+        "message": {
+          "type": "string"
+        }
+      }
     }
   }
 }

model/auth.proto

@@ -0,0 +1,10 @@
+syntax="proto3";
+
+package model;
+
+option go_package = "github.com/zoobc/zoobc-core/common/model";
+
+// RequestType used to sign a node administration request
+enum RequestType {
+    GetNodeHardware = 0;
+}

model/nodeHardware.proto

@@ -0,0 +1,63 @@
+syntax="proto3";
+
+package model;
+
+option go_package = "github.com/zoobc/zoobc-core/common/model";
+
+message GetNodeHardwareResponse {
+    NodeHardware NodeHardware = 1;
+}
+
+message GetNodeHardwareRequest {
+}
+
+message NodeHardware {
+    repeated CPUInformation CPUInformation = 1;
+    MemoryInformation MemoryInformation = 2;
+    StorageInformation StorageInformation = 3;
+    HostInformation HostInformation = 4;
+}
+
+message CPUInformation {
+   string Family = 1;
+   int32 CPUIndex = 2;
+   string Model = 3;
+   string ModelName = 4;
+   string VendorId = 5;
+   double Mhz = 6;
+   int32 CacheSize = 7;
+   double UsedPercent = 8;
+   string CoreID = 9;
+   int32 Cores = 10;
+}
+
+message HostInformation {
+    uint64 Uptime = 1;
+    string OS = 2;
+    string Platform = 3;
+    string PlatformFamily = 4;
+    string PlatformVersion = 5;
+    uint64 NumberOfRunningProcess = 6;
+    string HostID = 7;
+    string HostName = 8;
+}
+
+message MemoryInformation {
+    uint64 Total = 1;
+    // This is the kernel's notion of free memory; RAM chips whose bits nobody
+    // cares about the value of right now. For a human consumable number,
+    // Available is what you really want.
+    uint64 Free = 2;
+    // RAM available for programs to allocate
+    uint64 Available = 3;
+    uint64 Used = 4;
+    double UsedPercent = 5;
+}
+
+message StorageInformation {
+    string FsType = 1;
+    uint64 Total = 2;
+    uint64 Free = 3;
+    uint64 Used = 4;
+    double UsedPercent = 5;
+}

service/nodeHardware.proto

@@ -0,0 +1,13 @@
+syntax="proto3";
+
+package service;
+
+option go_package = "github.com/zoobc/zoobc-core/common/service";
+
+import "model/nodeHardware.proto";
+import "google/api/annotations.proto";
+
+// NodeHardwareService represent request on get node hardware information
+service NodeHardwareService {
+    rpc GetNodeHardware(stream model.GetNodeHardwareRequest) returns (stream model.GetNodeHardwareResponse) {}
+}