docs: Comprehensive Spice.ai connector docs (Cloud + Spice-to-Spice / sidecar)#1653
Merged
Merged
Conversation
The Spice.ai data connector targets two architectures with the same spice.ai: URI scheme, but the existing docs only covered the managed Cloud Platform case. Add comprehensive coverage of the Spice → Spice self-hosted federation pattern (cluster sidecar, edge-to-core, local development) including: - All five `from:` URI formats (path/colon/URL-style cloud + colon-prefixed http/https/grpc+tls for self-hosted) - The full parameter list: spiceai_api_key, spiceai_token, spiceai_region, spiceai_endpoint, spiceai_flight_endpoint, spiceai_tls_ca_certificate_file - Endpoint resolution precedence (params -> from URI -> region default) - Authentication via runtime.auth.api-key on the upstream - TLS with custom CA pinning for cluster-internal certs - Append-stream CDC between Spice runtimes - Sidecar deployment patterns and example spicepods - Topology decision matrix and per-topology troubleshooting Also corrects parameter names that the previous docs had wrong (plain `endpoint` -> `spiceai_endpoint`; missing `spiceai_region`). Verified against the connector source: spice_dataset_path URI parsing, get_endpoint resolution order, get_credentials handling, and the full PARAMETERS array.
🔍 Pull with Spice FailedPassing checks:
Failed checks:
Please address these issues and update your pull request. |
|
🚀 deployed to https://5261d810.spiceai-org-website.pages.dev |
lukekim
approved these changes
May 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrite the Spice.ai data connector docs to cover both architectures the connector actually supports — the existing docs only covered the managed Cloud Platform path. The same connector federates queries to any Spice runtime over Arrow Flight, including self-hosted Spice instances in a cluster-sidecar, edge-to-core, or local-dev topology.
What changed
website/docs/components/data-connectors/spiceai/index.md(rewritten)from:URI formats: path-style, colon-style, and URL-style cloud forms; plus colon-prefixedhttp:///https:///grpc+tls://forms for self-hosted upstreams.spiceai_api_key,spiceai_token,spiceai_region,spiceai_endpoint,spiceai_flight_endpoint,spiceai_tls_ca_certificate_file. The previous docs incorrectly used unprefixed names likeendpointand were missingspiceai_regionandspiceai_tls_ca_certificate_fileentirely.spiceai_endpoint→from:URI scheme → built fromspiceai_region.runtime.auth.api-key.keys(not previously documented).spiceai_tls_ca_certificate_filefor cluster-internal certs.refresh_mode: appendexample.website/docs/components/data-connectors/spiceai/deployment.md(rewritten)runtime.auth.api-key.keys).UnsupportedEndpointScheme,CloudEndpointRegionMismatch,MissingRequiredParameter: api_key or token, TLS handshake failures with private CAs.Verification
All claims verified against the actual connector source:
from:URI parsing →spice_dataset_path(crates/runtime/src/dataconnector/spiceai.rs:526-553); test cases at:651-757.is_flight_endpoint_path(:207-212).http://,https://,grpc+tls://; rejectsgrpc://) →ensure_supported_endpoint_scheme(:214-223).PARAMETERSarray (:176-184).get_endpoint(:252-279).get_credentials(:293-306); test (:858-864).test/spicepods/tpch/sf1/federated/spicecloud.yaml.Test plan
runtime.auth.api-key.keyssyntax matchesruntime.mdreference