You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by do...@apache.org on 2022/11/11 09:22:20 UTC

[inlong-website] branch master updated: [INLONG-6475][Docker] Refactor the docker-compose guide after add a base flink environment (#593)

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 f5bcb5d118 [INLONG-6475][Docker] Refactor the docker-compose guide after add a base flink environment (#593)
f5bcb5d118 is described below

commit f5bcb5d11888766424d004026a29427ec6d8d967
Author: Charles Zhang <do...@apache.org>
AuthorDate: Fri Nov 11 17:22:15 2022 +0800

    [INLONG-6475][Docker] Refactor the docker-compose guide after add a base flink environment (#593)
---
 docs/deployment/docker.md                          |  55 ++++++--------------
 docs/deployment/img/create_cluster_tag.png         | Bin 0 -> 22555 bytes
 docs/deployment/img/create_pulsar_cluster.png      | Bin 0 -> 55846 bytes
 docs/deployment/img/dp_cluster.png                 | Bin 50574 -> 0 bytes
 docs/deployment/img/dp_cluster_node.png            | Bin 48235 -> 0 bytes
 docs/deployment/img/dp_cluster_node_save.png       | Bin 37326 -> 0 bytes
 docs/deployment/img/pulsar_cluster_save.png        | Bin 34839 -> 0 bytes
 .../current/deployment/docker.md                   |  57 ++++++++-------------
 .../current/deployment/img/create_cluster_tag.png  | Bin 0 -> 23246 bytes
 .../deployment/img/create_pulsar_cluster.png       | Bin 0 -> 56981 bytes
 .../current/deployment/img/dp_cluster_cn.png       | Bin 42230 -> 0 bytes
 .../current/deployment/img/dp_cluster_node_cn.png  | Bin 50501 -> 0 bytes
 .../deployment/img/dp_cluster_node_save_cn.png     | Bin 51542 -> 0 bytes
 .../deployment/img/pulsar_cluster_save_cn.png      | Bin 40501 -> 0 bytes
 14 files changed, 35 insertions(+), 77 deletions(-)

diff --git a/docs/deployment/docker.md b/docs/deployment/docker.md
index b09bc08ba4..d47e60d916 100644
--- a/docs/deployment/docker.md
+++ b/docs/deployment/docker.md
@@ -5,67 +5,42 @@ sidebar_position: 2
 
 Deploy all InLong module by Docker Compose, it's only available for development. 
 
-*Notice: The default message queue is Apache Pulsar for Docker.*
+:::note
+The default message queue is [Apache Pulsar](https://pulsar.apache.org/docs/concepts-overview) for Docker.
 
 ## Environment Requirements
 - [Docker](https://docs.docker.com/engine/install/) 19.03.1+
 - Docker Compose 1.29.2+
-- Flink 1.13.5
 
 ## Download
 You can get `apache-inlong-[version]-bin.tar.gz` from [Download Page](https://inlong.apache.org/download) ,or you can build the InLong refer to [How to Build](quick_start/how_to_build.md).
 
-## Configure
-Replace the `FLINK_HOST` and `FLINK_PORT` environment variables in `docker/docker-compose/docker-compose.yml` refer to the Flink cluster address.
-
 ## Deploy
-
 Start all components.
-
 ```shell
 cd docker/docker-compose
 docker-compose up -d
 ```
+### Create Cluster Tag
+Click [Clusters]->[ClusterTags]->[Create] on the page to specify the cluster label name and person in charge:
+![](img/create_cluster_tag.png)
 
-## Register Cluster
-
-### DataProxy Cluster
-
-Open the Inlong-Dashboard page (the default is <http://127.0.0.1>), and select to add a DataProxy cluster on the [Clusters] tab:
-
-![](img/dp_cluster.png)
-
-Click the [Create] button, and fill in the cluster name, cluster label, and responsible person in the pop-up box to save.
-
-> 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.
-
-Then add nodes to this DataProxy cluster - a DataProxy cluster can support adding multiple nodes:
+:::caution
+Since each component reports the ClusterTags as 'default_cluster' by default, do not use other names.
 
-![](img/dp_cluster_node.png)
+### Register Pulsar Cluster
+Click [Clusters]->[ClusterTags]->[Create] on the page to register Pulsar Cluster:
+![](img/create_pulsar_cluster.png)
 
-Just fill in the IP and port of the DataProxy node.
+:::note
+The ClusterTags selects the newly created 'default_cluster', the Pulsar cluster deployed by docker:
 
-![](img/dp_cluster_node_save.png)
+Service URL is `pulsar://pulsar:6650`, Admin URL is `http://pulsar:8080`.
 
-### Pulsar Cluster
-
-Similar to the above entry for adding a DataProxy cluster, the filling example is as follows:
-
-![](img/pulsar_cluster_save.png)
-
-## Usage
-
-After all containers run successfully, you can access `http://localhost` with default account:
-
-```shell
-User: admin
-Password: inlong
-```
+### Create Data Stream
+You can refer [Pulsar Example](quick_start/pulsar_example.md) to create Data Stream.
 
 ## Destroy
-
 ```shell
 docker-compose down
 ```
diff --git a/docs/deployment/img/create_cluster_tag.png b/docs/deployment/img/create_cluster_tag.png
new file mode 100644
index 0000000000..cde903c4c1
Binary files /dev/null and b/docs/deployment/img/create_cluster_tag.png differ
diff --git a/docs/deployment/img/create_pulsar_cluster.png b/docs/deployment/img/create_pulsar_cluster.png
new file mode 100644
index 0000000000..456cea0c46
Binary files /dev/null and b/docs/deployment/img/create_pulsar_cluster.png differ
diff --git a/docs/deployment/img/dp_cluster.png b/docs/deployment/img/dp_cluster.png
deleted file mode 100644
index fc0fdf2e85..0000000000
Binary files a/docs/deployment/img/dp_cluster.png and /dev/null differ
diff --git a/docs/deployment/img/dp_cluster_node.png b/docs/deployment/img/dp_cluster_node.png
deleted file mode 100644
index cd15287d68..0000000000
Binary files a/docs/deployment/img/dp_cluster_node.png and /dev/null differ
diff --git a/docs/deployment/img/dp_cluster_node_save.png b/docs/deployment/img/dp_cluster_node_save.png
deleted file mode 100644
index b3a98bb4e1..0000000000
Binary files a/docs/deployment/img/dp_cluster_node_save.png and /dev/null differ
diff --git a/docs/deployment/img/pulsar_cluster_save.png b/docs/deployment/img/pulsar_cluster_save.png
deleted file mode 100644
index 261fd28294..0000000000
Binary files a/docs/deployment/img/pulsar_cluster_save.png and /dev/null differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/docker.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/docker.md
index 65ddcee29d..f7b7fd89ec 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/docker.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/docker.md
@@ -5,25 +5,17 @@ sidebar_position: 2
 
 通过 Docker Compose 部署 InLong,这种部署方式只适用于开发与调试,不适用于生产环境。
 
-*注意:Docker 部署默认使用 Apache Pulsar 作为消息队列服务。*
+:::note
+Docker 部署默认使用 [Apache Pulsar](https://pulsar.apache.org/docs/concepts-overview) 作为消息队列服务。
 
 ## 环境要求
 - [Docker](https://docs.docker.com/engine/install/) 19.03.1+
 - Docker Compose 1.29.2+
-- Flink 1.13.5
 
 ## 下载
 你可以从 [下载页面](https://inlong.apache.org/zh-CN/download/) 获取 `apache-inlong-[version]-bin.tar.gz`,或者参考 [How to Build](quick_start/how_to_build.md) 编译。
 
-## 配置
-根据 Flink 集群地址替换 `docker/docker-compose/docker-compose.yml` 中的 `FLINK_HOST` 和 `FLINK_PORT` 环境变量。
-
-## 编译
-
-可以参考[如何编译](quick_start/how_to_build.md).
-
 ## 部署
-
 启动所有组件:
 ```
 cd docker/docker-compose
@@ -31,41 +23,32 @@ docker-compose up -d
 ```
 
 ## 注册集群
+当所有容器都成功启动后,可以访问 InLong Dashboard 地址`http://localhost`,并使用以下默认账号登录:
+```
+User: admin
+Password: inlong
+```
 
-### DataProxy 集群
-
-打开 Inlong-Dashboard 页面(默认是 <http://127.0.0.1>),在 [集群管理] 页签中选择添加 DataProxy 集群:
-
-![](img/dp_cluster_cn.png)
-
-点击 [新建集群] 按钮,在弹出的框中填写 集群名称、集群标签、责任人 即可保存。
-
-> 说明:[集群标签] 是一个逻辑概念,同名的标签将被视为同一套集群,比如相同集群标签的 DataProxy 集群和 Pulsar 集群,属于同一套集群。
-
-然后为此 DataProxy 集群添加节点 —— 一个 DataProxy 集群可以支持添加多个节点:
-
-![](img/dp_cluster_node_cn.png)
-
-填写 DataProxy 节点的 IP 和端口即可。
-
-![](img/dp_cluster_node_save_cn.png)
+### 创建集群标签
+页面点击 [集群管理]->[标签管理]->[新建],指定集群标签名称和负责人:
+![](img/create_cluster_tag.png)
 
-### Pulsar 集群
+:::caution
+由于各个组件默认上报集群标签为 'default_cluster',请勿使用其它名称。
 
-与上述 DataProxy 集群的添加入口相似,填写示例如下:
+### 注册 Pulsar 集群
+页面点击 [集群管理]->[集群管理]->[新建集群],注册 Pulsar 集群:
+![](img/create_pulsar_cluster.png)
 
-![](img/pulsar_cluster_save_cn.png)
+:::note
+集群标签选择刚创建的 'default_cluster',docker 部署的 Pulsar 集群:
 
-## 使用
+Service URL 为 `pulsar://pulsar:6650`,Admin URL 为 `http://pulsar:8080`。
 
-当所有容器都成功启动后,可以访问 `http://localhost`,并使用以下默认账号登录:
-```
-User: admin
-Password: inlong
-```
+### 创建数据流
+创建数据流可以参考 [Pulsar Example](quick_start/pulsar_example.md).
 
 ## 销毁
-
 ```
 docker-compose down
 ```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/create_cluster_tag.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/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/deployment/img/create_cluster_tag.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/create_pulsar_cluster.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/create_pulsar_cluster.png
new file mode 100644
index 0000000000..b7b137ecfc
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/create_pulsar_cluster.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_cn.png
deleted file mode 100644
index e52e990f71..0000000000
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_cn.png and /dev/null differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_node_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_node_cn.png
deleted file mode 100644
index a69134a4b5..0000000000
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_node_cn.png and /dev/null differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_node_save_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_node_save_cn.png
deleted file mode 100644
index 60abfc889b..0000000000
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/dp_cluster_node_save_cn.png and /dev/null differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/pulsar_cluster_save_cn.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/pulsar_cluster_save_cn.png
deleted file mode 100644
index fd87faac42..0000000000
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/img/pulsar_cluster_save_cn.png and /dev/null differ