Skip to content

docs(python): add mTLS examples to TLS page - #304

Open
Aryex wants to merge 1 commit into
mainfrom
alexl/agent/python-mtls-reload-docs
Open

docs(python): add mTLS examples to TLS page#304
Aryex wants to merge 1 commit into
mainfrom
alexl/agent/python-mtls-reload-docs

Conversation

@Aryex

@Aryex Aryex commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds Python code examples for all four mTLS subsections on the Configure TLS page, replacing the "Coming soon" placeholders.

⚠️ Attention: This PR was generated automatically. Verify that all relevant pages have been updated.

Source Commits

  • ba1ad81 — feat(python): add automatic mTLS client certificate/key reload (#6596)

Changes

  • Replaced Python "Coming soon" placeholders in the mTLS section with complete code examples:
    • In-memory PEM (static) — client_cert_pem / client_key_pem
    • Path-based with automatic reload — client_cert_path / client_key_path
    • Path-based with custom reload interval — cert_reload_interval_seconds
    • Loading PEM material from files — load_client_certificate_and_key_from_file helper
  • Extended the Common Pitfalls section with Python-specific notes (ConfigurationError at construction, interval type validation)

Context

Python mTLS support (both byte-based and path-based with automatic reload) shipped in valkey-glide #6596. This extends the same feature previously landed for Java (#6386) and Go (#6384). The existing doc PR #271 covers Java only and is authored from a fork; this PR adds the Python examples independently.

cc @xShinnRyuu


This PR was generated by the automated documentation pipeline.

Signed-off-by: kiro-agent <kiro-agent@users.noreply.github.com>
@Aryex Aryex added documentation Improvements or additions to documentation python AI Generated labels Jul 30, 2026
@Aryex
Aryex requested review from currantw and jeremyprime July 30, 2026 22:09
@Aryex
Aryex marked this pull request as ready for review July 30, 2026 22:09
@jeremyprime
jeremyprime requested review from jeremyprime and xShinnRyuu and removed request for jeremyprime July 30, 2026 22:22
* **Path vs bytes are exclusive:** do not mix modes on the same builder.
In Go, calling both `WithMutualTLS` and `WithMutualTLSFromFiles` on the same `TlsConfiguration` will replace the previous setting (the last call wins).
To switch modes, create a new `TlsConfiguration`.
In Python, passing both path-based (`client_cert_path`/`client_key_path`) and bytes-based (`client_cert_pem`/`client_key_pem`) parameters raises a `ConfigurationError` at construction time.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think both this and the other point below are no longer at construction time, instead at connection time now.

@currantw
currantw removed their request for review July 31, 2026 03:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI Generated documentation Improvements or additions to documentation python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants