Inputs
Properties
| Property | Description | Values | Example |
|---|---|---|---|
inputarray | list of inputs Array of input definitions that customers can configure during installation | Optional | - |
grouparray | list of input groups Array of input group definitions that organize related inputs in the installer UI | Optional | - |
sourcesarray | 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
| Property | Description | Values | Example |
|---|---|---|---|
display_namestring | display name of the input Human-readable name shown in the installer UI to customers | ✅ Required | "API Token", "Database URL" |
descriptionstring | 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" |
groupstring | input group name Name of the input group this field belongs to. Must match a defined group in the inputs section | ✅ Required | "database", "integrations" |
namestring | input name Used to reference the input via variable templating (e.g., {{.nuon.inputs.input_name}}) | Optional | "api_token", "database_url" |
defaultobject | default value for the input Default value used if customer does not provide one. Type must match the input type | Optional | "production", "5432" |
requiredboolean | whether input is required If true, customer must provide a value during installation. If false, can be skipped | Optional | - |
sensitiveboolean | 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 keys | Optional | - |
typestring | input type Data type for the input. Supported types: string, number, list, json, bool, yaml, hcl | Optional | "string", "number", "json", "bool", "yaml", "hcl" |
internalboolean | Deprecated: this field has no effect and will be ignored. | Optional | - |
user_configurableboolean | whether input is user configurable If true, input can be modified by end users after installation | Optional | - |
group
| Property | Description | Values | Example |
|---|---|---|---|
namestring | Group name, which must be referenced by each input. | ✅ Required | "database", "compute" |
descriptionstring | Human readable description which is rendered in the installer. | ✅ Required | "Database configuration options", "How many nodes to provision to support environments" |
display_namestring | Human readable name which is rendered in the installer. | Optional | "Database Settings", "Kubernetes Nodes" |