Skip to content

Commit

Permalink
docs: add example configs introduced by pg_kvbackend (#4573)
Browse files Browse the repository at this point in the history
chore: add example configs that introduced after pg_kvbackend
  • Loading branch information
lyang24 authored Aug 22, 2024
1 parent 9c1704d commit ff04109
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
3 changes: 2 additions & 1 deletion config/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,12 +260,13 @@
| `data_home` | String | `/tmp/metasrv/` | The working home directory. |
| `bind_addr` | String | `127.0.0.1:3002` | The bind address of metasrv. |
| `server_addr` | String | `127.0.0.1:3002` | The communication server address for frontend and datanode to connect to metasrv, "127.0.0.1:3002" by default for localhost. |
| `store_addr` | String | `127.0.0.1:2379` | Etcd server address. |
| `store_addr` | String | `127.0.0.1:2379` | Store server address default to etcd store. |
| `selector` | String | `round_robin` | Datanode selector type.<br/>- `round_robin` (default value)<br/>- `lease_based`<br/>- `load_based`<br/>For details, please see "https://docs.greptime.com/developer-guide/metasrv/selector". |
| `use_memory_store` | Bool | `false` | Store data in memory. |
| `enable_telemetry` | Bool | `true` | Whether to enable greptimedb telemetry. |
| `store_key_prefix` | String | `""` | If it's not empty, the metasrv will store all data with this key prefix. |
| `enable_region_failover` | Bool | `false` | Whether to enable region failover.<br/>This feature is only available on GreptimeDB running on cluster mode and<br/>- Using Remote WAL<br/>- Using shared storage (e.g., s3). |
| `backend` | String | `EtcdStore` | The datastore for meta server. |
| `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. |
Expand Down
5 changes: 4 additions & 1 deletion config/metasrv.example.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ bind_addr = "127.0.0.1:3002"
## The communication server address for frontend and datanode to connect to metasrv, "127.0.0.1:3002" by default for localhost.
server_addr = "127.0.0.1:3002"

## Etcd server address.
## Store server address default to etcd store.
store_addr = "127.0.0.1:2379"

## Datanode selector type.
Expand All @@ -32,6 +32,9 @@ store_key_prefix = ""
## - Using shared storage (e.g., s3).
enable_region_failover = false

## The datastore for meta server.
backend = "EtcdStore"

## The runtime options.
[runtime]
## The number of threads to execute the runtime for global read operations.
Expand Down

0 comments on commit ff04109

Please sign in to comment.