Struct Args

pub(crate) struct Args {

    pub trace_level: Level,
    pub log_level: Level,
    pub(crate) nats_host: String,
    pub(crate) nats_port: u16,
    pub(crate) nats_jwt: Option<String>,
    pub(crate) nats_seed: Option<String>,
    pub(crate) nats_creds: Option<PathBuf>,
    pub(crate) lattice: String,
    pub(crate) host_seed: Option<String>,
    pub(crate) provider_shutdown_delay: Duration,
    pub(crate) allow_latest: bool,
    pub(crate) allowed_insecure: Vec<String>,
    pub(crate) js_domain: Option<String>,
    pub(crate) config_service_enabled: bool,
    pub(crate) allow_file_load: bool,
    pub(crate) enable_structured_logging: bool,
    pub(crate) label: Option<Vec<String>>,
    pub(crate) ctl_host: Option<String>,
    pub(crate) ctl_port: Option<u16>,
    pub(crate) ctl_jwt: Option<String>,
    pub(crate) ctl_seed: Option<String>,
    pub(crate) ctl_creds: Option<PathBuf>,
    pub(crate) ctl_tls: bool,
    pub(crate) ctl_topic_prefix: String,
    pub(crate) rpc_host: Option<String>,
    pub(crate) rpc_port: Option<u16>,
    pub(crate) rpc_jwt: Option<String>,
    pub(crate) rpc_seed: Option<String>,
    pub(crate) rpc_creds: Option<PathBuf>,
    pub(crate) rpc_timeout_ms: Duration,
    pub(crate) rpc_tls: bool,
    pub(crate) policy_topic: Option<String>,
    pub(crate) policy_changes_topic: Option<String>,
    pub(crate) max_execution_time: Duration,
    pub(crate) max_linear_memory: u64,
    pub(crate) max_component_size: u64,
    pub(crate) max_components: u32,
    pub(crate) policy_timeout_ms: Option<Duration>,
    pub(crate) secrets_topic_prefix: Option<String>,
    pub(crate) oci_registry: Option<String>,
    pub(crate) oci_user: Option<String>,
    pub(crate) oci_password: Option<String>,
    pub(crate) enable_observability: bool,
    pub(crate) enable_traces: Option<bool>,
    pub(crate) enable_metrics: Option<bool>,
    pub(crate) enable_logs: Option<bool>,
    pub(crate) observability_endpoint: Option<String>,
    pub(crate) traces_endpoint: Option<String>,
    pub(crate) metrics_endpoint: Option<String>,
    pub(crate) logs_endpoint: Option<String>,
    pub(crate) observability_protocol: Option<OtelProtocol>,
    pub(crate) flame_graph: Option<String>,
    pub tls_ca_paths: Option<Vec<PathBuf>>,
    pub(crate) heartbeat_interval: Option<Duration>,
    pub(crate) experimental_features: Vec<Features>,
    pub(crate) help_markdown: bool,
    pub(crate) http_admin: Option<SocketAddr>,
}

Fields

trace_level: Level

Controls the verbosity of traces emitted from the wasmCloud host

log_level: Level

Controls the verbosity of logs from the wasmCloud host

nats_host: String

NATS server host to connect to

nats_port: u16

NATS server port to connect to

nats_jwt: Option<String>

A user JWT to use to authenticate to NATS

nats_seed: Option<String>

A seed nkey to use to authenticate to NATS

nats_creds: Option<PathBuf>

A NATS credentials file that contains the JWT and seed for authenticating to NATS

lattice: String

The lattice the host belongs to

host_seed: Option<String>

The seed key (a printable 256-bit Ed25519 private key) used by this host to generate its public key

provider_shutdown_delay: Duration

Delay, in milliseconds, between requesting a provider shut down and forcibly terminating its process

allow_latest: bool

Determines whether OCI images tagged latest are allowed to be pulled from OCI registries and started

allowed_insecure: Vec<String>

A comma-separated list of OCI hosts to which insecure (non-TLS) connections are allowed

js_domain: Option<String>

NATS Jetstream domain name

config_service_enabled: bool

Denotes if a wasmCloud host should issue requests to a config service on startup

allow_file_load: bool

Denotes if a wasmCloud host should allow starting components from the file system

enable_structured_logging: bool

Enable JSON structured logging from the wasmCloud host

label: Option<Vec<String>>

Start the host with a set of labels, can be specified multiple times. This can alternatively be specified via environment variables prefixed with WASMCLOUD_LABEL_, e.g. WASMCLOUD_LABEL_foo=bar

