Struct ConnectProxyConfig

pub struct ConnectProxyConfig {
    pub envoy_extensions: Option<Vec<EnvoyExtension>>,
    pub destination_service_name: Option<String>,
    pub destination_service_id: Option<String>,
    pub local_service_address: Option<String>,
    pub local_service_port: Option<u16>,
    pub local_service_socket_path: Option<String>,
    pub mode: String,
    pub upstreams: Option<Upstreams>,
    pub mesh_gateway: Option<MeshGatewayConfig>,
    pub expose: Option<ExposeConfig>,
    pub transparent_proxy: Option<TransparentProxyConfig>,
    pub access_logs: Option<AccessLogsConfig>,
}

ConnectProxyConfig describes the configuration needed for any proxy managed or unmanaged. It describes a single logical service’s listener and optionally upstreams and sidecar-related config for a single instance. To describe a centralized proxy that routed traffic for multiple services, a different one of these would be needed for each, sharing the same LogicalProxyID.

Fields

envoy_extensions: Option<Vec<EnvoyExtension>>

EnvoyExtensions are the list of Envoy extensions configured for the local service.

destination_service_name: Option<String>

DestinationServiceName is required and is the name of the service to accept traffic for.

destination_service_id: Option<String>

DestinationServiceID is optional and should only be specified for “side-car” style proxies where the proxy is in front of just a single instance of the service. It should be set to the service ID of the instance being represented which must be registered to the same agent. It’s valid to provide a service ID that does not yet exist to avoid timing issues when bootstrapping a service with a proxy.

local_service_address: Option<String>

LocalServiceAddress is the address of the local service instance. It is optional and should only be specified for “side-car” style proxies. It will default to 127.0.0.1 if the proxy is a “side-car” (DestinationServiceID is set) but otherwise will be ignored.

local_service_port: Option<u16>

LocalServicePort is the port of the local service instance. It is optional and should only be specified for “side-car” style proxies. It will default to the registered port for the instance if the proxy is a “side-car” (DestinationServiceID is set) but otherwise will be ignored.

local_service_socket_path: Option<String>

LocalServiceSocketPath is the socket of the local service instance. It is optional and should only be specified for “side-car” style proxies.

mode: String

Mode represents how the proxy’s inbound and upstream listeners are dialed.

upstreams: Option<Upstreams>

Upstreams describes any upstream dependencies the proxy instance should setup.

mesh_gateway: Option<MeshGatewayConfig>

MeshGateway defines the mesh gateway configuration for this upstream

expose: Option<ExposeConfig>

Expose defines whether checks or paths are exposed through the proxy

transparent_proxy: Option<TransparentProxyConfig>

TransparentProxy defines configuration for when the proxy is in transparent mode.

access_logs: Option<AccessLogsConfig>

AccessLogs configures the output and format of Envoy access logs

Trait Implementations

impl Clone for ConnectProxyConfig

fn clone(&self) -> ConnectProxyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectProxyConfig

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

Formats the value using the given formatter.

impl Default for ConnectProxyConfig

fn default() -> ConnectProxyConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConnectProxyConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ConnectProxyConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.