aboutsummaryrefslogtreecommitdiff
path: root/src/util/config.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/util/config.rs')
-rw-r--r--src/util/config.rs27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/util/config.rs b/src/util/config.rs
index 9ff67711..fcbb32a9 100644
--- a/src/util/config.rs
+++ b/src/util/config.rs
@@ -1,3 +1,4 @@
+//! Contains type and functions related to Garage configuration file
use std::io::Read;
use std::net::SocketAddr;
use std::path::PathBuf;
@@ -6,57 +7,82 @@ use serde::{de, Deserialize};
use crate::error::Error;
+/// Represent the whole configuration
#[derive(Deserialize, Debug, Clone)]
pub struct Config {
+ /// Path where to store metadata. Should be fast, but low volume
pub metadata_dir: PathBuf,
+ /// Path where to store data. Can be slower, but need higher volume
pub data_dir: PathBuf,
+ /// Address to bind for RPC
pub rpc_bind_addr: SocketAddr,
+ /// Bootstrap peers RPC address
#[serde(deserialize_with = "deserialize_vec_addr")]
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>,
+ /// Max number of concurrent RPC request
#[serde(default = "default_max_concurrent_rpc_requests")]
pub max_concurrent_rpc_requests: usize,
+ /// Size of data blocks to save to disk
#[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
#[serde(default = "default_replication_factor")]
pub meta_replication_factor: usize,
+ /// How many nodes should hold a copy of data
#[serde(default = "default_replication_factor")]
pub data_replication_factor: usize,
+ /// Configuration for RPC TLS
pub rpc_tls: Option<TlsConfig>,
+ /// Configuration for S3 api
pub s3_api: ApiConfig,
+ /// Configuration for serving files as normal web server
pub s3_web: WebConfig,
}
+/// Configuration for RPC TLS
#[derive(Deserialize, Debug, Clone)]
pub struct TlsConfig {
+ /// Path to certificate autority used for all nodes
pub ca_cert: String,
+ /// Path to public certificate for this node
pub node_cert: String,
+ /// Path to private key for this node
pub node_key: String,
}
+/// Configuration for S3 api
#[derive(Deserialize, Debug, Clone)]
pub struct ApiConfig {
+ /// Address and port to bind for api serving
pub api_bind_addr: SocketAddr,
+ /// S3 region to use
pub s3_region: String,
}
+/// Configuration for serving files as normal web server
#[derive(Deserialize, Debug, Clone)]
pub struct WebConfig {
+ /// Address and port to bind for web serving
pub bind_addr: SocketAddr,
+ /// Suffix to remove from domain name to find bucket
pub root_domain: String,
+ /// Suffix to add when user-agent request path end with "/"
pub index: String,
}
@@ -73,6 +99,7 @@ fn default_control_write_max_faults() -> usize {
1
}
+/// Read and parse configuration
pub fn read_config(config_file: PathBuf) -> Result<Config, Error> {
let mut file = std::fs::OpenOptions::new()
.read(true)