Skip to content

docs: revert version-1.0 CLI flags from grpc-* back to rpc-* #2516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 3 commits into from
Closed

docs: revert version-1.0 CLI flags from grpc-* back to rpc-* #2516

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f32187
Initial plan
Copilot Jun 2, 2026
5290876
docs: align version-1.0 gRPC CLI option names
Copilot Jun 2, 2026
08cf0d8
docs: revert version-1.0 grpc flag renames
Copilot Jun 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions ...-content-docs/version-1.0/getting-started/installation/greptimedb-standalone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ docker run -p 127.0.0.1:4000-4003:4000-4003 \
--name greptime --rm \
greptime-registry.cn-hangzhou.cr.aliyuncs.com/greptime/greptimedb:VAR::greptimedbVersion standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-bind-addr 0.0.0.0:4001 \
--grpc-bind-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```
Expand All @@ -83,7 +83,7 @@ docker run -p 127.0.0.1:4000-4003:4000-4003 \
--name greptime --rm \
greptime-registry.cn-hangzhou.cr.aliyuncs.com/greptime/greptimedb:VAR::greptimedbVersion standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-bind-addr 0.0.0.0:4001 \
--grpc-bind-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```
Expand All @@ -105,7 +105,7 @@ GreptimeDB 默认绑定地址为 `127.0.0.1`。如果你需要能够接收来自
```shell
./greptime standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-bind-addr 0.0.0.0:4001 \
--grpc-bind-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```
Expand All @@ -120,7 +120,7 @@ docker run -p 0.0.0.0:4000-4003:4000-4003 \
--name greptime --rm \
greptime-registry.cn-hangzhou.cr.aliyuncs.com/greptime/greptimedb:VAR::greptimedbVersion standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-bind-addr 0.0.0.0:4001 \
--grpc-bind-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```
Expand Down
6 changes: 3 additions & 3 deletions .../docusaurus-plugin-content-docs/version-1.0/reference/command-lines/datanode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ greptime datanode start --help
| `--http-timeout <HTTP_TIMEOUT>` | HTTP 超时设置，单位秒 |
| `--metasrv-addrs <METASRV_ADDR>` | Metasrv 服务器列表，用逗号或者空格隔开 |
| `--node-id <NODE_ID>` | 节点 ID |
| `--rpc-bind-addr <RPC_BIND_ADDR>` | gRPC 服务绑定地址址 |
| `--rpc-server-addr <RPC_SERVER_ADDR>` | 该地址用于来自主机外部的连接和通信。如果留空或未设置，服务器将自动使用主机上第一个网络接口的 IP 地址，其端口号与 `rpc_bind_addr` 中指定的相同； |
| `--grpc-bind-addr <GRPC_BIND_ADDR>` | gRPC 服务绑定地址址 |
| `--grpc-server-addr <GRPC_SERVER_ADDR>` | 该地址用于来自主机外部的连接和通信。如果留空或未设置，服务器将自动使用主机上第一个网络接口的 IP 地址，其端口号与 `grpc_bind_addr` 中指定的相同； |
| `--wal-dir <WAL_DIR>` | WAL 目录 |

所有的 `addr` 类选项都是 `ip:port` 形式的字符串。
Expand All @@ -47,7 +47,7 @@ greptime datanode start -c config/datanode.example.toml
使用命令行参数启动 Datanode，指定 gRPC 服务地址、MySQL 服务地址、Metasrv 地址和该 Datanode 的 ID：

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

`datanode.example.toml` 配置文件来自 `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` 仓库的 `config` 目录。你可以在那里找到更多示例配置文件。`-c` 选项指定配置文件，更多信息请参考 [Configuration](/user-guide/deployments-administration/configuration.md)。
Expand Down
6 changes: 3 additions & 3 deletions .../docusaurus-plugin-content-docs/version-1.0/reference/command-lines/flownode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ greptime flownode start --help
| `--env-prefix <ENV_PREFIX>` | 配置的环境变量前缀，默认为`GREPTIMEDB_FLOWNODE` |
| `--metasrv-addrs <METASRV_ADDRS>...` | etasrv 服务器列表，用逗号或者空格隔开 |
| `--node-id <NODE_ID>` | 节点 ID |
| `--rpc-bind-addr <RPC_BIND_ADDR>` | gRPC 服务绑定地址 |
| `--rpc-server-addr <RPC_SERVER_ADDR>` | 该地址用于来自主机外部的连接和通信。如果留空或未设置，服务器将自动使用主机上第一个网络接口的 IP 地址，其端口号与 `rpc_bind_addr` 中指定的相同； |
| `--grpc-bind-addr <GRPC_BIND_ADDR>` | gRPC 服务绑定地址 |
| `--grpc-server-addr <GRPC_SERVER_ADDR>` | 该地址用于来自主机外部的连接和通信。如果留空或未设置，服务器将自动使用主机上第一个网络接口的 IP 地址，其端口号与 `grpc_bind_addr` 中指定的相同； |

所有的 `addr` 类选项都是 `ip:port` 形式的字符串。

Expand All @@ -37,7 +37,7 @@ greptime flownode start -c config/flownode.example.toml
使用命令行参数启动 Flownode，指定 gRPC 服务地址、Metasrv 地址：

```sh
greptime flownode start --node-id=0 --rpc-bind-addr=127.0.0.1:6800 --metasrv-addrs=127.0.0.1:3002
greptime flownode start --node-id=0 --grpc-bind-addr=127.0.0.1:6800 --metasrv-addrs=127.0.0.1:3002
```

`flownode.example.toml` 配置文件来自 `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` 仓库的 `config` 目录。你可以在那里找到更多示例配置文件。`-c` 选项指定配置文件，更多信息请参考 [Configuration](/user-guide/deployments-administration/configuration.md)。
4 changes: 2 additions & 2 deletions .../docusaurus-plugin-content-docs/version-1.0/reference/command-lines/frontend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ greptime frontend start --help
| `-c`/`--config-file` | Frontend 的配置文件 |
| `--disable-dashboard` | 禁用 dashboard http 服务，默认是 `false` |
| `--env-prefix <ENV_PREFIX>` | 配置的环境变量前缀，默认为`GREPTIMEDB_FRONTEND` |
| `--rpc-bind-addr <RPC_BIND_ADDR>` | gRPC 服务绑定地址 |
| `--rpc-server-addr <RPC_SERVER_ADDR>` | 该地址用于来自主机外部的连接和通信。如果留空或未设置，服务器将自动使用主机上第一个网络接口的 IP 地址，其端口号与 `rpc_bind_addr` 中指定的相同； |
| `--grpc-bind-addr <GRPC_BIND_ADDR>` | gRPC 服务绑定地址 |
| `--grpc-server-addr <GRPC_SERVER_ADDR>` | 该地址用于来自主机外部的连接和通信。如果留空或未设置，服务器将自动使用主机上第一个网络接口的 IP 地址，其端口号与 `grpc_bind_addr` 中指定的相同； |
| `--http-timeout <HTTP_TIMEOUT>` | HTTP 请求超时时间（秒） |
| `--influxdb-enable` | 是否启用 InfluxDB 协议 |
| `--metasrv-addrs <METASRV_ADDR>` | Metasrv 服务器列表，用逗号或者空格隔开 |
Expand Down
4 changes: 2 additions & 2 deletions ...h/docusaurus-plugin-content-docs/version-1.0/reference/command-lines/metasrv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ greptime metasrv start --help
| `-c`/`--config-file` | Metasrv 的配置文件 |
| `--enable-region-failover` | 是否启用 Region 自动容灾，默认是 `false`。开启条件请参考：[Region 自动容灾](/user-guide/deployments-administration/manage-data/region-failover.md) |
| `--env-prefix <ENV_PREFIX>` | 配置的环境变量前缀，默认为`GREPTIMEDB_METASRV` |
| `--rpc-bind-addr <RPC_BIND_ADDR>` | gRPC 服务绑定地址 |
| `--rpc-server-addr <RPC_SERVER_ADDR>` | 该地址用于来自主机外部的连接和通信。如果留空或未设置，服务器将自动使用主机上第一个网络接口的 IP 地址，其端口号与 `rpc_bind_addr` 中指定的相同； |
| `--grpc-bind-addr <GRPC_BIND_ADDR>` | gRPC 服务绑定地址 |
| `--grpc-server-addr <GRPC_SERVER_ADDR>` | 该地址用于来自主机外部的连接和通信。如果留空或未设置，服务器将自动使用主机上第一个网络接口的 IP 地址，其端口号与 `grpc_bind_addr` 中指定的相同； |
| `--http-addr <HTTP_ADDR>` | HTTP 服务器地址 |
| `--http-timeout <HTTP_TIMEOUT>` | HTTP 请求超时时间（秒） |
| `--selector <SELECTOR>` | 您可以参考 [selector-type](/contributor-guide/metasrv/selector.md#selector-type) |
Expand Down
2 changes: 1 addition & 1 deletion ...ocusaurus-plugin-content-docs/version-1.0/reference/command-lines/standalone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ greptime standalone start --help
| `--influxdb-enable` | 是否启用 InfluxDB 协议 |
| `--mysql-addr <MYSQL_ADDR>` | MySQL 服务器地址 |
| `--postgres-addr <POSTGRES_ADDR>` | Postgres 服务器地址 |
| `--rpc-bind-addr <RPC_BIND_ADDR>` | gRPC 服务绑定地址 |
| `--grpc-bind-addr <GRPC_BIND_ADDR>` | gRPC 服务绑定地址 |

所有的 `addr` 类选项都是 `ip:port` 形式的字符串。

Expand Down
8 changes: 4 additions & 4 deletions versioned_docs/version-1.0/getting-started/installation/greptimedb-standalone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ docker run -p 127.0.0.1:4000-4003:4000-4003 \
--name greptime --rm \
greptime/greptimedb:VAR::greptimedbVersion standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-bind-addr 0.0.0.0:4001 \
--grpc-bind-addr 0.0.0.0:4001 \
Comment thread
fengjiachun marked this conversation as resolved.
Outdated
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```
Expand All @@ -83,7 +83,7 @@ You can:
--name greptime --rm \
greptime/greptimedb:VAR::greptimedbVersion standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-bind-addr 0.0.0.0:4001 \
--grpc-bind-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```
Expand All @@ -105,7 +105,7 @@ GreptimeDB binds to `127.0.0.1` by default. If you need to accept connections fr
```shell
./greptime standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-bind-addr 0.0.0.0:4001 \
--grpc-bind-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```
Expand All @@ -120,7 +120,7 @@ docker run -p 0.0.0.0:4000-4003:4000-4003 \
--name greptime --rm \
greptime/greptimedb:VAR::greptimedbVersion standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-bind-addr 0.0.0.0:4001 \
--grpc-bind-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-1.0/reference/command-lines/datanode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ greptime datanode start --help
| `--http-timeout <HTTP_TIMEOUT>` | HTTP request timeout in seconds |
| `--metasrv-addrs <METASRV_ADDR>` | Metasrv address list |
| `--node-id <NODE_ID>` | The datanode ID |
| `--rpc-bind-addr <RPC_BIND_ADDR>` | The address to bind the gRPC server |
| `--rpc-server-addr <RPC_SERVER_ADDR>` | The address advertised to the metasrv, and used for connections from outside the host. If left empty or unset, the server will automatically use the IP address of the first network interface on the host, with the same port number as the one specified in `rpc_bind_addr` |
| `--grpc-bind-addr <GRPC_BIND_ADDR>` | The address to bind the gRPC server |
| `--grpc-server-addr <GRPC_SERVER_ADDR>` | The address advertised to the metasrv, and used for connections from outside the host. If left empty or unset, the server will automatically use the IP address of the first network interface on the host, with the same port number as the one specified in `grpc_bind_addr` |
| `--wal-dir <WAL_DIR>` | The directory of WAL |

All the `addr` options are in the form of `ip:port`.
Expand All @@ -47,7 +47,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-bind-addr=0.0.0.0:4001 --mysql-addr=0.0.0.0:4002 --metasrv-addrs=0.0.0.0:3002 --node-id=1
greptime datanode start --grpc-bind-addr=0.0.0.0:4001 --mysql-addr=0.0.0.0:4002 --metasrv-addrs=0.0.0.0:3002 --node-id=1
```

