You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/DISTRIBUTIONS.md
+23-16Lines changed: 23 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ The Spice open source project provides multiple distribution variants to support
4
4
5
5
> **Note:** The Spice runtime is **64-bit only**. 32-bit platforms are not supported.
6
6
7
-
> **Note:** Variant distributions (data, allocators, CUDA) are only available in **nightly images** for the open source project. All features and distributions are available in the [Spice Cloud Platform](https://spice.ai/pricing) and [Spice.ai Enterprise](https://spice.ai/pricing).
7
+
> **Note:** Variant distributions (data, allocators, CUDA) are only available in **nightly images** for the open source project. All features and distributions are available in the [Spice Cloud Platform](https://spice.ai/pricing) and [Spice.ai Enterprise](https://docs.spice.ai/docs/enterprise).
8
8
9
9
## Supported Platforms & Hardware Requirements
10
10
@@ -19,15 +19,16 @@ The Spice open source project provides multiple distribution variants to support
19
19
20
20
## Distribution Availability
21
21
22
-
| Distribution / Variant | Open Source | Spice Cloud | Enterprise |
The data distribution excludes AI/ML model support, resulting in a smaller binary size and reduced attack surface. Use this when you only need data federation and acceleration capabilities without AI features.
63
64
64
-
> **Open Source:** Available in nightly builds only. **[Cloud Platform & Enterprise](https://spice.ai/pricing):** Production-ready data distribution available.
65
+
> **Open Source:** Available in nightly builds only. **[Cloud Platform](https://spice.ai/pricing) & [Enterprise](https://docs.spice.ai/docs/enterprise):** Production-ready data distribution available.
65
66
66
67
**Included Features:**
67
68
@@ -108,7 +109,7 @@ make install-metal
108
109
109
110
For Linux systems with NVIDIA GPUs, CUDA distributions enable GPU-accelerated AI/ML inference. Multiple CUDA compute capability versions are available.
110
111
111
-
> **Open Source:** Available in nightly builds only. **[Cloud Platform & Enterprise](https://spice.ai/pricing):** Production-ready CUDA distribution available.
112
+
> **Open Source:** Available in nightly builds only. **[Cloud Platform](https://spice.ai/pricing) & [Enterprise](https://docs.spice.ai/docs/enterprise):** Production-ready CUDA distribution available.
112
113
113
114
**Included Features:**
114
115
@@ -139,7 +140,7 @@ CUDA_COMPUTE_CAP=89 make install-cuda
139
140
140
141
The NAS (Network Attached Storage) distribution adds support for SMB and NFS data connectors, enabling federated queries against data stored on network file shares.
141
142
142
-
> **[Enterprise](https://spice.ai/pricing):** The NAS distribution is available in nightly builds and with Spice.ai Enterprise.
143
+
> **[Enterprise](https://docs.spice.ai/docs/enterprise):** The NAS distribution is available in nightly builds and with Spice.ai Enterprise.
143
144
144
145
**Included Features:**
145
146
@@ -157,7 +158,7 @@ make install-nas
157
158
158
159
Different memory allocators can significantly impact performance depending on workload characteristics.
159
160
160
-
> **Open Source:** Allocator variants are available in nightly builds only for testing and benchmarking. **[Cloud Platform & Enterprise](https://spice.ai/pricing):** Production-ready allocator variants available.
161
+
> **Open Source:** Allocator variants are available in nightly builds only for testing and benchmarking. **[Cloud Platform](https://spice.ai/pricing) & [Enterprise](https://docs.spice.ai/docs/enterprise):** Production-ready allocator variants available.
| Windows (Native) | ❌ | Enterprise only | Enterprise only | ❌ | Enterprise only |
205
206
206
-
> **Note:** Native Windows support for the Spice runtime is available with the [Spice Cloud Platform and Spice.ai Enterprise](https://spice.ai/pricing). Open source users on Windows should use Windows Subsystem for Linux (WSL).
207
+
> **Note:** Native Windows support for the Spice runtime is available with the [Spice Cloud Platform](https://spice.ai/pricing) and [Spice.ai Enterprise](https://docs.spice.ai/docs/enterprise). Open source users on Windows should use Windows Subsystem for Linux (WSL).
Some connectors require additional dependencies and are available with the [Spice Cloud Platform and Spice.ai Enterprise](https://spice.ai/pricing):
222
+
Some connectors require additional dependencies and are available with the [Spice Cloud Platform](https://spice.ai/pricing) and [Spice.ai Enterprise](https://docs.spice.ai/docs/enterprise):
222
223
223
224
-**ODBC** - Connect to any ODBC-compatible data source
224
225
@@ -228,6 +229,12 @@ These can be built locally for development and testing:
228
229
make install-odbc
229
230
```
230
231
232
+
## Enterprise Authentication
233
+
234
+
The following authentication features are available with the [Spice Cloud Platform](https://spice.ai/pricing) and [Spice.ai Enterprise](https://docs.spice.ai/docs/enterprise):
235
+
236
+
-**OIDC Token Verification** - Validate identity tokens from enterprise providers (Okta, Azure AD, Auth0, Google, etc.) for secure access to Spice runtime endpoints.
237
+
231
238
### Linux arm64 Notes
232
239
233
240
-**FP16 (FEAT_FP16)** is required because the `gemm` matrix multiplication library (used by the Candle ML framework) contains half-precision ARM inline assembly that requires the `fullfp16` CPU feature. This is supported on AWS Graviton2+, Ampere Altra, Apple M-series (via Linux VM), and most ARMv8.2-A+ processors.
- Documentation quality should match code quality standard.
7
+
8
+
## Scope
9
+
10
+
A "component" refers to any of the following:
11
+
12
+
- Data Connectors — see [connectors/](./connectors/).
13
+
- Data Accelerators — see [accelerators/](./accelerators/).
14
+
- Catalog Connectors — see [catalogs/](./catalogs/).
15
+
- Models (LLM providers) — see [models/](./models/).
16
+
- Embedding providers — see [embeddings/](./embeddings/).
17
+
18
+
Runtime subsystems and cross-cutting capabilities that are not a single component (e.g. search, HA, distributed query) use the generic [features/](./features/) criteria.
19
+
20
+
The generic feature criteria and the component-specific criteria are complementary:
21
+
22
+
-**Component criteria apply first.** Connector/accelerator/catalog/model/embedding releases are governed by the files in their respective subdirectories.
23
+
-**Feature criteria apply to component releases as well**, wherever the component-specific criteria do not already cover the same requirement (e.g. preview-warning removal, deprecation policy). Where the two conflict, the component criteria win.
5
24
6
25
## Per Level
26
+
7
27
### Alpha
28
+
8
29
- Code complete at quality benchmark for most basic, valuable functionality.
9
30
- Limitations & edge case failures expected.
10
31
11
32
### Beta
12
-
- Functionally complete.
13
-
- Satisfies minimal performance bar. Resource efficiency (memory, CPU, and I/O usage) is measured.
14
-
- Metrics & tracing in place for observability.
33
+
34
+
- Functionally complete.
35
+
- Satisfies minimal performance bar. Resource efficiency (memory, CPU, and I/O usage) is measured.
<sup>\*</sup> PostgreSQL is a [Spice.ai Enterprise](https://docs.spice.ai/docs/enterprise)-only accelerator.
16
18
17
19
## Beta Release Criteria
18
20
@@ -28,7 +30,7 @@ The Beta release criteria expand on and require that all [Alpha release criteria
28
30
-[ ] The accelerator supports full federation within a single dataset (e.g. `select * from my_dataset`)
29
31
-[ ] The accelerator supports federation push down across multiple datasets within the same accelerator (e.g. `select * from first_dataset, second_dataset`)
30
32
-[ ] The accelerator supports resolving on conflict behaviors (e.g. Drop/Upsert)
31
-
-[ ]Embdedded accelerators support file-mode storage (e.g. SQLite, DuckDB)
33
+
-[ ]Embedded accelerators support file-mode storage (e.g. SQLite, DuckDB)
32
34
-[ ][Core Arrow Data Types](../definitions.md) are supported
33
35
-[ ] All known [Major Bugs](../definitions.md) are resolved
34
36
-[ ] The accelerator supports reading datasets with the same max column count as the accelerator source.
0 commit comments