Skip to main content

Inputs

Properties

PropertyDescriptionValuesExample
input
array
list of inputs Array of input definitions that customers can configure during installationOptional-
group
array
list of input groups Array of input group definitions that organize related inputs in the installer UIOptional-
sources
array
external input source files Array of paths to external files containing additional input definitions. Each file is loaded and merged into the inputs configuration. Supports YAML, JSON, and TOML for…Optional-

input

PropertyDescriptionValuesExample
display_name
string
display name of the input Human-readable name shown in the installer UI to customers✅ Required"API Token", "Database URL"
description
string
input description Detailed explanation of what this input is for, rendered in the installer to guide users✅ Required"The API token for authenticating with the external service", "Connection string for the PostgreSQL database"
group
string
input group name Name of the input group this field belongs to. Must match a defined group in the inputs section✅ Required"database", "integrations"
name
string
input name Used to reference the input via variable templating (e.g., {{.nuon.inputs.input_name}})Optional"api_token", "database_url"
default
object
default value for the input Default value used if customer does not provide one. Type must match the input typeOptional"production", "5432"
required
boolean
whether input is required If true, customer must provide a value during installation. If false, can be skippedOptional-
sensitive
boolean
whether input is sensitive If true, the value will be masked/hidden in the UI and logs after the install is created. Use for passwords, tokens, and API keysOptional-
type
string
input type Data type for the input. Supported types: string, number, list, json, boolOptional"string", "number", "json", "bool"
internal
boolean
whether input is internal-only If true, input is only settable via the admin panel and not shown to regular usersOptional-
user_configurable
boolean
whether input is user configurable If true, input can be modified by end users after installationOptional-

group

PropertyDescriptionValuesExample
name
string
Group name, which must be referenced by each input.✅ Required"database", "compute"
description
string
Human readable description which is rendered in the installer.✅ Required"Database configuration options", "How many nodes to provision to support environments"
display_name
string
Human readable name which is rendered in the installer.Optional"Database Settings", "Kubernetes Nodes"