You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by ve...@apache.org on 2025/02/11 08:12:29 UTC
(inlong-website) branch master updated: [INLONG-1118][Doc] Fix Design and Deployment Chapter (#1108)
This is an automated email from the ASF dual-hosted git repository.
vernedeng 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 071002b0043 [INLONG-1118][Doc] Fix Design and Deployment Chapter (#1108)
071002b0043 is described below
commit 071002b0043d7c379eb31321153ffa0ebb1ccf93
Author: James Zow <ja...@163.com>
AuthorDate: Tue Feb 11 16:12:24 2025 +0800
[INLONG-1118][Doc] Fix Design and Deployment Chapter (#1108)
* Fix: Code block tag completion and format
* Fix: remove duplicates
---------
Co-authored-by: James Zow <v_...@tencent.com>
---
docs/deployment/docker.md | 2 +-
docs/deployment/k8s.md | 2 +-
docs/deployment/standalone.md | 4 +--
docs/design_and_concept/the_format_in_inlong.md | 42 +++++++++++-----------
.../current/deployment/docker.md | 6 ++--
.../current/deployment/k8s.md | 2 +-
.../current/deployment/standalone.md | 4 +--
.../design_and_concept/the_format_in_inlong.md | 24 ++++++-------
8 files changed, 43 insertions(+), 43 deletions(-)
diff --git a/docs/deployment/docker.md b/docs/deployment/docker.md
index ec87e0e4ce3..ecf20d2ceca 100644
--- a/docs/deployment/docker.md
+++ b/docs/deployment/docker.md
@@ -25,7 +25,7 @@ docker-compose up -d
## 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:
-```
+```properties
User: admin
Password: inlong
```
diff --git a/docs/deployment/k8s.md b/docs/deployment/k8s.md
index 8073fc29f8d..c88c3bf6541 100644
--- a/docs/deployment/k8s.md
+++ b/docs/deployment/k8s.md
@@ -45,7 +45,7 @@ kubectl port-forward $DASHBOARD_POD_NAME 80:$DASHBOARD_CONTAINER_PORT --address=
```
And then access [http://127.0.0.1:80](http://127.0.0.1:80), and use the following default account to log in:
-```
+```properties
User: admin
Password: inlong
```
diff --git a/docs/deployment/standalone.md b/docs/deployment/standalone.md
index 27fef87548b..876f31bb337 100644
--- a/docs/deployment/standalone.md
+++ b/docs/deployment/standalone.md
@@ -34,7 +34,7 @@ inlong-tubemq-manager/lib/
## Configure
In `conf/inlong.conf`, configure the parameters according to the actual situation, mainly include:
-```shell
+```properties
# local IP
local_ip=
# message queue: pulsar or kafka
@@ -57,7 +57,7 @@ bin/inlong-daemon start standalone
## 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:
-```
+```properties
User: admin
Password: inlong
```
diff --git a/docs/design_and_concept/the_format_in_inlong.md b/docs/design_and_concept/the_format_in_inlong.md
index e203792f95c..bf633a08bd5 100644
--- a/docs/design_and_concept/the_format_in_inlong.md
+++ b/docs/design_and_concept/the_format_in_inlong.md
@@ -20,7 +20,7 @@ Format provides two interfaces : SerializationSchema and DeserializationSchema :
-InLong serves as a one-stop, full-scenario data integration platform , with MQ (the Cache part in the picture) as the transmission channel , which decouples DataProxy and Sort and provides better scalability . When DataProxy is reporting data , it needs to serialize the data into corresponding format ( `SerializationSchema#serialize` ) . When Sort receives data, it will deserialize the MQ's data ( `DeserializationSchema#deserialize` ) into `Flink Row` , and then write to the correspondin [...]
+InLong serves as a one-stop, full-scenario data integration platform , with MQ (the Cache part in the picture) as the transmission channel , which decouples DataProxy and Sort and provides better scalability . When DataProxy is reporting data , it needs to serialize the data into corresponding format ( `SerializationSchema#serialize` ) . When Sort receives data, it will deserialize the MQ data ( `DeserializationSchema#deserialize` ) into `Flink Row` , and then write to the corresponding [...]
## What are the formats?
@@ -30,9 +30,9 @@ Currently , InLong-sort provides CSV / KeyValue / JSON , and the corresponding I
```xml
<dependency>
-<groupId>org.apache.inlong</groupId>
-<artifactId>sort-format-csv</artifactId>
-<version>${inlong.version}</version>
+ <groupId>org.apache.inlong</groupId>
+ <artifactId>sort-format-csv</artifactId>
+ <version>${inlong.version}</version>
</dependency>
```
@@ -52,32 +52,32 @@ Currently , InLong-sort provides CSV / KeyValue / JSON , and the corresponding I
```xml
<dependency>
-<groupId>org.apache.inlong</groupId>
-<artifactId>sort-format-kv</artifactId>
-<version>${inlong.version}</version>
+ <groupId>org.apache.inlong</groupId>
+ <artifactId>sort-format-kv</artifactId>
+ <version>${inlong.version}</version>
</dependency>
```
`org.apache.inlong.sort.formats.csv.CsvFormatFactory`
-| Option | Type | Required | Default value | Advanced | Remark |
-|---------------------------|---------|----------|------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `format.entry-delimiter` | char | N | '&' | N | |
-| `format.kv-delimiter` | char | N | '=' | N | |
-| `format.escape-character` | char | N | disabled | Y | |
-| `format.quote-character` | char | N | disabled | Y | |
-| `format.null-literal` | char | N | disabled | Y | |
-| `format.charset` | String | Y | "UTF-8" | N | |
-| `format.ignore-errors` | Boolean | Y | true | N | |
+| Option | Type | Required | Default value | Advanced | Remark |
+|---------------------------|---------|----------|-------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `format.entry-delimiter` | char | N | `&` | N | |
+| `format.kv-delimiter` | char | N | `=` | N | |
+| `format.escape-character` | char | N | disabled | Y | |
+| `format.quote-character` | char | N | disabled | Y | |
+| `format.null-literal` | char | N | disabled | Y | |
+| `format.charset` | String | Y | "UTF-8" | N | |
+| `format.ignore-errors` | Boolean | Y | true | N | |
| `format.derive_schema` | Boolean | N | Required if no format schema is defined . | Y | Derives the format schema from the table's schema . This allows for defining schema information only once . <br/> The names , types , and fields' order of the format are determined by the table's schema . <br/> Time attributes are ignored if their origin is not a field . <br/> A "from" definition is interpreted as a field renaming in the format . |
### JSON
```xml
<dependency>
-<groupId>org.apache.flink</groupId>
-<artifactId>flink-json</artifactId>
-<version>${flink.version}</version>
+ <groupId>org.apache.flink</groupId>
+ <artifactId>flink-json</artifactId>
+ <version>${flink.version}</version>
</dependency>
```
@@ -88,8 +88,8 @@ Currently , InLong-sort provides CSV / KeyValue / JSON , and the corresponding I
| Option | Type | Required | Default value | Advanced | Remark |
|----------------------------------|---------|----------|---------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `ignore-parse-errors` | Boolean | N | false | N | Optional flag to skip fields and rows with parse errors instead of failing ; <br/> fields are set to null in case of errors , false by default . |
-| `map-null-key.mode` | String | N | "FAIL" | Y | Optional flag to control the handling mode when serializing null key for map data ." <br/> Option DROP will drop null key entries for map data ." <br/> Option LITERAL will use 'map-null-key.literal' as key literal . |
-| `map-null-key.literal` | String | N | "null" | Y | Optional flag to specify string literal for null keys when 'map-null-key.mode' is LITERAL . |
+| `map-null-key.mode` | String | N | "FAIL" | Y | Optional flag to control the handling mode when serializing null key for map data ." <br/> Option DROP will drop null key entries for map data ." <br/> Option LITERAL will use `map-null-key.literal` as key literal . |
+| `map-null-key.literal` | String | N | "null" | Y | Optional flag to specify string literal for null keys when `map-null-key.mode` is LITERAL . |
| `encode.decimal-as-plain-number` | Boolean | N | false | Y | Optional flag to specify whether to encode all decimals as plain numbers instead of possible scientific notations , false by default . |
| `timestamp-format.standard` | String | N | "SQL" | Y | Optional flag to specify timestamp format , SQL by default ."<br/> Option ISO-8601 will parse input timestamp in "yyyy-MM-ddTHH:mm:ss.s{precision}" format and output timestamp in the same format ."<br/> Option SQL will parse input timestamp in "yyyy-MM-dd HH:mm:ss.s{precision}" format and output timestamp in the same format . |
| `encode.decimal-as-plain-number` | Boolean | N | false | Y | Optional flag to specify whether to encode all decimals as plain numbers instead of possible scientific notations , false by default . |
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 0f4eb5bf340..c940bca5c21 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
@@ -18,14 +18,14 @@ Docker Compose 部署了`标准架构`所需要的所有组件，使用 [Apache
## 部署
启动所有组件：
-```
+```shell
cd docker/docker-compose
docker-compose up -d
```
## 集群初始化
当所有容器都成功启动后，可以访问 InLong Dashboard 地址`http://localhost`，并使用以下默认账号登录:
-```
+```properties
User: admin
Password: inlong
```
@@ -52,6 +52,6 @@ Service URL 为 `pulsar://pulsar:6650`，Admin URL 为 `http://pulsar:8080`。
创建数据流可以参考 [Example](quick_start/data_ingestion/file_pulsar_clickhouse_example.md).
## 销毁
-```
+```shell
docker-compose down
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/k8s.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/k8s.md
index ba10c35c123..dd3c0fa1ed8 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/k8s.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/k8s.md
@@ -41,7 +41,7 @@ kubectl port-forward $DASHBOARD_POD_NAME 80:$DASHBOARD_CONTAINER_PORT --address=
```
之后就可以访问 [http://127.0.0.1:80](http://127.0.0.1:80) 进入 InLong Dashboard 了，默认登录账号为：
-```
+```properties
User: admin
Password: inlong
```
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 6682184a57b..49d7696092d 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
@@ -34,7 +34,7 @@ inlong-tubemq-manager/lib/
## 配置
在`conf/inlong.conf`文件中根据实际情况配置参数，主要包括：
-```shell
+```properties
# 本地机器 IP
local_ip=
# 消息队列服务： pulsar 或者 kafka
@@ -57,7 +57,7 @@ bin/inlong-daemon start standalone
## 集群初始化
当所有容器都成功启动后，可以访问 InLong Dashboard 地址`http://localhost`，并使用以下默认账号登录:
-```
+```properties
User: admin
Password: inlong
```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/design_and_concept/the_format_in_inlong.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/design_and_concept/the_format_in_inlong.md
index 0b2bcd9cd14..d2038e18b7c 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/design_and_concept/the_format_in_inlong.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/design_and_concept/the_format_in_inlong.md
@@ -35,9 +35,9 @@ InLong 作为一站式、全场景的数据集成平台，将 MQ（图中 Cache
```xml
<dependency>
-<groupId>org.apache.inlong</groupId>
-<artifactId>sort-format-csv</artifactId>
-<version>${inlong.version}</version>
+ <groupId>org.apache.inlong</groupId>
+ <artifactId>sort-format-csv</artifactId>
+ <version>${inlong.version}</version>
</dependency>
```
@@ -57,9 +57,9 @@ InLong 作为一站式、全场景的数据集成平台，将 MQ（图中 Cache
```xml
<dependency>
-<groupId>org.apache.inlong</groupId>
-<artifactId>sort-format-kv</artifactId>
-<version>${inlong.version}</version>
+ <groupId>org.apache.inlong</groupId>
+ <artifactId>sort-format-kv</artifactId>
+ <version>${inlong.version}</version>
</dependency>
```
@@ -67,8 +67,8 @@ InLong 作为一站式、全场景的数据集成平台，将 MQ（图中 Cache
| Option | Type | Required | Default value | 高级属性 | Remark |
|---------------------------|---------|----------|------------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------|
-| `format.entry-delimiter` | char | N | '&' | N | |
-| `format.kv-delimiter` | char | N | '=' | N | |
+| `format.entry-delimiter` | char | N | `&` | N | |
+| `format.kv-delimiter` | char | N | `=` | N | |
| `format.escape-character` | char | N | disabled | Y | |
| `format.quote-character` | char | N | disabled | Y | |
| `format.null-literal` | char | N | disabled | Y | |
@@ -80,9 +80,9 @@ InLong 作为一站式、全场景的数据集成平台，将 MQ（图中 Cache
```xml
<dependency>
-<groupId>org.apache.flink</groupId>
-<artifactId>flink-json</artifactId>
-<version>${flink.version}</version>
+ <groupId>org.apache.flink</groupId>
+ <artifactId>flink-json</artifactId>
+ <version>${flink.version}</version>
</dependency>
```
@@ -93,7 +93,7 @@ InLong 作为一站式、全场景的数据集成平台，将 MQ（图中 Cache
| Option | Type | Required | Default value | 高级属性 | Remark |
|----------------------------------|---------|----------|---------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `ignore-parse-errors` | Boolean | N | false | N | 可选标志以跳过具有解析错误而不是失败的字段和行； <br/>如果出现错误，字段设置为 null，默认情况下为 false。 |
-| `map-null-key.mode` | String | N | "FAIL" | Y | 可选标志，用于在序列化map数据的空键时控制处理模式。<br/><br/>选项 DROP 将删除map数据的空键条目。<br/>选项 LITERAL 将使用 'map-null-key.literal' 作为 key 关键字。 |
+| `map-null-key.mode` | String | N | "FAIL" | Y | 可选标志，用于在序列化map数据的空键时控制处理模式。<br/><br/>选项 DROP 将删除map数据的空键条目。<br/>选项 LITERAL 将使用 `map-null-key.literal` 作为 key 关键字。 |
| `map-null-key.literal` | String | N | "null" | Y | 当“map-null-key.mode”为 LITERAL 时，用于为空键指定字符串文字的可选标志。 |
| `encode.decimal-as-plain-number` | Boolean | N | false | Y | 可选标志，用于指定是否将所有小数编码为普通数字而不是科学记数法，默认情况下为 false。 |
| `timestamp-format.standard` | String | N | "SQL" | Y | 用于指定时间戳格式的可选标志，默认为 SQL。<br/>选项 ISO-8601 将以“yyyy-MM-ddTHH:mm:ss.s{precision}” 格式解析输入时间戳，并以相同格式输出时间戳。 <br/>选项 SQL 将以“yyyy-MM-dd HH:mm:ss.s{precision}”格式解析输入时间戳，并以相同格式输出时间戳。 |