docs: add explicit warning for redis single replica configuration #382
+8
−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
pierluigilenoci
force-pushed
the
docs/redis-single-replica-config
branch
from
70562a8 to
8e637df
Compare
When using redis-ha with a single replica (replicas: 1), Redis requires min-replicas-to-write to be set to 0, otherwise write operations fail with 'NOREPLICAS Not enough good replicas to write' error. This change adds an explicit IMPORTANT note in the values.yaml documentation, positioned immediately after the replicas setting to make the requirement clear to users. This configuration is already used in the CI tests (helm/oauth2-proxy/ci/redis-standalone-values.yaml:29) and is documented in the Redis documentation. Supersedes oauth2-proxy#359 Signed-off-by: Pierluigi Lenoci <[email protected]>
Signed-off-by: Pierluigi Lenoci <[email protected]>
pierluigilenoci
force-pushed
the
docs/redis-single-replica-config
branch
from
0b37384 to
284d264
Compare
tuunit
reviewed
Jan 16, 2026
tuunit
force-pushed
the
docs/redis-single-replica-config
branch
from
6073992 to
82b7237
Compare
Signed-off-by: Jan Larwig <[email protected]>
tuunit
force-pushed
the
docs/redis-single-replica-config
branch
from
82b7237 to
7638d06
Compare
tuunit
approved these changes
Jan 16, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This PR adds an explicit warning in the
values.yamldocumentation about the requiredmin-replicas-to-write: 0configuration when using Redis HA with a single replica.Problem
When users configure
redis-ha.replicas: 1, Redis by default requires at least one secondary replica to accept writes. Without settingmin-replicas-to-write: 0, users encounter the error:Solution
This PR adds an IMPORTANT note directly after the
replicas: 1setting, making it immediately clear that users must also configuremin-replicas-to-write: 0when using a single replica setup.Changes:
replicas: 1for visibilityWhy supersede #359?
While #359 identified the same issue, this PR improves the documentation by:
replicas: 1instead of afterpersistentVolumeValidation
This configuration is already used in the project's CI tests:
helm/oauth2-proxy/ci/redis-standalone-values.yaml:29Supersedes #359
Ref: https://stackoverflow.com/a/59737862