Skip to main content

Action

Properties

PropertyDescriptionValuesExample
name
string
name of the action The action name is displayed in the Actions tab of the Nuon dashboard✅ Required"http_healthcheck", "database_migration"
timeout
string
timeout for action execution Maximum time the action can run. Maximum allowed is 30 minutes. Must be a valid Go duration string (e.g., 30s, 5m, 30m)✅ Required"15s", "5m", "30m"
triggers
array
triggers that execute this action Actions can be triggered manually, on a cron schedule, or by install lifecycle events (provision, deploy, teardown, etc). Define multiple triggers if needed✅ Required-
steps
array
steps to execute in this action Ordered list of steps to execute. Each step requires a command and can optionally load scripts from repositories✅ Required-
dependencies
array
component dependencies referenced in this action Automatically extracted from template references in steps (e.g., {{.component.component_name}})Optional"database", "api-server"
break_glass_role
string
IAM role for break-glass access to this action When set, allows the action to use a break glass role for elevated permissions during critical operations. Break glass roles are defined in CloudForma…Optional"bucket-operations-break-glass", "database-migration-break-glass"
role
string
IAM role name for action execution Name of the IAM role to use when executing this action. The role must be defined in the CloudFormation stack deployed to the customer’s AWS account. If not specif…Optional"{{.nuon.install.id}}-maintenance"
enable_kube_config
boolean
whether to fetch and inject kubeconfig for this action When set to false, the action runner will not fetch the install’s kubeconfig or set the KUBECONFIG env var. Defaults to true. Set to false for…Optional"true", "false"

triggers

PropertyDescriptionValuesExample
type
string
type of trigger Supported trigger types: manual, cron, pre-provision, post-provision, pre-reprovision, post-reprovision, pre-deprovision, post-deprovision, pre-deploy-all-components, post-deploy-al…✅ Required"manual", "cron", "post-provision"
index
integer
index for manual trigger Used to differentiate multiple manual triggers in the same actionOptional"0", "1"
cron_schedule
string
cron schedule expression for scheduled triggers Standard cron format (minute hour day month weekday). For example, ’*/5 * * * *’ runs every 5 minutesOptional"*/5 * * * *", "0 */4 * * *"
component_name
string
component name for component-specific triggers Required for pre-deploy-component, post-deploy-component, pre-teardown-component, post-teardown-component triggersOptional"database", "api-server"

steps

PropertyDescriptionValuesExample
name
string
name of the step Displayed in action logs and the Nuon dashboard✅ Required"healthcheck", "database_migration"
env_vars
object
environment variables to pass to the step Map of environment variables that will be available to the command. Supports Go templating for valuesOptional-
public_repo
PublicRepoConfig
public repository containing the step script Clone a public GitHub repository to load scripts from. Requires ‘repo’, ‘branch’, and optionally ‘directory’ fieldsOptional-
connected_repo
ConnectedRepoConfig
connected repository containing the step script Use a Nuon-connected repository to load scripts from. Requires ‘repo’, ‘branch’, and optionally ‘directory’ fieldsOptional-
command
string
command to execute Required field. Supports Go templating (e.g., {{.nuon.install.id}}). The command is executed in the runner environmentOptional"./healthcheck", "bash -c 'curl https://example.com'"
inline_contents
string
inline script contents Embed script contents directly in the config file. Supports Go templating and external URLs: HTTP(S) (https://example.com/script.sh), git repositories (git::https://github.coOptional"./src/healthcheck.sh", "#!/usr/bin/env sh\nkubectl get pods -n default"