Skip to content

Commit c57cdaa

Browse files
committed
Update documentation for Spice CLI and runtime
- Changed Spicepod version from v1beta1 to v1 in add.md - Enabled dataset acceleration by default in dataset.md - Expanded command reference in index.md to include new commands and descriptions - Updated run.md to reflect new flags and options for the Spice runtime - Removed OpenTelemetry status from status.md - Updated version.md to reflect new CLI and runtime versions - Added optional metrics configuration in Docker deployment documentation - Updated Kubernetes deployment parameters for image repository and tag - Cleaned up getting started documentation by removing unnecessary metrics log - Removed Go installation instructions from installation.md - Added new runtime configuration options for flight, ready_state, and scheduler in runtime.md - Clarified system requirements documentation regarding port usage and requirements
1 parent ae3be0a commit c57cdaa

26 files changed

Lines changed: 267 additions & 159 deletions

File tree

website/docs/api/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Spice provides high-performance, industry-standard APIs:
1616

1717
### OpenAI-Compatible APIs
1818

19-
- **HTTP APIs**: Compatible the OpenAI SDK, AI SDK with local model serving (CUDA/Metal accelerated) and gateway to hosted models.
19+
- **HTTP APIs**: Compatible with the OpenAI SDK and AI SDK. Supports local model serving (CUDA/Metal accelerated) and gateway to hosted models.
2020

2121
### Iceberg Catalog REST APIs
2222

website/docs/cli/reference/add.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Any other Spicepods added using `spice add` are placed in the `spicepods` direct
5151
```yaml
5252
# File: ./spicepods/spiceai/quickstart/spicepod.yaml
5353

54-
version: v1beta1
54+
version: v1
5555
kind: Spicepod
5656
name: quickstart
5757

website/docs/cli/reference/dataset.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ from: s3://spiceai-demo-datasets/taxi_trips/2024/
6464
name: taxi-trips
6565
description: Taxi trips in s3
6666
acceleration:
67-
- enabled: false
67+
enabled: true
6868
```
6969
7070
The command additionally updates the root `spicepod.yaml` file to include the configured dataset as a reference (`ref`). For this example, `spicepod.yaml` would include the following:

website/docs/cli/reference/index.md

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,36 @@ spice [command] [--help]
1515

1616
### Full Command Reference
1717

