High level Design

High-level Design (概要设计规约)

Prototype Design (原型设计)

Home Page

Signed Page

Sidebar

Sidebar

Knowledge Graph

algorithm display page

Architecture Context Diagram（系统环境表示）

business architecture

Business Architecture (业务架构)

business architecture

Technology Architecture (技术架构)

technology architecture

Architecture Design（架构设计）

architecture

Deployment Topology (部署结构)

deployment topology

Data Models (数据建模)

Entity-Relation Design (实体-关系设计)

![mongo](./images/E-R Mongo Diagram.png)

Database Design (数据库设计)

基于图形数据库 Neog4j 进行数据库设计，以“节点空间”来表达领域数据——相对于传统的模型表、行和列来说，节点空间是很多节点、关系和属性（键值对）构成的网络。

Service_Node:

Column	Type	Description
name	String	name of node
nameSpace	String	node name space
port	String	port of node
targetPort	String	target port of node
type	String	type of node

Container_Node

Column	Type	Description
name	String	name of node
ArrayListAdd	String	list name added
ArrayListDrop	String	list name dropped
volumeMount	String	volume mount
type	String	type of node

Deployment_Node

Column	Type	Description
name	String	name of node
nameSpace	String	node name space
containerPort	String	port of container
image	String	image source
type	String	type of node

Relation

Column	Type	Description
type	String	type of relation

Causation_Node

Column	Type	Description
name	String	name of node
type	String	type of node

Dateset

Column	Type	Description
name	String	name of node
type	String	type of node
path	String	path of the .csv file
from	String	dataset from path
to	String	dataset to path

Metric

Column	Type	Description
name	String	name of node

System

Column	Type	Description
name	String	name of node
type	String	type of node

Interface Specifications （接口规约）

bbs/api/getAll

Description (接口描述)

Get all nodes and links.

Authorization	Required
Request Method	Get

Parameters (参数)

None

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

bbs/api/getAll

Response Sample (示例结果)

{
    "nodes": [
        {
            "performance": "name:System1;type:System",
            "name": "System1",
            "id": 1021,
            "type": "System",
            "layer": "NULL"
        }
    ],
    "links": [
        {
            "source": 1074,
            "type": "records",
            "target": 1021
        }
    ]
}

bbs/api/getLabel

Description (接口描述)

Get nodes by node label.

Authorization	Required
Request Method	Get

Parameters (参数)

Name	Located in	Description	Required	Schema
label	query	node label	Yes	String

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

bbs/api/getLabel?label=Service_Node

Response Sample (示例结果)

{
    "nodes": [
        {
            "performance": "name:carts-db;port:27017;nameSpace:sock-shop;targetPort:27017;type:Service_Node",
            "name": "carts-db",
            "id": 1024,
            "type": "Service_Node",
            "layer": "NULL"
        }
    ],
    "links": [
        {
            "source": 1021,
            "type": "exposes",
            "target": 1024
        }
    ]
}

bbs/api/getAllLabel

Description (接口描述)

Get all labels.

Authorization	Required
Request Method	Get

Parameters (参数)

Name	Located in	Description	Required	Schema
label	query	node label	Yes	String

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

bbs/api/getAllLabel

Response Sample (示例结果)

{
    "Label": [
        "System",
        "Deployment_Node",
        "Container_Node",
        "Service_Node",
        "Node",
        "Dataset",
        "Causation_Node",
        "Metric"
    ]
}

bbs/api/metricInfo

Description (接口描述)

Get nodes by node label.

Authorization	Required
Request Method	Get

Parameters (参数)

Name	Located in	Description	Required	Schema
filename	query	file name	Yes	String

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

bbs/api/metricInfo?filename=result.csv

Response Sample (示例结果)

{
    "container": {
        "place": []
    },
    "service": {
        "place": []
    },
    "Node": {
        "name": [
            "service",
            "deployment",
            "container"
        ]
    },
    "deployment": {
        "place": []
    }
}

bbs/api/addMetric

Description (接口描述)

Add metric node.

Authorization	Required
Request Method	POST

Parameters (参数)

Name	Located in	Description	Required	Schema
pod	query	pod name	Yes	String
Type	query	type	Yes	String
dateset	query	dataset name	Yes	String
relation	query	relation name	Yes	String

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

bbs/api/addMetric?pod=edge-router:80&Type=request_duration_seconds_count&dateset=front-end-cpu-2(1).csv&relation=cause

bbs/api/getCSV

Description (接口描述)

Get nodes by node label.

Authorization	Required
Request Method	Get

Parameters (参数)

None

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

bbs/api/getCSV

Response Sample (示例结果)

{
    "CSV": [
        "result.csv",
        "front-end-cpu-2(1).csv"
    ]
}

bbs/api/getDataset

Description (接口描述)

Get dataset.

Authorization	Required
Request Method	Get

Parameters (参数)

None

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

bbs/api/getDataset

Response Sample (示例结果)

{
    "nodes": [
        {
            "name": "System1/result.csv",
            "type": "Dataset"
        },
        {
            "name": "frontend1/front-end-cpu-2(1).csv",
            "type": "Dataset"
        }
    ]
}

bbs/api/addNods

Description (接口描述)

Add nods.

Authorization	Required
Request Method	POST

Parameters (参数)

Name	Located in	Description	Required	Schema
Url	query	url	Yes	String

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

bbs/api/addNods?Url=http://10.60.38.182:5525/tool/api/v1.0/get_pods/kube-public

Response Sample (示例结果)

bbs/api/yamldeal

Description (接口描述)

Upload yaml file.

Authorization	Required
Request Method	POST

Parameters (参数)

Name	Located in	Description	Required	Schema
systemName	query	system name	Yes	String
file	body	csv file	Yes	String

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

bbs/api/yamldeal?systemName=System1

Response Sample (示例结果)

bbs/api/fileupdate

Description (接口描述)

Upload csv file.

Authorization	Required
Request Method	POST

Parameters (参数)

Name	Located in	Description	Required	Schema
systemName	query	system name	Yes	String
file	body	csv file	Yes	String

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

bbs/api/fileupdate?systemName=System1

/bbs/api/addServiceRelation

Description (接口描述)

Upload json file.

Authorization	Required
Request Method	POST

Parameters (参数)

Name	Located in	Description	Required	Schema
systemName	query	system name	Yes	String
file	body	csv file	Yes	String

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

/bbs/api/addServiceRelation?systemName=System1

bbs/api/getSystem

Description (接口描述)

Get all systems.

Authorization	Required
Request Method	GET

Parameters (参数)

None

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

bbs/api/getSystem

Response Sample (示例结果)

{
    "nodes": [
        {
            "name": "System1",
            "type": "System"
        }
    ]
}

bbs/api/getElementName

Description (接口描述)

Get element name.

Authorization	Required
Request Method	POST

Parameters (参数)

None

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

bbs/api/getElementName

Response Sample (示例结果)

{
    "Element": [
        "default",
        "kube-public",
        "kube-system",
        "monitoring",
        "monitoring-sock-shop",
        "sock-shop"
    ]
}

bbs/api/getOperationData

Description (接口描述)

Get operation data.

Authorization	Required
Request Method	GET

Parameters (参数)

Name	Located in	Description	Required	Schema
filename	query	file name	Yes	String

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

bbs/api/getOperationData?filename=example.csv

Response Sample (示例结果)

{
    "Operations": {}
}

/bbs/api/getTimestamp

Description (接口描述)

Get timestamp.

Authorization	Required
Request Method	GET

Parameters (参数)

Name	Located in	Description	Required	Schema
filename	query	file name	Yes	String

Responses (返回结果)

Code	Description
200	Successful response

Request Sample (示例请求)

/bbs/api/getTimestamp?filename=example.csv

Response Sample (示例结果)

{
    "Timestamp": []
}

Specification

Deployment Document

Docker-Vue Frontend Deploy Doc