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/09/14 09:24:01 UTC

[inlong-website] branch master updated: [INLONG-553][Doc] Optimize the standalone deployment guide (#554)

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 1af9b06e74 [INLONG-553][Doc] Optimize the standalone deployment guide (#554)
1af9b06e74 is described below

commit 1af9b06e746a3c72d127afbf0277ff551140debc
Author: Charles Zhang <do...@apache.org>
AuthorDate: Wed Sep 14 17:23:56 2022 +0800

    [INLONG-553][Doc] Optimize the standalone deployment guide (#554)
---
 docs/deployment/standalone.md                        | 20 +++++++++++++++++---
 .../current/deployment/standalone.md                 | 20 +++++++++++++++++---
 .../version-1.3.0/deployment/standalone.md           | 20 +++++++++++++++++---
 .../version-1.3.0/deployment/standalone.md           | 20 +++++++++++++++++---
 4 files changed, 68 insertions(+), 12 deletions(-)

diff --git a/docs/deployment/standalone.md b/docs/deployment/standalone.md
index 1d58b156a3..7a08b04ffd 100644
--- a/docs/deployment/standalone.md
+++ b/docs/deployment/standalone.md
@@ -5,7 +5,7 @@ sidebar_position: 1
 
 ## Environment Requirements
 - MySQL 5.7+
-- Flink 1.13.5
+- [Flink 1.13.5](https://nightlies.apache.org/flink/flink-docs-release-1.13/docs/try-flink/local_installation/)
 - [Docker](https://docs.docker.com/engine/install/) 19.03.1+
 
 ## Prepare Message Queue
@@ -16,7 +16,7 @@ InLong Support the following Message Queue services now, you can choose one of t
 ## Download the Binary Package
 You can get binary package 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).
 
-Extract `apache-inlong-[version]-bin.tar.gz` and `apache-inlong-[version]-sort-connectors.tar.gz`, and make sure the `inlong-sort/connectors/` directory contains Connectors.
+Extract `apache-inlong-[version]-bin.tar.gz` and `apache-inlong-[version]-sort-connectors.tar.gz`, and make sure the `inlong-sort/connectors/` directory contains `sort-connector-[type]-[version].jar`.
 
 ## DB Dependencies
 - If the backend database is MySQL, please download [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar) and put it into the following directories:
@@ -29,7 +29,21 @@ inlong-tubemq-manager/lib/
 - If the backend database is PostgreSQL, there's no need for additional dependencies.
 
 ## Configure 
-In `conf/inlong.conf`, configure the parameters according to the actual situation.
+In `conf/inlong.conf`, configure the parameters according to the actual situation, mainly include:
+```shell
+# local IP
+local_ip=
+# Configure MySQL
+spring_datasource_hostname=
+spring_datasource_port=3306
+spring_datasource_username=root
+spring_datasource_password=inlong
+# Configure Pulsar or TubeMQ Address
+# the REST server address for Flink
+flink_rest_address=
+# the REST server Port for Flink
+flink_rest_port=8081
+```
 
 ## Start
 ```shell
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 f3511c098d..5fc4ac9c9c 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
@@ -4,7 +4,7 @@ sidebar_position: 1
 ---
 ## 环境要求
 - MySQL 5.7+
-- Flink 1.13.5
+- [Flink 1.13.5](https://nightlies.apache.org/flink/flink-docs-release-1.13/docs/try-flink/local_installation/)
 - [Docker](https://docs.docker.com/engine/install/) 19.03.1+
 
 ## 准备消息队列
@@ -15,7 +15,7 @@ InLong 当前支持以下消息队列，根据使用情况**选择其一**即可
 ## 下载安装包
 可以从 [下载页面](https://inlong.apache.org/download) 获取二进制包，或参考 [如何编译](quick_start/how_to_build.md) 编译需要的版本。
 
-解压 `apache-inlong-[version]-bin.tar.gz` 和 `apache-inlong-[version]-sort-connectors.tar.gz`，并确保 `inlong-sort/connectors/` 目录包含 Connectors。
+解压 `apache-inlong-[version]-bin.tar.gz` 和 `apache-inlong-[version]-sort-connectors.tar.gz`，并确保 `inlong-sort/connectors/` 目录包含 `sort-connector-[type]-[version].jar`。
 
 ## DB 依赖
 - 如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar), 并将其放入以下目录：
@@ -29,7 +29,21 @@ inlong-tubemq-manager/lib/
 - 如果后端连接 PostgreSQL 数据库，不需要引入额外依赖。
 
 ## 配置
-在`conf/inlong.conf`文件中根据实际情况配置参数。
+在`conf/inlong.conf`文件中根据实际情况配置参数，主要包括：
+```shell
+# 本地机器 IP
+local_ip=
+# MySQL 配置
+spring_datasource_hostname=
+spring_datasource_port=3306
+spring_datasource_username=root
+spring_datasource_password=inlong
+# 配置 Pulsar 或者 TubeMQ 地址
+# Flink REST server 地址
+flink_rest_address=
+# Flink REST server 端口
+flink_rest_port=8081
+```
 
 ## 启动
 ```shell
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.0/deployment/standalone.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.0/deployment/standalone.md
index f3511c098d..5fc4ac9c9c 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.0/deployment/standalone.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.0/deployment/standalone.md
@@ -4,7 +4,7 @@ sidebar_position: 1
 ---
 ## 环境要求
 - MySQL 5.7+
-- Flink 1.13.5
+- [Flink 1.13.5](https://nightlies.apache.org/flink/flink-docs-release-1.13/docs/try-flink/local_installation/)
 - [Docker](https://docs.docker.com/engine/install/) 19.03.1+
 
 ## 准备消息队列
@@ -15,7 +15,7 @@ InLong 当前支持以下消息队列，根据使用情况**选择其一**即可
 ## 下载安装包
 可以从 [下载页面](https://inlong.apache.org/download) 获取二进制包，或参考 [如何编译](quick_start/how_to_build.md) 编译需要的版本。
 
-解压 `apache-inlong-[version]-bin.tar.gz` 和 `apache-inlong-[version]-sort-connectors.tar.gz`，并确保 `inlong-sort/connectors/` 目录包含 Connectors。
+解压 `apache-inlong-[version]-bin.tar.gz` 和 `apache-inlong-[version]-sort-connectors.tar.gz`，并确保 `inlong-sort/connectors/` 目录包含 `sort-connector-[type]-[version].jar`。
 
 ## DB 依赖
 - 如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar), 并将其放入以下目录：
@@ -29,7 +29,21 @@ inlong-tubemq-manager/lib/
 - 如果后端连接 PostgreSQL 数据库，不需要引入额外依赖。
 
 ## 配置
-在`conf/inlong.conf`文件中根据实际情况配置参数。
+在`conf/inlong.conf`文件中根据实际情况配置参数，主要包括：
+```shell
+# 本地机器 IP
+local_ip=
+# MySQL 配置
+spring_datasource_hostname=
+spring_datasource_port=3306
+spring_datasource_username=root
+spring_datasource_password=inlong
+# 配置 Pulsar 或者 TubeMQ 地址
+# Flink REST server 地址
+flink_rest_address=
+# Flink REST server 端口
+flink_rest_port=8081
+```
 
 ## 启动
 ```shell
diff --git a/versioned_docs/version-1.3.0/deployment/standalone.md b/versioned_docs/version-1.3.0/deployment/standalone.md
index 1d58b156a3..7a08b04ffd 100644
--- a/versioned_docs/version-1.3.0/deployment/standalone.md
+++ b/versioned_docs/version-1.3.0/deployment/standalone.md
@@ -5,7 +5,7 @@ sidebar_position: 1
 
 ## Environment Requirements
 - MySQL 5.7+
-- Flink 1.13.5
+- [Flink 1.13.5](https://nightlies.apache.org/flink/flink-docs-release-1.13/docs/try-flink/local_installation/)
 - [Docker](https://docs.docker.com/engine/install/) 19.03.1+
 
 ## Prepare Message Queue
@@ -16,7 +16,7 @@ InLong Support the following Message Queue services now, you can choose one of t
 ## Download the Binary Package
 You can get binary package 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).
 
-Extract `apache-inlong-[version]-bin.tar.gz` and `apache-inlong-[version]-sort-connectors.tar.gz`, and make sure the `inlong-sort/connectors/` directory contains Connectors.
+Extract `apache-inlong-[version]-bin.tar.gz` and `apache-inlong-[version]-sort-connectors.tar.gz`, and make sure the `inlong-sort/connectors/` directory contains `sort-connector-[type]-[version].jar`.
 
 ## DB Dependencies
 - If the backend database is MySQL, please download [mysql-connector-java-8.0.27.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.27/mysql-connector-java-8.0.27.jar) and put it into the following directories:
@@ -29,7 +29,21 @@ inlong-tubemq-manager/lib/
 - If the backend database is PostgreSQL, there's no need for additional dependencies.
 
 ## Configure 
-In `conf/inlong.conf`, configure the parameters according to the actual situation.
+In `conf/inlong.conf`, configure the parameters according to the actual situation, mainly include:
+```shell
+# local IP
+local_ip=
+# Configure MySQL
+spring_datasource_hostname=
+spring_datasource_port=3306
+spring_datasource_username=root
+spring_datasource_password=inlong
+# Configure Pulsar or TubeMQ Address
+# the REST server address for Flink
+flink_rest_address=
+# the REST server Port for Flink
+flink_rest_port=8081
+```
 
 ## Start
 ```shell