a9cd7750f4
CI / unit-test (push) Has been cancelled
CI / detect-changes (push) Has been cancelled
CI / build (push) Has been cancelled
Publish docs via GitHub Pages / Deploy docs (push) Has been cancelled
CI / test-harness (push) Has been cancelled
CI / generate-e2e-matrix (push) Has been cancelled
CI / e2e (push) Has been cancelled
CI / build-ui (push) Has been cancelled
Release Drafter / update_release_draft (push) Has been cancelled
UI v2 Integration CI / E2E (Integration) (push) Has been cancelled
UI v2 CI / Lint, Format & Test (push) Has been cancelled
UI v2 CI / E2E (Mocked) (push) Has been cancelled
53 lines
2.1 KiB
Markdown
53 lines
2.1 KiB
Markdown
---
|
|
description: "Redis Backend — configure Redis Standalone, Cluster, or Sentinel as the database and queue backend for Conductor."
|
|
---
|
|
# Redis
|
|
|
|
Configure Redis as the database and queue backend by setting the properties below.
|
|
|
|
## `conductor.db.type` and `conductor.queue.type`
|
|
|
|
| Value | Description |
|
|
|--------------------------------|----------------------------------------------------------------------------------------|
|
|
| redis_standalone | Redis Standalone configuration. |
|
|
| redis_cluster | Redis Cluster configuration. |
|
|
| redis_sentinel | Redis Sentinel configuration. |
|
|
|
|
## `conductor.redis.hosts`
|
|
|
|
Expected format is `host:port:rack` separated by semicolon, e.g.:
|
|
|
|
```properties
|
|
conductor.redis.hosts=host0:6379:us-east-1c;host1:6379:us-east-1c;host2:6379:us-east-1c
|
|
```
|
|
|
|
## `conductor.redis.database`
|
|
Redis database value other than default of 0 is supported in sentinel and standalone configurations.
|
|
Redis cluster mode only uses database 0, and the configuration is ignored.
|
|
|
|
```properties
|
|
conductor.redis.database=1
|
|
```
|
|
|
|
|
|
## `conductor.redis.username`
|
|
|
|
[Redis ACL](https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/) using username and password authentication is now supported.
|
|
|
|
The username property should be set as `conductor.redis.username`, e.g.:
|
|
```properties
|
|
conductor.redis.username=conductor
|
|
```
|
|
If not set, the client uses `default` as the username.
|
|
|
|
The password should be set as the 4th param of the first host `host:port:rack:password`, e.g.:
|
|
|
|
```properties
|
|
conductor.redis.hosts=host0:6379:us-east-1c:my_str0ng_pazz;host1:6379:us-east-1c;host2:6379:us-east-1c
|
|
```
|
|
|
|
**Notes**
|
|
|
|
- In a cluster, all nodes use the same username and password.
|
|
- In a sentinel configuration, sentinels and redis nodes use the same database index, username, and password.
|