This is an automated email from the ASF dual-hosted git repository.
dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new 98f1840beb [INLONG-691][Doc] Optimize the Manager and Dashboard
deployment guide (#692)
98f1840beb is described below
commit 98f1840beb41cb0e80a77072dc04bbb85dd119e0
Author: Charles Zhang <[email protected]>
AuthorDate: Fri Feb 24 09:57:09 2023 +0800
[INLONG-691][Doc] Optimize the Manager and Dashboard deployment guide (#692)
---
docs/deployment/img/create_pulsar_cluster.png | Bin 55846 -> 86516 bytes
docs/deployment/standalone.md | 4 +-
docs/modules/dashboard/quick_start.md | 50 +++++++++++++--------
docs/modules/manager/img/create_cluster_tag.png | Bin 0 -> 22127 bytes
docs/modules/manager/img/pulsar_cluster.png | Bin 49524 -> 0 bytes
docs/modules/manager/quick_start.md | 44 ++++++++++--------
.../current/deployment/standalone.md | 4 +-
.../current/modules/dashboard/quick_start.md | 50 +++++++++++++--------
.../modules/manager/img/create_cluster_tag.png | Bin 0 -> 23246 bytes
.../modules/manager/img/pulsar_cluster_cn.png | Bin 41978 -> 0 bytes
...cluster_save_cn.png => pulsar_cluster_save.png} | Bin
...e_cluster_save_cn.png => tube_cluster_save.png} | Bin
.../current/modules/manager/quick_start.md | 44 ++++++++++--------
13 files changed, 117 insertions(+), 79 deletions(-)
diff --git a/docs/deployment/img/create_pulsar_cluster.png
b/docs/deployment/img/create_pulsar_cluster.png
index 456cea0c46..b91eb82ea4 100644
Binary files a/docs/deployment/img/create_pulsar_cluster.png and
b/docs/deployment/img/create_pulsar_cluster.png differ
diff --git a/docs/deployment/standalone.md b/docs/deployment/standalone.md
index 170c7a4f99..d594b371aa 100644
--- a/docs/deployment/standalone.md
+++ b/docs/deployment/standalone.md
@@ -41,8 +41,8 @@ spring_datasource_port=3306
spring_datasource_username=root
spring_datasource_password=inlong
# Configure Pulsar Address if use Pulsar for Audit
-pulsar_service_url=pulsar://172.17.0.2:6650
-pulsar_admin_url=http://172.17.0.2:8080
+pulsar_service_url=
+pulsar_admin_url=
# the REST server address for Flink
flink_rest_address=
# the REST server Port for Flink
diff --git a/docs/modules/dashboard/quick_start.md
b/docs/modules/dashboard/quick_start.md
index 87fef91c93..470dac9947 100644
--- a/docs/modules/dashboard/quick_start.md
+++ b/docs/modules/dashboard/quick_start.md
@@ -1,20 +1,32 @@
----
-title: Deployment
-sidebar_position: 2
----
-
-## Prepare Docker Image
-pull image from central hub：
-```
-docker pull inlong/dashboard:latest
-```
-or build image from source：
-```
-mvn package -DskipTests -Pdocker -pl inlong-dashboard
-```
-
-## Run
-```
-# MANAGER_API_ADDRESS must be replaced by inlong-manager address
-docker run -d --name dashboard -e MANAGER_API_ADDRESS=127.0.0.1:8083 -p 80:80
inlong/dashboard
+---
+title: Deployment
+sidebar_position: 2
+---
+
+## Option 1 : Dashboard in Docker
+### Prepare Docker Image
+pull image from central hub：
+```
+docker pull inlong/dashboard:latest
+```
+
+### Run
+```
+# MANAGER_API_ADDRESS must be replaced by inlong-manager address
+docker run -d --name dashboard -e MANAGER_API_ADDRESS=127.0.0.1:8083 -p 80:80
inlong/dashboard
+```
+
+## Option 2 : Dashboard in Nginx
+For example, please replace the value according to the path of
`inlong-dashboard` and the manager service address:
+```
+server {
+listen 80;
+listen [::]:80;
+server_name _;
+root ${dashboard_installed_path};
+# API prefix of InlongManager
+location /inlong/manager {
+proxy_pass http://{manager_api_address};
+}
+}
```
\ No newline at end of file
diff --git a/docs/modules/manager/img/create_cluster_tag.png
b/docs/modules/manager/img/create_cluster_tag.png
new file mode 100644
index 0000000000..8fb4d7e16f
Binary files /dev/null and b/docs/modules/manager/img/create_cluster_tag.png
differ
diff --git a/docs/modules/manager/img/pulsar_cluster.png
b/docs/modules/manager/img/pulsar_cluster.png
deleted file mode 100644
index 57a682eebe..0000000000
Binary files a/docs/modules/manager/img/pulsar_cluster.png and /dev/null differ
diff --git a/docs/modules/manager/quick_start.md
b/docs/modules/manager/quick_start.md
index 1dc0bffdeb..5a9d918375 100644
--- a/docs/modules/manager/quick_start.md
+++ b/docs/modules/manager/quick_start.md
@@ -62,34 +62,40 @@ metrics.audit.proxy.hosts=127.0.0.1:10081
bash +x bin/startup.sh
```
-## Register MQ Cluster
-
-### Pulsar Cluster
-
-If you use Pulsar as the message queue for data cache, you need to add its
configuration to InLong-Manager:
-
-Open the Inlong-Dashboard page (the default is <http://127.0.0.1>), and select
to add a Pulsar cluster on the [Clusters] tab:
-
-
+## Cluster Initialize
+When all containers are successfully started, you can access the Inlong
dashboard address `http: // localhost`, and use the following default account
to log in:
+```
+User: admin
+Password: inlong
+```
-Click the [Create] button, and fill in the required information such as
cluster name, cluster tag, responsible person, AdminUrl, ServiceUrl and default
tenant in the pop-up box to save.
+### Create Cluster Tag
+Click [Clusters]->[ClusterTags]->[Create] on the page to specify the cluster
label name and person in charge:
+
-> Note: [Cluster Tag] is a logical concept. Tags with the same name will be
regarded as the same cluster.
->
-> For example, the DataProxy cluster and the Pulsar cluster with the same
cluster tag belong to the same cluster.
+:::caution
+Since each component reports the ClusterTags as `default_cluster` by default,
do not use other names.
+:::
-Fill in the example:
+### Register MQ Cluster
+You could only Register the MQ type you chose.
+- Option 1: Register Pulsar Cluster
+Click [Clusters]->[ClusterTags]->[Create] on the page to register Pulsar
Cluster:
-### TubeMQ Cluster
-
-If you use InLong TubeMQ as the message queue for data cache, you need to add
its configuration to InLong-Manager:
-
-Similar to the above entry for adding a Pulsar cluster, the filling example is
as follows:
+:::note
+The ClusterTags selects the newly created `default_cluster`, and then
configuring the Pulsar cluster info.
+:::
+- Option 2: Register TubeMQ Cluster
+Click [Clusters]->[ClusterTags]->[Create] on the page to register TubeMQ
Cluster:
+:::note
+The ClusterTags selects the newly created `default_cluster`, and then
configuring the TubeMQ cluster info.
+:::
+
## (Optional) Enable OpenAPI Authentication
### Enable Authentication
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/standalone.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/standalone.md
index 6cf3979ffd..c2f2d82f32 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/standalone.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/standalone.md
@@ -41,8 +41,8 @@ spring_datasource_port=3306
spring_datasource_username=root
spring_datasource_password=inlong
# 配置 Pulsar 集群地址，如果 Audit 使用 Pulsar
-pulsar_service_url=pulsar://172.17.0.2:6650
-pulsar_admin_url=http://172.17.0.2:8080
+pulsar_service_url=
+pulsar_admin_url=
# Flink REST server 地址
flink_rest_address=
# Flink REST server 端口
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dashboard/quick_start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dashboard/quick_start.md
index fe0a2d9e7e..14d00bcdec 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dashboard/quick_start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dashboard/quick_start.md
@@ -1,20 +1,32 @@
----
-title: 安装部署
-sidebar_position: 2
----
-
-## 准备镜像
-从仓库拉起最新镜像：
-```
-docker pull inlong/dashboard:latest
-```
-或者从源码编译镜像：
-```
-mvn package -DskipTests -Pdocker -pl inlong-dashboard
-```
-
-## 运行
-```
-# MANAGER_API_ADDRESS 环境变量 使用inlong-manager 部署地址替换
-docker run -d --name dashboard -e MANAGER_API_ADDRESS=127.0.0.1:8083 -p 80:80
inlong/dashboard
+---
+title: 安装部署
+sidebar_position: 2
+---
+
+## 选择 1：Docker 部署
+### 准备镜像
+从仓库拉起最新镜像：
+```
+docker pull inlong/dashboard:latest
+```
+
+### 运行
+```
+# MANAGER_API_ADDRESS 环境变量 使用inlong-manager 部署地址替换
+docker run -d --name dashboard -e MANAGER_API_ADDRESS=127.0.0.1:8083 -p 80:80
inlong/dashboard
+```
+
+## 选择 2：Nginx 部署
+例如，修改 `inlong-dashboard` 安装路径和 Manager 服务地址。
+```
+server {
+listen 80;
+listen [::]:80;
+server_name _;
+root ${dashboard_installed_path};
+# API prefix of InlongManager
+location /inlong/manager {
+proxy_pass http://{manager_api_address};
+}
+}
```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/create_cluster_tag.png
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/create_cluster_tag.png
new file mode 100644
index 0000000000..8dc5f2d417
Binary files /dev/null and
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/create_cluster_tag.png
differ
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/pulsar_cluster_cn.png
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/pulsar_cluster_cn.png
deleted file mode 100644
index b883c47e19..0000000000
Binary files
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/pulsar_cluster_cn.png
and /dev/null differ
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/pulsar_cluster_save_cn.png
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/pulsar_cluster_save.png
similarity index 100%
rename from
i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/pulsar_cluster_save_cn.png
rename to
i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/pulsar_cluster_save.png
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/tube_cluster_save_cn.png
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/tube_cluster_save.png
similarity index 100%
rename from
i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/tube_cluster_save_cn.png
rename to
i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/img/tube_cluster_save.png
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md
index f310df5a7d..d240672b03 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md
@@ -61,31 +61,39 @@ metrics.audit.proxy.hosts=127.0.0.1:10081
bash +x bin/startup.sh
```
-## 注册 MQ 集群
-
-### Pulsar 集群
-
-若使用 Pulsar 作为数据缓存的消息队列，则需要添加其配置到 InLong-Manager 中：
-
-打开 Inlong-Dashboard 页面（默认是 <http://127.0.0.1>），在 [集群管理] 页签中选择添加 Pulsar 集群：
-
-
-
-点击 [新建集群] 按钮，在弹出的框中填写 集群名称、集群标签、责任人、AdminUrl、ServiceUrl 及默认租户等必填信息即可保存。
+## 集群初始化
+当所有容器都成功启动后，可以访问 InLong Dashboard 地址`http://localhost`，并使用以下默认账号登录:
+```
+User: admin
+Password: inlong
+```
-> 说明：[集群标签] 是一个逻辑概念，同名的标签将被视为同一套集群，比如相同集群标签的 DataProxy 集群和 Pulsar 集群，属于同一套集群。
+### 创建集群标签
+页面点击 [集群管理]->[标签管理]->[新建]，指定集群标签名称和负责人：
+
-填写示例：
+:::caution
+由于各个组件默认上报集群标签为 `default_cluster`，请勿使用其它名称。
+:::
-
+### 注册 MQ 集群
+只用注册你选择的 MQ 类型集群。
-### TubeMQ 集群
+- 选择 1：注册 Pulsar 集群
+页面点击 [集群管理]->[集群管理]->[新建集群]，注册 Pulsar 集群：
+
-若使用 InLong TubeMQ 作为数据缓存的消息队列，则需要添加其配置到 InLong-Manager 中：
+:::note
+集群标签选择刚创建的 `default_cluster`，然后配置 Pulsar 集群信息。
+:::
-与上述 Pulsar 集群的添加入口相似，填写示例如下：
+- 选择 2：注册 TubeMQ 集群
+页面点击 [集群管理]->[集群管理]->[新建集群]，注册 TubeMQ 集群：
+
-
+:::note
+集群标签选择刚创建的 `default_cluster`，然后配置 TubeMQ 集群信息。
+:::
## (可选) 开启OpenAPI认证
