Skip to main content

​
Runbook

​
Properties

PropertyDescriptionValuesExample
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 pathsOptional"./release-notes.md"
labels
object		-Optional-
dependencies
array		-Optional-

​
steps

PropertyDescriptionValuesExample
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 Either ‘deploy’ for deploying a component, or ‘action’ for running an action✅ Required"deploy", "action"
component_name
string		component to deploy (for deploy steps) Name of the component to deploy. Required when type is ‘deploy’Optional"database", "api-server"
deploy_dependencies
boolean		also deploy transitive dependencies When true, deploys the component and all its transitive dependencies in dependency order. Only applies to deploy stepsOptional-
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 templatingOptional"./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 URLsOptional"./scripts/validate.sh"
env_vars
object		environment variables for inline action steps Map of environment variables passed to the inline action commandOptional-
timeout
string		timeout for inline action steps Maximum execution time for inline action steps. Must be a valid Go duration stringOptional"30s", "5m"
role
string		IAM role for inline action execution IAM role name to use when executing the inline action stepOptional-