Configuration
vey-gateway uses YAML for configuration.
The main configuration file is passed with the -c command-line option.
If a directory is set, the main configuration file is loaded automatically from
it based on the executable binary name.
Its top-level keys are listed below.
At a high level, vey-gateway is organized around three reusable object
families:
serveraccepts client traffic and defines frontend behaviordiscoverresolves or expands upstream targetsbackendconnects to upstream services and forwards requests
Static daemon settings such as runtime, worker, log, and stat
live alongside those object definitions in the main configuration file.
Key |
Type |
Reload |
Description |
|---|---|---|---|
runtime |
Map |
no |
Runtime configuration, see Runtime |
worker |
Map [2] |
no |
Starts unaided worker runtimes if present |
log |
Map |
no |
Logging configuration, see Log |
stat |
Map |
no |
Metrics configuration, see Stat |
controller |
Seq |
no |
Controller configuration |
discover |
Mix [1] |
yes |
Service-discovery configuration, see Discover |
backend |
Mix [1] |
yes |
Backend configuration, see Backend |
server |
Mix [1] |
yes |
Server configuration, see Server |
Read the object-family sections listed in the hidden toctree below when you need the detailed keys and behavior for each server, discover, or backend type.
Footnotes