> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nuon.co/llms.txt
> Use this file to discover all available pages before exploring further.

> JSON Schema reference for runbook configuration

# Runbook

# Runbook

## Properties

| Property                         | Description                                                                                                                                                                                              | Values         | Example                                 |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | --------------------------------------- |
| **`name`**<br />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`**<br />[array](#steps) | 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`**<br />string    | -                                                                                                                                                                                                        | **Optional**   | -                                       |
| **`readme`**<br />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`**<br />object         | -                                                                                                                                                                                                        | **Optional**   | -                                       |
| **`input`**<br />[array](#input) | -                                                                                                                                                                                                        | **Optional**   | -                                       |
| **`dependencies`**<br />array    | -                                                                                                                                                                                                        | **Optional**   | -                                       |

### `steps`

| Property                                  | Description                                                                                                                                                                                                  | Values         | Example                                                                            |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- | ---------------------------------------------------------------------------------- |
| **`name`**<br />string                    | name of the step Displayed in the workflow UI and runbook detail page                                                                                                                                        | **✅ Required** | `"deploy-database"`, `"run-migrations"`                                            |
| **`type`**<br />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"` |
| **`component_name`**<br />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`**<br />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`**<br />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`**<br />boolean    | legacy alias for deploy\_dependents \[DEPRECATED: use 'deploy\_dependents' instead]                                                                                                                          | **Optional**   | -                                                                                  |
| **`skip_component_deploys`**<br />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`**<br />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`**<br />string                 | command to execute (for inline action steps) Shell command for an inline action. Supports Go templating                                                                                                      | **Optional**   | `"./validate.sh"`                                                                  |
| **`inline_contents`**<br />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`**<br />object                | environment variables for inline action steps Map of environment variables passed to the inline action command                                                                                               | **Optional**   | -                                                                                  |
| **`timeout`**<br />string                 | timeout for inline action steps Maximum execution time for inline action steps. Must be a valid Go duration string                                                                                           | **Optional**   | `"30s"`, `"5m"`                                                                    |
| **`role`**<br />string                    | IAM role for inline action execution IAM role name to use when executing the inline action step                                                                                                              | **Optional**   | -                                                                                  |

### `input`

| Property                       | Description | Values         | Example |
| ------------------------------ | ----------- | -------------- | ------- |
| **`display_name`**<br />string | -           | **✅ Required** | -       |
| **`description`**<br />string  | -           | **✅ Required** | -       |
| **`name`**<br />string         | -           | **Optional**   | -       |
| **`default`**<br />object      | -           | **Optional**   | -       |
| **`required`**<br />boolean    | -           | **Optional**   | -       |
| **`sensitive`**<br />boolean   | -           | **Optional**   | -       |
| **`type`**<br />string         | -           | **Optional**   | -       |