Struct Args

pub struct Args {

    unsafe_mode: bool,
    all_features: bool,
    listeners_config_path: PathBuf,
    external_login_password_mz_system: Option<Password>,
    internal_persist_pubsub_listen_addr: SocketAddr,
    cors_allowed_origin: Vec<HeaderValue>,
    announce_egress_address: Vec<IpNet>,
    http_host_name: Option<String>,
    internal_console_redirect_url: Option<String>,
    tls: TlsCliArgs,
    frontegg: FronteggCliArgs,
    orchestrator: OrchestratorKind,
    orchestrator_kubernetes_scheduler_name: Option<String>,
    orchestrator_kubernetes_service_annotation: Vec<KeyValueArg<String, String>>,
    orchestrator_kubernetes_service_label: Vec<KeyValueArg<String, String>>,
    orchestrator_kubernetes_service_node_selector: Vec<KeyValueArg<String, String>>,
    orchestrator_kubernetes_service_affinity: Option<String>,
    orchestrator_kubernetes_service_tolerations: Option<String>,
    orchestrator_kubernetes_service_account: Option<String>,
    orchestrator_kubernetes_context: String,
    orchestrator_kubernetes_image_pull_policy: KubernetesImagePullPolicy,
    orchestrator_kubernetes_init_container_image: Option<String>,
    orchestrator_kubernetes_ephemeral_volume_class: Option<String>,
    orchestrator_kubernetes_service_fs_group: Option<i64>,
    orchestrator_kubernetes_name_prefix: Option<String>,
    orchestrator_kubernetes_disable_pod_metrics_collection: bool,
    orchestrator_kubernetes_enable_prometheus_scrape_annotations: bool,
    orchestrator_process_wrapper: Option<String>,
    orchestrator_process_secrets_directory: Option<PathBuf>,
    orchestrator_process_propagate_crashes: bool,
    orchestrator_process_tcp_proxy_listen_addr: Option<IpAddr>,
    orchestrator_process_prometheus_service_discovery_directory: Option<PathBuf>,
    orchestrator_process_scratch_directory: Option<PathBuf>,
    orchestrator_kubernetes_coverage: bool,
    secrets_controller: SecretsControllerKind,
    aws_secrets_controller_tags: Vec<KeyValueArg<String, String>>,
    clusterd_image: Option<String>,
    deploy_generation: u64,
    metadata_backend_url: Option<SensitiveUrl>,
    helm_chart_version: Option<String>,
    persist_blob_url: SensitiveUrl,
    persist_consensus_url: Option<SensitiveUrl>,
    persist_pubsub_url: String,
    persist_isolated_runtime_threads: Option<isize>,
    storage_usage_collection_interval_sec: Duration,
    storage_usage_retention_period: Option<Duration>,
    timestamp_oracle_url: Option<SensitiveUrl>,
    availability_zone: Vec<String>,
    cluster_replica_sizes: String,
    segment_api_key: Option<String>,
    segment_client_side: bool,
    test_only_dummy_segment_client: bool,
    launchdarkly_sdk_key: Option<String>,
    launchdarkly_key_map: Vec<KeyValueArg<String, String>>,
    config_sync_timeout: Duration,
    config_sync_loop_interval: Option<Duration>,
    config_sync_file_path: Option<PathBuf>,
    environment_id: EnvironmentId,
    bootstrap_role: Option<String>,
    bootstrap_default_cluster_replica_size: String,
    bootstrap_builtin_system_cluster_replica_size: String,
    bootstrap_builtin_catalog_server_cluster_replica_size: String,
    bootstrap_builtin_probe_cluster_replica_size: String,
    bootstrap_builtin_support_cluster_replica_size: String,
    bootstrap_builtin_analytics_cluster_replica_size: String,
    bootstrap_default_cluster_replication_factor: u32,
    bootstrap_builtin_system_cluster_replication_factor: u32,
    bootstrap_builtin_catalog_server_cluster_replication_factor: u32,
    bootstrap_builtin_probe_cluster_replication_factor: u32,
    bootstrap_builtin_support_cluster_replication_factor: u32,
    bootstrap_builtin_analytics_cluster_replication_factor: u32,
    system_parameter_default: Vec<KeyValueArg<String, String>>,
    license_key: Option<String>,
    aws_account_id: Option<String>,
    aws_connection_role_arn: Option<String>,
    aws_external_id_prefix: Option<AwsExternalIdPrefix>,
    aws_privatelink_availability_zones: Option<Vec<String>>,
    tracing: TracingCliArgs,
    unsafe_builtin_table_fingerprint_whitespace: Option<UnsafeBuiltinTableFingerprintWhitespace>,
    unsafe_builtin_table_fingerprint_whitespace_version: usize,
}

