Struct PathConfigSource

pub struct PathConfigSource {
    pub path: String,
    pub watched_directory: Option<WatchedDirectory>,
}

Local filesystem path configuration source.

Fields

path: String

Path on the filesystem to source and watch for configuration updates. When sourcing configuration for a :ref:secret <envoy_v3_api_msg_extensions.transport_sockets.tls.v3.Secret>, the certificate and key files are also watched for updates.

.. note::

The path to the source must exist at config load time.

.. note::

If watched_directory is not configured, Envoy will watch the file path for moves. This is because in general only moves are atomic. The same method of swapping files as is demonstrated in the :ref:runtime documentation <config_runtime_symbolic_link_swap> can be used here also. If watched_directory is configured, no watch will be placed directly on this path. Instead, the configured watched_directory will be used to trigger reloads of this path. This is required in certain deployment scenarios. See below for more information.

watched_directory: Option<WatchedDirectory>

If configured, this directory will be watched for moves. When an entry in this directory is moved to, the path will be reloaded. This is required in certain deployment scenarios.

Specifically, if trying to load an xDS resource using a Kubernetes ConfigMap <<https://kubernetes.io/docs/concepts/configuration/configmap/>_,> the following configuration might be used:

1. Store xds.yaml inside a ConfigMap.
2. Mount the ConfigMap to /config_map/xds
3. Configure path /config_map/xds/xds.yaml
4. Configure watched directory /config_map/xds

The above configuration will ensure that Envoy watches the owning directory for moves which is required due to how Kubernetes manages ConfigMap symbolic links during atomic updates.

Trait Implementations

impl Clone for PathConfigSource

fn clone(&self) -> PathConfigSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathConfigSource

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

Formats the value using the given formatter.

impl Default for PathConfigSource

fn default() -> Self

Returns the “default value” for a type.

impl Message for PathConfigSource

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for PathConfigSource

const NAME: &'static str = "PathConfigSource"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "envoy.config.core.v3"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for PathConfigSource

fn eq(&self, other: &PathConfigSource) -> 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 StructuralPartialEq for PathConfigSource