Skip to content

Commit 6692db6

Browse files
authored
docs: Add API auth spicepod reference (#1233)
1 parent 000bb0f commit 6692db6

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

website/docs/reference/spicepod/runtime.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,29 @@ description: 'Runtime YAML reference'
66

77
The `runtime` section specifies configuration settings for the Spice runtime.
88

9+
## `runtime.auth`
10+
11+
### `runtime.auth.api-key`
12+
13+
Spice supports adding optional authentication to its API endpoints via configurable API keys. [Learn more](../../api/auth/index.md).
14+
15+
```yaml
16+
runtime:
17+
auth:
18+
api-key:
19+
enabled: true
20+
keys:
21+
- ${ secrets:api_key } # Use the secret replacement syntax to load the API key from a secret store
22+
- 1234567890 # Or specify the API key directly
23+
```
24+
25+
API key authentication supports the following configuration parameters:
26+
27+
| Parameter name | Optional | Default | Description |
28+
| -------------- | -------- | ------- | -------------------------------------------------------------- |
29+
| `enabled` | Yes | `false` | Defaults to `false`. Whether API key authentication is enabled |
30+
| `keys` | Yes | `[]` | A list of API keys used to authenticate requests. |
31+
932
## `runtime.dataset_load_parallelism`
1033

1134
This setting specifies the maximum number of datasets that can be loaded in parallel during startup. By default, the number of parallel datasets is unlimited.

0 commit comments

Comments
 (0)