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-1095][Release] Create the 2.1.0 version document #1098

Merged
merged 2 commits into from
Jan 15, 2025
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion docs/version.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export const siteVariables = {
inLongVersion: '2.1.0-SNAPSHOT',
inLongVersion: '2.2.0-SNAPSHOT',
};
6 changes: 3 additions & 3 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -82,12 +82,12 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
to: "/docs/next/introduction",
},
{
label: "2.0.0",
label: "2.1.0",
to: "/docs/introduction",
},
{
label: "1.13.0",
to:"/docs/1.13.0/introduction",
label: "2.0.0",
to:"/docs/2.0.0/introduction",
},
{
label: "All versions",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export const siteVariables = {
inLongVersion: '2.1.0-SNAPSHOT',
inLongVersion: '2.2.0-SNAPSHOT',
};
150 changes: 150 additions & 0 deletions i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1.0.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
{
"version.label": {
"message": "Next",
"description": "The label for version current"
},
"sidebar.tutorialSidebar.category.Design and Concept": {
"message": "设计和概念",
"description": "The label for category Design and Concept in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Quick Start": {
"message": "快速开始",
"description": "The label for category Quick Start in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Data Ingestion": {
"message": "数据接入",
"description": "The label for category Data Ingestion in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Realtime Data Synchronization": {
"message": "实时数据同步",
"description": "The label for category Data Synchronization in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Offline Data Synchronization": {
"message": "离线数据同步",
"description": "The label for category Offline Data Synchronization in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.HTTP Report": {
"message": "HTTP 消息上报",
"description": "The label for category HTTP Report in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Data Subscription": {
"message": "数据订阅",
"description": "The label for category Data Subscription in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Transform": {
"message": "Transform",
"description": "The label for category Transform in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Deployment": {
"message": "安装部署",
"description": "The label for category Deployment in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Components": {
"message": "组件介绍",
"description": "The label for category Components in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Agent": {
"message": "Agent",
"description": "The label for category Agent in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.DataProxy": {
"message": "DataProxy",
"description": "The label for category DataProxy in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.TubeMQ": {
"message": "TubeMQ",
"description": "The label for category TubeMQ in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Sort": {
"message": "Sort",
"description": "The label for category Sort in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Manager": {
"message": "Manager",
"description": "The label for category Manager in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Dashboard": {
"message": "Dashboard",
"description": "The label for category Dashboard in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Sort Standalone": {
"message": "Sort Standalone",
"description": "The label for category Sort Standalone in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Audit": {
"message": "Audit",
"description": "The label for category Audit in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.tubemq-manager": {
"message": "tubemq-manager",
"description": "The label for category tubemq-manager in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Data Nodes": {
"message": "数据节点",
"description": "The label for category Data Nodes in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Extract Nodes": {
"message": "Extract Nodes",
"description": "The label for category Extract Nodes in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Load Nodes": {
"message": "Load Nodes",
"description": "The label for category Load Nodes in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.SDK": {
"message": "SDK",
"description": "The label for category SDK in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.DataProxy SDK": {
"message": "DataProxy SDK",
"description": "The label for category DataProxy SDK in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Manager SDK": {
"message": "Manager SDK",
"description": "The label for category Manager SDK in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.TubeMQ SDK": {
"message": "TubeMQ SDK",
"description": "The label for category TubeMQ SDK in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.User Guide": {
"message": "用户指引",
"description": "The label for category User Guide in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Development": {
"message": "开发指引",
"description": "The label for category Development in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Binary Protocol": {
"message": "数据协议",
"description": "The label for Binary Protocol in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Agent Plugins Extension": {
"message": "Agent 插件扩展",
"description": "The label for Agent Plugins Extension in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.DataProxy Plugins Extension": {
"message": "DataProxy 插件扩展",
"description": "The label for DataProxy Plugins Extension in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Manager Plugins Extension": {
"message": "Manager 插件扩展",
"description": "The label for Manager Plugins Extension in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Sort Plugins Extension": {
"message": "Sort 插件扩展",
"description": "The label for Sort Plugins Extension in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Transform Plugins Extension": {
"message": "Transform 插件扩展",
"description": "The label for Transform Plugins Extension in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Dashboard Plugins Extension": {
"message": "Dashboard 插件扩展",
"description": "The label for Dashboard Plugins Extension in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Administration": {
"message": "Administration",
"description": "The label for Administration in sidebar tutorialSidebar"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
title: Agent 管理
sidebar_position: 8
---

## 概述
平台实现了 Agent 的界面化管理能力,支持在界面进行 Agent 的安装包管理、版本管理、安装操作、卸载操作、升级操作、重启操作等,并且支持批量操作的能力。

## 安装包管理
安装包管理主要是对安装包的名称、地址、MD5 的管理。
### 新增
如图所示在 "系统运维-安装包" 点击 "新建 Package" 进行安装包新建:
![](img/agent_package_new.png)
文件名称:Agent 安装包名称

下载地址:安装包的下载地址,我们是通过 wget 来下载安装包。

MD5:安装包文件的 MD5 值,用于下载完成后校验安装包是否有损坏。

存储路径:安装包下载完成后的存放路径。

### 修改、删除
点击 "详情" 即可进行 Agent 的修改;点击 "删除" 即可进行安装包删除。
![](img/agent_package_modify_delete.png)

### Installer
Installer 是 Agent 的守护进程,实际上我们在业务机器上同时装了 Installer 和 Agent 两个进程。Installer 的安装包、版本管理和 Agent 一样。

## 版本管理
版本管理是基于安装包管理之上的,主要是管理这个安装包所需的安装、检查、启动、停止命令。
### 新增
如图所示在 "系统运维-版本管理" 点击 "新建 module" 进行版本新建:
![](img/agent_version_new.png)
名称:版本名称。

版本:版本号,需要遵循 X.X.X 三段式规范,并且只能是数字。

安装包:选择该版本对应的安装包。

检查命令:用于检测进程是否存在的命令。

启动命令:用于启动进程。

停止命令:用于停止进程。

卸载命令:用于卸载 Agent。

### 修改、删除
点击 "详情" 即可进行版本修改;点击 "删除" 即可进行版本删除。
![](img/agent_version_modify_delete.png)


## Agent 安装
如图所示在集群管理里找到 Agent 集群后,选择新建节点:
![](img/agent_install.png)
IP:要安装 Agent 的机器的 IP。

协议类型:标识 Agent 与 Manager 交互所用协议类型,如果是同一个局域网的我们选择 HTTP;如果是需要跨公网传输的就选择 HTTPS。

版本:选择 Agent 的版本。

安装方式:如果要平台自动安装,请选择 SSH 安装,并且一般是通过 SSH 密码安装。

SSH 用户名:SSH 登录用户名

SSH 密码:SSH 登录密码

SSH 端口:SSH 端口号

填写完成后可以点击 "测试连接" 按钮测试 SSH 登录是否成功。
点击 "保存" 按钮后即可进行自动安装。
## 修改、删除
点击 "编辑" 即可进行 Agent 节点修改;点击 "删除" 即可进行 Agent 节点删除。
![](img/agent_modify_delete.png)

## 批量操作
如图所示,我们可以选择多个 Agent 节点,然后点击 "批量操作" 按钮进行批量操作。
![](img/agent_batch.png)
分批:我们可以进行分批操作,这个是分的批次。

间隔:每个批次之间的时间间隔。

操作类型:对这批节点要进行的操作,

版本:Agent 版本。

Installer:Installer 版本。
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: 审批管理
sidebar_position: 2
---

作为具有审批权限的数据接入员和系统成员,具备对数据接入或者消费审批职责:

![](img/approval-list.png)

#### 数据接入审批

新建数据接入审批:目前为一级审批,由系统管理员审批。

系统管理员将根据数据接入业务信息,审核此次接入流程是否符合接入要求:

![](img/approval-access.png)

#### 新建数据消费审批

新建数据消费审批:目前为一级审批,由业务负责人审批。

业务审批:由数据接入业务负责人根据接入信息判断此消费是否符合业务要求:

![](img/approval-consumption.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: 集群管理
sidebar_position: 5
---

角色为系统管理员或者租户管理员的用户才可以使用此功能,他们可以创建、修改、删除集群。

### 新建集群

具有系统管理员或者租户管理员权限用户,可以进行创建新集群:

![](img/create_cluster.png)

- 集群名称:用户自定义名,用来标识此集群信息
- 类型:集群类型
- 集群标签:该集群所属集群标签
- 责任人:该集群负责人,只有责任人能够修改该集群的配置信息
- 集群描述:集群描述信息

以上为集群的公用配置,另外,根据不同的集群类型,还会有不同的配置信息,如 Pulsar 集群需要填写 Service URL、AdminURL、默认租户、token 等信息。

### 删除集群

系统管理员或者租户管理员权限可以对已创建的集群进行删除,删除后此集群将停止使用:

![](img/delete_cluster.png)

### 修改集群

系统管理员或者租户管理员可以修改已创建的集群:

![](img/update_cluster.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
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
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.
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: 租户管理
sidebar_position: 3
---

## 总览

多租户(Multi-tenancy)是一种软件架构模式,允许一个应用程序同时为多个独立的用户或组织(称为“租户”)提供服务。
在这种模式下,每个租户在逻辑上是相互隔离的,但共享相同的底层软件基础设施和资源。
这意味着同一个应用程序实例可以为多个租户提供服务,而无需为每个租户单独部署和维护应用程序。
为了解决多用户场景下对于权限和资源隔离性的要求,InLong 在 1.8.0 版本引入了多租户架构。

InLong多租户实现可以参考:
https://github.com/apache/inlong/issues/7914

:::caution
- 不同租户之间资源和权限互相隔离,用户只能看到该租户下的资源。
- 从低版本升级至 1.8.0 版本后,所有资源会被迁移到公共租户 `public` 下。
:::

## 创建租户

- 选择`租户管理`,点击`新建角色`
![img.png](img/create_tenant_1.png)
- 选择`新建租户`
![img_1.png](img/create_tenant_2.png)
- 完善`租户名称`和`描述`,点击`确定`,则完成租户的创建
![img.png](img/create_tenant_3.png)
至此完成了租户的创建

:::caution
目前只允许 `InLong 管理员`来进行租户的创建和修改操作。
:::

## 创建租户角色

- 选择`租户管理`,点击`新建角色`
![img.png](img/create_tenant_1.png)
- 选则`目标租户`,`用户名称`,和想要授予的`租户角色`(如果租户不存在,请参考 [创建租户](#创建租户))
![img.png](img/create_tenant_role_1.png)
- 创建成功后,可以在`租户管理`界面看到名下的租户以及对应的用户角色
![img.png](img/create_tenant_role_2.png)

## 租户切换

- 点击右上角`租户`字段,可以选择切换到名下拥有的租户
![img.png](img/create_tenant_role_3.png)

Loading
Loading