Engine definition
A YAML file that teaches the platform an engine: how to detect it, read its version, back it up, restore it, validate and clean up.
Engine definitions and custom commands
Custom command
One backup profile whose capture is a command you write - for a one-off system.
Recipes
Ready-made custom commands to import and adapt.
Add an engine definition
Section titled “Add an engine definition”-
Open Admin › Engine definitions and click Upload definition
-
Read the lint report
Every version is checked before it can be approved.
-
Ask a colleague to approve it
A definition runs commands on production hosts, so it is treated as privileged code: it runs only after somebody other than its author has approved exactly that YAML.
-
Register instances of the new engine
It appears as an engine in Register a database.