docs: add versioned docs for v2.4 (#2414)
* docs: add versioned docs for v2.4
Copy of website/docs at 77dd0e0f, made with website/create-release.sh 2.4.
* docs(v2.4): exclude 223a66e4 (Parquet page-size bound, JSON function federation, Docker /tmp, GraphQL error previews, MySQL binlog thread)
Reverts 223a66e4 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15078, spiceai/spiceai#15181, spiceai/spiceai#15245, spiceai/spiceai#15255, spiceai/spiceai#15321, which release/2.4 does not contain.
* docs(v2.4): exclude 249d7eac (async queries reject task history; /v1/search rejects empty text)
Reverts 249d7eac in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15119, spiceai/spiceai#15213, which release/2.4 does not contain.
* docs(v2.4): exclude af5309a4 (snapshot refresh error reasons, snapshot metrics, query-interactive pool, Iceberg append warning, Datadog pod panels)
Reverts af5309a4 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15144, spiceai/spiceai#15212, spiceai/spiceai#15309, spiceai/spiceai#15310, which release/2.4 does not contain. Keeps the components/data-accelerators/cayenne/index.md change, which documents spiceai/spiceai#15340, backported to release/2.4.
* docs(v2.4): exclude a2aab93e (http: file reads send Basic credentials as a header, not in the URL)
Reverts a2aab93e in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15305, which release/2.4 does not contain.
* docs(v2.4): exclude db4fe591 (search: pass query parameters to search table functions)
Reverts db4fe591 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15048, which release/2.4 does not contain.
* docs(v2.4): exclude 94f266ff (models: chat completions keep the text a model writes beside a tool call)
Reverts 94f266ff in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15035, spiceai/spiceai#15088, which release/2.4 does not contain.
* docs(v2.4): exclude 6359209c (http: forward the query's traceparent to the HTTP origin)
Reverts 6359209c in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15089, which release/2.4 does not contain.
* docs(v2.4): exclude bfeec6c8 (auth: read-only sql tool without a read-write key; startup warning for writable data without runtime.auth)
Reverts bfeec6c8 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15284, which release/2.4 does not contain.
* docs(v2.4): exclude f7c360b5 (cluster: a restarted scheduler waits for its old heartbeat to lapse, then registers)
Reverts f7c360b5 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15196, which release/2.4 does not contain.
* docs(v2.4): exclude 511eac6b (cdc: MySQL CDC takes commit time from the GTID event, to the millisecond)
Reverts 511eac6b in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15188, which release/2.4 does not contain.
* docs(v2.4): exclude 7b1a3f48 (models: Spice replays its tool calls from earlier turns on /v1/chat/completions)
Reverts 7b1a3f48 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15127, which release/2.4 does not contain.
* docs(v2.4): exclude b33f2255 (distributed-query: cluster port requires mTLS; deprecate --allow-insecure-connections)
Reverts b33f2255 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15285, which release/2.4 does not contain.
* docs(v2.4): exclude 9c2a7d95 (models: retry failed model loads in the background)
Reverts 9c2a7d95 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15277, which release/2.4 does not contain.
* docs(v2.4): exclude 93f2cbe0 (cli: spice dataset configure prompts for spiceai_region)
Reverts 93f2cbe0 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15170, which release/2.4 does not contain.
* docs(v2.4): exclude 7f7633ec (refresh: warn about on_zero_results in caching mode only when set to use_source)
Reverts 7f7633ec in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15254, which release/2.4 does not contain.
* docs(v2.4): exclude 94b3239b (snapshots: release the snapshot writer lease on graceful shutdown)
Reverts 94b3239b in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15256, which release/2.4 does not contain.
* docs(v2.4): exclude c01cc016 (observability: state-store request, conflict and cleanup metrics)
Reverts c01cc016 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15203, which release/2.4 does not contain.
* docs(v2.4): exclude f65269c0 (snapshots: keep 28 days of snapshots)
Reverts f65269c0 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15199, spiceai/spiceai#15241, which release/2.4 does not contain.
* docs(v2.4): exclude 6561cca6 (cayenne: refuse a Spicepod whose Cayenne datasets resolve to different metastore directories)
Reverts 6561cca6 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15232, which release/2.4 does not contain.
* docs(v2.4): exclude f4d86be6 (snapshots: pin and unpin a snapshot; spice acceleration CLI reference)
Reverts f4d86be6 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15221, which release/2.4 does not contain.
* docs(v2.4): exclude 4720cf21 (store and query OpenTelemetry logs)
Reverts 4720cf21 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15206, which release/2.4 does not contain.
* docs(v2.4): exclude f443ab63 (snapshots: keep 14 days of snapshots, and async job cleanup timing)
Reverts f443ab63 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15199, which release/2.4 does not contain.
* docs(v2.4): exclude 52139445 (snapshots: per-dataset snapshot settings; deprecate top-level snapshots and runtime.scheduler state settings)
Reverts 52139445 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15136, which release/2.4 does not contain.
* docs(v2.4): exclude be5092e8 (observability: store every OTLP metric in one table and query it with time-series functions)
Reverts be5092e8 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15066, which release/2.4 does not contain.
* docs(v2.4): exclude 66ab1e4e (runtime: one instance identity for every shared-state feature)
Reverts 66ab1e4e in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15135, which release/2.4 does not contain.
* docs(v2.4): exclude 9058c8da (sql: fractional literals compare exactly with DECIMAL columns)
Reverts 9058c8da in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15082, which release/2.4 does not contain.
* docs(v2.4): exclude d28c5171 (observability: list Drasi forward delivery metrics)
Reverts d28c5171 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15075, which release/2.4 does not contain.
* docs(v2.4): exclude 2c75b374 (ai: /v1/decisions names load failures and reports cached and reasoning tokens)
Reverts 2c75b374 in website/versioned_docs/version-2.4.x. It documents spiceai/spiceai#15146, which release/2.4 does not contain.
* docs: link the views, DuckDB, and Databricks pages to .md files
These index.md pages used file-relative paths without .md, which Docusaurus resolves as URLs one level too high. In Next they land on the latest version's pages; in the latest version they resolve outside /docs and fail the broken-link check.
15 days ago
docs: ECS EBS volumes on Fargate, Bedrock models in the AWS integrations, the Azure guide row, every S3 Express zone prefix, and spice workers (#2501)
* docs: ECS EBS volumes on Fargate and their lifetime, Bedrock models in the AWS integrations list, the Azure guide row, every S3 Express zone prefix Cayenne recognizes, and a spice workers reference page
* docs(aws): EFS is a shared mounted file system, not the only storage that outlives a Fargate task
---------
Co-authored-by: Emma Spice <emma@EmmasMacStudio.localdomain>
15 hours ago
docs(cayenne): add the migration guide for deprecated acceleration engines (#2427)
* docs(cayenne): add the migration guide for deprecated acceleration engines
The v2.4 deprecation warning for the arrow, duckdb, sqlite, turso, and postgres
acceleration engines links to this page. It covers which accelerations are safe
to rebuild from their source, switching the engine, and which acceleration
files and snapshots to delete afterwards.
Refs spiceai/spiceai#15492
* docs(cayenne): drop the undefined migration tag
* docs(cayenne): cover migrating off the DuckDB vector engine
* docs(cayenne): note the _score scale change when leaving the DuckDB vector engine
* docs(cayenne): check retained data directly, cover partition_by and keyless Debezium, and keep non-cosine metrics
- Retention settings explain but do not bound what an acceleration holds, so
step 1 now compares the acceleration's rows with the source's.
- Step 2 covers the two configurations that need more than the engine change:
partition_by with mode: memory, and Debezium topics without message keys.
- The vector section maps duckdb_distance_metric to vector_search's
distance_metric argument and limits the _score conversion to cosine.
* docs(cayenne): migrate snapshot writers before readers, and verify the load before deleting
- Readers that load from snapshots never rebuild from the source, and Cayenne
skips other engines' snapshots, so step 2 migrates the writer first and step 4
keeps the old snapshots until every reader has moved.
- A dataset can report ready before its first load (ready_state:
on_registration or on_schema_resolved), so step 2 now verifies the loaded data
with the step 1 query before anything is deleted.
* docs(cayenne): confirm Cayenne's first load, not just readiness, before verifying the migration
With ready_state on_registration or on_schema_resolved a dataset answers from the
source until its first load, so a verification query run then checks the source.
Use on_load (the default) or wait for the dataset's load line in the log.
12 days ago
docs(v2.4): backport docs for PRs cherry-picked into release/2.4 (#2445)
* docs(v2.4): backport 9058c8da (sql: fractional literals compare exactly with DECIMAL columns)
Restores 9058c8da, excluded in 513e63d8. It documents spiceai/spiceai#15082, which release/2.4 now contains (v2.4.0).
* docs(v2.4): backport 66ab1e4e (runtime: one instance identity for every shared-state feature)
Restores 66ab1e4e, excluded in 513e63d8. It documents spiceai/spiceai#15135, which release/2.4 now contains (v2.4.0).
* docs(v2.4): backport 52139445 (snapshots: per-dataset snapshot settings; deprecate top-level snapshots and runtime.scheduler state settings)
Restores 52139445, excluded in 513e63d8. It documents spiceai/spiceai#15136, which release/2.4 now contains (v2.4.0).
* docs(v2.4): backport f443ab63 (snapshots: keep 14 days of snapshots, and async job cleanup timing)
Restores f443ab63, excluded in 513e63d8. It documents spiceai/spiceai#15199, which release/2.4 now contains (v2.4.0).
* docs(v2.4): backport f65269c0 (snapshots: keep 28 days of snapshots)
Restores f65269c0, excluded in 513e63d8. It documents spiceai/spiceai#15241, which release/2.4 now contains (v2.4.0).
* docs(v2.4): backport c01cc016 (observability: state-store request, conflict and cleanup metrics)
Restores c01cc016, excluded in 513e63d8. It documents spiceai/spiceai#15203, which release/2.4 now contains (v2.4.0).
* docs(v2.4): backport 94b3239b (snapshots: release the snapshot writer lease on graceful shutdown)
Restores 94b3239b, excluded in 513e63d8. It documents spiceai/spiceai#15256, which release/2.4 now contains (v2.4.0).
* docs(v2.4): backport f7c360b5 (cluster: a restarted scheduler waits for its old heartbeat to lapse, then registers)
Restores f7c360b5, excluded in 513e63d8. It documents spiceai/spiceai#15196, which release/2.4 now contains (v2.4.0).
* docs(v2.4): backport af5309a4 (snapshot refresh error reasons, snapshot metrics, Datadog pod panels)
Restores af5309a4 except reference/spicepod/runtime.md. It documents spiceai/spiceai#15310, #15212, #15309, which release/2.4 now contains (v2.4.0). The query-interactive pool (spiceai/spiceai#15144) is not in release/2.4 and stays out; the cayenne/index.md change (#15340) was already kept in 513e63d8. Snapshot pinning (spiceai/spiceai#15221) is not in release/2.4, so the conflicting lines take trunk's wording, which no longer mentions it.
* docs(v2.4): backport 249d7eac (/v1/search rejects empty text)
Restores the /v1/search part of 249d7eac. It documents spiceai/spiceai#15119, which release/2.4 now contains (v2.4.0). The task-history change for async queries (spiceai/spiceai#15213) is not in release/2.4 and stays out.
* docs(v2.4): backport 223a66e4 (JSON function federation, MySQL binlog thread)
Restores the JSON function and MySQL binlog parts of 223a66e4. It documents spiceai/spiceai#15078 and #15181, which release/2.4 now contains (v2.4.0). The Parquet page-size bound (#15321), Docker /tmp (#15245), and GraphQL retry warnings (#15255) are not in release/2.4 and stay out.
* docs(v2.4): backport 0a9ef6d5 (cayenne: append-only compaction)
Backports the cayenne_compaction_max_files_per_pick changes from 0a9ef6d5. They document spiceai/spiceai#15227, which release/2.4 contains (v2.4.0). Scan-view reuse under target_freshness (spiceai/spiceai#15259) is not in release/2.4 and stays out; the caching and Iceberg parts of 0a9ef6d5 are already in version-2.4.x.
* docs(v2.4): backport f5f3b977 (fix three typos on the SQL SELECT page)
Docs-only fix.
* docs(v2.4): backport 6a82bb96 (append accelerations with snapshots are served before their first refresh)
Backports the append readiness changes from 6a82bb96. They document spiceai/spiceai#15463, which release/2.4 contains (v2.4.0). The tool-call limit (#15353), Cloud default region (#15414), env store precedence (#15469), and accelerated views (#15371) are not in release/2.4 and stay out.
* docs(v2.4): backport 7df4ed2f (refresh: a source that stops sending mid-refresh fails and retries)
Backports the refresh stall section from 7df4ed2f. It documents spiceai/spiceai#15457, which release/2.4 contains (v2.4.0). The SMB port (#15502), compressed HTTP responses (#15327), DynamoDB numbers (#15513), and URL table checks (#15354) are not in release/2.4 and stay out.
* docs(v2.4): backport 0e1cc953 (deprecate non-Cayenne accelerators; snapshot download failures)
Backports two of the five changes in 0e1cc953. They document spiceai/spiceai#15496 (non-Cayenne acceleration engines and the DuckDB vector engine are deprecated) and #15472 (a snapshot reader that cannot load a newer snapshot reports snapshot_download_failed), which release/2.4 contains (v2.4.0). Decimal division pushdown (#15512), the full-text index rebuild (#14954), and MySQL CDC column type changes (#15134) are not in release/2.4 and stay out.