From 0f52ad5d3de99133cc07e113cbfc9a57cc750797 Mon Sep 17 00:00:00 2001 From: JaySon-Huang Date: Tue, 15 Dec 2020 18:51:19 +0800 Subject: [PATCH 1/4] Add configuration Signed-off-by: JaySon-Huang --- tiflash/tiflash-configuration.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/tiflash/tiflash-configuration.md b/tiflash/tiflash-configuration.md index 34c7c09b6f19..fd688a7ecd36 100644 --- a/tiflash/tiflash-configuration.md +++ b/tiflash/tiflash-configuration.md @@ -85,6 +85,19 @@ delta_index_cache_size = 0 # DeltaIndex 内存 cache 大小限制,默认为 0 dt_enable_logical_split = true # 存储引擎的 segment 分裂是否使用逻辑分裂。使用逻辑分裂可以减小写放大,提高写入速度,但是会造成一定的空间浪费。默认为 true max_memory_usage = 0 # 单次 coprocessor 查询过程中,对中间数据的内存限制,单位为 byte,默认为 0,表示不限制 max_memory_usage_for_all_queries = 0 # 所有查询过程中,对中间数据的内存限制,单位为 byte,默认为 0,表示不限制 + +## Security settings effective since v4.0.5 +[security] + ## 若开启该选项,日志中的用户数据会以 `?` 代替。如果你需要开启此选项,你需要在 tiflash-learner.toml 中 + ## 开启 `security.redact-info-log` 以替换 tiflash-learner 日志中的用户数据。 + # redact_info_log = false + + ## 包含可信 SSL CA 列表的文件路径。如果你设置了该值,`cert_path`, `key_path`中的路径也需要填写。 + # ca_path = "/path/to/ca.pem" + ## 包含 PEM 格式的 X509 certificate 文件路径。 + # cert_path = "/path/to/tiflash-server.pem" + ## 包含 PEM 格式的 X509 key 文件路径。 + # key_path = "/path/to/tiflash-server-key.pem" ``` ### 配置文件 tiflash-learner.toml From 35232d595a703b100be8c05a20150992eb7bf942 Mon Sep 17 00:00:00 2001 From: JaySon Date: Tue, 15 Dec 2020 05:00:56 -0600 Subject: [PATCH 2/4] Apply suggestions from code review --- tiflash/tiflash-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiflash/tiflash-configuration.md b/tiflash/tiflash-configuration.md index fd688a7ecd36..845597aa4247 100644 --- a/tiflash/tiflash-configuration.md +++ b/tiflash/tiflash-configuration.md @@ -86,7 +86,7 @@ delta_index_cache_size = 0 # DeltaIndex 内存 cache 大小限制,默认为 0 max_memory_usage = 0 # 单次 coprocessor 查询过程中,对中间数据的内存限制,单位为 byte,默认为 0,表示不限制 max_memory_usage_for_all_queries = 0 # 所有查询过程中,对中间数据的内存限制,单位为 byte,默认为 0,表示不限制 -## Security settings effective since v4.0.5 +## 安全相关配置,从 v4.0.5 开始生效 [security] ## 若开启该选项,日志中的用户数据会以 `?` 代替。如果你需要开启此选项,你需要在 tiflash-learner.toml 中 ## 开启 `security.redact-info-log` 以替换 tiflash-learner 日志中的用户数据。 From 29d61b08110cafe33e811fd5c3617baacb378ee7 Mon Sep 17 00:00:00 2001 From: JaySon Date: Wed, 16 Dec 2020 04:07:19 -0600 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: Flowyi --- tiflash/tiflash-configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tiflash/tiflash-configuration.md b/tiflash/tiflash-configuration.md index 845597aa4247..fda24ecc783d 100644 --- a/tiflash/tiflash-configuration.md +++ b/tiflash/tiflash-configuration.md @@ -88,8 +88,8 @@ delta_index_cache_size = 0 # DeltaIndex 内存 cache 大小限制,默认为 0 ## 安全相关配置,从 v4.0.5 开始生效 [security] - ## 若开启该选项,日志中的用户数据会以 `?` 代替。如果你需要开启此选项,你需要在 tiflash-learner.toml 中 - ## 开启 `security.redact-info-log` 以替换 tiflash-learner 日志中的用户数据。 + ## 若开启该选项,日志中的用户数据会以 `?` 代替。 + ## 注意,tiflash-learner 的对应选项为`security.redact-info-log`,需要在 tiflash-learner.toml 中另外开启。 # redact_info_log = false ## 包含可信 SSL CA 列表的文件路径。如果你设置了该值,`cert_path`, `key_path`中的路径也需要填写。 From 30967d27b0a55f87a45bfc6de6c45a428cb78035 Mon Sep 17 00:00:00 2001 From: JaySon Date: Fri, 18 Dec 2020 03:23:10 -0600 Subject: [PATCH 4/4] Apply suggestions from code review Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com> --- tiflash/tiflash-configuration.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/tiflash/tiflash-configuration.md b/tiflash/tiflash-configuration.md index fda24ecc783d..0246988a31b6 100644 --- a/tiflash/tiflash-configuration.md +++ b/tiflash/tiflash-configuration.md @@ -88,15 +88,15 @@ delta_index_cache_size = 0 # DeltaIndex 内存 cache 大小限制,默认为 0 ## 安全相关配置,从 v4.0.5 开始生效 [security] - ## 若开启该选项,日志中的用户数据会以 `?` 代替。 - ## 注意,tiflash-learner 的对应选项为`security.redact-info-log`,需要在 tiflash-learner.toml 中另外开启。 + ## 若开启该选项,日志中的用户数据会以 `?` 代替显示 + ## 注意,tiflash-learner 对应的安全配置选项为 `security.redact-info-log`,需要在 tiflash-learner.toml 中另外开启 # redact_info_log = false - ## 包含可信 SSL CA 列表的文件路径。如果你设置了该值,`cert_path`, `key_path`中的路径也需要填写。 + ## 包含可信 SSL CA 列表的文件路径。如果你设置了该值,`cert_path` 和 `key_path` 中的路径也需要填写 # ca_path = "/path/to/ca.pem" - ## 包含 PEM 格式的 X509 certificate 文件路径。 + ## 包含 PEM 格式的 X509 certificate 文件路径 # cert_path = "/path/to/tiflash-server.pem" - ## 包含 PEM 格式的 X509 key 文件路径。 + ## 包含 PEM 格式的 X509 key 文件路径 # key_path = "/path/to/tiflash-server-key.pem" ```