Skip to content

Commit f06f25e

Browse files
Add Helm Deployment docs (#177)
* Add Helm Deployment docs * upd
1 parent 947f44f commit f06f25e

File tree

5 files changed

+115
-3
lines changed

5 files changed

+115
-3
lines changed

spiceaidocs/docs/cli/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'Spice.ai OSS CLI documentation'
33
sidebar_label: 'CLI'
44
description: 'Detailed documentation on the Spice.ai OSS CLI'
5-
sidebar_position: 9
5+
sidebar_position: 11
66
pagination_prev: null
77
---
88

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: 'Deployment'
3+
sidebar_label: 'Deployment'
4+
description: 'Deploy Spice.ai in your environment'
5+
sidebar_position: 10
6+
pagination_prev: null
7+
pagination_next: null
8+
---
9+
10+
Learn how to deploy Spice.ai in your environment.
11+
12+
import DocCardList from '@theme/DocCardList';
13+
14+
<DocCardList />
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: 'Helm - Kubernetes'
3+
sidebar_label: 'Helm - Kubernetes'
4+
sidebar_position: 1
5+
description: 'Deploy Spice.ai in Kubernetes using Helm.'
6+
pagination_prev: 'deployment/index'
7+
pagination_next: null
8+
---
9+
10+
## TL;DR
11+
12+
```bash
13+
helm repo add spiceai https://helm.spiceai.org
14+
helm upgrade --install spiceai spiceai/spiceai
15+
```
16+
17+
Deploy Spice using Helm in Kubernetes.
18+
19+
## Values
20+
21+
The following table lists the configurable parameters of the Spice.ai chart and their default values. Override the default values by creating a `values.yaml` file.
22+
23+
```bash
24+
helm upgrade --install spiceai spiceai/spiceai -f values.yaml
25+
```
26+
27+
### Spicepod
28+
29+
Add a custom Spicepod to be loaded by the Spice.ai runtime by overriding the `spicepod` value in the `values.yaml` file.
30+
31+
```yaml
32+
spicepod:
33+
name: app
34+
version: v1beta1
35+
kind: Spicepod
36+
37+
datasets:
38+
- from: s3://spiceai-demo-datasets/taxi_trips/2024/
39+
name: taxi_trips
40+
description: Demo taxi trips in s3
41+
acceleration:
42+
enabled: true
43+
```
44+
45+
### Common Parameters
46+
47+
| Name | Description | Value |
48+
| ------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------- |
49+
| `image.repository` | The repository of the Docker image . | `spiceai` |
50+
| `image.tag` | Replace with a specific version of Spice.ai to run. | `latest` |
51+
| `replicaCount` | Number of Spice.ai replicas to run | `1` |
52+
| `image.pullSecrets` | Specify docker-registry secret names as an array | `[]` |
53+
| `tolerations` | List of node taints to tolerate | `[]` |
54+
| `resources` | Resource requests and limits for the Spice.ai container | `{}` |
55+
| `additionalEnv` | Additional environment variables to set in the Spice.ai container | `[]` |
56+
57+
58+
### Adding extra environment variables
59+
60+
Add extra environment variables using the `additionalEnv` property. This can be useful when combining with the [Environement Secret Store](../../secret-stores/env/index.md).
61+
62+
```yaml
63+
additionalEnv:
64+
- name: SPICE_SECRET_SPICEAI_KEY
65+
valueFrom:
66+
secretKeyRef:
67+
name: spice-secrets
68+
key: spiceai-key
69+
```
70+
71+
### Example values.yaml
72+
73+
```yaml
74+
image:
75+
repository: spiceai/spiceai
76+
tag: 0.10.0-alpha
77+
replicaCount: 1
78+
additionalEnv:
79+
- name: SPICE_SECRET_SPICEAI_KEY
80+
valueFrom:
81+
secretKeyRef:
82+
name: spice-secrets
83+
key: spiceai-key
84+
spicepod:
85+
name: app
86+
version: v1beta1
87+
kind: Spicepod
88+
89+
datasets:
90+
- from: s3://spiceai-demo-datasets/taxi_trips/2024/
91+
name: taxi_trips
92+
description: Demo taxi trips in s3
93+
acceleration:
94+
enabled: true
95+
# Uncomment to refresh the acceleration on a schedule
96+
# refresh_interval: 1h
97+
# refresh_mode: full
98+
```

spiceaidocs/docs/intelligent-applications/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Intelligent Applications'
33
sidebar_label: 'Intelligent Applications'
4-
sidebar_position: 10
4+
sidebar_position: 12
55
description: 'Building intelligent data and AI-driven applications with Spice.ai'
66
pagination_prev: null
77
pagination_next: null

spiceaidocs/docs/reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Spice.ai OSS Reference Docs'
33
sidebar_label: 'Reference'
4-
sidebar_position: 11
4+
sidebar_position: 20
55
description: 'Reference documentation on the Spice API, CLI and Pod manifest syntax.'
66
pagination_prev: null
77
pagination_next: null

0 commit comments

Comments
 (0)