Skip to content

docs(redis): document the Web Console sentinel password - #62

Merged
chideat merged 1 commit into
release-5.1from
docs/sentinel-password
Sep 9, 2026
Merged

docs(redis): document the Web Console sentinel password#62
chideat merged 1 commit into
release-5.1from
docs/sentinel-password

Conversation

@chideat

@chideat chideat commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

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, the spec.sentinel.passwordSecret vs spec.passwordSecret split, and the note that existing instances are untouched.

docs/en/functions/10-create-instance.mdx

  • Web Console table: a new Set Sentinel Password row under Connection Configuration (rowspan 3 → 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.
  • Sentinel CLI tab: a note that the example sets neither password, with the Secret shape (key password, 8–32 characters, per ValidatePasswordSecret) and the spec.sentinel.passwordSecret reference.

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

Client Field Verified against
go-redis FailoverOptions.SentinelPassword redis/go-redis sentinel.go — passed as Password in sentinelOptions()
Jedis .password(...) on the sentinelConfig DefaultJedisClientConfig (the 5-arg JedisSentinelPool already splits master vs sentinel config) redis/jedis docs
Lettuce withSentinel(String host, int port, CharSequence password), replacing withSentinel(RedisURI.create(...)) overload read from RedisURI.java upstream; Lettuce docs confirm the URI password applies to data nodes only
Redisson .setSentinelPassword(...) redisson/redisson configuration docs — falls back to the Redis password when unset

Notes for the reviewer

  • "Mandatory" is a Web Console default, not an API rule. The Set Password toggle is an ordinary switch the user can turn off, and the webhook only validates a non-empty passwordSecret — so the docs say "enabled by default … unless the toggle is deliberately turned off". Say the word if you want it stated as hard-required.
  • Whether the tab itself is new in 5.1 or only the default-on behaviour could not be confirmed from source (the frontend history is squashed into its initial split commit). The heading hedges accordingly.
  • docs/en/functions/70-backup-restore.mdx is not touched, though restore shows the same tabs. The release note covers restore; tell me if the restore page should mention it too.

Verification

yarn lint — 0 errors, 0 warnings. yarn build — succeeds.

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.
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying alauda-redis with  Cloudflare Pages  Cloudflare Pages

Latest commit: 51df38e
Status: ✅  Deploy successful!
Preview URL: https://e6a3cb4d.alauda-redis.pages.dev
Branch Preview URL: https://docs-sentinel-password.alauda-redis.pages.dev

View logs

@chideat
chideat merged commit ec1115e into release-5.1 Sep 9, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant