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 64add824c4 [INLONG-574][Audit] Update configuration item description
(#575)
64add824c4 is described below
commit 64add824c47a049b579c23aff7d8d0ac922cbde4
Author: doleyzi <[email protected]>
AuthorDate: Tue Oct 25 18:40:50 2022 +0800
[INLONG-574][Audit] Update configuration item description (#575)
Co-authored-by: doleyzi <[email protected]>
---
docs/modules/audit/configure.md | 89 ++++++++++++++++++++++
.../current/modules/audit/configure.md | 88 +++++++++++++++++++++
.../current/modules/dataproxy/configuration.md | 2 +-
.../current/modules/manager/configure.md | 2 +-
4 files changed, 179 insertions(+), 2 deletions(-)
diff --git a/docs/modules/audit/configure.md b/docs/modules/audit/configure.md
new file mode 100644
index 0000000000..2240d113a0
--- /dev/null
+++ b/docs/modules/audit/configure.md
@@ -0,0 +1,89 @@
+---
+title: Configuration
+sidebar_position: 3
+---
+
+## Overview
+
+Audit-proxy source-channel-sink pipeline configuration
(dataproxy-{tube|pulsar}.conf).Audit-store storage service
+configuration (application.properties)
+
+## Audit-proxy source-channel-sink pipeline configuration
(`dataproxy-{tube|pulsar}.conf`)
+
+### Basic Configuration
+
+| Parameter | Description
| Default value |
Notes |
+|----------------------------|---------------------------------------------|-------------------------------------------------------|--------------------------------------------------------|
+| agent1.sources | source typpe | tcp-source
| |
+| agent1.channels | used channel | ch-msg1
|
|
+| agent1.sinks | used sink | pulsar-sink-msg1
| |
+|
+
+### sources Configuration
+
+| Parameter | Description | Default value
| Notes |
+|---------------------------|--------------------|-------|---------------------------------------------|
+| agent1.sources.tcp-source.channels | Define the channel used in the source
| ch-msg1 | |
+| agent1.sources.tcp-source.host | tcp ip binding and listening | 0.0.0.0 |
|
+| agent1.sources.tcp-source.port | tcp port binding | 10081 | |
+
+### channel Configuration
+
+| Parameter | Description | Default
value | Notes |
+|--------------------------|----------------------------|------|-----|
+| agent1.channels.ch-msg1.type | memory channel type | memory | |
+| agent1.channels.ch-msg2.type | file channel type | file | |
+
+### sink Configuration
+
+| Parameter | Description |
Default value | Notes |
+|------------------------|----------------------------------|-------|-----|
+| agent1.sinks.pulsar-sink-msg1.channel | The upstream channel name of the
sink | ch-msg1 | |
+| agent1.sinks.pulsar-sink-msg1.type | The sink class is implemented, where
the message pushes data to the pulsar cluster |
org.apache.inlong.audit.sink.PulsarSink | |
+| agent1.sinks.pulsar-sink-msg1.pulsar_server_url | pulsar broker
| pulsar://localhost:6650 | |
+| agent1.sinks.pulsar-sink-msg1.topic | pulsar topic |
persistent://public/Default value/inlong-audit | |
+| agent1.sinks.pulsar-sink-msg1.enable_token_auth | Whether security
certification is required | false | |
+| agent1.sinks.pulsar-sink-msg1.auth_token | pulsar authentication token |
| |
+
+## Audit-store storage service configuration (`application.properties`)
+
+### MQ configuration
+
+| Parameter | Description
| Default value |
Notes |
+|----------------------------|---------------------------------------------|-------------------------------------------------------|--------------------------------------------------------|
+| audit.config.proxy.type | MQ type | pulsar
| |
+| audit.pulsar.server.url | pulsar broker |
pulsar://127.0.0.1:6650 |
|
+| audit.pulsar.topic | pulsar topic | persistent://public/Default
value/inlong-audit |
|
+| audit.pulsar.consumer.sub.name | consumer | inlong-audit-subscription
|
|
+| audit.pulsar.enable.auth | Whether security certification is required |
false |
|
+| audit.pulsar.token | pulsar authentication token |
|
|
+
+### DB configuration
+
+| Parameter | Description | Default value
| Notes |
+|---------------------------|--------------------|-------|---------------------------------------------|
+| spring.datasource.druid.driver-class-name | Set the driver type |
com.mysql.cj.jdbc.Driver | |
+| spring.datasource.druid.url| jdbc URL |
jdbc:mysql://127.0.0.1:3306/apache_inlong_audit?characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2b8&rewriteBatchedStatements=true&allowMultiQueries=true&zeroDateTimeBehavior=CONVERT_TO_NULL&allowPublicKeyRetrieval=true
| |
+| spring.datasource.druid.username | account name | root | |
+| spring.datasource.druid.password | password | inlong | |
+
+### ElasticSearch configuration
+
+| Parameter | Description | Default
value | Notes |
+|--------------------------|----------------------------|------|-----|
+| elasticsearch.host | broker | 127.0.0.1 | |
+| elasticsearch.port | port | 9200 | |
+| elasticsearch.authEnable | Whether security certification is required |
false | |
+| elasticsearch.username | account name | elastic | |
+| elasticsearch.password | password | inlong | |
+| elasticsearch.indexDeleteDay | Index retention time, days | 5 | |
+| elasticsearch.auditIdSet | List of audit IDs that are allowed to write |
1,2 | |
+
+### clickhouse configuration
+
+| Parameter | Description | Default value
| Notes |
+|---------------------------|--------------------|-------|---------------------------------------------|
+| clickhouse.driver | Set the driver type |
ru.yandex.clickhouse.ClickHouseDriver |
|
+| clickhouse.url| clickhouse URL | jdbc:clickhouse://127.0.0.1:8123/Default
value | |
+| clickhouse.username | account name | Default value | |
+| clickhouse.password | password | Default value | |
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/configure.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/configure.md
new file mode 100644
index 0000000000..2e7c602782
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/configure.md
@@ -0,0 +1,88 @@
+---
+title: 参数配置
+sidebar_position: 3
+---
+
+## 概览
+
+审计代理服务audit-proxy `audit-proxy-pulsar.conf` 或者`audit-proxy-tube.conf`中设置。
审计存储服务audit-store `application.properties`中设置。
+
+## 审计代理层audit-proxy source-channel-sink 管道配置（dataproxy-{tube|pulsar}.conf）
+
+### 通用设置
+
+| 参数 | 描述 | 默认值
| 备注
|
+|----------------------------|---------------------------------------------|-------------------------------------------------------|--------------------------------------------------------|
+| agent1.sources | source类型 | tcp-source
| |
+| agent1.channels | 使用的channel | ch-msg1
|
|
+| agent1.sinks | 使用的sink | pulsar-sink-msg1
| |
+|
+
+### sources 相关设置
+
+| 参数 | 描述 | 默认值 | 备注
|
+|---------------------------|--------------------|-------|---------------------------------------------|
+| agent1.sources.tcp-source.channels | 定义source中使用到的channel | ch-msg1 |
|
+| agent1.sources.tcp-source.host | 服务ip | 0.0.0.0 |
|
+| agent1.sources.tcp-source.port | 监听端口 | 10081 | |
+
+### channel 相关配置
+
+| 参数 | 描述 | 默认值 | 备注 |
+|--------------------------|----------------------------|------|-----|
+| agent1.channels.ch-msg1.type | memory channel类型 | memory | |
+| agent1.channels.ch-msg2.type | file channel类型 | file | |
+
+### sink 相关配置
+
+| 参数 | 描述 | 默认值 | 备注 |
+|------------------------|----------------------------------|-------|-----|
+| agent1.sinks.pulsar-sink-msg1.channel | sink的上游channel名称 |
ch-msg1 | |
+| agent1.sinks.pulsar-sink-msg1.type | sink类实现 |
org.apache.inlong.audit.sink.PulsarSink | |
+| agent1.sinks.pulsar-sink-msg1.pulsar_server_url | pulsar集群broker节点
| pulsar://localhost:6650 | |
+| agent1.sinks.pulsar-sink-msg1.topic | pulsar集群topic |
persistent://public/default/inlong-audit | |
+| agent1.sinks.pulsar-sink-msg1.enable_token_auth | 是否需要安全认证 | false |
|
+| agent1.sinks.pulsar-sink-msg1.auth_token | pulsar认证token | 空 | |
+
+## 审计存储服务audit-store 配置 `application.properties`
+
+### MQ配置
+
+| 参数 | 描述 | 默认值
| 备注
|
+|----------------------------|---------------------------------------------|-------------------------------------------------------|--------------------------------------------------------|
+| audit.config.proxy.type | MQ类型 | pulsar
| |
+| audit.pulsar.server.url | pulsar的集群地址 |
pulsar://127.0.0.1:6650 |
|
+| audit.pulsar.topic | pulsar topic |
persistent://public/default/inlong-audit
| |
+| audit.pulsar.consumer.sub.name | 订阅组 | inlong-audit-subscription
|
|
+| audit.pulsar.enable.auth | 是否需要安全认证 | false
| |
+| audit.pulsar.token | 认证token |
| |
+
+### DB 相关设置
+
+| 参数 | 描述 | 默认值 | 备注
|
+|---------------------------|--------------------|-------|---------------------------------------------|
+| spring.datasource.druid.driver-class-name | 设置Driver类型 |
com.mysql.cj.jdbc.Driver | |
+| spring.datasource.druid.url| jdbc的URL |
jdbc:mysql://127.0.0.1:3306/apache_inlong_audit?characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2b8&rewriteBatchedStatements=true&allowMultiQueries=true&zeroDateTimeBehavior=CONVERT_TO_NULL&allowPublicKeyRetrieval=true
| |
+| spring.datasource.druid.username | 账号名 | root | |
+| spring.datasource.druid.password | 密码 | inlong | |
+
+### ElasticSearch配置
+
+| 参数 | 描述 | 默认值 | 备注 |
+|--------------------------|----------------------------|------|-----|
+| elasticsearch.host | 集群地址 | 127.0.0.1 | |
+| elasticsearch.port | 集群端口 | 9200 | |
+| elasticsearch.authEnable | 是否认证 | false | |
+| elasticsearch.username | 账号名 | elastic | |
+| elasticsearch.password | 密码 | inlong | |
+| elasticsearch.indexDeleteDay | 索引保存时间，天 | 5 | |
+| elasticsearch.auditIdSet | 允许写入的审计ID列表 | 1,2 | |
+
+### clickhouse 相关配置
+
+| 参数 | 描述 | 默认值 | 备注
|
+|---------------------------|--------------------|-------|---------------------------------------------|
+| clickhouse.driver | 设置Driver类型 | ru.yandex.clickhouse.ClickHouseDriver |
|
+| clickhouse.url| clickhouse的URL | jdbc:clickhouse://127.0.0.1:8123/default |
|
+| clickhouse.username | 账号名 | default | |
+| clickhouse.password | 密码 | default | |
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/configuration.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/configuration.md
index ac48207ed9..865dfdd38a 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/configuration.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/configuration.md
@@ -1,5 +1,5 @@
---
-title: 配置
+title: 参数配置
sidebar_position: 3
---
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/configure.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/configure.md
index 84cb4e72cf..4a244f2411 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/configure.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/configure.md
@@ -1,5 +1,5 @@
---
-title: 配置
+title: 参数配置
sidebar_position: 3
---
