← Schema index / Config Reference

actions schema

Canonical generated docsThis section is generated from caco config schema --json. The table below preserves the runtime field path, type, required/default markers, and canonical description for every value in this slice.

Top-level operator-defined runnable commands. Keyed by action name.

Field pathTypeRequiredDefaultCanonical description
actionssectionoptionalTop-level operator-defined runnable commands. Keyed by action name.
└ actions.<action-name>mapoptionalNamed action entry.
└ actions.<action-name>.typestringrequiredAction type (currently only 'command').
└ actions.<action-name>.commandstringrequiredShell command to execute.
└ actions.<action-name>.descriptionstringoptionalHuman-readable description.
└ actions.<action-name>.roles_permittedlist[string]optionalRoles/profiles allowed to invoke (e.g. 'operator', 'profile:<name>').
└ actions.<action-name>.cwdstringoptionalWorking directory for command execution.
└ actions.<action-name>.timeout_secsu64optional300Timeout in seconds for command execution.
└ actions.<action-name>.idempotentbooloptionalfalseWhether exact replay is safe after restart.
└ actions.<action-name>.checkstringoptionalSide-effect-free shell command that exercises the action's prerequisites; run by 'caco action check'.