Skip to content

docs(redis): add TLS config and examples#513

Merged
adityathebe merged 3 commits into
mainfrom
docs/redis-tls
Jun 22, 2026
Merged

docs(redis): add TLS config and examples#513
adityathebe merged 3 commits into
mainfrom
docs/redis-tls

Conversation

@adityathebe

@adityathebe adityathebe commented Jun 20, 2026

Copy link
Copy Markdown
Member

Document tlsConfig field with enable, ca, cert, key, handshakeTimeout, and insecureSkipVerify. Add examples for all four TLS variants: system trust store, custom CA, mutual TLS, and insecure.

related: flanksource/canary-checker#2982

Summary by CodeRabbit

  • Documentation

    • Added Redis TLS configuration documentation with setup examples, including custom CA certificates, mutual TLS, and verification options.
  • Chores

    • Updated canary-checker module to latest version.

Document tlsConfig field with enable, ca, cert, key, handshakeTimeout,
and insecureSkipVerify. Add examples for all four TLS variants:
system trust store, custom CA, mutual TLS, and insecure.
rediss://, ssl=true, and other Redis native TLS URL formats are not
supported. TLS must be configured via the tlsConfig field.
@vercel

vercel Bot commented Jun 20, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Jun 22, 2026 10:24am

Request Review

@netlify

netlify Bot commented Jun 20, 2026

Copy link
Copy Markdown

Deploy Preview for canarychecker ready!

Name Link
🔨 Latest commit f4c38fd
🔍 Latest deploy log https://app.netlify.com/projects/canarychecker/deploys/6a390d0518f8ce00085cac1c
😎 Deploy Preview https://deploy-preview-513--canarychecker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1f56b0f2-52c7-4172-b951-712cbcd692f9

📥 Commits

Reviewing files that changed from the base of the PR and between abfe9b8 and f4c38fd.

📒 Files selected for processing (2)
  • canary-checker/docs/reference/1-redis.mdx
  • modules/canary-checker

Walkthrough

The Redis health check reference page gains a tlsConfig field in its schema table, a new "TLS Config" section documenting all supported TLS options (system trust, custom CA, mutual TLS, handshake timeout, insecure skip-verify), and an "Examples" subsection with four TLS fixture references. The modules/canary-checker submodule pointer is also bumped to a new commit.

Changes

Redis TLS Documentation

Layer / File(s) Summary
Redis schema extension and TLS Config reference
canary-checker/docs/reference/1-redis.mdx
Adds tlsConfig field to the Redis health check schema table and introduces a "TLS Config" section covering all supported options: system trust store, custom CA, client cert/key for mutual TLS, handshake timeout, and insecure skip-verify. Includes a note that native Redis TLS URL string formats are not supported.
Redis TLS examples and submodule bump
canary-checker/docs/reference/1-redis.mdx, modules/canary-checker
Adds an "Examples" section with fixture references for system trust store TLS, custom CA, mutual TLS, and insecure TLS. The canary-checker submodule pointer is updated from 8cc042d to e9d20f4 to include the corresponding implementation.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/redis-tls
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/redis-tls

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

PR #513 references four redis TLS fixture files
(redis-tls, redis-custom-ca, redis-mtls, redis-tls-insecure) via
file=<rootDir> imports in canary-checker/docs/reference/1-redis.mdx.
These fixtures were added upstream in canary-checker e9d20f4
("feat: redis TLS (#2987)"), but the submodule was pinned to 8cc042d
which predates them, so the Vercel/Netlify docusaurus build failed to
resolve the imports. Bump the submodule so the fixtures exist.
@adityathebe adityathebe marked this pull request as ready for review June 22, 2026 10:56
@adityathebe adityathebe merged commit ec9930c into main Jun 22, 2026
14 of 15 checks passed
@adityathebe adityathebe deleted the docs/redis-tls branch June 22, 2026 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant