Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[INLONG-1027][Doc] Update dashboard guidelines #1034

Merged
merged 2 commits into from
Sep 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 96 additions & 1 deletion docs/user_guide/dashboard_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,4 +149,99 @@ the information filling module
- Data usage: select data usage usage
- Data usage description: The applicant needs to briefly explain the items used and the purpose of the data according to
their own consumption scenarios After completing the information, click [Submit], and the data consumption process
will be formally submitted to the approver before it will take effect.
will be formally submitted to the approver before it will take effect.

## Synchronization

The data synchronization module displays a list of all tasks in the synchronization system within the current user permissions. You can view, edit, update and delete the details of these tasks.
Click [New Data Synchronization] to enter the data synchronization process. You need to fill in the relevant information about the synchronization information. You can choose two synchronization types: real-time or offline.

![Create sync](img/create-sync.png)

### Base Information

#### Realtime Synchronization

After filling in the relevant basic information, you can proceed to the next step.

![Realtime sync](img/realtime-sync.png)

- Data flow group ID: The brief name of the synchronization task, which must be composed of lowercase letters, numbers, and underscores.
- Responsible person: The responsible person can view and modify synchronized information.
- Entire database migration: Choose whether you need to migrate the entire database according to your own needs.

#### Offline Synchronization

After filling in the relevant basic information, you also need to fill in the offline synchronization related information, such as: scheduling rules and dependency configuration.

![Offline sync](img/offline-sync.png)

Scheduling type: Choose regular or Crontab type according to your own needs.

##### Regular Type

- Scheduling unit: select minutes, hours, days, weeks, etc. according to your own needs.
- Scheduling cycle: Select the cycle according to your own needs, and its unit is determined by the selection of the scheduling unit.
- Delay time: fill in the required delay time.
- Validity time: Configure the validity time of offline rules.

##### Crontab Type

- Valid time: The time interval can be filled in, the format is: 2021-01-01 00:00-2021-12-31 23:59
- Crontab expression: Fill in the Crontab expression according to your own needs.

## Data Node

The data node module displays the list of data nodes within the current user permissions. You can view, edit, update and delete the details of these nodes.
Click [New] to pop up a dialog box for creating a new node. You can choose different node types, such as: Redis, Kafka, MySQL, etc.

![Create node](img/create-node.png)

![create note type](img/create-node-type.png)

- Node name: The brief name of the node, which must be composed of lowercase letters, numbers, and underscores.
- Node type: Select the type of node.
- Responsible person: The node responsible person can view and modify node information.

## Cluster Management

The cluster management module is divided into two modules: cluster label management and cluster management. Cluster label management is used to manage cluster labels, and cluster management is used to manage clusters.

### Cluster Tag Management

Cluster label management can add, delete, modify cluster labels, view the cluster list, bind clusters, etc.

![Cluster tag](img/cluster-tag.png)

#### Add New Cluster Label

![add_cluster_tag](img/add-cluster-tag.png)

- Cluster label: The brief name of the label, which must be composed of lowercase letters, numbers, and underscores. Modifying the cluster label name will also modify the label names in all clusters bound to this label. Make sure that this label is not used by InlongGroup. .
- Person in charge: The person in charge can view and modify cluster label information.
- Tenant: Select the tenant to be bound.

#### Bind Cluster

![Bind cluster](img/bind-cluster.png)

![detail bind cluster](img/detail-bind-cluster.png)

- Cluster name: When the cluster list is empty, you need to go to the cluster management page to create the required cluster so that the cluster label can be bound to the cluster.

### Cluster Management

Cluster management can add, delete, modify clusters, view the cluster list, view cluster details, view cluster nodes, etc.

#### Create New Cluster

Click [New Cluster] and a dialog box for creating a new cluster will pop up. You can choose different cluster types, such as Agent, Kafka, etc.

![create cluster](img/create-cluster.png)

![cluster detail](img/cluster-detail.png)

- Cluster name: The brief name of the cluster, which must be composed of lowercase letters, numbers, and underscores.
- Cluster type: Select the type of cluster.
- Person in charge: The person in charge of the cluster can view and modify the cluster information.
- Cluster label: Select the label to be bound.
Binary file added docs/user_guide/img/add-cluster-tag.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user_guide/img/bind-cluster.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user_guide/img/cluster-detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user_guide/img/cluster-tag.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user_guide/img/create-cluster.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user_guide/img/create-node-type.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user_guide/img/create-node.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user_guide/img/create-sync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user_guide/img/detail-bind-cluster.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user_guide/img/offline-sync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user_guide/img/realtime-sync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -124,4 +124,103 @@ HIVE流向:
- 数据用途:选择数据使用用途
- 数据用途说明:需申请人根据自身消费场景,简要说明使用的项目和数据的用途

信息填完完成后,点击【提交】后,会将次数据消费流程正式提交待审批人审批后方可生效。
信息填完完成后,点击【提交】后,会将次数据消费流程正式提交待审批人审批后方可生效。

## 数据同步

数据同步模块展示目前用户权限内同步系统所有任务列表,可以对这些任务详情查看、编辑更新和删除操作。
点击【新建数据同步】,进入数据同步流程,需要对同步信息相关信息进行填写,可选择两种同步类型:实时或者离线。

![Create sync](img/create-sync.png)

### 基础信息

- 数据流组 ID:同步任务的简要名称,必须是小写字母、数字、下划线组成。
- 责任人:责任人可查看、修改同步信息。
- 整库迁移:根据自身需求是否选择是否需要进行整库迁移。
-
#### 实时同步

填写好相关基础信息之后即可进行下一步

![Realtime sync](img/realtime-sync.png)

#### 离线同步

填写好相关基础信息后,还需要填写离线同步相关信息,比如:调度规则、依赖配置。

![Offline sync](img/offline-sync.png)

调度类型:根据自身需求选择常规或者Crontab类型。

##### 常规类型

- 调度单位:根据自身需求选择分钟、小时、天、周等。
- 调度周期:根据自身需求选择周期,其单位根据调度单位的选择决定。
- 延迟时间:填写需要的延迟时间。
- 有效时间:配置离线规则的有效时间。

##### Crontab类型

- 有效时间: 可填写时间区间,格式为:2021-01-01 00:00-2021-12-31 23:59
- Crontab 表达式:根据自身需求填写Crontab表达式。

## 数据节点

数据节点模块展示目前用户权限内数据节点列表,可以对这些节点详情查看、编辑更新和删除操作。
点击【新建】,弹出新建节点的对话框,可选择不同的节点类型,比如:Redis,Kafka,MySQL等。

![Create node](img/create-node.png)

![create note type](img/create-node-type.png)

- 节点名称:节点的简要名称,必须是小写字母、数字、下划线组成。
- 节点类型:选择节点的类型。
- 责任人:节点责任人可查看、修改节点信息。

## 集群管理

集群管理模块分为集群标签管理和集群管理两个模块,集群标签管理用于管理集群标签,集群管理用于管理集群。

### 标签管理

集群标签管理可以对集群标签进行新增、删除、修改以及查看集群列表、绑定集群等操作

![Cluster tag](img/cluster-tag.png)

#### 新增集群标签

![add_cluster_tag](img/add-cluster-tag.png)

- 集群标签:标签的简要名称,必须是小写字母、数字、下划线组成,修改集群标签名称,会同时修改所有绑定了此标签的集群中的标签名,且需确保此标签没有被 InlongGroup 所使。
- 负责人:负责人可查看、修改集群标签信息。
- 租户:选择需要绑定的租户。

#### 绑定集群

![Bind cluster](img/bind-cluster.png)

![detail bind cluster](img/detail-bind-cluster.png)

- 集群名称:当集群列表为空时,需要去集群管理页面创建需要的集群,集群标签才能绑定集群

### 集群管理

集群管理可以对集群进行新增、删除、修改以及查看集群列表、查看集群详情、查看集群节点等操作

#### 新建集群

点击【新建集群】 ,弹出新建集群的对话框,可选择不同的集群类型,比如:Agent,Kafka等。

![create cluster](img/create-cluster.png)

![cluster detail](img/cluster-detail.png)

- 集群名称:集群的简要名称,必须是小写字母、数字、下划线组成。
- 集群类型:选择集群的类型。
- 负责人:集群责任人可查看、修改集群信息。
- 集群标签:选择需要绑定的标签。




Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading