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 c577822d46 [INLONG-825][Doc] Add the quick start guide for collecting 
MySQL and writing to ClickHouse (#839)
c577822d46 is described below

commit c577822d4686266393b6fc3570bdcc813acb88ad
Author: Amelie <[email protected]>
AuthorDate: Thu Aug 24 17:20:59 2023 +0800

    [INLONG-825][Doc] Add the quick start guide for collecting MySQL and 
writing to ClickHouse (#839)
    
    Co-authored-by: joytzli <[email protected]>
    Co-authored-by: Charles Zhang <[email protected]>
---
 docs/quick_start/img/mysql_clickhouse/approval.png | Bin 0 -> 83618 bytes
 .../img/mysql_clickhouse/create_cluster_label.png  | Bin 0 -> 22127 bytes
 .../img/mysql_clickhouse/create_data_source.png    | Bin 0 -> 147936 bytes
 .../img/mysql_clickhouse/create_ingestion.png      | Bin 0 -> 159264 bytes
 .../img/mysql_clickhouse/create_sink.png           | Bin 0 -> 229676 bytes
 .../quick_start/img/mysql_clickhouse/data_page.png | Bin 0 -> 142836 bytes
 .../img/mysql_clickhouse/data_stream_config.png    | Bin 0 -> 169165 bytes
 .../img/mysql_clickhouse/data_table.png            | Bin 0 -> 11751 bytes
 docs/quick_start/img/mysql_clickhouse/datanode.png | Bin 0 -> 101757 bytes
 .../img/mysql_clickhouse/kafka_cluster.png         | Bin 0 -> 89194 bytes
 docs/quick_start/img/mysql_clickhouse/result.png   | Bin 0 -> 123659 bytes
 .../quick_start/img/mysql_clickhouse/send_data.png | Bin 0 -> 4877 bytes
 docs/quick_start/mysql_kafka_clickhouse_example.md |  89 +++++++++++++++++++++
 .../quick_start/img/mysql_clickhouse/approval.png  | Bin 0 -> 14554 bytes
 .../img/mysql_clickhouse/create_cluster_label.png  | Bin 0 -> 5211 bytes
 .../img/mysql_clickhouse/create_data_source.png    | Bin 0 -> 43896 bytes
 .../img/mysql_clickhouse/create_ingestion.png      | Bin 0 -> 42189 bytes
 .../img/mysql_clickhouse/create_sink.png           | Bin 0 -> 108070 bytes
 .../quick_start/img/mysql_clickhouse/data_page.png | Bin 0 -> 72009 bytes
 .../img/mysql_clickhouse/data_stream_config.png    | Bin 0 -> 49984 bytes
 .../img/mysql_clickhouse/data_table.png            | Bin 0 -> 11751 bytes
 .../quick_start/img/mysql_clickhouse/datanode.png  | Bin 0 -> 27843 bytes
 .../img/mysql_clickhouse/kafka_cluster.png         | Bin 0 -> 10461 bytes
 .../quick_start/img/mysql_clickhouse/result.png    | Bin 0 -> 28199 bytes
 .../quick_start/img/mysql_clickhouse/send_data.png | Bin 0 -> 4877 bytes
 .../quick_start/mysql_kafka_clickhouse_example.md  |  86 ++++++++++++++++++++
 26 files changed, 175 insertions(+)

diff --git a/docs/quick_start/img/mysql_clickhouse/approval.png 
b/docs/quick_start/img/mysql_clickhouse/approval.png
new file mode 100644
index 0000000000..10071397ce
Binary files /dev/null and b/docs/quick_start/img/mysql_clickhouse/approval.png 
differ
diff --git a/docs/quick_start/img/mysql_clickhouse/create_cluster_label.png 
b/docs/quick_start/img/mysql_clickhouse/create_cluster_label.png
new file mode 100644
index 0000000000..8fb4d7e16f
Binary files /dev/null and 
b/docs/quick_start/img/mysql_clickhouse/create_cluster_label.png differ
diff --git a/docs/quick_start/img/mysql_clickhouse/create_data_source.png 
b/docs/quick_start/img/mysql_clickhouse/create_data_source.png
new file mode 100644
index 0000000000..a4a143c9a9
Binary files /dev/null and 
b/docs/quick_start/img/mysql_clickhouse/create_data_source.png differ
diff --git a/docs/quick_start/img/mysql_clickhouse/create_ingestion.png 
b/docs/quick_start/img/mysql_clickhouse/create_ingestion.png
new file mode 100644
index 0000000000..8c6cbec226
Binary files /dev/null and 
b/docs/quick_start/img/mysql_clickhouse/create_ingestion.png differ
diff --git a/docs/quick_start/img/mysql_clickhouse/create_sink.png 
b/docs/quick_start/img/mysql_clickhouse/create_sink.png
new file mode 100644
index 0000000000..2b0b70ebbc
Binary files /dev/null and 
b/docs/quick_start/img/mysql_clickhouse/create_sink.png differ
diff --git a/docs/quick_start/img/mysql_clickhouse/data_page.png 
b/docs/quick_start/img/mysql_clickhouse/data_page.png
new file mode 100644
index 0000000000..b67ba707cc
Binary files /dev/null and 
b/docs/quick_start/img/mysql_clickhouse/data_page.png differ
diff --git a/docs/quick_start/img/mysql_clickhouse/data_stream_config.png 
b/docs/quick_start/img/mysql_clickhouse/data_stream_config.png
new file mode 100644
index 0000000000..69d02de9e4
Binary files /dev/null and 
b/docs/quick_start/img/mysql_clickhouse/data_stream_config.png differ
diff --git a/docs/quick_start/img/mysql_clickhouse/data_table.png 
b/docs/quick_start/img/mysql_clickhouse/data_table.png
new file mode 100644
index 0000000000..321406a4a2
Binary files /dev/null and 
b/docs/quick_start/img/mysql_clickhouse/data_table.png differ
diff --git a/docs/quick_start/img/mysql_clickhouse/datanode.png 
b/docs/quick_start/img/mysql_clickhouse/datanode.png
new file mode 100644
index 0000000000..47df5ca8ce
Binary files /dev/null and b/docs/quick_start/img/mysql_clickhouse/datanode.png 
differ
diff --git a/docs/quick_start/img/mysql_clickhouse/kafka_cluster.png 
b/docs/quick_start/img/mysql_clickhouse/kafka_cluster.png
new file mode 100644
index 0000000000..681677d13c
Binary files /dev/null and 
b/docs/quick_start/img/mysql_clickhouse/kafka_cluster.png differ
diff --git a/docs/quick_start/img/mysql_clickhouse/result.png 
b/docs/quick_start/img/mysql_clickhouse/result.png
new file mode 100644
index 0000000000..a9c3d91078
Binary files /dev/null and b/docs/quick_start/img/mysql_clickhouse/result.png 
differ
diff --git a/docs/quick_start/img/mysql_clickhouse/send_data.png 
b/docs/quick_start/img/mysql_clickhouse/send_data.png
new file mode 100644
index 0000000000..2879b84b5d
Binary files /dev/null and 
b/docs/quick_start/img/mysql_clickhouse/send_data.png differ
diff --git a/docs/quick_start/mysql_kafka_clickhouse_example.md 
b/docs/quick_start/mysql_kafka_clickhouse_example.md
new file mode 100644
index 0000000000..8a32c268c5
--- /dev/null
+++ b/docs/quick_start/mysql_kafka_clickhouse_example.md
@@ -0,0 +1,89 @@
+---
+title: MySQL -> Kafka -> ClickHouse Example
+sidebar_position: 5
+---
+
+Here we use an example to introduce how to use Apache InLong creating MySQL -> 
Kafka -> ClickHouse data ingestion.
+
+## Deployment
+### Install InLong
+
+Before we begin, we need to install InLong. Here we provide two ways:
+1. Install InLong with Docker by according to the [instructions 
here](deployment/docker.md).(Recommanded)
+2. Install InLong binary according to the [instructions 
here](deployment/bare_metal.md).
+
+### Install ClickHouse
+```shell
+docker run -d --rm --net=host --name clickhouse -e CLICKHOUSE_USER=admin -e 
CLICKHOUSE_PASSWORD=inlong -e CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT=1 
clickhouse/clickhouse-server:22.8
+```
+
+### Install Kafka
+```shell
+# Prepare zookeeper for Kafka
+docker run -d --name zookeeper -p 2181:2181 -t wurstmeister/zookeeper
+# Install Kafka 
+docker run -d --name kafka -p 9092:9092 -e KAFKA_BROKER_ID=0 -e 
KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181 --link zookeeper -e 
KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092 -e 
KAFKA_LISTENERS=PLAINTEXT://0.0.0.0:9092 -t wurstmeister/kafka
+```
+
+## 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
+```
+
+### Create Cluster Tag
+Click [Clusters] -> [ClusterTags] -> [Create] on the page to specify the 
cluster label name and person in charge.
+![Create Cluster label](img/mysql_clickhouse/create_cluster_label.png)
+
+:::caution
+Since each component reports the ClusterTags as `default_cluster` by default, 
do not use other names.
+:::
+
+### Register Kafka Cluster
+Click [Clusters] -> [Create] on the page to register Kafka Cluster.
+![Create kafka cluster](img/mysql_clickhouse/kafka_cluster.png)
+
+### Register Clickhouse DataNodes
+Click [DataNodes] -> [Create] on the page to register ClickHouse DataNodes.
+![Create kafka cluster](img/mysql_clickhouse/datanode.png)
+
+## Create Task
+### Create Data Streams Group
+Click [Ingestion] -> [Create], input ID and select Kafka MQ Type.
+![Create datastream](img/mysql_clickhouse/create_ingestion.png)
+
+### Create Data Stream
+Click [Next] -> [Create], config data stream.
+![Create datastream](img/mysql_clickhouse/data_stream_config.png)
+
+### Create Data Source
+Click [Sources create] -> [MySQL], config data source informations.
+![Create datastream](img/mysql_clickhouse/create_data_source.png)
+
+### Create Data Sink
+Click [Sinks create] -> [ClickHouse], input Name, DbName, TableName and select 
created ck DataNode and so on, then click [save].
+![Create data object](img/mysql_clickhouse/create_sink.png)
+
+### Approve Data Stream
+Click [Approval] -> [MyApproval] -> [Detail] -> [Select Cluster tag] -> [Ok].
+![clickhouse](img/mysql_clickhouse/approval.png)
+
+Back to [Ingestion] page, wait for [configuration success].
+![clickhouse](img/mysql_clickhouse/result.png)
+
+## Test Data
+### Send Data
+![clickhouse](img/mysql_clickhouse/send_data.png)
+Add 1001 datas to MySQL.
+
+### Verify Data
+Check data in [Audit] page.
+![clickhouse](img/mysql_clickhouse/data_page.png)
+
+then enter ClickHouse container, check data in table.
+![clickhouse](img/mysql_clickhouse/data_table.png)
+
+## Questions
+### Task Configuration Failed
+Generally, the MQ or Flink group configuration is incorrect. You can view the 
error information on the page, or enter the Manager container to view detailed 
logs.
\ No newline at end of file
diff --git 
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/approval.png
 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/approval.png
new file mode 100644
index 0000000000..53c52e8ba5
Binary files /dev/null and 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/approval.png
 differ
diff --git 
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/create_cluster_label.png
 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/create_cluster_label.png
new file mode 100644
index 0000000000..34abe0b592
Binary files /dev/null and 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/create_cluster_label.png
 differ
diff --git 
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/create_data_source.png
 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/create_data_source.png
new file mode 100644
index 0000000000..7932e1d67a
Binary files /dev/null and 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/create_data_source.png
 differ
diff --git 
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/create_ingestion.png
 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/create_ingestion.png
new file mode 100644
index 0000000000..d400d57fc0
Binary files /dev/null and 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/create_ingestion.png
 differ
diff --git 
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/create_sink.png
 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/create_sink.png
new file mode 100644
index 0000000000..006f1870ba
Binary files /dev/null and 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/create_sink.png
 differ
diff --git 
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/data_page.png
 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/data_page.png
new file mode 100644
index 0000000000..c81121f715
Binary files /dev/null and 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/data_page.png
 differ
diff --git 
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/data_stream_config.png
 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/data_stream_config.png
new file mode 100644
index 0000000000..be2db9024c
Binary files /dev/null and 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/data_stream_config.png
 differ
diff --git 
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/data_table.png
 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/data_table.png
new file mode 100644
index 0000000000..321406a4a2
Binary files /dev/null and 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/data_table.png
 differ
diff --git 
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/datanode.png
 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/datanode.png
new file mode 100644
index 0000000000..1b7e77b239
Binary files /dev/null and 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/datanode.png
 differ
diff --git 
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/kafka_cluster.png
 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/kafka_cluster.png
new file mode 100644
index 0000000000..9d750f7f95
Binary files /dev/null and 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/kafka_cluster.png
 differ
diff --git 
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/result.png
 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/result.png
new file mode 100644
index 0000000000..ddd99d487d
Binary files /dev/null and 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/result.png
 differ
diff --git 
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/send_data.png
 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/send_data.png
new file mode 100644
index 0000000000..2879b84b5d
Binary files /dev/null and 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/img/mysql_clickhouse/send_data.png
 differ
diff --git 
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/mysql_kafka_clickhouse_example.md
 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/mysql_kafka_clickhouse_example.md
new file mode 100644
index 0000000000..a6021a5053
--- /dev/null
+++ 
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/mysql_kafka_clickhouse_example.md
@@ -0,0 +1,86 @@
+---
+title: MySQL -> Kafka -> ClickHouse 示例
+sidebar_position: 5
+---
+
+在下面的内容中,我们将通过一个完整的示例介绍如何使用 Apache InLong 创建 MySQL -> Kafka -> ClickHouse 数据链路。
+
+## 环境部署
+### 安装 InLong
+在开始之前,我们需要安装 InLong 的全部组件,这里提供两种方式:
+1. 按照 [这里的说明](deployment/docker.md),使用 Docker 进行快速部署。(推荐)
+2. 按照 [这里的说明](deployment/bare_metal.md),使用二进制包依次安装各组件。
+
+### 安装 ClickHouse
+```shell
+docker run -d --rm --net=host --name clickhouse -e CLICKHOUSE_USER=admin -e 
CLICKHOUSE_PASSWORD=inlong -e CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT=1 
clickhouse/clickhouse-server:22.8
+```
+
+### 安装Kafka
+```shell
+# 准备 Kafka 需要的 zookeeper
+docker run -d --name zookeeper -p 2181:2181 -t wurstmeister/zookeeper
+# 安装 Kafka 
+docker run -d --name kafka -p 9092:9092 -e KAFKA_BROKER_ID=0 -e 
KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181 --link zookeeper -e 
KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092 -e 
KAFKA_LISTENERS=PLAINTEXT://0.0.0.0:9092 -t wurstmeister/kafka
+```
+
+## 集群初始化
+容器启动成功后,访问 InLong Dashboard 地址 http://localhost,并使用以下默认账号登录:
+```
+User: admin
+Password: inlong
+```
+
+### 创建集群标签
+页面点击【集群管理】->【标签管理】->【新建】,指定集群标签名称和负责人:
+![Create Cluster label](img/mysql_clickhouse/create_cluster_label.png)
+
+**注:default_cluster 是各个组件默认上报集群标签,请勿使用其它名称**
+
+### 注册 Kafka 集群
+页面点击【集群管理】->【新建集群】,注册 Kafka 集群:
+![Create kafka cluster](img/mysql_clickhouse/kafka_cluster.png)
+
+### 注册 Clickhouse 数据节点
+页面点击【数据节点】->【新建】,新增 ClickHouse 数据节点:
+![Create kafka cluster](img/mysql_clickhouse/datanode.png)
+
+## 任务创建
+### 新建数据流组
+页面点击【数据集成】->【新建数据流组】,填写 ID,选择 MQ 类型为 Kafka 即可:
+![Create datastream](img/mysql_clickhouse/create_ingestion.png)
+
+### 新建数据流
+点击【下一步】->【新建数据流】,配置数据流 ID 及测试源字段信息:
+![Create datastream](img/mysql_clickhouse/data_stream_config.png)
+
+### 新建数据源
+点击【新建数据源】->【MySQL】,配置数据源名称、地址、用户密码以及库表信息等:
+![Create datastream](img/mysql_clickhouse/create_data_source.png)
+
+### 新建数据目标
+点击【新建数据目标】->【ClickHouse】,配置名称、库表、已创建的 ck 数据节点以及 Schema 映射信息等,完成后点击 【提交审批】:
+![Create data object](img/mysql_clickhouse/create_sink.png)
+
+### 审批数据流
+页面点击【审批管理】->【我的审批】->【详情】->【选择集群标签】->【通过】:
+![clickhouse](img/mysql_clickhouse/approval.png)
+
+返回【数据集成】,等待任务配置成功:
+![clickhouse](img/mysql_clickhouse/result.png)
+
+## 测试数据
+### 发送数据
+![clickhouse](img/mysql_clickhouse/send_data.png)
+累计对 MySQL 添加 1001 条数据。
+
+### 数据验证
+查看审计页面发送数据:
+![clickhouse](img/mysql_clickhouse/data_page.png)
+
+然后进入 ClickHouse 容器,查看库表数据:
+![clickhouse](img/mysql_clickhouse/data_table.png)
+
+## 常见问题
+### 任务配置失败
+一般是 MQ 或者 Flink 集群配置错误导致,可以在页面查看错误信息,或者进入 Manager 容器查看详细日志。
\ No newline at end of file

Reply via email to