Skip to content

Commit

Permalink
docs: start command args, metasrv-addrs, store-addrs
Browse files Browse the repository at this point in the history
  • Loading branch information
fengjiachun committed May 13, 2024
1 parent 9b879da commit 63ac4cd
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/nightly/en/reference/command-lines.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ greptime datanode start -c config/datanode.example.toml
Starts a datanode instance with command line arguments specifying the gRPC service address, the MySQL service address, the address of the metasrv, and the node id of the instance:

```sh
greptime datanode start --rpc-addr=0.0.0.0:4001 --mysql-addr=0.0.0.0:4002 --metasrv-addr=0.0.0.0:3002 --node-id=1
greptime datanode start --rpc-addr=0.0.0.0:4001 --mysql-addr=0.0.0.0:4002 --metasrv-addrs=0.0.0.0:3002 --node-id=1
```

Starts a frontend instance with customized configurations:
Expand All @@ -70,5 +70,5 @@ greptime frontend start -c config/frontend.example.toml
Starts a frontend instance with command line arguments specifying the address of the metasrv:

```sh
greptime frontend start --metasrv-addr=0.0.0.0:3002
greptime frontend start --metasrv-addrs=0.0.0.0:3002
```
4 changes: 2 additions & 2 deletions docs/nightly/en/user-guide/operations/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ greptime datanode start --help
- `--env-prefix <ENV_PREFIX>`: The prefix of environment variables, default is `GREPTIMEDB_DATANODE`;
- `--http-addr <HTTP_ADDR>`: HTTP server address;
- `--http-timeout <HTTP_TIMEOUT>`: HTTP request timeout in seconds.
- `--metasrv-addr <METASRV_ADDR>`: Metasrv address list;
- `--metasrv-addrs <METASRV_ADDR>`: Metasrv address list;
- `--node-id <NODE_ID>`: The datanode ID;
- `--rpc-addr <RPC_ADDR>`: The datanode RPC addr;
- `--rpc-hostname <RPC_HOSTNAME>`: The datanode hostname;
Expand All @@ -61,7 +61,7 @@ greptime metasrv start --help
- `--http-timeout <HTTP_TIMEOUT>`: HTTP request timeout in seconds.
- `--selector <SELECTOR>`: You can refer [selector-type](/contributor-guide/metasrv/selector#selector-type);
- `--server-addr <SERVER_ADDR>`: The communication server address for frontend and datanode to connect to metasrv;
- `--store-addr <STORE_ADDR>`: Comma seperated etcd server addresses to store metadata;
- `--store-addrs <STORE_ADDR>`: Comma or space separated key-value storage server (default is etcd) address, used for storing metadata;
- `--use-memory-store`: Use memory store instead of etcd, for test purpose only;

### Frontend subcommand options
Expand Down
4 changes: 2 additions & 2 deletions docs/nightly/zh/reference/command-lines.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ greptime datanode start -c config/datanode.example.toml
使用命令行参数启动 datanode,指定 gRPC 服务地址、MySQL 服务地址、metasrv 地址和该 datanode 的 ID:

```sh
greptime datanode start --rpc-addr=0.0.0.0:4001 --mysql-addr=0.0.0.0:4002 --metasrv-addr=0.0.0.0:3002 --node-id=1
greptime datanode start --rpc-addr=0.0.0.0:4001 --mysql-addr=0.0.0.0:4002 --metasrv-addrs=0.0.0.0:3002 --node-id=1
```

使用自定义配置启动 frontend:
Expand All @@ -70,5 +70,5 @@ greptime frontend start -c config/frontend.example.toml
使用命令行参数启动 frontend,指定 metasrv 的地址:

```sh
greptime frontend start --metasrv-addr=0.0.0.0:3002
greptime frontend start --metasrv-addrs=0.0.0.0:3002
```
6 changes: 3 additions & 3 deletions docs/nightly/zh/user-guide/operations/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ greptime datanode start --help
- `--env-prefix <ENV_PREFIX>`: 配置的环境变量前缀,默认为 `GREPTIMEDB_DATANODE`;
- `--http-addr <HTTP_ADDR>`: HTTP 服务地址
- `--http-timeout <HTTP_TIMEOUT>`: HTTP 超时设置,单位秒
- `--metasrv-addr <METASRV_ADDR>`: Metasrv 服务器列表,用逗号隔开
- `--metasrv-addrs <METASRV_ADDR>`: Metasrv 服务器列表,用逗号或者空格隔开
- `--node-id <NODE_ID>`: 节点 ID
- `--rpc-addr <RPC_ADDR>`: gRPC 服务地址
- `--rpc-hostname <RPC_HOSTNAME>`: 节点 hostname
Expand All @@ -61,7 +61,7 @@ greptime metasrv start --help
- `--http-timeout <HTTP_TIMEOUT>`: HTTP 超时设置,单位秒
- `--selector <SELECTOR>`: 参考 [selector 类型](/contributor-guide/metasrv/selector#selector-type);
- `--server-addr <SERVER_ADDR>`: 提供给 frontend 和 datanode 的外部通讯服务器地址
- `--store-addr <STORE_ADDR>`: 存储元数据的 etcd 地址列表,用逗号隔开
- `--store-addrs <STORE_ADDR>`: 逗号或空格分隔的键值存储服务器(默认为etcd)地址,用于存储元数据;
- `--use-memory-store`: 是否使用内存存储替代 etcd,仅用于测试

### frontend 子命令选项
Expand All @@ -79,7 +79,7 @@ greptime frontend start --help
- `--http-addr <HTTP_ADDR>`: HTTP 服务器地址
- `--http-timeout <HTTP_TIMEOUT>`: HTTP 超时设置,单位秒
- `--influxdb-enable`: 是否启用 `influxdb` HTTP 接口,默认为 true。
- `--metasrv-addr <METASRV_ADDR>`: Metasrv 地址列表,用逗号隔开
- `--metasrv-addrs <METASRV_ADDR>`: Metasrv 地址列表,用逗号或者空格隔开
- `--mysql-addr <MYSQL_ADDR>`: MySQL 服务地址
- `--postgres-addr <POSTGRES_ADDR>`: Postgres 服务地址
- `--tls-cert-path <TLS_CERT_PATH>`: TLS 公钥文件地址
Expand Down

0 comments on commit 63ac4cd

Please sign in to comment.