Skip to content

docs: Add mTLS client params to Spice.ai data connector#1725

Merged
lukekim merged 1 commit into
trunkfrom
docs/spiceai-connector-mtls-client-params
May 14, 2026
Merged

docs: Add mTLS client params to Spice.ai data connector#1725
lukekim merged 1 commit into
trunkfrom
docs/spiceai-connector-mtls-client-params

Conversation

@lukekim
Copy link
Copy Markdown
Contributor

@lukekim lukekim commented May 14, 2026

Summary

Documents the four new mTLS client identity parameters added in spiceai/spiceai#10764 for spice-to-spice mutual TLS:

  • spiceai_tls_client_certificate_file
  • spiceai_tls_client_key_file
  • spiceai_tls_client_certificate
  • spiceai_tls_client_key

Mirrors the FlightSQL connector docs update merged in #1720.

Source PRs

Changes

  • website/docs/components/data-connectors/spiceai/index.md — adds the four mTLS client params to the Parameters table and a new "Mutual TLS (mTLS)" subsection covering file-based and inline configuration.
  • website/docs/components/data-connectors/spiceai/deployment.md — same params added to the deployment guide reference table, plus a deployment-oriented mTLS subsection.

Test plan

  • cd website && npm run build passes locally
  • Parameter names verified against crates/runtime/src/dataconnector/spiceai.rs PARAMETERS array
  • Mutual-exclusivity behavior verified against resolve_client_identity_params in source

Documents the four new mTLS client identity parameters
(`spiceai_tls_client_certificate_file`, `spiceai_tls_client_key_file`,
`spiceai_tls_client_certificate`, `spiceai_tls_client_key`) added in
spiceai/spiceai#10764 for spice-to-spice mTLS. Mirrors the FlightSQL
connector docs update in #1720.

- Adds the parameters to the connector reference table.
- Adds the parameters to the deployment guide reference table.
- Adds an "Mutual TLS (mTLS)" subsection with file-based and inline
  configuration examples to both pages.
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 14, 2026

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: claudespice

1 similar comment
@github-actions
Copy link
Copy Markdown

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: claudespice

@github-actions
Copy link
Copy Markdown

🚀 deployed to https://f4b7c575.spiceai-org-website.pages.dev

@lukekim lukekim merged commit f4c9cbd into trunk May 14, 2026
8 of 11 checks passed
@lukekim lukekim deleted the docs/spiceai-connector-mtls-client-params branch May 14, 2026 03:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants