Skip to content

docs: mTLS configuration reference and TLS API update#1718

Merged
phillipleblanc merged 1 commit into
trunkfrom
phillip/mtls-docs
May 12, 2026
Merged

docs: mTLS configuration reference and TLS API update#1718
phillipleblanc merged 1 commit into
trunkfrom
phillip/mtls-docs

Conversation

@phillipleblanc
Copy link
Copy Markdown
Contributor

Adds documentation for the new mutual TLS (mTLS) feature (Enterprise).

reference/spicepod/runtime.md

New fields under runtime.tls:

  • client_auth_modenone (default) / request / required
  • client_auth_ca_file — PEM CA bundle path (hot-reloaded)
  • client_auth_ca — inline PEM CA (or `${ secrets:... }`)

Includes Enterprise admonition, mode behavior table, and example YAML.

api/tls/index.md

New "Mutual TLS (mTLS)" section covering:

  • Enabling mTLS via spicepod.yaml and CLI flags
  • Client auth mode table
  • Connecting with client certs (cURL and spice sql with --client-tls-certificate-file / --client-tls-key-file)
  • Probe/metrics access behavior
  • Client CA hot-reload
  • Link to the new mTLS cookbook recipe

@phillipleblanc phillipleblanc self-assigned this May 12, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 12, 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: phillipleblanc

@github-actions
Copy link
Copy Markdown

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

@github-actions
Copy link
Copy Markdown

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

@phillipleblanc phillipleblanc merged commit 118fcc6 into trunk May 12, 2026
6 checks passed
@phillipleblanc phillipleblanc deleted the phillip/mtls-docs branch May 12, 2026 07:03
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.

2 participants