Skip to main content

NodeConfig

Struct NodeConfig 

Source
pub struct NodeConfig {
    pub bind_addr: String,
    pub node_id: u64,
    pub peers: Vec<String>,
    pub heartbeat_interval_ms: u64,
    pub election_timeout_ms: u64,
    pub compaction_threshold: usize,
    pub data_dir: Option<PathBuf>,
    pub metrics_addr: String,
    pub key_rotation_interval_secs: Option<u64>,
    pub key_retention_count: usize,
}
Expand description

Full cluster node configuration.

Can be loaded from a TOML file with NodeConfig::load or from a TOML string with NodeConfig::from_toml. After loading, call NodeConfig::apply_env_overrides to layer environment variable overrides on top.

§Field restart requirements

FieldHot-reloadable
heartbeat_interval_msYes (via DynamicConfig)
compaction_thresholdYes (via DynamicConfig)
All other fieldsNo — requires restart

Fields§

§bind_addr: String

Bind address for Raft RPC server (e.g. "0.0.0.0:7001").

§node_id: u64

Node ID — must be unique across the cluster and > 0.

§peers: Vec<String>

Peer addresses as "node_id=addr" strings, e.g. ["2=10.0.0.2:7001"].

§heartbeat_interval_ms: u64

Raft heartbeat interval in milliseconds (default 150).

Hot-reloadable.

§election_timeout_ms: u64

Raft election timeout in milliseconds (default 300).

Must be >= 2 * heartbeat_interval_ms. Requires restart to change.

§compaction_threshold: usize

Log compaction threshold: number of entries before triggering a snapshot (default 10 000).

Hot-reloadable.

§data_dir: Option<PathBuf>

Data directory for Raft log persistence. None disables persistence.

§metrics_addr: String

Metrics HTTP endpoint address (default "0.0.0.0:9091").

Requires restart to change.

§key_rotation_interval_secs: Option<u64>

Optional automatic-rotation interval for the log-encryption master key, in seconds. None disables time-based rotation; rotation can still be triggered manually via crate::key_rotation::KeyManager::rotate.

The background tokio task that drives time-based rotation is deferred to a future cycle; this field reserves the configuration surface for when it lands.

§key_retention_count: usize

Number of crate::key_rotation::KeyVersions the crate::key_rotation::KeyManager retains in its history (current and previous keys). Default 3. Lower values reclaim memory faster at the cost of decrypting fewer historical entries after rotation.

Implementations§

Source§

impl NodeConfig

Source

pub fn load(path: &Path) -> Result<Self, ConfigError>

Load from a TOML file, then layer environment variable overrides.

Env vars override individual fields:

Env varField
AMATERS_BIND_ADDRbind_addr
AMATERS_NODE_IDnode_id
AMATERS_PEERSpeers (comma-separated id=addr pairs)
AMATERS_HEARTBEAT_INTERVAL_MSheartbeat_interval_ms
AMATERS_ELECTION_TIMEOUT_MSelection_timeout_ms
AMATERS_COMPACTION_THRESHOLDcompaction_threshold
AMATERS_DATA_DIRdata_dir
AMATERS_METRICS_ADDRmetrics_addr
Source

pub fn from_toml(toml_str: &str) -> Result<Self, ConfigError>

Parse from a TOML string directly.

Useful in tests and when the configuration is provided via a secret store rather than a file on disk. Does not apply env overrides; call apply_env_overrides if you also want those.

Source

pub fn apply_env_overrides(&mut self)

Apply environment variable overrides from the current process environment.

Unset variables leave the corresponding field unchanged.

Source

pub fn dynamic(&self) -> DynamicConfig

Extract the hot-reloadable subset of this configuration.

The returned DynamicConfig can be stored in an Arc<parking_lot::RwLock<DynamicConfig>> and updated in place when the configuration is reloaded (e.g. on SIGHUP or via an admin RPC) without restarting the node.

Source

pub fn validate(&self) -> Vec<ConfigError>

Validate configuration fields.

Returns a list of ConfigError::Validation variants describing each detected problem. An empty return value means the configuration is valid.

Trait Implementations§

Source§

impl Clone for NodeConfig

Source§

fn clone(&self) -> NodeConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for NodeConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for NodeConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for NodeConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Input, Output> CastInto<Output> for Input
where Output: CastFrom<Input>,

Source§

fn cast_into(self) -> Output

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more