diff --git a/canary-checker/docs/reference/1-redis.mdx b/canary-checker/docs/reference/1-redis.mdx index f17580ea..aaec2be8 100644 --- a/canary-checker/docs/reference/1-redis.mdx +++ b/canary-checker/docs/reference/1-redis.mdx @@ -12,6 +12,7 @@ The Redis check connects to a specified Redis database instance to check its ava ```yaml title="redis.yaml" file=/modules/canary-checker/fixtures/datasources/redis_pass.yaml ``` + +## TLS Config + +The `tlsConfig` field enables TLS for the Redis connection. Set `enable: true` to use the system trust store. Use `tlsConfig.ca` to verify with a custom CA. Add `tlsConfig.cert` and `tlsConfig.key` for mutual TLS. + +:::note +Native Redis TLS connection string formats are **not** supported — e.g. `rediss://` scheme, +`ssl=true`, or other query-string flags in the URL. TLS must be configured explicitly via `tlsConfig`. +::: + + + +## Examples + +### Redis with TLS (system trust store) + +```yaml title="redis-tls.yaml" file=/modules/canary-checker/fixtures/datasources/redis-tls.yaml + +``` + +### Redis with custom CA +```yaml title="redis-custom-ca.yaml" file=/modules/canary-checker/fixtures/datasources/redis-custom-ca.yaml + +``` + +### Redis with mutual TLS + +```yaml title="redis-mtls.yaml" file=/modules/canary-checker/fixtures/datasources/redis-mtls.yaml + +``` + +### Redis with insecure TLS (skip verification) + +```yaml title="redis-tls-insecure.yaml" file=/modules/canary-checker/fixtures/datasources/redis-tls-insecure.yaml + +``` diff --git a/modules/canary-checker b/modules/canary-checker index 8cc042df..e9d20f4a 160000 --- a/modules/canary-checker +++ b/modules/canary-checker @@ -1 +1 @@ -Subproject commit 8cc042df1520b271314471f2b1c86a3edef234d2 +Subproject commit e9d20f4ace8e8884b2eb49d18106c92eb0211f75