Skip to content

Commit 179393a

Browse files
authored
Docs for rc5 (#1731)
* docs for rc5 * docs improve * proofread docs * again * more
1 parent 6128b26 commit 179393a

3 files changed

Lines changed: 39 additions & 7 deletions

File tree

website/docs/components/data-connectors/mongodb.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,32 @@ datasets:
265265
mongodb_pool_max: 10
266266
```
267267

268+
### Using MongoDB Change Streams
269+
270+
Spice supports real-time Change Data Capture (CDC) from MongoDB using native [MongoDB Change Streams](https://www.mongodb.com/docs/manual/changeStreams/). This enables streaming inserts, updates, and deletes from your MongoDB collections directly into Spice accelerators.
271+
272+
To enable real-time CDC, set `refresh_mode: changes` in the dataset's configuration:
273+
274+
```yaml
275+
datasets:
276+
- from: mongodb:my_collection
277+
name: my_collection
278+
params:
279+
host: my-cluster.mongodb.net
280+
db: mydb
281+
acceleration:
282+
enabled: true
283+
engine: duckdb
284+
refresh_mode: changes
285+
```
286+
287+
#### Notes
288+
- Requires MongoDB 4.0+ and a replica set or sharded cluster.
289+
- Ensure your MongoDB user has `changeStream` privileges.
290+
291+
---
292+
293+
268294
## Secrets
269295

270296
Spice integrates with multiple secret stores to help manage sensitive data securely. For detailed information on supported secret stores, refer to the [secret stores documentation](../secret-stores). Additionally, learn how to use referenced secrets in component parameters by visiting the [using referenced secrets guide](../secret-stores#using-secrets).

website/docs/components/data-connectors/snowflake.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: 'Snowflake Data Connector'
33
sidebar_label: 'Snowflake Data Connector'
44
description: 'Snowflake Data Connector Documentation'
55
pagination_prev: null
6+
tags:
7+
- data-connectors
8+
- write
69
---
710

811
import Tabs from '@theme/Tabs';

website/docs/reference/spicepod/runtime.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,15 @@ The TLS section specifies the configuration for enabling Transport Layer Securit
215215

216216
In addition to configuring TLS via the manifest, TLS can also be configured via `spiced` command line arguments using the `--tls-enabled true` flag along with `--tls-certificate`/`--tls-certificate-file` and `--tls-key`/`--tls-key-file`.
217217

218+
### Certificate Hot-Reload
219+
220+
Spice can hot-reload TLS certificates and client CA files for runtime endpoints. Update the certificate, key, or CA file on disk, then send `SIGHUP` to the Spice process to reload without restart. Only file-based certificates/keys/CA are hot-reloaded (not inline PEM). Existing connections are not interrupted; only new connections use the updated files. If reload fails, the previous certificate remains active and a warning is logged.
221+
222+
**Steps:**
223+
1. Replace the certificate/key/CA file on disk.
224+
2. Send `SIGHUP` to the Spice process (e.g., `kill -SIGHUP <pid>`).
225+
3. Check logs for reload confirmation or errors.
226+
218227
### `runtime.tls.enabled`
219228

220229
Enables or disables TLS for the runtime endpoints.
@@ -233,7 +242,6 @@ The TLS certificate to use for securing the runtime endpoints. The certificate c
233242
```yaml
234243
runtime:
235244
tls:
236-
...
237245
certificate: |
238246
-----BEGIN CERTIFICATE-----
239247
...
@@ -254,7 +262,6 @@ The path to the TLS PEM-encoded certificate file. Only one of `certificate` or `
254262
```yaml
255263
runtime:
256264
tls:
257-
...
258265
certificate_file: /path/to/cert.pem
259266
```
260267

@@ -265,10 +272,9 @@ The TLS key to use for securing the runtime endpoints. The key can also come fro
265272
```yaml
266273
runtime:
267274
tls:
268-
...
269275
key: |
270276
-----BEGIN PRIVATE KEY-----
271-
...
277+
(private key contents)
272278
-----END PRIVATE KEY-----
273279
```
274280

@@ -286,7 +292,6 @@ The path to the TLS PEM-encoded key file. Only one of `key` or `key_file` must b
286292
```yaml
287293
runtime:
288294
tls:
289-
...
290295
key_file: /path/to/key.pem
291296
```
292297

@@ -323,7 +328,6 @@ Path to a PEM-encoded CA bundle used to verify client certificates. The file is
323328
```yaml
324329
runtime:
325330
tls:
326-
...
327331
client_auth_ca_file: /path/to/client-ca.pem
328332
```
329333

@@ -334,7 +338,6 @@ Inline PEM (or `${ secrets:... }`) form of the client CA bundle. Mutually exclus
334338
```yaml
335339
runtime:
336340
tls:
337-
...
338341
client_auth_ca: |
339342
-----BEGIN CERTIFICATE-----
340343
...

0 commit comments

Comments
 (0)