docs: add configs about record write service (#137)

Signed-off-by: Gao Jiyao <[email protected]>

src/guide/reference/configurations.md

@@ -917,3 +917,65 @@ diff = 20
 abs = 20000  
 max = 100000  
 cool-down = "30m"  
+
+## [record-write]
+
+Controls how the record-write service are configured within openGemini.
+
+**enabled**
+
+  - Type: `bool`
+  - Default: `true`
+  - Determines whether the record write service is enabled.
+
+**auth-enabled**
+
+  - Type: `bool`
+  - Default: `false`
+  - Determines whether the username/password auth in record write service is enabled.
+
+**max-message-size**
+
+  - Type: `int`
+  - Default: `4194304` 
+  - The maximum message size of record write service counted in Bytes. By default, it is 4194304 Bytes.(4 MB)
+
+**rpc-address**
+
+  - Type: `string`
+  - Default: `127.0.0.1:8305`
+  - The rpc bind address of record write service.
+
+## [record-write.TLS]
+
+some TLS-releted configs in record-write service.
+
+**enabled**
+
+  - Type: `bool`
+  - Default: `false`
+  - Determines whether the TLS in record write service is enabled. If TLS is enabled, then key-file and cert-file MUST be provided.
+
+**mTLS-enabled**
+
+  - Type: `bool`
+  - Default: `false`
+  - Determines whether the mutal-TLS in record write service is enabled. If mutual-TLS is enabled, then the CA-root MUST be provided.
+
+**key-file**
+
+  - Type: `string`
+  - Default: `None`
+  - The path to TLS key file.
+
+**cert-file**
+
+  - Type: `string`
+  - Default: `None`
+  - The path to TLS cert file.
+
+**CA-root**
+
+  - Type: `string`
+  - Default: `None`
+  - The path to CA root file.

src/zh/guide/reference/configurations.md

@@ -917,3 +917,65 @@ diff = 20
 abs = 20000  
 max = 100000  
 cool-down = "30m"  
+
+## [record-write]
+
+用于配置基于record进行批量写入服务的相关配置项
+
+**enabled**
+
+  - 类型：`bool`
+  - 默认值：`true`
+  - 是否开启record write服务
+
+**auth-enabled**
+
+  - 类型：`bool`
+  - 默认值：`false`
+  - 是否进行写入身份校验
+
+**max-message-size**
+
+  - 类型：`int`
+  - 默认值：`4194304` 
+  - 单条RPC消息所包含的最大请求长度，用字节表示，默认为4MB
+
+**rpc-address**
+
+  - 类型：`string`
+  - 默认值：`127.0.0.1:8305`
+  - record write服务的监听地址及端口，若启用record write服务则必填
+
+## [record-write.TLS]
+
+record write服务中，RPC部分的TLS相关配置
+
+**enabled**
+
+  - 类型：`bool`
+  - 默认值：`false`
+  - 是否启用TLS。若启用TLS，则必须在下面的`key-file`和`cert-file`中提供对应的私钥和TLS证书文件
+
+**mTLS-enabled**
+
+  - 类型：`bool`
+  - 默认值：`false`
+  - 是否启用双向TLS。在启用双向TLS之前必须开启TLS，即`record-write.TLS.enabled`必须设置为`true`。同时，需要提供私钥，TLS证书，CA证书文件。
+
+**key-file**
+
+  - 类型：`string`
+  - 默认值：`无`
+  - TLS私钥文件路径
+
+**cert-file**
+
+  - 类型：`string`
+  - 默认值：`无`
+  - TLS证书文件路径
+
+**CA-root**
+
+  - 类型：`string`
+  - 默认值：`无`
+  - CA根证书文件路径