Struct cni_plugin::config::RuntimeConfig

#[non_exhaustive]pub struct RuntimeConfig {
    pub port_mappings: Vec<PortMapping>,
    pub ips_ranges: Vec<Vec<IpRange>>,
    pub bandwidth: Option<BandwidthLimits>,
    pub dns: Option<Dns>,
    pub ips: Vec<IpNetwork>,
    pub mac: Option<MacAddr6>,
    pub aliases: Vec<String>,
    pub specific: HashMap<String, Value>,
}

Dynamic information provided by the runtime.

These are generated by the runtime. Note that not all runtimes implement all of these. Also note that all fields below except for specific are for “well-known” configs as documented in CONVENTIONS.md, and those that are not implemented here will appear in the specific map.

Finally, note this struct is marked non-exhaustive: new fields may be added to hoist new “well-known” configs out of the specific map.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct {{ .. }} syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

port_mappings: Vec<PortMapping>

List of port mappings from host to namespace to set up.

ips_ranges: Vec<Vec<IpRange>>

List of pools to use for IPAM.

An IP pool is a list of IP ranges, hence this is this a list of lists of IP ranges. The outer list defines how many IP addresses to allocate, with each inner pool defining where to allocate from.

The IpRange type has methods to help with allocation.

bandwidth: Option<BandwidthLimits>

Bandwidth limits to set.

dns: Option<Dns>

DNS configuration.

Note that this section is set by the runtime. There is another field for DNS in sourced in the administrative config, see NetworkConfig.

ips: Vec<IpNetwork>

List of static IPs to use for IPAM.

mac: Option<MacAddr6>

MAC address to use for the interface.

aliases: Vec<String>

List of names mapped to the IPs assigned to this interface.

specific: HashMap<String, Value>

Custom runtime fields.

This is a serde(flatten) field which aggregates any and all additional custom fields not covered above.

Take note of the caveats in the struct documentation.

Trait Implementations

impl Clone for RuntimeConfig

fn clone(&self) -> RuntimeConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeConfig

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

Formats the value using the given formatter.

impl Default for RuntimeConfig

fn default() -> RuntimeConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RuntimeConfig

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

Deserialize this value from the given Serde deserializer.

impl Serialize for RuntimeConfig

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

Serialize this value into the given Serde serializer.