Skip to content

Commit 225d74c

Browse files
committed
fix: update links in GCP deployment and read/write separation documentation for consistency
1 parent 18cc463 commit 225d74c

4 files changed

Lines changed: 13 additions & 10 deletions

File tree

website/docs/deployment/gcp/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ For burst or low-utilization workloads, use [GKE Autopilot](https://cloud.google
6464

6565
#### 2. Configure Workload Identity for GCP access
6666

67-
Most Spice connectors (Cloud Storage via the [S3 connector](../../components/data-connectors/s3) with HMAC, BigQuery via [ADBC](../../components/data-connectors/adbc), Cloud SQL via [PostgreSQL](../../components/data-connectors/postgres) or [MySQL](../../components/data-connectors/mysql)) accept GCP credentials from [Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials). Use Workload Identity so pods receive scoped, short-lived tokens without static keys:
67+
Most Spice connectors (Cloud Storage via the [S3 connector](../components/data-connectors/s3) with HMAC, BigQuery via [ADBC](../components/data-connectors/adbc), Cloud SQL via [PostgreSQL](../components/data-connectors/postgres) or [MySQL](../components/data-connectors/mysql)) accept GCP credentials from [Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials). Use Workload Identity so pods receive scoped, short-lived tokens without static keys:
6868

6969
```bash
7070
# 1. Create a Google service account and grant it the roles the Spicepod needs

website/docs/deployment/read-write-separation.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -87,14 +87,14 @@ It is overkill when one Spice instance is sufficient (start with [Sidecar](archi
8787

8888
### The cluster (write tier)
8989

90-
The cluster owns every refresh, acceleration, and search index for the datasets in scope. It runs as a standalone Spice deployment — typically a Kubernetes [`Deployment`](deployment/kubernetes/helm) or [`StatefulSet`](https://docs.spice.ai/docs/enterprise/kubernetes-operator/spicepodset), or a managed [Spice Cloud](deployment/cloud) app — and holds the only credentials to the source systems.
90+
The cluster owns every refresh, acceleration, and search index for the datasets in scope. It runs as a standalone Spice deployment — typically a Kubernetes [`Deployment`](./kubernetes/helm) or [`StatefulSet`](https://docs.spice.ai/docs/enterprise/kubernetes-operator/spicepodset), or a managed [Spice Cloud](./cloud) app — and holds the only credentials to the source systems.
9191

9292
Cluster Spicepod responsibilities:
9393

9494
- Connect to every source: object stores, OLTP databases, lakehouses, search indices, message queues.
9595
- Run all refresh schedules, CDC, and stream ingest.
9696
- Accelerate to file-mode engines (DuckDB or SQLite) so the materialization can be exported as a snapshot.
97-
- Write [snapshots](features/data-acceleration/snapshots) to a shared object store after each refresh.
97+
- Write [snapshots](../features/data-acceleration/snapshots) to a shared object store after each refresh.
9898

9999
```yaml
100100
# cluster spicepod.yaml
@@ -138,7 +138,7 @@ datasets:
138138
duckdb_file: /data/customers.db
139139
```
140140
141-
Snapshots are partitioned by date and dataset (`month=YYYY-MM/day=YYYY-MM-DD/dataset=<name>/...`), so retention is a normal object-store lifecycle rule. See [Snapshots](features/data-acceleration/snapshots) for the full configuration reference.
141+
Snapshots are partitioned by date and dataset (`month=YYYY-MM/day=YYYY-MM-DD/dataset=<name>/...`), so retention is a normal object-store lifecycle rule. See [Snapshots](../features/data-acceleration/snapshots) for the full configuration reference.
142142

143143
### The read instances (read tier)
144144

@@ -187,7 +187,7 @@ datasets:
187187

188188
### Live delegation for the long tail
189189

190-
Snapshots cover the working set. For queries that span beyond it — historical analytics, cross-dataset joins, distributed search — read instances delegate to the cluster using a [`spiceai` connector](components/data-connectors/spiceai) entry pointing at the cluster's Arrow Flight endpoint.
190+
Snapshots cover the working set. For queries that span beyond it — historical analytics, cross-dataset joins, distributed search — read instances delegate to the cluster using a [`spiceai` connector](../components/data-connectors/spiceai) entry pointing at the cluster's Arrow Flight endpoint.
191191

192192
```yaml
193193
# read instance spicepod.yaml (continued)
@@ -251,7 +251,7 @@ Whichever approach is chosen, treat schema changes as backward-compatible by def
251251

252252
## Deploy on Kubernetes
253253

254-
The reference topology runs the cluster as a `StatefulSet` (or [`SpicepodSet`](https://docs.spice.ai/docs/enterprise/kubernetes-operator/spicepodset) on Spice.ai Enterprise) and the read instances as sidecars in application pods. Both use the same [Spice Helm chart](deployment/kubernetes/helm).
254+
The reference topology runs the cluster as a `StatefulSet` (or [`SpicepodSet`](https://docs.spice.ai/docs/enterprise/kubernetes-operator/spicepodset) on Spice.ai Enterprise) and the read instances as sidecars in application pods. Both use the same [Spice Helm chart](./kubernetes/helm).
255255

256256
### Cluster release
257257

@@ -362,9 +362,9 @@ A high delegation rate is a signal to expand the materialized working set. A gro
362362
## Related
363363

364364
- [Cluster-Sidecar Architecture](architectures/cluster-sidecar) — the conceptual model and live-delegation pattern.
365-
- [Snapshots](features/data-acceleration/snapshots) — full reference for snapshot configuration, triggers, and modes.
365+
- [Snapshots](../features/data-acceleration/snapshots) — full reference for snapshot configuration, triggers, and modes.
366366
- [Sidecar Architecture](architectures/sidecar) — single-instance precursor to this pattern.
367367
- [Cluster Architecture](architectures/cluster) — internal scheduler/executor split for the cluster tier (Spice.ai Enterprise).
368-
- [Kubernetes Deployment Guide](deployment/kubernetes) — Helm, Argo CD, and Flux options for the cluster.
369-
- [CI/CD](deployment/ci-cd) — automating cluster and read-instance rollouts.
368+
- [Kubernetes Deployment Guide](./kubernetes) — Helm, Argo CD, and Flux options for the cluster.
369+
- [CI/CD](./ci-cd) — automating cluster and read-instance rollouts.
370370
- [Spice.ai Enterprise Kubernetes Operator](https://docs.spice.ai/docs/enterprise/kubernetes-operator/kubernetes) — recommended for production self-hosted deployments.

website/src/partials/deployment/architectures/_cluster-sidecar.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,4 @@ A multi-tenant SaaS platform where each tenant's application pod includes a Spic
7272

7373
**See also**
7474

75-
- [Read/Write Separation](../read-write-separation) — production guide for splitting ingest from reads using shared acceleration snapshots, including Spicepod and Helm reference configurations.
75+
- [Read/Write Separation](https://spiceai.org/docs/deployment/read-write-separation) — production guide for splitting ingest from reads using shared acceleration snapshots, including Spicepod and Helm reference configurations.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import Content from './_cluster-sidecar.mdx';
2+
3+
<Content />

0 commit comments

Comments
 (0)