Runbook

Properties

Property	Description	Values	Example
`name` string	name of the runbook The runbook name is displayed in the Runbooks tab of the Nuon dashboard and used to identify it during sync	✅ Required	`"v2.3-update"`, `"database-migration"`
`steps` array	ordered steps to execute in the runbook Sequential list of deploy and action steps. Each step executes in order. Deploy steps can include dependency deployment. Action steps can reference existing …	✅ Required	-
`description` string	-	Optional	-
`readme` string	readme file for the runbook Markdown file with runbook documentation and instructions. Supports Go templating and external file sources: HTTP(S) URLs, git repositories, file paths, and relative paths	Optional	`"./release-notes.md"`
`labels` object	-	Optional	-
`input` array	-	Optional	-
`dependencies` array	-	Optional	-

`steps`

Property	Description	Values	Example
`name` string	name of the step Displayed in the workflow UI and runbook detail page	✅ Required	`"deploy-database"`, `"run-migrations"`
`type` string	type of step One of: ‘component_deploy’ (deploy a component; ‘deploy’ is accepted as a legacy alias), ‘component_tear_down’ (tear down a component), ‘action’ (run an action), ‘sandbox_reprovision’,…	✅ Required	`"component_deploy"`, `"component_tear_down"`, `"action"`, `"sandbox_reprovision"`
`plan_only` boolean	generate a plan without applying it Only applies to ‘component_deploy’ and ‘sandbox_reprovision’ steps. When true, the step generates its plan but does not apply it. Plan-only sandbox reprovision s…	Optional	-
`component_name` string	component to deploy or tear down (for component steps) Name of the component to deploy or tear down. Required when type is ‘component_deploy’ or ‘component_tear_down’	Optional	`"database"`, `"api-server"`
`deploy_dependents` boolean	also deploy transitive dependents When true, deploys the component and all components that transitively depend on it (downstream), in dependency order. Only applies to component_deploy steps	Optional	-
`tear_down_dependents` boolean	also tear down transitive dependents When true, tears down the component and all components that transitively depend on it (downstream), with dependents torn down first. Only applies to component_t…	Optional	-
`deploy_dependencies` boolean	legacy alias for deploy_dependents [DEPRECATED: use ‘deploy_dependents’ instead]	Optional	-
`skip_component_deploys` boolean	skip component deployments after sandbox reprovision Only applies to ‘sandbox_reprovision’ steps. When true, only the sandbox infrastructure is reprovisioned and components are NOT redeployed on to…	Optional	-
`action_name` string	existing action to run (for action steps) Name of a previously defined action workflow to execute. Mutually exclusive with inline action fields (command, inline_contents)	Optional	`"database-migration"`
`command` string	command to execute (for inline action steps) Shell command for an inline action. Supports Go templating	Optional	`"./validate.sh"`
`inline_contents` string	inline script contents (for inline action steps) Embed script contents directly or reference an external file. Supports Go templating and external URLs	Optional	`"./scripts/validate.sh"`
`env_vars` object	environment variables for inline action steps Map of environment variables passed to the inline action command	Optional	-
`timeout` string	timeout for inline action steps Maximum execution time for inline action steps. Must be a valid Go duration string	Optional	`"30s"`, `"5m"`
`role` string	IAM role for inline action execution IAM role name to use when executing the inline action step	Optional	-
`trigger` string	trigger to wait on Required for wait_for_event steps. The matched normalized event is available to later action steps by step name, for example {{.runbook_outputs.wait_for_tag.event.payload.tag}…	Optional	-
`event_types` array	event types that can resume this step For wait_for_event steps, the step resumes when an event from trigger has one of these types and matches every configured filter	Optional	-
`filters` array	-	Optional	-
`match_all` boolean	explicitly match all event types For wait_for_event steps, permits matching all event types, including when filters contain only exclusion predicates	Optional	-

`input`

Property	Description	Values	Example
`display_name` string	-	✅ Required	-
`description` string	-	✅ Required	-
`name` string	-	Optional	-
`default` object	-	Optional	-
`required` boolean	-	Optional	-
`sensitive` boolean	-	Optional	-
`type` string	-	Optional	-