Skip to content

[DX-2178] docs: clarify Redis Sentinel with master password configuration #1124

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
buger wants to merge 34 commits into
base: main
Choose a base branch
from
Open

[DX-2178] docs: clarify Redis Sentinel with master password configuration #1124

Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
5d775c8
[DX-2178] docs: clarify Redis Sentinel with master password configura…
buger Dec 5, 2025
5e94359
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 6, 2025
cd07797
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 9, 2025
7771bc4
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 9, 2025
04a18d5
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 9, 2025
ece7b01
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 9, 2025
0d2bd37
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 9, 2025
0a2871a
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 12, 2025
d171014
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 12, 2025
bf11638
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 12, 2025
510c095
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 18, 2025
d1de409
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 18, 2025
836db35
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 18, 2025
5644d66
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 18, 2025
4ed3827
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 19, 2025
1043407
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 19, 2025
5ef2718
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 19, 2025
a5e15d7
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 19, 2025
68b4f05
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 19, 2025
61db8ef
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 19, 2025
1c68622
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 19, 2025
966dba6
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 22, 2025
617f0c3
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 22, 2025
0e4dfcb
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Dec 23, 2025
a612bec
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Jan 7, 2026
d07bcca
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Jan 7, 2026
1dde355
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Jan 9, 2026
39dfe14
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Jan 9, 2026
476886e
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Jan 9, 2026
0912fe0
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Jan 12, 2026
8283188
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Jan 16, 2026
3b88f9d
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Jan 16, 2026
53a4039
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Jan 19, 2026
018ce41
Merge main into docs/dx-2178-redis-sentinel-master-password
buger Jan 28, 2026
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
80 changes: 80 additions & 0 deletions tyk-configuration-reference/redis-cluster-sentinel.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,86 @@ These settings allow you to support Sentinel password-only authentication in Red

See the Redis and Sentinel authentication section of the [Redis Sentinel docs](https://redis.io/topics/sentinel) for more details.

### Configuring Both Sentinel and Master Redis Passwords

When your Redis Sentinel deployment uses authentication for both the Sentinel nodes **and** the master Redis instance, you must configure **both** passwords in your Tyk configuration:

1. **Sentinel password** (`sentinel_password` or `redis_sentinel_password`): Used to authenticate with the Redis Sentinel nodes
2. **Master Redis password** (`password` or `redis_password`): Used to authenticate with the master Redis instance after Sentinel provides its address

<Warning>
If you only configure the `sentinel_password` but your master Redis instance also requires authentication, Tyk will successfully connect to Sentinel but fail to authenticate with the master Redis instance. Make sure to configure both passwords when both are required.
</Warning>

#### Gateway Configuration Example (with both passwords)

```json
"storage": {
"type": "redis",
"addrs": [
"sentinel1:26379",
"sentinel2:26379",
"sentinel3:26379"
],
"master_name": "mymaster",
"sentinel_password": "your-sentinel-password",
"username": "",
"password": "your-master-redis-password",
"database": 0,
"optimisation_max_idle": 2000,
"optimisation_max_active": 4000,
"use_ssl": false
}
```

| Field | Environment Variable | Description |
|-------|---------------------|-------------|
| `sentinel_password` | `TYK_GW_STORAGE_SENTINELPASSWORD` | Password for authenticating with Redis Sentinel nodes |
| `password` | `TYK_GW_STORAGE_PASSWORD` | Password for authenticating with the master Redis instance |

#### Dashboard Configuration Example (with both passwords)

```json
"redis_addrs": [
"sentinel1:26379",
"sentinel2:26379",
"sentinel3:26379"
],
"redis_master_name": "mymaster",
"redis_sentinel_password": "your-sentinel-password",
"redis_password": "your-master-redis-password"
```

| Field | Environment Variable | Description |
|-------|---------------------|-------------|
| `redis_sentinel_password` | `TYK_DB_REDISSENTINELPASSWORD` | Password for authenticating with Redis Sentinel nodes |
| `redis_password` | `TYK_DB_REDISPASSWORD` | Password for authenticating with the master Redis instance |

#### Pump Configuration Example (with both passwords)

```json
"analytics_storage_config": {
"type": "redis",
"addrs": [
"sentinel1:26379",
"sentinel2:26379",
"sentinel3:26379"
],
"master_name": "mymaster",
"sentinel_password": "your-sentinel-password",
"username": "",
"password": "your-master-redis-password",
"database": 0,
"optimisation_max_idle": 100,
"use_ssl": false
}
```

| Field | Environment Variable | Description |
|-------|---------------------|-------------|
| `sentinel_password` | `TYK_PMP_ANALYTICSSTORAGECONFIG_SENTINELPASSWORD` | Password for authenticating with Redis Sentinel nodes |
| `password` | `TYK_PMP_ANALYTICSSTORAGECONFIG_PASSWORD` | Password for authenticating with the master Redis instance |

### Configure Redis TLS Encryption
Redis supports [SSL/TLS encryption](https://redis.io/topics/encryption) from version 6 as an optional feature, enhancing the security of data in transit. To configure TLS or mTLS connections between an application and Redis, consider the following settings in Tyk's configuration files:

Expand Down