Skip to main content

Secret

Properties

PropertyTypeRequiredDescriptionDefaultExample
namestring✅ Yessecret name Identifier for the secret used to reference it via variable templating (e.g., {{.nuon.secrets.name}}). Supports templating-"database_password"
display_namestringNodisplay name Human-readable name shown in the installer UI. Supports templating-"Database Password"
descriptionstring✅ Yessecret description Detailed explanation of what this secret is for, displayed to users during installation-"Master password for the database"
requiredbooleanNowhether secret is required If true, customer must provide a value during installation. If false, can be skipped--
auto_generatebooleanNowhether to auto-generate secret If true, a random secret will be generated if customer does not provide one. Cannot be used with required or default--
formatstringNosecret format Format of the secret value. Supported values: ‘base64’ for base64-encoded secrets, or empty for plain text-"base64"
defaultstringNodefault value Default value used if customer does not provide one. Cannot be used with required or auto_generate--
kubernetes_syncbooleanNosync to Kubernetes If true, the secret will be synced to a Kubernetes Secret resource--
kubernetes_secret_namespacestringNoKubernetes namespace Kubernetes namespace where the secret will be created. Required if kubernetes_sync is true. Supports templating-"default"
kubernetes_secret_namestringNoKubernetes secret name Name of the Kubernetes Secret resource. Required if kubernetes_sync is true. Supports templating-"app-secret"

Property Details

name

Examples:
"database_password"
"api_key"

display_name

Examples:
"Database Password"
"API Key"

description

Examples:
"Master password for the database"
"API key for external service authentication"

kubernetes_secret_namespace

Examples:
"default"
"{{.nuon.install.id}}-namespace"

kubernetes_secret_name

Examples:
"app-secret"
"{{.nuon.install.id}}-secret"