18-
| Command | Description |
19-
| -------------------------- | ---------------------------------------------------------------------- |
20-
| [add](reference/add) | Add Pod - adds a pod to the project |
21-
| [catalogs](reference/catalogs) | List [catalogs](../../components/catalogs) loaded by the Spice runtime |
22-
| [completion](reference/completion) | Generate the autocompletion script for the specified shell |
23-
| [dataset](reference/dataset) | Dataset operations |
24-
| [datasets](reference/datasets) | Lists datasets loaded by the Spice runtime |
25-
| help | Help about any command |
26-
| [init](reference/init) | Initialize Pod - initializes a new pod in the project |
27-
| [login](reference/login) | Login to the Spice.ai Platform |
28-
| [models](reference/models) | Lists models loaded by the Spice runtime |
29-
| [pods](reference/pods) | Lists Spicepods loaded by the Spice runtime |
30-
| [refresh](reference/refresh) | Refreshes an accelerated dataset loaded by the Spice runtime |
31-
| [run](reference/run) | Run Spice - starts the Spice runtime, installing if necessary |
32-
| [search](reference/search) | Perform embeddings-based searches across |
33-
| [sql](reference/sql) | Start an interactive SQL query session against the Spice runtime |
34-
| [status](reference/status) | Spice runtime status |
35-
| [upgrade](reference/upgrade) | Upgrades the Spice CLI to the latest release |
36-
| [version](reference/version) | Spice CLI version |
18+
| Command | Description |
19+
| -------------------------------------- | ---------------------------------------------------------------------- |
20+
| [acceleration](reference/acceleration) | Manage dataset acceleration features |
21+
| [add](reference/add) | Add Spicepod - adds a Spicepod to the project |
22+
| [catalogs](reference/catalogs) | List [catalogs](../../components/catalogs) loaded by the Spice runtime |
23+
| [chat](reference/chat) | Chat with an LLM |
24+
| [cloud](reference/cloud) | Manage Spice Cloud resources |
25+
| [cluster](reference/cluster) | Cluster operations for the Spice runtime |
26+
| [completion](reference/completion) | Generate the autocompletion script for the specified shell |
27+
| [connect](reference/connect) | Connect to a Spice.ai Cloud Platform app |
28+
| [dataset](reference/dataset) | Dataset operations (configure datasets) |
29+
| [datasets](reference/datasets) | Lists datasets loaded by the Spice runtime |
30+
| [eval](reference/eval) | Run model evaluation |
31+
| help | Help about any command |
32+
| [init](reference/init) | Initialize Spice app - creates a new spicepod.yaml |
33+
| [install](reference/install) | Install or reinstall the Spice.ai runtime |
34+
| [login](reference/login) | Login to Spice.ai or configure credentials for data sources |
35+
| [models](reference/models) | Lists models loaded by the Spice runtime |
36+
| [nsql](reference/nsql) | Text-to-SQL REPL - translate natural language to SQL |
37+
| [pods](reference/pods) | Lists Spicepods loaded by the Spice runtime |
38+
| [query](reference/query) | Submit an async query or start an interactive async query REPL |
39+
| [refresh](reference/refresh) | Refresh a dataset loaded by the Spice runtime |
40+
| [run](reference/run) | Run Spice - starts the Spice runtime, installing if necessary |
41+
| [search](reference/search) | Search datasets with embeddings |
42+
| [sql](reference/sql) | Start an interactive SQL query session against the Spice runtime |
43+
| [status](reference/status) | Spice runtime status |
44+
| [trace](reference/trace) | Return traces for operations that occurred in Spice |
45+
| [upgrade](reference/upgrade) | Upgrades the Spice CLI and runtime to the latest release |
46+
| [version](reference/version) | Spice CLI version |
47+
| [workers](reference/workers) | Lists workers loaded by the Spice runtime |
3748

3849
### Command Flags
3950

website/docs/cli/reference/run.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,26 @@ spice run [flags] -- [spiced flags]
2020
- `--flight-endpoint` Configure runtime Flight endpoint. Defaults to `http://127.0.0.1:50051`.
2121
- `--http-endpoint` Configure runtime HTTP endpoint. Defaults to `http://127.0.0.1:8090`.
2222
- `--metrics-endpoint` Configure runtime Prometheus metrics endpoint. Defaults to `http://127.0.0.1:9090`.
23-
- `--captured-outputs` Configure the captured output setting for task history. Defaults to `truncated`.
2423

2524
#### Spiced Flags
2625

27-
Flags that are passed to the `spiced` runtime directly.
26+
Flags that are passed to the `spiced` runtime directly using `--`.
2827

2928
- `--http` Configure runtime HTTP address [default: 127.0.0.1:8090]
3029
- `--flight` Configure runtime Flight address [default: 127.0.0.1:50051]
30+
- `--metrics` Enable and configure the Prometheus metrics endpoint (disabled by default)
3131
- `--tls-enabled` Enable TLS
3232
- `--tls-certificate` The TLS PEM-encoded certificate
3333
- `--tls-certificate-file` Path to the TLS PEM-encoded certificate file
3434
- `--tls-key` The TLS PEM-encoded key
3535
- `--tls-key-file` Path to the TLS PEM-encoded key file
36+
- `--telemetry-enabled` Enable or disable anonymous telemetry
37+
- `--pods-watcher-enabled` Enable the pods watcher (disabled by default)
38+
- `--repl` Start a SQL REPL against the runtime's Flight endpoint
39+
- `-v`, `--verbose` Enable verbose logging (use `-vv` for more detail)
40+
- `--very-verbose` Enable very verbose logging
3641
- `--set-runtime` Override [runtime configuration](../../reference/spicepod/#runtime) with a name/value pair specified as `name=value`. Multiple overrides can be specified by using the flag multiple times.
42+
- `[PATH]` Positional argument specifying the path to a Spicepod directory or file. Supports local paths and `s3://` remote URLs.
3743

3844
### Examples
3945

@@ -83,8 +89,8 @@ spice run
8389
#### `--captured-outputs none`
8490

8591
```shell
86-
# Set task history captured outputs to none
87-
spice run -- --captured-outputs none
92+
# Set task history captured outputs to none via --set-runtime
93+
spice run -- --set-runtime task_history.captured_output=none
8894
```
8995

9096
#### `--http`

website/docs/cli/reference/status.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ NAME ENDPOINT STATUS
2626
http 127.0.0.1:8090 Ready
2727
flight 127.0.0.1:50051 Ready
2828
metrics N/A Disabled
29-
opentelemetry 127.0.0.1:50051 Ready
3029
```
3130

3231
### Additional Example
@@ -38,5 +37,4 @@ NAME ENDPOINT STATUS
3837
http 127.0.0.1:8090 Ready
3938
flight 127.0.0.1:50051 Ready
4039
metrics N/A Disabled
41-
opentelemetry 127.0.0.1:50051 Ready
4240
```

website/docs/cli/reference/version.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ spice version [flags]
2323
```shell
2424
> spice version
2525

26-
2024/12/17 22:42:11 INFO CLI version: v0.18.3-beta
27-
2024/12/17 22:42:13 INFO Runtime version: v0.20.0-beta+models
28-
2024/12/17 22:42:14 INFO
29-
CLI version v1.0.0-rc.4 is now available!
30-
To upgrade, run "spice upgrade".
26+
CLI version: v1.0.6
27+
Runtime version: v1.0.6+models
28+
29+
CLI version v1.1.0 is now available!
30+
To upgrade, run "spice upgrade".
3131
```
3232

3333
Learn more about upgrading the Spice CLI and runtime using `spice upgrade` [here.](./upgrade)
@@ -37,6 +37,6 @@ Learn more about upgrading the Spice CLI and runtime using `spice upgrade` [here
3737
```shell
3838
> spice version
3939

40-
CLI version: v1.0.0-rc.4
41-
Runtime version: v1.0.0-rc.4+models
40+
CLI version: v1.1.0
41+
Runtime version: v1.1.0+models
4242
```

website/docs/deployment/docker/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ COPY data /app/data
3030
COPY .env* /app/
3131

3232
# Spice runtime start-up arguments
33+
# --metrics is optional; omit it if Prometheus metrics are not needed
3334
CMD ["--http","0.0.0.0:8090","--metrics", "0.0.0.0:9090","--flight","0.0.0.0:50051"]
3435

3536
EXPOSE 8090

website/docs/deployment/kubernetes/index.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -166,24 +166,24 @@ The Helm convention is to use a file called `values.yaml`, but any file name can
166166

167167
## Common Parameters
168168

169-
| **Name** | **Description** | **Value** |
170-
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
171-
| `additionalEnv` | Additional environment variables to set in the Spice.ai container. | `[]` |
172-
| `additionalLabels` | Additional labels to add to all resources. | `{}` |
173-
| `image.pullSecrets` | Specify Docker registry secret names as an array. | `[]` |
174-
| `image.repository` | The repository of the Docker image. | `spiceai` |
175-
| `image.tag` | Replace with a specific version of Spice.ai to run. | `1.3.0` |
176-
| `monitoring.podMonitor.enabled` | Enable Prometheus metrics collection for the Spice pods. Requires the [Prometheus Operator](https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.PodMonitor) CRDs. | `false` |
177-
| `replicaCount` | Number of Spice.ai replicas to run. | `1` |
178-
| `resources` | Resource requests and limits for the Spice.ai container. See [Container resource examples](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#example-1). | `{}` |
179-
| `service.type` | Kubernetes service type. Can be null, ClusterIP, NodePort, or LoadBalancer. | `null` |
180-
| `serviceAccount.create` | Specifies whether a ServiceAccount should be created. | `false` |
181-
| `spicepod` | Define the [Spicepod](https://spiceai.org/docs/getting-started/spicepods) to be loaded by the Spice.ai runtime. | `{}` |
182-
| `stateful.enabled` | Use a StatefulSet with a PVC (Persistent Volume Claim) for the data volume. | `false` |
183-
| `stateful.mountPath` | Mount path in container for the persistent volume. | `/data` |
184-
| `stateful.size` | Size of each PV in the StatefulSet. | `1Gi` |
185-
| `stateful.storageClass` | Storage class for the volume claim template in the StatefulSet. | `standard` |
186-
| `tolerations` | List of node taints to tolerate. | `[]` |
169+
| **Name** | **Description** | **Value** |
170+
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
171+
| `additionalEnv` | Additional environment variables to set in the Spice.ai container. | `[]` |
172+
| `additionalLabels` | Additional labels to add to all resources. | `{}` |
173+
| `image.pullSecrets` | Specify Docker registry secret names as an array. | `[]` |
174+
| `image.repository` | The repository of the Docker image. | `spiceai/spiceai` |
175+
| `image.tag` | Replace with a specific version of Spice.ai to run. | `latest-models` |
176+
| `monitoring.podMonitor.enabled` | Enable Prometheus metrics collection for the Spice pods. Requires the [Prometheus Operator](https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.PodMonitor) CRDs. | `false` |
177+
| `replicaCount` | Number of Spice.ai replicas to run. | `1` |
178+
| `resources` | Resource requests and limits for the Spice.ai container. See [Container resource examples](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#example-1). | `{}` |
179+
| `service.type` | Kubernetes service type. Can be null, ClusterIP, NodePort, or LoadBalancer. | `null` |
180+
| `serviceAccount.create` | Specifies whether a ServiceAccount should be created. | `false` |
181+
| `spicepod` | Define the [Spicepod](https://spiceai.org/docs/getting-started/spicepods) to be loaded by the Spice.ai runtime. | `{}` |
182+
| `stateful.enabled` | Use a StatefulSet with a PVC (Persistent Volume Claim) for the data volume. | `false` |
183+
| `stateful.mountPath` | Mount path in container for the persistent volume. | `/data` |
184+
| `stateful.size` | Size of each PV in the StatefulSet. | `1Gi` |
185+
| `stateful.storageClass` | Storage class for the volume claim template in the StatefulSet. | `standard` |
186+
| `tolerations` | List of node taints to tolerate. | `[]` |
187187

188188
## Environment Variables and Secrets
189189

@@ -355,7 +355,7 @@ additionalLabels:
355355
356356
image:
357357
repository: spiceai/spiceai
358-
tag: 1.3.0
358+
tag: latest-models
359359
replicaCount: 1
360360
361361
service:

website/docs/getting-started/index.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,6 @@ Example output:
111111
```bash
112112
Spice.ai runtime starting...
113113
2024-08-05T13:02:40.247484Z INFO runtime::flight: Spice Runtime Flight listening on 127.0.0.1:50051
114-
2024-08-05T13:02:40.247490Z INFO runtime::metrics_server: Spice Runtime Metrics listening on 127.0.0.1:9090
115114
2024-08-05T13:02:40.247949Z INFO runtime: Initialized results cache; max size: 128.00 MiB, item ttl: 1s
116115
2024-08-05T13:02:40.248611Z INFO runtime::http: Spice Runtime HTTP listening on 127.0.0.1:8090
117116
```

0 commit comments

Comments
 (0)