You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: daprdocs/content/en/reference/components-reference/supported-locks/redis-lock.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,7 +86,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
86
86
| maxRetryBackoff | N | Maximum backoff between each retry. Defaults to `2` seconds; `"-1"` disables backoff. | `3000000000` |
87
87
| failover | N | Enable failover configuration. Needs sentinelMasterName to be set. The redisHost should be the sentinel host address. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/). Defaults to `"false"` | `"true"`, `"false"` |
88
88
| sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/) | `"mymaster"` |
89
-
| sentinelPassword | N | Password for Redis sentinel. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"`
89
+
| sentinelPassword | N | Password for Redis Sentinel. No Default. Applicable only when “failover” is true, and Redis Sentinel has authentication enabled | `""`, `"KeFg23!"`
90
90
| redeliverInterval | N | The interval between checking for pending messages for redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"` |
91
91
| processingTimeout | N | The amount of time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"` |
92
92
| redisType | N | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"` |
@@ -183,17 +183,18 @@ You can use [Helm](https://helm.sh/) to quickly create a Redis instance in our K
183
183
{{< /tabpane >}}
184
184
185
185
186
-
## Redis Sentinel Behavior
186
+
## Redis Sentinel behavior
187
187
188
188
Use `redisType: "node"` when connecting to Redis Sentinel. Additionally, set `failover` to `"true"` and `sentinelMasterName` to the name of the master node.
189
189
190
-
**Failover Characteristics:**
191
-
- **Lock Loss During Failover**: Locks may be lost during master failover if they weren't replicated to the promoted replica before the original master failed
- **Consistency**: All operations route to the current master, maintaining lock consistency
194
-
- **Trade-off**: High availability vs. potential lock loss during failover events
190
+
Failover characteristics:
191
+
- Lock loss during failover: Locks may be lost during master failover if they weren't replicated to the promoted replica before the original master failed
192
+
- Failover window: Brief server unavailability (typically seconds) during automatic master promotion
193
+
- Consistency: All operations route to the current master, maintaining lock consistency
195
194
196
-
⚠️ **Important**: Consider your application's tolerance for brief lock loss during failover scenarios.
195
+
{{% alert title="Warning" color="warning" %}}
196
+
Consider the trade-off of running Redis with high-availability and failover with the potential of lock loss during failover events. Your application should tolerate brief lock loss during failover scenarios.
197
+
{{% /alert %}}
197
198
198
199
## Related links
199
200
- [Basic schema for a Dapr component]({{% ref component-schema %}})
0 commit comments