> ## 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 secret configuration

# Secret

# Secret

## Properties

| Property                                                             | Description                                                                                                                                                                                              | Values         | Example                                                                               |
| -------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------- |
| **`name`**<br />string                                               | secret name Identifier for the secret used to reference it via variable templating (e.g., \{\{.nuon.secrets.name}}). Supports templating                                                                 | **✅ Required** | `"database_password"`, `"api_key"`                                                    |
| **`description`**<br />string                                        | secret description Detailed explanation of what this secret is for, displayed to users during installation                                                                                               | **✅ Required** | `"Master password for the database"`, `"API key for external service authentication"` |
| **`display_name`**<br />string                                       | display name Human-readable name shown in the installer UI. Supports templating                                                                                                                          | **Optional**   | `"Database Password"`, `"API Key"`                                                    |
| **`required`**<br />boolean                                          | whether secret is required If true, customer must provide a value during installation. If false, can be skipped                                                                                          | **Optional**   | -                                                                                     |
| **`auto_generate`**<br />boolean                                     | whether 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                                                     | **Optional**   | -                                                                                     |
| **`format`**<br />string                                             | secret format Format of the secret value. Supported values: 'base64' for base64-encoded secrets, or empty for plain text                                                                                 | **Optional**   | `"base64"`                                                                            |
| **`default`**<br />string                                            | default value Default value used if customer does not provide one. Cannot be used with required or auto\_generate                                                                                        | **Optional**   | -                                                                                     |
| **`kubernetes_sync`**<br />boolean                                   | sync to Kubernetes If true, the secret will be synced to a Kubernetes Secret resource                                                                                                                    | **Optional**   | -                                                                                     |
| **`kubernetes_secret_namespace`**<br />string                        | Kubernetes namespace Kubernetes namespace where the secret will be created. Required if kubernetes\_sync is true. Supports templating                                                                    | **Optional**   | `"default"`, `"{{.nuon.install.id}}-namespace"`                                       |
| **`kubernetes_secret_name`**<br />string                             | Kubernetes secret name Name of the Kubernetes Secret resource. Required if kubernetes\_sync is true. Supports templating                                                                                 | **Optional**   | `"app-secret"`, `"{{.nuon.install.id}}-secret"`                                       |
| **`kubernetes_sync_targets`**<br />[array](#kubernetes_sync_targets) | Kubernetes sync targets List of Kubernetes destinations to sync this secret to. When present, Kubernetes sync is enabled. Each target writes the secret value into a given key of a named secret acro... | **Optional**   | -                                                                                     |

### `kubernetes_sync_targets`

| Property                    | Description                                                                                        | Values         | Example             |
| --------------------------- | -------------------------------------------------------------------------------------------------- | -------------- | ------------------- |
| **`namespaces`**<br />array | target namespaces List of Kubernetes namespaces the secret will be created in. Supports templating | **✅ Required** | `"datadog"`         |
| **`name`**<br />string      | Kubernetes secret name Name of the Kubernetes Secret resource. Supports templating                 | **✅ Required** | `"datadog-api-key"` |
| **`key`**<br />string       | Kubernetes secret key Key within the Kubernetes Secret to write the value to. Supports templating  | **✅ Required** | `"api-key"`         |