ctl_host: Option<String>

An IP address or DNS name to use to connect to NATS for Control Interface (CTL) messages, defaults to the value supplied to –nats-host if not supplied

ctl_port: Option<u16>

A port to use to connect to NATS for CTL messages, defaults to the value supplied to –nats-port if not supplied

ctl_jwt: Option<String>

A user JWT to use to authenticate to NATS for CTL messages, defaults to the value supplied to –nats-jwt if not supplied

ctl_seed: Option<String>

A seed nkey to use to authenticate to NATS for CTL messages, defaults to the value supplied to –nats-seed if not supplied

ctl_creds: Option<PathBuf>

A NATS credentials file to use to authenticate to NATS for CTL messages, defaults to the value supplied to –nats-creds or –nats-jwt and –nats-seed

ctl_tls: bool

Optional flag to require host communication over TLS with a NATS server for CTL messages

ctl_topic_prefix: String

Advanced: A prefix to use for all CTL topics

rpc_host: Option<String>

An IP address or DNS name to use to connect to NATS for RPC messages, defaults to the value supplied to –nats-host if not supplied

rpc_port: Option<u16>

A port to use to connect to NATS for RPC messages, defaults to the value supplied to –nats-port if not supplied

rpc_jwt: Option<String>

A user JWT to use to authenticate to NATS for RPC messages, defaults to the value supplied to –nats-jwt if not supplied

rpc_seed: Option<String>

A seed nkey to use to authenticate to NATS for RPC messages, defaults to the value supplied to –nats-seed if not supplied

rpc_creds: Option<PathBuf>

A NATS credentials file to use to authenticate to NATS for RPC messages, defaults to the value supplied to –nats-creds or –nats-jwt and –nats-seed

rpc_timeout_ms: Duration

Timeout in milliseconds for all RPC calls

rpc_tls: bool

Optional flag to require host communication over TLS with a NATS server for RPC messages

policy_topic: Option<String>

If provided, enables policy checks on start actions and component invocations

policy_changes_topic: Option<String>

If provided, allows the host to subscribe to updates on past policy decisions. Requires policy_topic to be set.

max_execution_time: Duration

If provided, allows to set a custom Max Execution time for the Host in ms.

max_linear_memory: u64

The maximum amount of memory bytes that a component can allocate (default 256 MiB)

max_component_size: u64

The maximum byte size of a component binary that can be loaded (default 50 MiB)

max_components: u32

The maximum number of components that can be run simultaneously

policy_timeout_ms: Option<Duration>

If provided, allows setting a custom timeout for requesting policy decisions. Defaults to one second. Requires policy_topic to be set.

secrets_topic_prefix: Option<String>

If provided, enables interfacing with a secrets backend for secret retrieval over the given topic prefix. Must not be empty.

oci_registry: Option<String>

Used in tandem with oci_user and oci_password to override credentials for a specific OCI registry.

oci_user: Option<String>

Username for the OCI registry specified by oci_registry.

oci_password: Option<String>

Password for the OCI registry specified by oci_registry.

enable_observability: bool

Determines whether observability should be enabled.

enable_traces: Option<bool>

Determines whether traces should be enabled.

enable_metrics: Option<bool>

Determines whether metrics should be enabled.

enable_logs: Option<bool>

Determines whether logs should be enabled.

observability_endpoint: Option<String>

Overrides the OpenTelemetry endpoint used for emitting traces, metrics and logs.

traces_endpoint: Option<String>

Overrides the OpenTelemetry endpoint used for emitting traces.

metrics_endpoint: Option<String>

Overrides the OpenTelemetry endpoint used for emitting metrics.

logs_endpoint: Option<String>

Overrides the OpenTelemetry endpoint used for emitting logs.

observability_protocol: Option<OtelProtocol>

Configures whether grpc or http will be used for exporting the enabled telemetry. This defaults to ‘http’.

flame_graph: Option<String>

Path to generate flame graph at

tls_ca_paths: Option<Vec<PathBuf>>

Configures the set of certificate authorities as repeatable set of file paths to load into the OCI and OpenTelemetry clients

heartbeat_interval: Option<Duration>

If provided, overrides the default heartbeat interval of every 30 seconds. Provided value is interpreted as seconds.

experimental_features: Vec<Features>

Experimental features to enable in the host. This is a repeatable option.

help_markdown: bool

http_admin: Option<SocketAddr>

HTTP administration endpoint address

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.