Skip to content

[DOCs] Update cache configuration to support Redis-backed caching #2139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KaveeshaPiumini wants to merge 1 commit into
base: main
Choose a base branch
from
+72 −3
Open

[DOCs] Update cache configuration to support Redis-backed caching #2139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 72 additions & 3 deletions docs/content/guides/getting-started/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,16 +121,85 @@

## Cache Configuration

Thunder includes an in-memory caching layer to improve performance.
Thunder includes both in-memory and Redis-backed caching to improve performance.

| Setting | Default | Description |
|---------|---------|-------------|
| `cache.disabled` | `false` | If `true`, disables caching entirely |
| `cache.type` | `inmemory` | Cache type (currently only `inmemory` is supported) |
| `cache.type` | `inmemory` | Cache type (`inmemory` or `redis`). When `cache.type` is `redis`, Thunder does not use the periodic cleanup routine. |
| `cache.size` | `1000` | Maximum number of cache entries |
| `cache.ttl` | `3600` | Default time-to-live for cache entries in seconds |
| `cache.eviction_policy` | `LRU` | Cache eviction policy (`LRU` - Least Recently Used) |
| `cache.cleanup_interval` | `300` | Interval in seconds to clean up expired entries |
| `cache.cleanup_interval` | `300` | In-memory only. Interval in seconds to clean up expired entries. Not used when `cache.type` is `redis`. |
| `cache.properties[]` | `[]` | Per-cache overrides for `name`, `disabled`, `size`, `ttl`, and `eviction_policy` |
| `cache.redis.address` | `""` | Redis server address in `host:port` format |
| `cache.redis.username` | `""` | Redis username |
| `cache.redis.password` | `""` | Redis password |
| `cache.redis.db` | `0` | Redis database index |
| `cache.redis.key_prefix` | `thunder` | Prefix added to all Redis cache keys |

### Per-Cache Overrides with `cache.properties`

Check failure on line 141 in docs/content/guides/getting-started/configuration.mdx

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[WSO2-IAM.TitleCaseTitles] Use Title Case for headings.

Raw Output:
{"message": "[WSO2-IAM.TitleCaseTitles] Use Title Case for headings.", "location": {"path": "docs/content/guides/getting-started/configuration.mdx", "range": {"start": {"line": 141, "column": 1}}}, "severity": "ERROR"}

Use `cache.properties` when you want to override cache behavior for a specific internal cache instead of changing the global cache settings for all caches.

Each item in `cache.properties` supports these fields:

| Field | Required | Description |
|---------|---------|-------------|
| `name` | Yes | Internal cache name to override. The value must match the cache name exactly. |
| `disabled` | No | Disables only that cache when set to `true`. |
| `size` | No | Maximum number of entries for that cache. This setting applies to in-memory caches only. |
| `ttl` | No | Time-to-live for that cache in seconds. |
| `eviction_policy` | No | Eviction policy for that cache. Supported values are `LRU` and `LFU`. This setting applies to in-memory caches only. |

If you omit a field in a `cache.properties` entry, Thunder falls back to the corresponding global `cache.*` setting.

That means you can override only the fields you need. Thunder continues to use the global cache settings for any fields you leave unset.

Thunder currently uses cache names such as:

- `ApplicationByIDCache`
- `ApplicationByNameCache`
- `OAuthAppCache`
- `FlowByIDCache`
- `FlowByHandleCache`
- `CertificateByIDCache`
- `CertificateByReferenceCache`
- `UserSchemaByIDCache`
- `UserSchemaByNameCache`
- `FlowGraphCache`

:::note
`FlowGraphCache` is always in-memory. It caches process-local flow graph Go objects during flow execution, not shared system-level cache data.
:::

:::note
When `cache.type` is `redis`, per-cache `ttl` and `disabled` remain useful. Per-cache `size` and `eviction_policy` do not affect Redis behavior because Redis manages memory and eviction independently.
:::

### Redis Cache Configuration

Set `cache.type` to `redis` and configure `cache.redis.address` to enable Redis-backed cache storage.

```yaml
cache:
type: "redis"
ttl: 3600
redis:
address: "localhost:6379"
username: ""
password: ""
db: 0
key_prefix: "thunder"
```

:::note
When Redis caching is enabled, Thunder uses Redis native key expiry for TTL handling.
:::

:::warning
If Thunder cannot connect to Redis during startup, it disables the cache layer.
:::

## JWT Configuration

Expand Down
Loading