This is an automated email from the ASF dual-hosted git repository. kunni pushed a commit to branch FLINK-39288 in repository https://gitbox.apache.org/repos/asf/flink-cdc.git
commit a50c1ab9efda408a96806b8be7a862842fd3aafa Author: lvyanquan <[email protected]> AuthorDate: Thu Mar 26 16:46:34 2026 +0800 [FLINK-39288][docs] Add JDK/Flink version requirements, connectors summary and reorganize quickstart docs for Flink 1.20 and 2.2 --- docs/content.zh/docs/get-started/introduction.md | 46 +++++++++++++++++++- .../{quickstart => quickstart-for-1.20}/_index.md | 0 .../cdc-up-quickstart-guide.md | 0 .../mysql-to-doris.md | 0 .../mysql-to-kafka.md | 0 .../mysql-to-starrocks.md | 0 .../postgres-to-fluss.md | 0 .../{quickstart => quickstart-for-2.2}/_index.md | 0 .../mysql-to-doris.md | 8 ++-- .../mysql-to-kafka.md | 12 +++--- .../mysql-to-starrocks.md | 8 ++-- .../postgres-to-fluss.md | 10 ++--- docs/content/docs/get-started/introduction.md | 47 ++++++++++++++++++++- .../{quickstart => quickstart-for-1.20}/_index.md | 0 .../cdc-up-quickstart-guide.md | 0 .../mysql-to-doris.md | 0 .../mysql-to-kafka.md | 0 .../mysql-to-starrocks.md | 0 .../postgres-to-fluss.md | 0 .../{quickstart => quickstart-for-2.2}/_index.md | 0 .../mysql-to-doris.md | 8 ++-- .../mysql-to-kafka.md | 10 ++--- .../mysql-to-starrocks.md | 8 ++-- .../postgres-to-fluss.md | 10 ++--- .../fig/mysql-Kafka-tutorial/flink-ui-flink22.png | Bin 0 -> 1556874 bytes .../fig/mysql-doris-tutorial/flink-ui-flink22.png | Bin 0 -> 1556874 bytes .../mysql-postgres-tutorial/flink-ui-flink22.png | Bin 0 -> 1556874 bytes .../mysql-starrocks-tutorial/flink-ui-flink22.png | Bin 0 -> 1556874 bytes 28 files changed, 126 insertions(+), 41 deletions(-) diff --git a/docs/content.zh/docs/get-started/introduction.md b/docs/content.zh/docs/get-started/introduction.md index e992569f7..97ec788f5 100644 --- a/docs/content.zh/docs/get-started/introduction.md +++ b/docs/content.zh/docs/get-started/introduction.md @@ -37,6 +37,46 @@ Flink CDC 深度集成并由 Apache Flink 驱动，提供以下核心功能： * ✅ 整库同步 * ✅具备表结构变更自动同步的能力（Schema Evolution）， +## 环境要求 + +Flink CDC 有以下环境要求： + +* **JDK**：JDK 11 或更高版本（Flink CDC 从 3.6.0 版本开始基于 JDK 11 构建） +* **Apache Flink**：Flink 1.20.x 或 Flink 2.2.x + +{{< hint info >}} +在运行 Flink CDC 之前，请确保已安装正确的 JDK 版本。您可以使用 `java -version` 命令验证 Java 版本。 +{{< /hint >}} + +## 支持的连接器 + +Flink CDC 提供了丰富的连接器生态系统，用于与各种外部系统进行交互： + +| 连接器 | 类型 | +|-----------|------| +| MySQL | [Source Connector]({{< ref "docs/connectors/flink-sources/mysql-cdc" >}}) / [Pipeline Source Connector]({{< ref "docs/connectors/pipeline-connectors/mysql" >}}) | +| Oracle | [Source Connector]({{< ref "docs/connectors/flink-sources/oracle-cdc" >}}) / [Pipeline Source Connector]({{< ref "docs/connectors/pipeline-connectors/oracle" >}}) | +| PostgreSQL | [Source Connector]({{< ref "docs/connectors/flink-sources/postgres-cdc" >}}) / [Pipeline Source Connector]({{< ref "docs/connectors/pipeline-connectors/postgres" >}}) | +| Db2 | [Source Connector]({{< ref "docs/connectors/flink-sources/db2-cdc" >}}) | +| MongoDB | [Source Connector]({{< ref "docs/connectors/flink-sources/mongodb-cdc" >}}) | +| SQL Server | [Source Connector]({{< ref "docs/connectors/flink-sources/sqlserver-cdc" >}}) | +| TiDB | [Source Connector]({{< ref "docs/connectors/flink-sources/tidb-cdc" >}}) | +| Vitess | [Source Connector]({{< ref "docs/connectors/flink-sources/vitess-cdc" >}}) | +| Apache Doris | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/doris" >}}) | +| Elasticsearch | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/elasticsearch" >}}) | +| Fluss | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/fluss" >}}) | +| Hudi | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/hudi" >}}) | +| Iceberg | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/iceberg" >}}) | +| Kafka | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/kafka" >}}) | +| MaxCompute | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/maxcompute" >}}) | +| OceanBase | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/oceanbase" >}}) | +| Paimon | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/paimon" >}}) | +| StarRocks | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/starrocks" >}}) | + +{{< hint info >}} +有关每个连接器的详细信息，包括支持的版本、功能和配置选项，请参考[连接器]({{< ref "docs/connectors" >}})部分。 +{{< /hint >}} + ## 如何使用 Flink CDC Flink CDC 提供了基于 `YAML` 格式的用户 API，更适合于数据集成场景。以下是一个 `YAML` 文件的示例，它定义了一个数据管道(Pipeline)，该Pipeline从 MySQL 捕获实时变更，并将它们同步到 Apache Doris： @@ -77,8 +117,10 @@ pipeline: 查看快速入门指南，了解如何建立一个 Flink CDC Pipeline： -- [MySQL to Apache Doris]({{< ref "docs/get-started/quickstart/mysql-to-doris" >}}) -- [MySQL to StarRocks]({{< ref "docs/get-started/quickstart/mysql-to-starrocks" >}}) +| 示例 | 版本 | +|---------|---------| +| MySQL to Apache Doris | [1.20.x]({{< ref "docs/get-started/quickstart-for-1.20/mysql-to-doris" >}}) / [2.2.x]({{< ref "docs/get-started/quickstart-for-2.2/mysql-to-doris" >}}) | +| MySQL to StarRocks | [1.20.x]({{< ref "docs/get-started/quickstart-for-1.20/mysql-to-starrocks" >}}) / [2.2.x]({{< ref "docs/get-started/quickstart-for-2.2/mysql-to-starrocks" >}}) | ### 理解核心概念 diff --git a/docs/content.zh/docs/get-started/quickstart/_index.md b/docs/content.zh/docs/get-started/quickstart-for-1.20/_index.md similarity index 100% copy from docs/content.zh/docs/get-started/quickstart/_index.md copy to docs/content.zh/docs/get-started/quickstart-for-1.20/_index.md diff --git a/docs/content.zh/docs/get-started/quickstart/cdc-up-quickstart-guide.md b/docs/content.zh/docs/get-started/quickstart-for-1.20/cdc-up-quickstart-guide.md similarity index 100% rename from docs/content.zh/docs/get-started/quickstart/cdc-up-quickstart-guide.md rename to docs/content.zh/docs/get-started/quickstart-for-1.20/cdc-up-quickstart-guide.md diff --git a/docs/content.zh/docs/get-started/quickstart/mysql-to-doris.md b/docs/content.zh/docs/get-started/quickstart-for-1.20/mysql-to-doris.md similarity index 100% copy from docs/content.zh/docs/get-started/quickstart/mysql-to-doris.md copy to docs/content.zh/docs/get-started/quickstart-for-1.20/mysql-to-doris.md diff --git a/docs/content.zh/docs/get-started/quickstart/mysql-to-kafka.md b/docs/content.zh/docs/get-started/quickstart-for-1.20/mysql-to-kafka.md similarity index 100% copy from docs/content.zh/docs/get-started/quickstart/mysql-to-kafka.md copy to docs/content.zh/docs/get-started/quickstart-for-1.20/mysql-to-kafka.md diff --git a/docs/content.zh/docs/get-started/quickstart/mysql-to-starrocks.md b/docs/content.zh/docs/get-started/quickstart-for-1.20/mysql-to-starrocks.md similarity index 100% copy from docs/content.zh/docs/get-started/quickstart/mysql-to-starrocks.md copy to docs/content.zh/docs/get-started/quickstart-for-1.20/mysql-to-starrocks.md diff --git a/docs/content.zh/docs/get-started/quickstart/postgres-to-fluss.md b/docs/content.zh/docs/get-started/quickstart-for-1.20/postgres-to-fluss.md similarity index 100% copy from docs/content.zh/docs/get-started/quickstart/postgres-to-fluss.md copy to docs/content.zh/docs/get-started/quickstart-for-1.20/postgres-to-fluss.md diff --git a/docs/content.zh/docs/get-started/quickstart/_index.md b/docs/content.zh/docs/get-started/quickstart-for-2.2/_index.md similarity index 100% rename from docs/content.zh/docs/get-started/quickstart/_index.md rename to docs/content.zh/docs/get-started/quickstart-for-2.2/_index.md diff --git a/docs/content.zh/docs/get-started/quickstart/mysql-to-doris.md b/docs/content.zh/docs/get-started/quickstart-for-2.2/mysql-to-doris.md similarity index 97% rename from docs/content.zh/docs/get-started/quickstart/mysql-to-doris.md rename to docs/content.zh/docs/get-started/quickstart-for-2.2/mysql-to-doris.md index a57ded7bc..f7dc84320 100644 --- a/docs/content.zh/docs/get-started/quickstart/mysql-to-doris.md +++ b/docs/content.zh/docs/get-started/quickstart-for-2.2/mysql-to-doris.md @@ -33,11 +33,11 @@ under the License. 准备一台已经安装了 Docker 的 Linux 或者 MacOS 电脑。 ### 准备 Flink Standalone 集群 -1. 下载 [Flink 1.20.3](https://archive.apache.org/dist/flink/flink-1.20.3/flink-1.20.3-bin-scala_2.12.tgz)，解压后得到 flink-1.20.3 目录。 - 使用下面的命令跳转至 Flink 目录下，并且设置 FLINK_HOME 为 flink-1.20.3 所在目录。 +1. 下载 [Flink 2.2.0](https://archive.apache.org/dist/flink/flink-2.2.0/flink-2.2.0-bin-scala_2.12.tgz)，解压后得到 flink-2.2.0 目录。 + 使用下面的命令跳转至 Flink 目录下，并且设置 FLINK_HOME 为 flink-2.2.0 所在目录。 ```shell - cd flink-1.20.3 + cd flink-2.2.0 ``` 2. 通过在 conf/config.yaml 配置文件追加下列参数开启 checkpoint，每隔 3 秒做一次 checkpoint。 @@ -340,7 +340,7 @@ Flink CDC 提供了将源表的表结构/数据路由到其他表名的配置， ```shell docker-compose down ``` -在 Flink 所在目录 `flink-1.20.3` 下执行如下命令停止 Flink 集群： +在 Flink 所在目录 `flink-2.2.0` 下执行如下命令停止 Flink 集群： ```shell ./bin/stop-cluster.sh diff --git a/docs/content.zh/docs/get-started/quickstart/mysql-to-kafka.md b/docs/content.zh/docs/get-started/quickstart-for-2.2/mysql-to-kafka.md similarity index 97% rename from docs/content.zh/docs/get-started/quickstart/mysql-to-kafka.md rename to docs/content.zh/docs/get-started/quickstart-for-2.2/mysql-to-kafka.md index f8fdd7f61..5565eae0d 100644 --- a/docs/content.zh/docs/get-started/quickstart/mysql-to-kafka.md +++ b/docs/content.zh/docs/get-started/quickstart-for-2.2/mysql-to-kafka.md @@ -34,13 +34,13 @@ under the License. 准备一台已经安装了 Docker 的 Linux 或者 macOS 电脑。 ### 准备 Flink Standalone 集群 -1. 下载 [Flink 1.20.3](https://archive.apache.org/dist/flink/flink-1.20.3/flink-1.20.3-bin-scala_2.12.tgz)，解压后得到 flink-1.20.3 目录。 - 使用下面的命令跳转至 Flink 目录下，并且设置 `FLINK_HOME` 为 flink-1.20.3 所在目录。 +1. 下载 [Flink 2.2.0](https://archive.apache.org/dist/flink/flink-2.2.0/flink-2.2.0-bin-scala_2.12.tgz)，解压后得到 flink-2.2.0 目录。 + 使用下面的命令跳转至 Flink 目录下，并且设置 `FLINK_HOME` 为 flink-2.2.0 所在目录。 ```shell - tar -zxvf flink-1.20.3-bin-scala_2.12.tgz - exprot FLINK_HOME=$(pwd)/flink-1.20.3 - cd flink-1.20.3 + tar -zxvf flink-2.2.0-bin-scala_2.12.tgz + exprot FLINK_HOME=$(pwd)/flink-2.2.0 + cd flink-2.2.0 ``` 2. 在 `conf/config.yaml` 配置文件追加下列参数开启检查点，每隔 3 秒进行一次 checkpoint。 @@ -623,7 +623,7 @@ pipeline: docker compose down ``` -在 Flink 所在目录 `flink-1.20.3` 下执行如下命令停止 Flink 集群： +在 `FLINK_HOME` 目录下执行如下命令停止 Flink 集群： ```shell ./bin/stop-cluster.sh diff --git a/docs/content.zh/docs/get-started/quickstart/mysql-to-starrocks.md b/docs/content.zh/docs/get-started/quickstart-for-2.2/mysql-to-starrocks.md similarity index 97% rename from docs/content.zh/docs/get-started/quickstart/mysql-to-starrocks.md rename to docs/content.zh/docs/get-started/quickstart-for-2.2/mysql-to-starrocks.md index f3bbcdb63..74731a39d 100644 --- a/docs/content.zh/docs/get-started/quickstart/mysql-to-starrocks.md +++ b/docs/content.zh/docs/get-started/quickstart-for-2.2/mysql-to-starrocks.md @@ -33,11 +33,11 @@ under the License. 准备一台已经安装了 Docker 的 Linux 或者 MacOS 电脑。 ### 准备 Flink Standalone 集群 -1. 下载 [Flink 1.20.3](https://archive.apache.org/dist/flink/flink-1.20.3/flink-1.20.3-bin-scala_2.12.tgz) ，解压后得到 flink-1.20.3 目录。 - 使用下面的命令跳转至 Flink 目录下，并且设置 FLINK_HOME 为 flink-1.20.3 所在目录。 +1. 下载 [Flink 2.2.0](https://archive.apache.org/dist/flink/flink-2.2.0/flink-2.2.0-bin-scala_2.12.tgz) ，解压后得到 flink-2.2.0 目录。 + 使用下面的命令跳转至 Flink 目录下，并且设置 FLINK_HOME 为 flink-2.2.0 所在目录。 ```shell - cd flink-1.20.3 + cd flink-2.2.0 ``` 2. 通过在 conf/config.yaml 配置文件追加下列参数开启 checkpoint，每隔 3 秒做一次 checkpoint。 @@ -308,7 +308,7 @@ Flink CDC 提供了将源表的表结构/数据路由到其他表名的配置， docker-compose down ``` -在 Flink 所在目录 `flink-1.20.3` 下执行如下命令停止 Flink 集群： +在 Flink 所在目录 `flink-2.2.0` 下执行如下命令停止 Flink 集群： ```shell ./bin/stop-cluster.sh diff --git a/docs/content.zh/docs/get-started/quickstart/postgres-to-fluss.md b/docs/content.zh/docs/get-started/quickstart-for-2.2/postgres-to-fluss.md similarity index 96% rename from docs/content.zh/docs/get-started/quickstart/postgres-to-fluss.md rename to docs/content.zh/docs/get-started/quickstart-for-2.2/postgres-to-fluss.md index 7ffb7852f..3644b5720 100644 --- a/docs/content.zh/docs/get-started/quickstart/postgres-to-fluss.md +++ b/docs/content.zh/docs/get-started/quickstart-for-2.2/postgres-to-fluss.md @@ -33,11 +33,11 @@ under the License. 准备一台已经安装了 Docker 的 Linux 或者 MacOS 电脑。 ### 准备 Flink Standalone 集群 -1. 下载 [Flink 1.20.3](https://archive.apache.org/dist/flink/flink-1.20.3/flink-1.20.3-bin-scala_2.12.tgz)，解压后得到 flink-1.20.3 目录。 - 使用下面的命令跳转至 Flink 目录下，并且设置 FLINK_HOME 为 flink-1.20.3 所在目录。 +1. 下载 [Flink 2.2.0](https://archive.apache.org/dist/flink/flink-2.2.0/flink-2.2.0-bin-scala_2.12.tgz)，解压后得到 flink-2.2.0 目录。 + 使用下面的命令跳转至 Flink 目录下，并且设置 FLINK_HOME 为 flink-2.2.0 所在目录。 ```shell - cd flink-1.20.3 + cd flink-2.2.0 ``` 2. 通过在 conf/config.yaml 配置文件追加下列参数开启 checkpoint，每隔 3 秒做一次 checkpoint。 @@ -258,7 +258,7 @@ under the License. ### 在 Fluss 中查询数据 要查询已同步到 Fluss 的数据，需要配置 Flink SQL Client。 -1. 下载 [fluss-flink-1.20-0.9.0-incubating.jar](https://repo1.maven.org/maven2/org/apache/fluss/fluss-flink-1.20/0.9.0-incubating/fluss-flink-1.20-0.9.0-incubating.jar) 并放入 Flink 的 `lib` 目录。 +1. 下载 [fluss-flink-2.2-0.9.0-incubating.jar](https://repo1.maven.org/maven2/org/apache/fluss/fluss-flink-2.2/0.9.0-incubating/fluss-flink-2.2-0.9.0-incubating.jar) 并放入 Flink 的 `lib` 目录。 2. 启动 Flink SQL Client： ```shell @@ -397,7 +397,7 @@ PostgreSQL 的表结构变更是**数据驱动**的 — DDL 变更不会立即 ```shell docker-compose down -v ``` -在 Flink 所在目录 `flink-1.20.3` 下执行如下命令停止 Flink 集群： +在 Flink 所在目录 `flink-2.2.0` 下执行如下命令停止 Flink 集群： ```shell ./bin/stop-cluster.sh diff --git a/docs/content/docs/get-started/introduction.md b/docs/content/docs/get-started/introduction.md index d0d4af7a8..7baf16d8a 100644 --- a/docs/content/docs/get-started/introduction.md +++ b/docs/content/docs/get-started/introduction.md @@ -41,6 +41,46 @@ Deeply integrated with and powered by Apache Flink, Flink CDC provides: * ✅ Synchronization of entire databases * ✅ Schema evolution capability +## Requirements + +Flink CDC has the following requirements: + +* **JDK**: JDK 11 or later (Flink CDC is built on JDK 11 after 3.6.0) +* **Apache Flink**: Flink 1.20.x or Flink 2.2.x + +{{< hint info >}} +Make sure you have the correct JDK version installed before running Flink CDC. You can verify your Java version with `java -version`. +{{< /hint >}} + +## Supported Connectors + +Flink CDC provides a rich ecosystem of connectors to interact with various external systems: + +| Connector | Type | +|-----------|------| +| MySQL | [Source Connector]({{< ref "docs/connectors/flink-sources/mysql-cdc" >}}) / [Pipeline Source Connector]({{< ref "docs/connectors/pipeline-connectors/mysql" >}}) | +| Oracle | [Source Connector]({{< ref "docs/connectors/flink-sources/oracle-cdc" >}}) / [Pipeline Source Connector]({{< ref "docs/connectors/pipeline-connectors/oracle" >}}) | +| PostgreSQL | [Source Connector]({{< ref "docs/connectors/flink-sources/postgres-cdc" >}}) / [Pipeline Source Connector]({{< ref "docs/connectors/pipeline-connectors/postgres" >}}) | +| Db2 | [Source Connector]({{< ref "docs/connectors/flink-sources/db2-cdc" >}}) | +| MongoDB | [Source Connector]({{< ref "docs/connectors/flink-sources/mongodb-cdc" >}}) | +| SQL Server | [Source Connector]({{< ref "docs/connectors/flink-sources/sqlserver-cdc" >}}) | +| TiDB | [Source Connector]({{< ref "docs/connectors/flink-sources/tidb-cdc" >}}) | +| Vitess | [Source Connector]({{< ref "docs/connectors/flink-sources/vitess-cdc" >}}) | +| Apache Doris | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/doris" >}}) | +| Elasticsearch | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/elasticsearch" >}}) | +| Fluss | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/fluss" >}}) | +| Hudi | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/hudi" >}}) | +| Iceberg | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/iceberg" >}}) | +| Kafka | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/kafka" >}}) | +| MaxCompute | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/maxcompute" >}}) | +| OceanBase | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/oceanbase" >}}) | +| Paimon | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/paimon" >}}) | +| StarRocks | [Pipeline Sink Connector]({{< ref "docs/connectors/pipeline-connectors/starrocks" >}}) | + +{{< hint info >}} +For detailed information about each connector including supported versions, features, and configuration options, please refer to the [Connectors]({{< ref "docs/connectors" >}}) section. +{{< /hint >}} + ## How to Use Flink CDC Flink CDC provides an YAML-formatted user API that more suitable for data @@ -85,8 +125,11 @@ pipeline: Check out the quickstart guide to learn how to establish a Flink CDC pipeline: -- [MySQL to Apache Doris]({{< ref "docs/get-started/quickstart/mysql-to-doris" >}}) -- [MySQL to StarRocks]({{< ref "docs/get-started/quickstart/mysql-to-starrocks" >}}) +| Example | Version | +|---------|---------| +| MySQL to Apache Doris | [1.20.x]({{< ref "docs/get-started/quickstart-for-1.20/mysql-to-doris" >}}) / [2.2.x]({{< ref "docs/get-started/quickstart-for-2.2/mysql-to-doris" >}}) | +| MySQL to StarRocks | [1.20.x]({{< ref "docs/get-started/quickstart-for-1.20/mysql-to-starrocks" >}}) / [2.2.x]({{< ref "docs/get-started/quickstart-for-2.2/mysql-to-starrocks" >}}) | +| MySQL to Kafka | [1.20.x]({{< ref "docs/get-started/quickstart-for-1.20/mysql-to-kafka" >}}) / [2.2.x]({{< ref "docs/get-started/quickstart-for-2.2/mysql-to-kafka" >}}) | ### Understand Core Concepts diff --git a/docs/content/docs/get-started/quickstart/_index.md b/docs/content/docs/get-started/quickstart-for-1.20/_index.md similarity index 100% copy from docs/content/docs/get-started/quickstart/_index.md copy to docs/content/docs/get-started/quickstart-for-1.20/_index.md diff --git a/docs/content/docs/get-started/quickstart/cdc-up-quickstart-guide.md b/docs/content/docs/get-started/quickstart-for-1.20/cdc-up-quickstart-guide.md similarity index 100% rename from docs/content/docs/get-started/quickstart/cdc-up-quickstart-guide.md rename to docs/content/docs/get-started/quickstart-for-1.20/cdc-up-quickstart-guide.md diff --git a/docs/content/docs/get-started/quickstart/mysql-to-doris.md b/docs/content/docs/get-started/quickstart-for-1.20/mysql-to-doris.md similarity index 100% copy from docs/content/docs/get-started/quickstart/mysql-to-doris.md copy to docs/content/docs/get-started/quickstart-for-1.20/mysql-to-doris.md diff --git a/docs/content/docs/get-started/quickstart/mysql-to-kafka.md b/docs/content/docs/get-started/quickstart-for-1.20/mysql-to-kafka.md similarity index 100% copy from docs/content/docs/get-started/quickstart/mysql-to-kafka.md copy to docs/content/docs/get-started/quickstart-for-1.20/mysql-to-kafka.md diff --git a/docs/content/docs/get-started/quickstart/mysql-to-starrocks.md b/docs/content/docs/get-started/quickstart-for-1.20/mysql-to-starrocks.md similarity index 100% copy from docs/content/docs/get-started/quickstart/mysql-to-starrocks.md copy to docs/content/docs/get-started/quickstart-for-1.20/mysql-to-starrocks.md diff --git a/docs/content/docs/get-started/quickstart/postgres-to-fluss.md b/docs/content/docs/get-started/quickstart-for-1.20/postgres-to-fluss.md similarity index 100% copy from docs/content/docs/get-started/quickstart/postgres-to-fluss.md copy to docs/content/docs/get-started/quickstart-for-1.20/postgres-to-fluss.md diff --git a/docs/content/docs/get-started/quickstart/_index.md b/docs/content/docs/get-started/quickstart-for-2.2/_index.md similarity index 100% rename from docs/content/docs/get-started/quickstart/_index.md rename to docs/content/docs/get-started/quickstart-for-2.2/_index.md diff --git a/docs/content/docs/get-started/quickstart/mysql-to-doris.md b/docs/content/docs/get-started/quickstart-for-2.2/mysql-to-doris.md similarity index 97% rename from docs/content/docs/get-started/quickstart/mysql-to-doris.md rename to docs/content/docs/get-started/quickstart-for-2.2/mysql-to-doris.md index ba34cc81f..0614fee29 100644 --- a/docs/content/docs/get-started/quickstart/mysql-to-doris.md +++ b/docs/content/docs/get-started/quickstart-for-2.2/mysql-to-doris.md @@ -35,11 +35,11 @@ without a single line of Java/Scala code or IDE installation. Prepare a Linux or MacOS computer with Docker installed. ### Prepare Flink Standalone cluster -1. Download [Flink 1.20.3](https://archive.apache.org/dist/flink/flink-1.20.3/flink-1.20.3-bin-scala_2.12.tgz) ，unzip and get flink-1.20.3 directory. - Use the following command to navigate to the Flink directory and set FLINK_HOME to the directory where flink-1.20.3 is located. +1. Download [Flink 2.2.0](https://archive.apache.org/dist/flink/flink-2.2.0/flink-2.2.0-bin-scala_2.12.tgz) ，unzip and get flink-2.2.0 directory. + Use the following command to navigate to the Flink directory and set FLINK_HOME to the directory where flink-2.2.0 is located. ```shell - cd flink-1.20.3 + cd flink-2.2.0 ``` 2. Enable checkpointing by appending the following parameters to the conf/config.yaml configuration file to perform a checkpoint every 3 seconds. @@ -345,7 +345,7 @@ After finishing the tutorial, run the following command to stop all containers i ```shell docker-compose down ``` -Run the following command to stop the Flink cluster in the directory of Flink `flink-1.20.3`: +Run the following command to stop the Flink cluster in the directory of Flink `flink-2.2.0`: ```shell ./bin/stop-cluster.sh diff --git a/docs/content/docs/get-started/quickstart/mysql-to-kafka.md b/docs/content/docs/get-started/quickstart-for-2.2/mysql-to-kafka.md similarity index 98% rename from docs/content/docs/get-started/quickstart/mysql-to-kafka.md rename to docs/content/docs/get-started/quickstart-for-2.2/mysql-to-kafka.md index 08f8f6d79..0c2ac49aa 100644 --- a/docs/content/docs/get-started/quickstart/mysql-to-kafka.md +++ b/docs/content/docs/get-started/quickstart-for-2.2/mysql-to-kafka.md @@ -36,13 +36,13 @@ without a single line of Java/Scala code or IDE installation. You need a Linux or macOS computer with Docker installed before starting. ### Prepare Flink Standalone cluster -1. Download [Flink 1.20.3](https://archive.apache.org/dist/flink/flink-1.20.3/flink-1.20.3-bin-scala_2.12.tgz), unzip it and enter `flink-1.20.3` directory. - Use the following command to navigate to the Flink directory and set `FLINK_HOME` to the directory where flink-1.20.3 is located. +1. Download [Flink 2.2.0](https://archive.apache.org/dist/flink/flink-2.2.0/flink-2.2.0-bin-scala_2.12.tgz), unzip it and enter `flink-2.2.0` directory. + Use the following command to navigate to the Flink directory and set `FLINK_HOME` to the directory where flink-2.2.0 is located. ```shell - tar -zxvf flink-1.20.3-bin-scala_2.12.tgz - exprot FLINK_HOME=$(pwd)/flink-1.20.3 - cd flink-1.20.3 + tar -zxvf flink-2.2.0-bin-scala_2.12.tgz + exprot FLINK_HOME=$(pwd)/flink-2.2.0 + cd flink-2.2.0 ``` 2. Enable checkpointing by appending the following parameters to the `conf/config.yaml` configuration file to perform a checkpoint every 3 seconds. diff --git a/docs/content/docs/get-started/quickstart/mysql-to-starrocks.md b/docs/content/docs/get-started/quickstart-for-2.2/mysql-to-starrocks.md similarity index 97% rename from docs/content/docs/get-started/quickstart/mysql-to-starrocks.md rename to docs/content/docs/get-started/quickstart-for-2.2/mysql-to-starrocks.md index 3975796a6..bd9346898 100644 --- a/docs/content/docs/get-started/quickstart/mysql-to-starrocks.md +++ b/docs/content/docs/get-started/quickstart-for-2.2/mysql-to-starrocks.md @@ -35,11 +35,11 @@ without a single line of Java/Scala code or IDE installation. Prepare a Linux or MacOS computer with Docker installed. ### Prepare Flink Standalone cluster -1. Download [Flink 1.20.3](https://archive.apache.org/dist/flink/flink-1.20.3/flink-1.20.3-bin-scala_2.12.tgz) ，unzip and get flink-1.20.3 directory. - Use the following command to navigate to the Flink directory and set FLINK_HOME to the directory where flink-1.20.3 is located. +1. Download [Flink 2.2.0](https://archive.apache.org/dist/flink/flink-2.2.0/flink-2.2.0-bin-scala_2.12.tgz) ，unzip and get flink-2.2.0 directory. + Use the following command to navigate to the Flink directory and set FLINK_HOME to the directory where flink-2.2.0 is located. ```shell - cd flink-1.20.3 + cd flink-2.2.0 ``` 2. Enable checkpointing by appending the following parameters to the conf/config.yaml configuration file to perform a checkpoint every 3 seconds. @@ -312,7 +312,7 @@ After finishing the tutorial, run the following command to stop all containers i docker-compose down ``` -Run the following command to stop the Flink cluster in the directory of Flink `flink-1.20.1`: +Run the following command to stop the Flink cluster in the directory of Flink `flink-2.2.0`: ```shell ./bin/stop-cluster.sh diff --git a/docs/content/docs/get-started/quickstart/postgres-to-fluss.md b/docs/content/docs/get-started/quickstart-for-2.2/postgres-to-fluss.md similarity index 97% rename from docs/content/docs/get-started/quickstart/postgres-to-fluss.md rename to docs/content/docs/get-started/quickstart-for-2.2/postgres-to-fluss.md index 36c66a0ff..38f1b9da1 100644 --- a/docs/content/docs/get-started/quickstart/postgres-to-fluss.md +++ b/docs/content/docs/get-started/quickstart-for-2.2/postgres-to-fluss.md @@ -35,11 +35,11 @@ without a single line of Java/Scala code or IDE installation. Prepare a Linux or MacOS computer with Docker installed. ### Prepare Flink Standalone cluster -1. Download [Flink 1.20.3](https://archive.apache.org/dist/flink/flink-1.20.3/flink-1.20.3-bin-scala_2.12.tgz), unzip and get flink-1.20.3 directory. - Use the following command to navigate to the Flink directory and set FLINK_HOME to the directory where flink-1.20.3 is located. +1. Download [Flink 2.2.0](https://archive.apache.org/dist/flink/flink-2.2.0/flink-2.2.0-bin-scala_2.12.tgz), unzip and get flink-2.2.0 directory. + Use the following command to navigate to the Flink directory and set FLINK_HOME to the directory where flink-2.2.0 is located. ```shell - cd flink-1.20.3 + cd flink-2.2.0 ``` 2. Enable checkpointing by appending the following parameters to the conf/config.yaml configuration file to perform a checkpoint every 3 seconds. @@ -260,7 +260,7 @@ This command automatically starts all the containers defined in the Docker Compo ### Query data in Fluss To query the synchronized data in Fluss, you need to set up the Flink SQL Client. -1. Download [fluss-flink-1.20-0.9.0-incubating.jar](https://repo1.maven.org/maven2/org/apache/fluss/fluss-flink-1.20/0.9.0-incubating/fluss-flink-1.20-0.9.0-incubating.jar) and place it in the Flink `lib` directory. +1. Download [fluss-flink-2.2-0.9.0-incubating.jar](https://repo1.maven.org/maven2/org/apache/fluss/fluss-flink-2.2/0.9.0-incubating/fluss-flink-2.2-0.9.0-incubating.jar) and place it in the Flink `lib` directory. 2. Start the Flink SQL Client: ```shell @@ -399,7 +399,7 @@ After finishing the tutorial, run the following command to stop all containers i ```shell docker-compose down -v ``` -Run the following command to stop the Flink cluster in the directory of Flink `flink-1.20.3`: +Run the following command to stop the Flink cluster in the directory of Flink `flink-2.2.0`: ```shell ./bin/stop-cluster.sh diff --git a/docs/static/fig/mysql-Kafka-tutorial/flink-ui-flink22.png b/docs/static/fig/mysql-Kafka-tutorial/flink-ui-flink22.png new file mode 100644 index 000000000..6abb60736 Binary files /dev/null and b/docs/static/fig/mysql-Kafka-tutorial/flink-ui-flink22.png differ diff --git a/docs/static/fig/mysql-doris-tutorial/flink-ui-flink22.png b/docs/static/fig/mysql-doris-tutorial/flink-ui-flink22.png new file mode 100644 index 000000000..6abb60736 Binary files /dev/null and b/docs/static/fig/mysql-doris-tutorial/flink-ui-flink22.png differ diff --git a/docs/static/fig/mysql-postgres-tutorial/flink-ui-flink22.png b/docs/static/fig/mysql-postgres-tutorial/flink-ui-flink22.png new file mode 100644 index 000000000..6abb60736 Binary files /dev/null and b/docs/static/fig/mysql-postgres-tutorial/flink-ui-flink22.png differ diff --git a/docs/static/fig/mysql-starrocks-tutorial/flink-ui-flink22.png b/docs/static/fig/mysql-starrocks-tutorial/flink-ui-flink22.png new file mode 100644 index 000000000..6abb60736 Binary files /dev/null and b/docs/static/fig/mysql-starrocks-tutorial/flink-ui-flink22.png differ
