Configuration File
Edge uses a JSON configuration file. Pass the path as the first argument:Full Example
config.json
Any string value can reference an environment variable with
${VAR} (for
example ${TERO_API_TOKEN}). See Environment
Variables.Configuration Reference
Edge supports up to 8,000 policies. Open an issue on
GitHub if you need more.
Server Settings
Upstream Settings
Service Settings
Theservice object identifies this Edge instance to the control plane and
attaches metadata to policy sync requests. Always set name, namespace, and
version — the control plane uses them to scope and match policies to this
service. resource_attributes and labels are optional but recommended.
instance_id is generated at startup and is not configurable.Policy Providers
Thepolicy_providers array configures where Edge loads policies from.
File Provider
Loads policies from a local file and watches for changes.
Edge watches the file with inotify (Linux) or kqueue (macOS) and applies changes
on save.
HTTP Provider
Loads policies from an HTTP endpoint with periodic polling.Prometheus Settings
The optionalprometheus object bounds memory use when filtering Prometheus
scrapes (relevant to distributions that handle metrics).
Policy File Format
Define policies in a JSON file:policies.json
Environment Variables
Edge reads environment variables two ways.Value Substitution
Any string value in the config file can reference an environment variable with${VAR}. The variable is resolved when the config loads:
- Unset variables resolve to an empty string.
- Use
$${VAR}to emit a literal${VAR}without substitution.
Field Overrides
ATERO_-prefixed environment variable overrides the matching config field. The
name is the field path in SCREAMING_SNAKE_CASE, with nested fields joined by
_. Overrides win over the file.
Next Steps
Operations
Logging, health checks, and resource requirements
Log Filtering
Configure log filtering policies