Skip to main content

Module system

Module system 

Source
Expand description

Schema for system.yaml: process-level settings (data-plane listener, TLS, HTTP/2, timeouts, logging, admin API). Loaded once at startup and never hot-reloaded; every top-level field has a serde default, so any section may be omitted.

Structsยง

AdminConfig
Admin REST API settings; presence of this section enables the admin server on a separate port from the data plane.
ConfigSourceConfig
Selects the gateway-config backend.
DebugConfig
Debug mode: per-request policy-execution tracing plus the plugin sandbox.
EtcdConfig
etcd connection settings (used when config.source is etcd).
Http2Config
HTTP/2 support toggle; enabled by default.
ListenerConfig
Bind address and port for the data-plane HTTP listener.
LoggingConfig
Logging configuration for the tracing subscriber.
SniCert
One SNI-selected certificate for multi-domain TLS termination: an exact or single-label-wildcard server name mapped to its own cert/key.
SniRoute
One SNI passthrough route: an exact or single-label-wildcard server name mapped to its own upstream pool.
StreamListenerConfig
An L4 stream listener: binds bind:port and proxies raw TCP or UDP to an upstream pool. Bound once at startup (fail-fast), like the HTTP listener.
StreamUpstreamConfig
Upstream pool for an L4 stream listener.
SystemConfig
Root of system.yaml.
TimeoutConfig
Connection lifecycle timeouts in seconds.
TlsConfig
TLS termination settings for a listener (data plane or admin).

Enumsยง

ConfigSourceKind
Which config backend to use.
StreamProtocol
Transport protocol for an L4 stream listener.

Functionsยง

default_admin_port ๐Ÿ”’
default_bind ๐Ÿ”’
default_etcd_prefix ๐Ÿ”’
default_etcd_timeout ๐Ÿ”’
default_listener ๐Ÿ”’
default_log_format ๐Ÿ”’
default_log_level ๐Ÿ”’
default_port ๐Ÿ”’
default_timeout_30 ๐Ÿ”’
default_timeout_300 ๐Ÿ”’
default_tls_min_version ๐Ÿ”’
default_trigger_header ๐Ÿ”’
default_true ๐Ÿ”’