docs(redis): document the Web Console sentinel password (cherry-pick of #62) - #63
Merged
Merged
Conversation
Creating a Sentinel instance in the Web Console now offers two password tabs, and the "Set Sentinel Password" tab has Set Password enabled by default with its fields required, so a new Sentinel instance normally carries a Sentinel credential of its own. The docs had no name for that credential and no mention of the tab. - release notes: a v5.1.0 entry covering the tabs, the default-on behaviour, the spec.sentinel.passwordSecret vs spec.passwordSecret split, and that existing instances are untouched (the tabs render only while creating or restoring, never while updating) - create instance: a Set Sentinel Password row in the Web Console table, plus a note on the Sentinel CLI tab, which sets neither password, with the Secret shape (key "password", 8-32 characters) - sentinel access: a two-password table, and the sentinel password added to all four client examples, using each client's own field: go-redis FailoverOptions.SentinelPassword, the sentinel-side DefaultJedisClientConfig for Jedis, Lettuce withSentinel(host, port, password), and Redisson setSentinelPassword Terms logged in TERMINOLOGY_CANDIDATES.md for confirmation. (cherry picked from commit 51df38e)
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
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.
Cherry-pick of #62 (
release-5.1→master). Applied withgit cherry-pick -x; no conflicts, and the resulting content is identical to therelease-5.1commit.Why
Creating a Sentinel instance in the Web Console now presents two password tabs — Set Redis Password and Set Sentinel Password. The Sentinel tab has Set Password enabled by default with its fields required, so a new Sentinel instance normally carries a Sentinel credential of its own. The docs had no name for that credential and no mention of the tab, and the client examples only ever set the Redis password.
Existing instances are unaffected: the tabs render only while an instance is being created or restored, never while updating.
What changed
docs/en/release_notes.mdx— a v5.1.0 entry, Sentinel Password Enabled by Default in the Web Console: the tabs, the default-on behaviour, the warning icon on the tab label if you click Create with the fields empty, thespec.sentinel.passwordSecretvsspec.passwordSecretsplit, and the note that existing instances are untouched.docs/en/functions/10-create-instance.mdxrowspan3 → 4), and a clarification on the existing Set Default Password row that for Sentinel it lives on the Set Redis Password tab and covers the data nodes only.Secretshape (keypassword, 8–32 characters, perValidatePasswordSecret) and thespec.sentinel.passwordSecretreference.docs/en/how_to/access/10-sentinel.mdx— a two-password table in Authentication Requirements, and the sentinel password added to all four client examples.TERMINOLOGY_CANDIDATES.md— logs Sentinel password / Set Sentinel Password for confirmation.Client fields — verified, not assumed
FailoverOptions.SentinelPasswordredis/go-redissentinel.go— passed asPasswordinsentinelOptions().password(...)on the sentinelConfigDefaultJedisClientConfig(the 5-argJedisSentinelPoolalready splits master vs sentinel config)redis/jedisdocswithSentinel(String host, int port, CharSequence password), replacingwithSentinel(RedisURI.create(...))RedisURI.javaupstream; Lettuce docs confirm the URI password applies to data nodes only.setSentinelPassword(...)redisson/redissonconfiguration docs — falls back to the Redis password when unsetNotes for the reviewer
passwordSecret— so the docs say "enabled by default … unless the toggle is deliberately turned off".docs/en/functions/70-backup-restore.mdxis not touched, though restore shows the same tabs.masteris still missing the cherry-pick of docs(redis): correct the cross-datacenter replication API surface #59 (docs/dr-api-corrections), soTERMINOLOGY_CANDIDATES.mdandrelease_notes.mdxdiffer fromrelease-5.1here for reasons predating this PR.Verification
yarn lint— 0 errors, 0 warnings.yarn build— succeeds.