garage/src/util/config.rs

142 lines
3.6 KiB
Rust
Raw Normal View History

2021-03-20 19:38:44 +00:00
//! Contains type and functions related to Garage configuration file
2020-04-23 17:05:46 +00:00
use std::io::Read;
use std::net::SocketAddr;
use std::path::PathBuf;
use serde::{de, Deserialize};
2020-04-23 17:05:46 +00:00
use crate::error::Error;
2021-03-20 19:38:44 +00:00
/// Represent the whole configuration
2020-04-23 17:05:46 +00:00
#[derive(Deserialize, Debug, Clone)]
pub struct Config {
/// Path where to store metadata. Should be fast, but low volume
2020-04-23 17:05:46 +00:00
pub metadata_dir: PathBuf,
/// Path where to store data. Can be slower, but need higher volume
2020-04-23 17:05:46 +00:00
pub data_dir: PathBuf,
/// Address to bind for RPC
2020-04-23 17:05:46 +00:00
pub rpc_bind_addr: SocketAddr,
/// Bootstrap peers RPC address
#[serde(deserialize_with = "deserialize_vec_addr")]
2020-04-23 17:05:46 +00:00
pub bootstrap_peers: Vec<SocketAddr>,
/// Consule host to connect to to discover more peers
pub consul_host: Option<String>,
/// Consul service name to use
pub consul_service_name: Option<String>,
2020-04-23 17:05:46 +00:00
/// Max number of concurrent RPC request
2020-04-23 17:05:46 +00:00
#[serde(default = "default_max_concurrent_rpc_requests")]
pub max_concurrent_rpc_requests: usize,
/// Size of data blocks to save to disk
2020-04-23 17:05:46 +00:00
#[serde(default = "default_block_size")]
pub block_size: usize,
#[serde(default = "default_control_write_max_faults")]
pub control_write_max_faults: usize,
/// How many nodes should hold a copy of meta data
2020-04-23 17:05:46 +00:00
#[serde(default = "default_replication_factor")]
pub meta_replication_factor: usize,
/// How many nodes should hold a copy of data
2020-04-23 17:05:46 +00:00
#[serde(default = "default_replication_factor")]
pub data_replication_factor: usize,
2021-03-17 19:37:31 +00:00
/// Zstd compression level used on data blocks
#[serde(default)]
pub compression_level: i32,
/// Configuration for RPC TLS
2020-04-23 17:05:46 +00:00
pub rpc_tls: Option<TlsConfig>,
2020-04-24 17:46:52 +00:00
/// Configuration for S3 api
2020-04-24 17:46:52 +00:00
pub s3_api: ApiConfig,
2020-10-31 16:28:56 +00:00
/// Configuration for serving files as normal web server
2020-10-31 16:28:56 +00:00
pub s3_web: WebConfig,
2020-04-23 17:05:46 +00:00
}
2021-03-20 19:38:44 +00:00
/// Configuration for RPC TLS
2020-04-24 10:10:01 +00:00
#[derive(Deserialize, Debug, Clone)]
pub struct TlsConfig {
/// Path to certificate autority used for all nodes
2020-04-24 10:10:01 +00:00
pub ca_cert: String,
/// Path to public certificate for this node
2020-04-24 10:10:01 +00:00
pub node_cert: String,
/// Path to private key for this node
2020-04-24 10:10:01 +00:00
pub node_key: String,
}
2021-03-20 19:38:44 +00:00
/// Configuration for S3 api
2020-04-24 17:46:52 +00:00
#[derive(Deserialize, Debug, Clone)]
pub struct ApiConfig {
/// Address and port to bind for api serving
2020-04-24 17:46:52 +00:00
pub api_bind_addr: SocketAddr,
/// S3 region to use
2020-04-24 17:46:52 +00:00
pub s3_region: String,
}
2021-03-20 19:38:44 +00:00
/// Configuration for serving files as normal web server
2020-10-31 16:28:56 +00:00
#[derive(Deserialize, Debug, Clone)]
pub struct WebConfig {
/// Address and port to bind for web serving
2020-11-10 08:57:07 +00:00
pub bind_addr: SocketAddr,
/// Suffix to remove from domain name to find bucket
2020-11-10 08:57:07 +00:00
pub root_domain: String,
/// Suffix to add when user-agent request path end with "/"
2020-11-11 18:48:01 +00:00
pub index: String,
2020-10-31 16:28:56 +00:00
}
2020-04-23 17:05:46 +00:00
fn default_max_concurrent_rpc_requests() -> usize {
12
}
fn default_block_size() -> usize {
1048576
}
fn default_replication_factor() -> usize {
3
}
fn default_control_write_max_faults() -> usize {
1
2020-04-23 17:05:46 +00:00
}
2021-03-20 19:38:44 +00:00
/// Read and parse configuration
2020-04-23 17:05:46 +00:00
pub fn read_config(config_file: PathBuf) -> Result<Config, Error> {
let mut file = std::fs::OpenOptions::new()
.read(true)
.open(config_file.as_path())?;
let mut config = String::new();
file.read_to_string(&mut config)?;
Ok(toml::from_str(&config)?)
}
fn deserialize_vec_addr<'de, D>(deserializer: D) -> Result<Vec<SocketAddr>, D::Error>
where
D: de::Deserializer<'de>,
{
use std::net::ToSocketAddrs;
Ok(<Vec<&str>>::deserialize(deserializer)?
.iter()
.filter_map(|&name| {
name.to_socket_addrs()
.map(|iter| (name, iter))
.map_err(|_| warn!("Error resolving \"{}\"", name))
.ok()
})
.map(|(name, iter)| {
let v = iter.collect::<Vec<_>>();
if v.is_empty() {
warn!("Error resolving \"{}\"", name)
}
v
})
.flatten()
.collect())
}