plugins.yaml
Every key of config/sites/<key>/plugins.yaml: the process plugins an endpoint step calls, with their command, pinned digest, environment, granted handlers and containment.
config/sites/<key>/plugins.yaml declares process plugins: separate binaries the engine starts and calls from an endpoint’s plugin step. The plugin protocol is version 0 and experimental. For extending the engine itself, see Extending.
| Key | Type | Default | Meaning |
|---|---|---|---|
plugins | map of objects | {} | The site’s plugins by key |
plugins.<key>.args | list of string | [] | Arguments the binary is started with |
plugins.<key>.build | string | The directory of the Go program engine-dmo plugin build compiles to command | |
plugins.<key>.circuit_breaker.cooldown | string | How long its steps fail at once before it is tried again | |
plugins.<key>.circuit_breaker.failures | integer | Failed calls within window that take the plugin out | |
plugins.<key>.circuit_breaker.window | string | The window failures are counted in | |
plugins.<key>.command | string | Required | The plugin binary, relative to the project or absolute |
plugins.<key>.concurrency | integer | Calls in flight at once, 1 to 256 | |
plugins.<key>.endpoints | list of string | [] | The endpoint handlers granted: a plugin step may call only these, and the plugin must serve every one |
plugins.<key>.env | map of string | {} | The environment the plugin gets. Nothing of the engine’s own environment is passed; a credential-like name must be an interpolation |
plugins.<key>.memory | string | The memory limit set on the process where the platform allows, such as 256MB | |
plugins.<key>.sha256 | string | The binary’s SHA-256 in lower case hex; the engine refuses to start a binary whose digest differs | |
plugins.<key>.timeout | string | The time limit per call |
endpoints.yaml
Every top-level key of config/sites/<key>/endpoints.yaml: declared endpoints with their path, methods, access, rate limit, spam controls, inputs, validation, steps and response.
promotions.yaml
Every key of config/sites/<key>/promotions.yaml (engine-dmo): paid promotion slots with their types, capacity, booking length, lead time, eligible tiers and prices, and the promoted label.