Manages a single Materialize environment.

Fields

unsafe_mode: bool

Enable unsafe features. Unsafe features are those that should never run in production but are appropriate for testing/local development.

all_features: bool

Enables all feature flags, meant only as a tool for local development; this should never be enabled in CI.

listeners_config_path: PathBuf

Path to a file containing the json-formatted configuration of our metrics, HTTP, and sql listeners.

external_login_password_mz_system: Option<Password>

Password for the mz_system user.

internal_persist_pubsub_listen_addr: SocketAddr

The address on which to listen for Persist PubSub connections.

Connections to this address are not subject to encryption, authentication, or access control. Care should be taken to not expose the listen address to the public internet or other unauthorized parties.

cors_allowed_origin: Vec<HeaderValue>

Enable cross-origin resource sharing (CORS) for HTTP requests from the specified origin.

The default allows all local connections. “” allows all. “.domain.com” allows connections from any matching subdomain.

Wildcards in other positions (e.g., “https://.foo.com” or “https://foo..com”) have no effect.

announce_egress_address: Vec<IpNet>

Public CIDR 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.

tls: TlsCliArgs

TLS arguments.

frontegg: FronteggCliArgs

Frontegg arguments.

orchestrator: OrchestratorKind

The service orchestrator implementation to use.

orchestrator_kubernetes_scheduler_name: Option<String>

Name of a non-default Kubernetes scheduler, if any.

orchestrator_kubernetes_service_annotation: Vec<KeyValueArg<String, String>>

Annotations to apply to all services created by the Kubernetes orchestrator in the form KEY=VALUE.

orchestrator_kubernetes_service_label: Vec<KeyValueArg<String, String>>

Labels to apply to all services created by the Kubernetes orchestrator in the form KEY=VALUE.

orchestrator_kubernetes_service_node_selector: Vec<KeyValueArg<String, String>>

Node selector to apply to all services created by the Kubernetes orchestrator in the form KEY=VALUE.

orchestrator_kubernetes_service_affinity: Option<String>

Affinity to apply to all services created by the Kubernetes orchestrator as a JSON string.

orchestrator_kubernetes_service_tolerations: Option<String>

Tolerations to apply to all services created by the Kubernetes orchestrator as a JSON string.

orchestrator_kubernetes_service_account: Option<String>

The name of a service account to apply to all services created by the Kubernetes orchestrator.

orchestrator_kubernetes_context: String

The Kubernetes context to use with the Kubernetes orchestrator.

This defaults to minikube to prevent disaster (e.g., connecting to a production cluster that happens to be the active Kubernetes context.)

orchestrator_kubernetes_image_pull_policy: KubernetesImagePullPolicy

The image pull policy to use for services created by the Kubernetes orchestrator.

orchestrator_kubernetes_init_container_image: Option<String>

The init container for services created by the Kubernetes orchestrator.

orchestrator_kubernetes_ephemeral_volume_class: Option<String>

The Kubernetes StorageClass to use for the ephemeral volume attached to services that request disk.

If unspecified, the Kubernetes orchestrator will refuse to create services that request disk.

orchestrator_kubernetes_service_fs_group: Option<i64>

The optional fs group for service’s pods’ securityContext.

orchestrator_kubernetes_name_prefix: Option<String>

The prefix to prepend to all kubernetes object names.

orchestrator_kubernetes_disable_pod_metrics_collection: bool

Whether to enable pod metrics collection.

orchestrator_kubernetes_enable_prometheus_scrape_annotations: bool

Whether to annotate pods for prometheus service discovery.

orchestrator_process_wrapper: Option<String>

orchestrator_process_secrets_directory: Option<PathBuf>

Where the process orchestrator should store secrets.

orchestrator_process_propagate_crashes: bool

Whether the process orchestrator should handle crashes in child processes by crashing the parent process.

orchestrator_process_tcp_proxy_listen_addr: Option<IpAddr>

An IP address on which the process orchestrator should bind TCP proxies for Unix domain sockets.

When specified, for each named port of each created service, the process orchestrator will bind a TCP listener to the specified address that proxies incoming connections to the underlying Unix domain socket. The allocated TCP port will be emitted as a tracing event.

The primary use is live debugging the running child services via tools that do not support Unix domain sockets (e.g., Prometheus, web browsers).

orchestrator_process_prometheus_service_discovery_directory: Option<PathBuf>

A directory in which the process orchestrator should write Prometheus scrape targets, for use with Prometheus’s file-based service discovery.

Each namespaced orchestrator will maintain a single JSON file into the directory named NAMESPACE.json containing the scrape targets for all extant services. The scrape targets will use the TCP proxy address, as Prometheus does not support scraping over Unix domain sockets.

This option is ignored unless --orchestrator-process-tcp-proxy-listen-addr is set.

See also: https://prometheus.io/docs/guides/file-sd/

orchestrator_process_scratch_directory: Option<PathBuf>

A scratch directory that orchestrated processes can use for ephemeral storage.

orchestrator_kubernetes_coverage: bool

Whether to use coverage build and collect coverage information. Not to be used for production, only testing.

secrets_controller: SecretsControllerKind

The secrets controller implementation to use.

aws_secrets_controller_tags: Vec<KeyValueArg<String, String>>

The list of tags to be set on AWS Secrets Manager secrets created by the AWS secrets controller.

clusterd_image: Option<String>

The clusterd image reference to use.

deploy_generation: u64

A number representing the environment’s generation.

This is incremented to request that the new process perform a graceful transition of power from the prior generation.

metadata_backend_url: Option<SensitiveUrl>

Can be provided in place of both persist_consensus_url and timestamp_oracle_url in order to point both at the same backend

helm_chart_version: Option<String>

Helm chart version for self-hosted Materialize. This version does not correspond to the Materialize (core) version (v0.125.0), but is time-based for our twice-a-year helm chart releases: v25.1.Z, v25.2.Z in 2025, then v26.1.Z, v26.2.Z in 2026, and so on. This version is displayed in addition in SELECT mz_version() if set.

persist_blob_url: SensitiveUrl

Where the persist library should store its blob data.

persist_consensus_url: Option<SensitiveUrl>

Where the persist library should perform consensus.

persist_pubsub_url: String

The Persist PubSub URL.

This URL is passed to clusterd for discovery of the Persist PubSub service.

persist_isolated_runtime_threads: Option<isize>

The number of worker threads created for the IsolatedRuntime used for storage related tasks. A negative value will subtract from the number of threads returned by num_cpus::get.

storage_usage_collection_interval_sec: Duration

The interval in seconds at which to collect storage usage information.

storage_usage_retention_period: Option<Duration>

The period for which to retain usage records. Note that the retention period is only evaluated at server start time, so rebooting the server is required to discard old records.

timestamp_oracle_url: Option<SensitiveUrl>

The PostgreSQL URL for the Postgres-backed timestamp oracle.

availability_zone: Vec<String>

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

cluster_replica_sizes: String

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

segment_api_key: Option<String>

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

segment_client_side: bool

Whether the Segment client is being used on the client side (rather than the server side).

Enabling this causes the Segment server to record the IP address from which the event was sent.

test_only_dummy_segment_client: bool

Only create a dummy segment client when no segment api key is provided, only to get more testing coverage.

launchdarkly_sdk_key: Option<String>

An SDK key for LaunchDarkly.

Setting this in combination with Self::config_sync_loop_interval will enable synchronization of LaunchDarkly features with system configuration parameters.

launchdarkly_key_map: Vec<KeyValueArg<String, String>>

A list of PARAM_NAME=KEY_NAME pairs from system parameter names to LaunchDarkly feature keys.

This is used (so far only for testing purposes) when propagating values from the latter to the former. The identity map is assumed for absent parameter names.

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.

If this is not explicitly set, the loop that synchronizes LaunchDarkly features with system configuration parameters will not run even if Self::launchdarkly_sdk_key is present.

config_sync_file_path: Option<PathBuf>

Path to a JSON file containing system parameter values. If specified, this file will be used instead of LaunchDarkly for configuration.

environment_id: EnvironmentId

bootstrap_role: Option<String>

If set, a role with the provided name will be created with CREATEDB and CREATECLUSTER attributes. It will also have CREATE privileges on the materialize database, materialize.public schema, and quickstart cluster.

This option is meant for local development and testing to simplify the initial process of granting attributes and privileges to some default role.

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.

bootstrap_builtin_analytics_cluster_replica_size: String

The size of the builtin analytics cluster replicas if bootstrapping.

bootstrap_default_cluster_replication_factor: u32

bootstrap_builtin_system_cluster_replication_factor: u32

The replication factor of the builtin system cluster replicas if bootstrapping.

bootstrap_builtin_catalog_server_cluster_replication_factor: u32

The replication factor of the builtin catalog server cluster replicas if bootstrapping.

bootstrap_builtin_probe_cluster_replication_factor: u32

The replication factor of the builtin probe cluster replicas if bootstrapping.

bootstrap_builtin_support_cluster_replication_factor: u32

The replication factor of the builtin support cluster replicas if bootstrapping.

bootstrap_builtin_analytics_cluster_replication_factor: u32

The replication factor of the builtin analytics cluster replicas if bootstrapping.

system_parameter_default: Vec<KeyValueArg<String, String>>

An list of NAME=VALUE pairs used to override static defaults for system parameters.

license_key: Option<String>

File containing a valid Materialize license key.

aws_account_id: Option<String>

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

aws_connection_role_arn: Option<String>

The ARN for a Materialize-controlled role to assume before assuming a customer’s requested role for an AWS connection.

aws_external_id_prefix: Option<AwsExternalIdPrefix>

Prefix for an external ID to be supplied to all AWS AssumeRole operations.

Details: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

aws_privatelink_availability_zones: Option<Vec<String>>

The list of supported AWS PrivateLink availability zone ids. Must be zone IDs, of format e.g. “use-az1”.

tracing: TracingCliArgs

unsafe_builtin_table_fingerprint_whitespace: Option<UnsafeBuiltinTableFingerprintWhitespace>

Injects arbitrary whitespace into builtin table fingerprints, which can trigger builtin item migrations. The amount of whitespace is determined by unsafe_builtin_table_fingerprint_whitespace_version. This argument is meant for testing only and as the names suggests should not be set in production.

unsafe_builtin_table_fingerprint_whitespace_version: usize

Controls the amount of whitespace injected by unsafe_builtin_table_fingerprint_whitespace. Incrementing this value can allow triggering multiple builtin migrations from a single test. This argument is meant for testing only and as the names suggests should not be set in production.

Trait Implementations

impl Args for Args

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for Args

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Args

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

Formats the value using the given formatter.

impl FromArgMatches for Args

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Args

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.