File tree Expand file tree Collapse file tree 2 files changed +124
-0
lines changed
Expand file tree Collapse file tree 2 files changed +124
-0
lines changed Original file line number Diff line number Diff line change @@ -917,3 +917,65 @@ diff = 20
917917abs = 20000
918918max = 100000
919919cool-down = "30m"
920+
921+ ## [ record-write]
922+
923+ Controls how the record-write service are configured within openGemini.
924+
925+ ** enabled**
926+
927+ - Type: ` bool `
928+ - Default: ` true `
929+ - Determines whether the record write service is enabled.
930+
931+ ** auth-enabled**
932+
933+ - Type: ` bool `
934+ - Default: ` false `
935+ - Determines whether the username/password auth in record write service is enabled.
936+
937+ ** max-message-size**
938+
939+ - Type: ` int `
940+ - Default: ` 4194304 `
941+ - The maximum message size of record write service counted in Bytes. By default, it is 4194304 Bytes.(4 MB)
942+
943+ ** rpc-address**
944+
945+ - Type: ` string `
946+ - Default: ` 127.0.0.1:8305 `
947+ - The rpc bind address of record write service.
948+
949+ ## [ record-write.TLS]
950+
951+ some TLS-releted configs in record-write service.
952+
953+ ** enabled**
954+
955+ - Type: ` bool `
956+ - Default: ` false `
957+ - Determines whether the TLS in record write service is enabled. If TLS is enabled, then key-file and cert-file MUST be provided.
958+
959+ ** mTLS-enabled**
960+
961+ - Type: ` bool `
962+ - Default: ` false `
963+ - Determines whether the mutal-TLS in record write service is enabled. If mutual-TLS is enabled, then the CA-root MUST be provided.
964+
965+ ** key-file**
966+
967+ - Type: ` string `
968+ - Default: ` None `
969+ - The path to TLS key file.
970+
971+ ** cert-file**
972+
973+ - Type: ` string `
974+ - Default: ` None `
975+ - The path to TLS cert file.
976+
977+ ** CA-root**
978+
979+ - Type: ` string `
980+ - Default: ` None `
981+ - The path to CA root file.
Original file line number Diff line number Diff line change @@ -917,3 +917,65 @@ diff = 20
917917abs = 20000
918918max = 100000
919919cool-down = "30m"
920+
921+ ## [ record-write]
922+
923+ 用于配置基于record进行批量写入服务的相关配置项
924+
925+ ** enabled**
926+
927+ - 类型:` bool `
928+ - 默认值:` true `
929+ - 是否开启record write服务
930+
931+ ** auth-enabled**
932+
933+ - 类型:` bool `
934+ - 默认值:` false `
935+ - 是否进行写入身份校验
936+
937+ ** max-message-size**
938+
939+ - 类型:` int `
940+ - 默认值:` 4194304 `
941+ - 单条RPC消息所包含的最大请求长度,用字节表示,默认为4MB
942+
943+ ** rpc-address**
944+
945+ - 类型:` string `
946+ - 默认值:` 127.0.0.1:8305 `
947+ - record write服务的监听地址及端口,若启用record write服务则必填
948+
949+ ## [ record-write.TLS]
950+
951+ record write服务中,RPC部分的TLS相关配置
952+
953+ ** enabled**
954+
955+ - 类型:` bool `
956+ - 默认值:` false `
957+ - 是否启用TLS。若启用TLS,则必须在下面的` key-file ` 和` cert-file ` 中提供对应的私钥和TLS证书文件
958+
959+ ** mTLS-enabled**
960+
961+ - 类型:` bool `
962+ - 默认值:` false `
963+ - 是否启用双向TLS。在启用双向TLS之前必须开启TLS,即` record-write.TLS.enabled ` 必须设置为` true ` 。同时,需要提供私钥,TLS证书,CA证书文件。
964+
965+ ** key-file**
966+
967+ - 类型:` string `
968+ - 默认值:` 无 `
969+ - TLS私钥文件路径
970+
971+ ** cert-file**
972+
973+ - 类型:` string `
974+ - 默认值:` 无 `
975+ - TLS证书文件路径
976+
977+ ** CA-root**
978+
979+ - 类型:` string `
980+ - 默认值:` 无 `
981+ - CA根证书文件路径
You can’t perform that action at this time.
0 commit comments