feat: add Redis Sentinel support to Redis lock component documentation #4771
+14
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Enable failover support while maintaining cluster restrictions for distributed lock safety Signed-off-by: inishchith <[email protected]>
Merged
4 tasks
sicoyle
approved these changes
Aug 18, 2025
msfussell
added
the
waiting-on-code-pr
inishchith
force-pushed
the
feat-lock-redis-sentinel
branch
from
4ada25a to
58dbd10
Compare
Signed-off-by: Nishchith Shetty <[email protected]> Signed-off-by: inishchith <[email protected]>
inishchith
force-pushed
the
feat-lock-redis-sentinel
branch
from
58dbd10 to
7cecdfe
Compare
|
Contrib PR merged, removing label! |
nelson-parente
removed
the
waiting-on-code-pr
alicejgibbons
suggested changes
Aug 26, 2025
There was a problem hiding this comment.
A couple minor suggestions @inishchith, otherwise looks good!
| @@ -86,6 +86,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | |||
| | maxRetryBackoff | N | Maximum backoff between each retry. Defaults to `2` seconds; `"-1"` disables backoff. | `3000000000` | | |||
| | 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"` | | |||
| | sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/) | `"mymaster"` | | |||
| | sentinelPassword | N | Password for Redis sentinel. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"` | |||
There was a problem hiding this comment.
Suggested change
| | sentinelPassword | N | Password for Redis sentinel. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"` | |
| | sentinelPassword | N | Password for Redis Sentinel. No Default. Applicable only when “failover” is true, and Redis Sentinel has authentication enabled | `""`, `"KeFg23!"` |
| @@ -182,6 +183,18 @@ You can use [Helm](https://helm.sh/) to quickly create a Redis instance in our K | |||
| {{< /tabpane >}} | |||
|
|
|||
|
|
|||
| ## Redis Sentinel Behavior | |||
There was a problem hiding this comment.
Suggested change
| ## Redis Sentinel Behavior | |
| ## Redis Sentinel behavior |
|
|
||
| Use `redisType: "node"` when connecting to Redis Sentinel. Additionally, set `failover` to `"true"` and `sentinelMasterName` to the name of the master node. | ||
|
|
||
| **Failover Characteristics:** |
There was a problem hiding this comment.
Suggested change
| **Failover Characteristics:** | |
| Failover characteristics: |
| Use `redisType: "node"` when connecting to Redis Sentinel. Additionally, set `failover` to `"true"` and `sentinelMasterName` to the name of the master node. | ||
|
|
||
| **Failover Characteristics:** | ||
| - **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 |
There was a problem hiding this comment.
Suggested change
| - **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 | |
| - 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 |
|
|
||
| **Failover Characteristics:** | ||
| - **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 | ||
| - **Failover Window**: Brief unavailability (typically seconds) during automatic master promotion |
There was a problem hiding this comment.
Suggested change
| - **Failover Window**: Brief unavailability (typically seconds) during automatic master promotion | |
| - Failover window: Brief server unavailability (typically seconds) during automatic master promotion |
| **Failover Characteristics:** | ||
| - **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 | ||
| - **Failover Window**: Brief unavailability (typically seconds) during automatic master promotion | ||
| - **Consistency**: All operations route to the current master, maintaining lock consistency |
There was a problem hiding this comment.
Suggested change
| - **Consistency**: All operations route to the current master, maintaining lock consistency | |
| - Consistency: All operations route to the current master, maintaining lock consistency |
| - **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 | ||
| - **Failover Window**: Brief unavailability (typically seconds) during automatic master promotion | ||
| - **Consistency**: All operations route to the current master, maintaining lock consistency | ||
| - **Trade-off**: High availability vs. potential lock loss during failover events |
There was a problem hiding this comment.
Suggested change
| - **Trade-off**: High availability vs. potential lock loss during failover events |
| - **Consistency**: All operations route to the current master, maintaining lock consistency | ||
| - **Trade-off**: High availability vs. potential lock loss during failover events | ||
|
|
||
| ⚠️ **Important**: Consider your application's tolerance for brief lock loss during failover scenarios. |
There was a problem hiding this comment.
Suggested change
| ⚠️ **Important**: Consider your application's tolerance for brief lock loss during failover scenarios. | |
| {{% alert title="Warning" color="warning" %}} | |
| 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. | |
| {{% /alert %}} |
thanks @alicejgibbons - fixed now! |
alicejgibbons
approved these changes
Aug 27, 2025
There was a problem hiding this comment.
lgtm @inishchith can you fix the dco? Just git commit --amend --signoff
Signed-off-by: inishchith <[email protected]>
inishchith
force-pushed
the
feat-lock-redis-sentinel
branch
from
a7cadc0 to
c363cd5
Compare
@alicejgibbons fixed now! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Enable failover support while maintaining cluster restrictions for distributed lock safety
Thank you for helping make the Dapr documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Issue reference