Struct mz_environmentd::Config

source · 
pub struct Config {
Show 36 fields
    pub unsafe_mode: bool,
    pub all_features: bool,
    pub tls: Option<TlsCertConfig>,
    pub tls_reload_certs: ReloadTrigger,
    pub frontegg: Option<Authenticator>,
    pub cors_allowed_origin: AllowOrigin,
    pub egress_ips: Vec<Ipv4Addr>,
    pub http_host_name: Option<String>,
    pub internal_console_redirect_url: Option<String>,
    pub controller: ControllerConfig,
    pub secrets_controller: Arc<dyn SecretsController>,
    pub cloud_resource_controller: Option<Arc<dyn CloudResourceController>>,
    pub storage_usage_collection_interval: Duration,
    pub storage_usage_retention_period: Option<Duration>,
    pub catalog_config: CatalogConfig,
    pub availability_zones: Vec<String>,
    pub cluster_replica_sizes: ClusterReplicaSizeMap,
    pub timestamp_oracle_url: Option<String>,
    pub segment_api_key: Option<String>,
    pub launchdarkly_sdk_key: Option<String>,
    pub launchdarkly_key_map: BTreeMap<String, String>,
    pub config_sync_timeout: Duration,
    pub config_sync_loop_interval: Option<Duration>,
    pub environment_id: EnvironmentId,
    pub bootstrap_role: Option<String>,
    pub bootstrap_default_cluster_replica_size: String,
    pub bootstrap_builtin_system_cluster_replica_size: String,
    pub bootstrap_builtin_catalog_server_cluster_replica_size: String,
    pub bootstrap_builtin_probe_cluster_replica_size: String,
    pub bootstrap_builtin_support_cluster_replica_size: String,
    pub system_parameter_defaults: BTreeMap<String, String>,
    pub aws_account_id: Option<String>,
    pub aws_privatelink_availability_zones: Option<Vec<String>>,
    pub metrics_registry: MetricsRegistry,
    pub tracing_handle: TracingHandle,
    pub now: NowFn,

}
Expand description

Configuration for an environmentd server.

Fields§

§unsafe_mode: bool

Whether to permit usage of unsafe features. This is never meant to run in production.

§all_features: bool

Whether the environmentd is running on a local dev machine. This is never meant to run in production or CI.

§tls: Option<TlsCertConfig>

TLS encryption and authentication configuration.

§tls_reload_certs: ReloadTrigger

Trigger to attempt to reload TLS certififcates.

§frontegg: Option<Authenticator>

Frontegg JWT authentication configuration.

§cors_allowed_origin: AllowOrigin

Origins for which cross-origin resource sharing (CORS) for HTTP requests is permitted.

§egress_ips: Vec<Ipv4Addr>

Public IP addresses which the cloud environment has configured for egress.

§http_host_name: Option<String>

The external host name to connect to the HTTP server of this environment.

Presently used to render webhook URLs for end users in notices and the system catalog. Not used to establish connections directly.

§internal_console_redirect_url: Option<String>

The URL of the Materialize console to proxy from the /internal-console endpoint on the internal HTTP server.

§controller: ControllerConfig

Storage and compute controller configuration.

§secrets_controller: Arc<dyn SecretsController>

Secrets controller configuration.

§cloud_resource_controller: Option<Arc<dyn CloudResourceController>>

VpcEndpoint controller configuration.

§storage_usage_collection_interval: Duration

The interval at which to collect storage usage information.

§storage_usage_retention_period: Option<Duration>

How long to retain storage usage records for.

§catalog_config: CatalogConfig

Catalog configuration.

§availability_zones: Vec<String>

Availability zones in which storage and compute resources may be deployed.

§cluster_replica_sizes: ClusterReplicaSizeMap

A map from size name to resource allocations for cluster replicas.

§timestamp_oracle_url: Option<String>

The PostgreSQL URL for the Postgres-backed timestamp oracle.

§segment_api_key: Option<String>

An API key for Segment. Enables export of audit events to Segment.

§launchdarkly_sdk_key: Option<String>

An SDK key for LaunchDarkly. Enables system parameter synchronization with LaunchDarkly.

§launchdarkly_key_map: BTreeMap<String, String>

An invertible map from system parameter names to LaunchDarkly feature keys to use when propagating values from the latter to the former.

§config_sync_timeout: Duration

The duration at which the system parameter synchronization times out during startup.

§config_sync_loop_interval: Option<Duration>

The interval in seconds at which to synchronize system parameter values.

§environment_id: EnvironmentId

The cloud ID of this environment.

§bootstrap_role: Option<String>

What role, if any, should be initially created with elevated privileges.

§bootstrap_default_cluster_replica_size: String

The size of the default cluster replica if bootstrapping.

§bootstrap_builtin_system_cluster_replica_size: String

The size of the builtin system cluster replicas if bootstrapping.

§bootstrap_builtin_catalog_server_cluster_replica_size: String

The size of the builtin catalog server cluster replicas if bootstrapping.

§bootstrap_builtin_probe_cluster_replica_size: String

The size of the builtin probe cluster replicas if bootstrapping.

§bootstrap_builtin_support_cluster_replica_size: String

The size of the builtin support cluster replicas if bootstrapping.

§system_parameter_defaults: BTreeMap<String, String>

Values to set for system parameters, if those system parameters have not already been set by the system user.

§aws_account_id: Option<String>

The AWS account ID, which will be used to generate ARNs for Materialize-controlled AWS resources.

§aws_privatelink_availability_zones: Option<Vec<String>>

Supported AWS PrivateLink availability zone ids.

§metrics_registry: MetricsRegistry

The metrics registry to use.

§tracing_handle: TracingHandle

Handle to tracing.

§now: NowFn

A now generation function for mocking time.

Trait Implementations§

source§

impl Debug for Config

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !Freeze for Config

§

impl !RefUnwindSafe for Config

§

impl Send for Config

§

impl !Sync for Config

§

impl Unpin for Config

§

impl !UnwindSafe for Config

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> AsAny for T
where T: Any,

source§

fn as_any(&self) -> &(dyn Any + 'static)

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<T, U> CastInto<U> for T
where U: CastFrom<T>,

source§

fn cast_into(self) -> U

Performs the cast.
source§

impl<T> Conv for T

source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
source§

impl<T> FmtForward for T

source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FutureExt for T

source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T, U> OverrideFrom<Option<&T>> for U
where U: OverrideFrom<T>,

source§

fn override_from(self, layer: &Option<&T>) -> U

Override the configuration represented by Self with values from the given layer.
source§

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

source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

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<P, R> ProtoType<R> for P
where R: RustType<P>,

source§

fn into_rust(self) -> Result<R, TryFromProtoError>

See RustType::from_proto.
source§

fn from_rust(rust: &R) -> P

See RustType::into_proto.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<'a, S, T> Semigroup<&'a S> for T
where T: Semigroup<S>,

source§

fn plus_equals(&mut self, rhs: &&'a S)

The method of std::ops::AddAssign, for types that do not implement AddAssign.
source§

impl<T> Tap for T

source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

impl<T> TryConv for T

source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

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

§

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>,

§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

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