The `datanode.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuration files there. The `-c` option specifies the configuration file, for more information check [Configuration](/user-guide/deployments-administration/configuration.md).
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-1.0/reference/command-lines/flownode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ greptime flownode start --help
| `--env-prefix <ENV_PREFIX>` | The prefix of environment variables, default is `GREPTIMEDB_FLOWNODE` |
| `--metasrv-addrs <METASRV_ADDRS>...` | Metasrv address list |
| `--node-id <NODE_ID>` | Flownode's id |
| `--rpc-bind-addr <RPC_BIND_ADDR>` | The address to bind the gRPC server |
| `--rpc-server-addr <RPC_SERVER_ADDR>` | The address advertised to the metasrv, and used for connections from outside the host. If left empty or unset, the server will automatically use the IP address of the first network interface on the host, with the same port number as the one specified in `rpc_bind_addr` |
| `--grpc-bind-addr <GRPC_BIND_ADDR>` | The address to bind the gRPC server |
| `--grpc-server-addr <GRPC_SERVER_ADDR>` | The address advertised to the metasrv, and used for connections from outside the host. If left empty or unset, the server will automatically use the IP address of the first network interface on the host, with the same port number as the one specified in `grpc_bind_addr` |

## Examples

Expand All @@ -34,7 +34,7 @@ greptime flownode start -c config/flownode.example.toml
Starts a flownode instance with command line arguments specifying the address of the metasrv:

```sh
greptime flownode start --node-id=0 --rpc-bind-addr=127.0.0.1:6800 --metasrv-addrs=127.0.0.1:3002
greptime flownode start --node-id=0 --grpc-bind-addr=127.0.0.1:6800 --metasrv-addrs=127.0.0.1:3002
```

The `flownode.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuration files there. The `-c` option specifies the configuration file, for more information check [Configuration](/user-guide/deployments-administration/configuration.md).
Loading
Loading