gsadmin/garage
1
0
Fork 0
mirror of https://github.com/deuxfleurs-org/garage.git synced 2026-09-04 11:15:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

small documentation fixes and simplify config struct

Browse Source
This commit is contained in:
Alex Auvolat
2026-01-06 14:32:07 +01:00
parent 2f7a649870
commit dc8d93698b
3 changed files with 19 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/book/reference-manual/configuration.md
+17 -10
View File
@@ -51,19 +51,21 @@ allow_punycode = false
[consul_discovery] [consul_discovery]
api = "catalog" api = "catalog"
consul_http_addr = "http://127.0.0.1:8500" consul_http_addr = "https://127.0.0.1:8500"
tls_skip_verify = false
service_name = "garage-daemon" service_name = "garage-daemon"
ca_cert = "/etc/consul/consul-ca.crt" ca_cert = "/etc/consul/consul-ca.crt"
client_cert = "/etc/consul/consul-client.crt" client_cert = "/etc/consul/consul-client.crt"
client_key = "/etc/consul/consul-key.crt" client_key = "/etc/consul/consul-key.crt"
# for `agent` API mode, unset client_cert and client_key, and optionally enable `token` # for `agent` API mode, unset client_cert and client_key, and optionally enable `token`
# token = "abcdef-01234-56789" # token = "abcdef-01234-56789"
tls_skip_verify = false
tags = [ "dns-enabled" ] tags = [ "dns-enabled" ]
meta = { dns-acl = "allow trusted" } meta = { dns-acl = "allow trusted" }
# If your consul cluster is in a WAN configuration, you can provide the datacenter names to allow garage to do discovery across a WAN federation. datacenters = ["dc1", "dc2", "dc3"]
# This is not required for non-WAN consul instances.
# datacenters = ["dc1", "dc2", "dc3"]
[kubernetes_discovery] [kubernetes_discovery]
namespace = "garage" namespace = "garage"
service_name = "garage-daemon" service_name = "garage-daemon"
@@ -730,14 +732,19 @@ node_prefix "" {
``` ```
### `consul datacenters` {#consul_datacenters} #### `datacenters` {#consul_datacenters}
Optional list of datacenters that allow garage to do service discovery when consul is configured in WAN federation. Optional list of datacenters that allow garage to do service discovery when Consul is configured in WAN federation.
e.g datacenters = ["dc1", "dc2", "dc3"]
In a WAN configuration the consul services API only responds with local `LAN` services. Example: `datacenters = ["dc1", "dc2", "dc3"]`
This queries the consul server API by datacenter directly, allowing for garage to discover nodes across consul WAN.
In a WAN configuration, by default the Consul services API only responds with
local LAN services. When a list of datacenters is specified using this option,
Garage will query the consul server API by datacenter directly, allowing for
Garage to discover nodes across the Consul WAN.
#### `tags` and `meta` {#consul_tags_and_meta} #### `tags` and `meta` {#consul_tags_and_meta}
Additional list of tags and map of service meta to add during service registration. Additional list of tags and map of service meta to add during service registration.
### The `[kubernetes_discovery]` section ### The `[kubernetes_discovery]` section
src/rpc/consul.rs
+1 -1
View File
@@ -141,7 +141,7 @@ impl ConsulDiscovery {
let mut ret = vec![]; let mut ret = vec![];
let dcs_to_query: Vec<Option<&str>> = match &self.config.datacenters { let dcs_to_query: Vec<Option<&str>> = match &self.config.datacenters {
Some(dcs) if !dcs.is_empty() => dcs.iter().map(|dc| Some(dc.as_str())).collect(), dcs if !dcs.is_empty() => dcs.iter().map(|dc| Some(dc.as_str())).collect(),
_ => vec![None], _ => vec![None],
}; };
src/util/config.rs
+1 -1
View File
@@ -258,7 +258,7 @@ pub struct ConsulDiscoveryConfig {
#[serde(default)] #[serde(default)]
pub meta: Option<std::collections::HashMap<String, String>>, pub meta: Option<std::collections::HashMap<String, String>>,
#[serde(default)] #[serde(default)]
pub datacenters: Option<Vec<String>>, pub datacenters: Vec<String>,
} }
#[derive(Deserialize, Debug, Clone)] #[derive(Deserialize, Debug, Clone)]