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§
- Acme
Config - Top-level ACME settings (
acme:insystem.yaml). - Acme
EabConfig - External Account Binding credentials issued by the CA.
- Acme
Slot - One ACME-managed certificate slot.
- Admin
Config - Admin REST API settings; presence of this section enables the admin server on a separate port from the data plane.
- Cache
Config - Process-wide response-cache limits.
- Config
Source Config - Selects the gateway-config backend.
- Debug
Config - Debug mode: per-request policy-execution tracing plus the plugin sandbox.
- Etcd
Config - etcd connection settings (used when
config.sourceisetcd). - Http2
Config - HTTP/2 support toggle; enabled by default.
- Listener
Config - Bind address and port for the data-plane HTTP listener.
- Logging
Config - Logging configuration for the
tracingsubscriber. - McpConfig
admin.mcp— the MCP server exposed to agents.- McpToken
Config - One MCP bearer token.
- 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.
- Stream
Listener Config - An L4 stream listener: binds
bind:portand proxies raw TCP or UDP to an upstream pool. Bound once at startup (fail-fast), like the HTTP listener. - Stream
Upstream Config - Upstream pool for an L4 stream listener.
- System
Config - Root of
system.yaml. - Timeout
Config - Connection lifecycle timeouts in seconds.
- TlsConfig
- TLS termination settings for a listener (data plane or admin).
Enums§
- Acme
Storage Config - ACME state storage backend (
acme.storage.type). - Config
Source Kind - Which config backend to use.
- McpScope
- What an MCP token may do.
writeimpliesread. - Stream
Protocol - Transport protocol for an L4 stream listener.
Constants§
- MCP_
MIN_ TOKEN_ LEN - Minimum accepted length of an MCP bearer token, in characters.
Functions§
- default_
acme_ 🔒dir - default_
acme_ 🔒directory - default_
acme_ 🔒key_ type - default_
acme_ 🔒renew_ before - default_
admin_ 🔒port - default_
bind 🔒 - default_
etcd_ 🔒prefix - default_
etcd_ 🔒timeout - default_
listener 🔒 - default_
log_ 🔒format - default_
log_ 🔒level - default_
mcp_ 🔒path - default_
port 🔒 - default_
timeout_ 🔒30 - default_
timeout_ 🔒300 - default_
tls_ 🔒min_ version - default_
trigger_ 🔒header - default_
true 🔒 - normalize_
domain - Lowercases and validates one ACME DNS identifier: no wildcards, no IPs, only
[a-z0-9.-], non-empty labels. - parse_
duration - Parses
30d/12h/5m/90s/ bare seconds into a [Duration].