From c9a7b1fd6855b17f32e250778ac37c31e3cbbece Mon Sep 17 00:00:00 2001 From: fys <40801205+fengys1996@users.noreply.github.com> Date: Sat, 22 Nov 2025 06:26:52 +0800 Subject: [PATCH] docs(config): clarify `store_addrs` format (#7279) --- config/config.md | 5 ++--- config/metasrv.example.toml | 24 ++++++++++++++++-------- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/config/config.md b/config/config.md index 3aa22a5cc6..29185c6b58 100644 --- a/config/config.md +++ b/config/config.md @@ -340,7 +340,7 @@ | Key | Type | Default | Descriptions | | --- | -----| ------- | ----------- | | `data_home` | String | `./greptimedb_data` | The working home directory. | -| `store_addrs` | Array | -- | Store server address default to etcd store.
For postgres store, the format is:
"password=password dbname=postgres user=postgres host=localhost port=5432"
For etcd store, the format is:
"127.0.0.1:2379" | +| `store_addrs` | Array | -- | Store server address(es). The format depends on the selected backend.

For etcd: a list of "host:port" endpoints.
e.g. ["192.168.1.1:2379", "192.168.1.2:2379"]

For PostgreSQL: a connection string in libpq format or URI.
e.g.
- "host=localhost port=5432 user=postgres password= dbname=postgres"
- "postgresql://user:password@localhost:5432/mydb?connect_timeout=10"
The detail see: https://docs.rs/tokio-postgres/latest/tokio_postgres/config/struct.Config.html

For mysql store, the format is a MySQL connection URL.
e.g. "mysql://user:password@localhost:3306/greptime_meta?ssl-mode=VERIFY_CA&ssl-ca=/path/to/ca.pem" | | `store_key_prefix` | String | `""` | If it's not empty, the metasrv will store all data with this key prefix. | | `backend` | String | `etcd_store` | The datastore for meta server.
Available values:
- `etcd_store` (default value)
- `memory_store`
- `postgres_store`
- `mysql_store` | | `meta_table_name` | String | `greptime_metakv` | Table name in RDS to store metadata. Effect when using a RDS kvbackend.
**Only used when backend is `postgres_store`.** | @@ -356,12 +356,11 @@ | `runtime` | -- | -- | The runtime options. | | `runtime.global_rt_size` | Integer | `8` | The number of threads to execute the runtime for global read operations. | | `runtime.compact_rt_size` | Integer | `4` | The number of threads to execute the runtime for global write operations. | -| `backend_tls` | -- | -- | TLS configuration for kv store backend (applicable for etcd, PostgreSQL, and MySQL backends)
When using etcd, PostgreSQL, or MySQL as metadata store, you can configure TLS here | +| `backend_tls` | -- | -- | TLS configuration for kv store backend (applicable for etcd, PostgreSQL, and MySQL backends)
When using etcd, PostgreSQL, or MySQL as metadata store, you can configure TLS here

Note: if TLS is configured in both this section and the `store_addrs` connection string, the
settings here will override the TLS settings in `store_addrs`. | | `backend_tls.mode` | String | `prefer` | TLS mode, refer to https://www.postgresql.org/docs/current/libpq-ssl.html
- "disable" - No TLS
- "prefer" (default) - Try TLS, fallback to plain
- "require" - Require TLS
- "verify_ca" - Require TLS and verify CA
- "verify_full" - Require TLS and verify hostname | | `backend_tls.cert_path` | String | `""` | Path to client certificate file (for client authentication)
Like "/path/to/client.crt" | | `backend_tls.key_path` | String | `""` | Path to client private key file (for client authentication)
Like "/path/to/client.key" | | `backend_tls.ca_cert_path` | String | `""` | Path to CA certificate file (for server certificate verification)
Required when using custom CAs or self-signed certificates
Leave empty to use system root certificates only
Like "/path/to/ca.crt" | -| `backend_tls.watch` | Bool | `false` | Watch for certificate file changes and auto reload | | `grpc` | -- | -- | The gRPC server options. | | `grpc.bind_addr` | String | `127.0.0.1:3002` | The address to bind the gRPC server. | | `grpc.server_addr` | String | `127.0.0.1:3002` | The communication server address for the frontend and datanode to connect to metasrv.
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 `bind_addr`. | diff --git a/config/metasrv.example.toml b/config/metasrv.example.toml index 38810362a8..7997383a52 100644 --- a/config/metasrv.example.toml +++ b/config/metasrv.example.toml @@ -1,11 +1,19 @@ ## The working home directory. data_home = "./greptimedb_data" -## Store server address default to etcd store. -## For postgres store, the format is: -## "password=password dbname=postgres user=postgres host=localhost port=5432" -## For etcd store, the format is: -## "127.0.0.1:2379" +## Store server address(es). The format depends on the selected backend. +## +## For etcd: a list of "host:port" endpoints. +## e.g. ["192.168.1.1:2379", "192.168.1.2:2379"] +## +## For PostgreSQL: a connection string in libpq format or URI. +## e.g. +## - "host=localhost port=5432 user=postgres password= dbname=postgres" +## - "postgresql://user:password@localhost:5432/mydb?connect_timeout=10" +## The detail see: https://docs.rs/tokio-postgres/latest/tokio_postgres/config/struct.Config.html +## +## For mysql store, the format is a MySQL connection URL. +## e.g. "mysql://user:password@localhost:3306/greptime_meta?ssl-mode=VERIFY_CA&ssl-ca=/path/to/ca.pem" store_addrs = ["127.0.0.1:2379"] ## If it's not empty, the metasrv will store all data with this key prefix. @@ -75,6 +83,9 @@ node_max_idle_time = "24hours" ## TLS configuration for kv store backend (applicable for etcd, PostgreSQL, and MySQL backends) ## When using etcd, PostgreSQL, or MySQL as metadata store, you can configure TLS here +## +## Note: if TLS is configured in both this section and the `store_addrs` connection string, the +## settings here will override the TLS settings in `store_addrs`. [backend_tls] ## TLS mode, refer to https://www.postgresql.org/docs/current/libpq-ssl.html ## - "disable" - No TLS @@ -98,9 +109,6 @@ key_path = "" ## Like "/path/to/ca.crt" ca_cert_path = "" -## Watch for certificate file changes and auto reload -watch = false - ## The gRPC server options. [grpc] ## The address to bind the gRPC server.