Enum OverlayMode 

pub enum OverlayMode {
    Auto,
    Shared,
    Dedicated,
    Isolated,
}

Per-service overlay data-plane attachment knob.

See the module docs for the full truth table; each variant bundles a container-attachment topology with a WireGuard transport choice.

Variants

Auto

Today’s default behavior: veth-per-container on a per-service Linux bridge, carried on the single cluster-wide WireGuard interface. No shared node-wide bridge / free-port proxy and no per-service WireGuard transport.

Shared

Max sharing: one shared node-wide bridge for all services plus a userspace free-port L4 proxy (host:FREEPORT -> container_ip:port). No per-service bridge and no per-service WireGuard; traffic rides the cluster-wide WireGuard interface.

Dedicated

Max isolation: veth-per-container on a per-service bridge, with its OWN per-service WireGuard transport (isolated crypto context). No shared node-wide bridge / free-port proxy.

Isolated

Per-service bridge on the cluster-wide WireGuard interface (same topology + transport as OverlayMode::Auto), but L3-fenced to its own isolation network: members reach their own network’s members plus the node IP and egress, never other networks’ members or arbitrary cluster overlay IPs. Sugar for “Auto topology auto-fenced to an isolation network named after the service” — it reuses the same isolation_network membership machinery the named-isolated-networks feature already uses on every platform. Distinct from OverlayMode::Dedicated, which isolates the crypto transport (its own WireGuard device), not the L3 scope.

Implementations

impl OverlayMode

pub fn resolve(self) -> OverlayMode

Identity resolution: each variant resolves to itself. Retained so existing .resolve() callers keep compiling. Auto no longer maps to Shared — Auto now denotes today’s default behavior (per-service bridge on the cluster-wide WireGuard interface) in its own right.

pub fn uses_shared_bridge(self) -> bool

Whether this mode uses the shared node-wide bridge plus the userspace free-port L4 proxy. True only for OverlayMode::Shared.

pub fn uses_per_service_wg(self) -> bool

Whether this mode provisions its own per-service WireGuard transport with an isolated crypto context. True only for OverlayMode::Dedicated.

pub fn uses_isolation_scope(self) -> bool

Whether this mode is L3-fenced to its own isolation network. True only for OverlayMode::Isolated. The fence reuses the platform-neutral isolation_network membership channel; the network is named after the service.

Trait Implementations

impl Clone for OverlayMode

fn clone(&self) -> OverlayMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OverlayMode

impl Debug for OverlayMode

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

Formats the value using the given formatter.

impl Default for OverlayMode

fn default() -> OverlayMode

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OverlayMode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OverlayMode

impl PartialEq for OverlayMode

fn eq(&self, other: &OverlayMode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OverlayMode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OverlayMode

impl ToSchema for OverlayMode

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.