Skip to content

Document mTLS and automatic client-certificate reloading across all client languages #272

Description

@xShinnRyuu

Summary

Document mutual TLS (mTLS) and automatic client-certificate reloading across every valkey-glide client language. Today only Java has a doc section under how-to/security/tls; the other languages either ship the API without docs or have the API in flight.

Current state

Related merged core work: reload cadence is core-driven, so a single core default (currently 300 seconds) applies to every language that opts into path-based reload.

What this issue tracks

Backfill the placeholder tabs in src/content/docs/how-to/security/tls.mdx (or open follow-up PRs) so every language with a shipped API has real code in the mTLS section. Each per-language backfill should include:

  1. In-memory (byte-based) example, loaded once at connection time.
  2. Path-based example that opts into the core-driven periodic reload (default cadence, no custom interval).
  3. Path-based example with an explicit reload interval, if the language exposes that knob.
  4. Any per-language file-loader helper (mirroring Java's loadClientCertificateFromFile / loadClientKeyFromFile).
  5. The mTLS-scoped pitfalls already documented for Java (file permissions, sub-second/non-positive interval rejection, path/bytes exclusivity, use_tls=True still required).

Suggested order of backfill, driven by shipped-API readiness:

  • Python: byte-based today, path-based reload when #6596 merges.
  • Go: when #6384 merges.
  • Node.js: when #6383 merges.
  • Java: land valkey-io/valkey-glide-docs#271 first as the reference shape.
  • C#, PHP: hold as Coming soon until an API ships upstream.

References

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions