docs(redis): port release-5.0 docs to master (v5.0.0/v5.0.1 + Redis 5.0 cleanup) - #48
Merged
Merged
Conversation
* feat: add v5.0.0 release notes and upgrade documentation
- Add v5.0.0 release notes with Redis 8.4 support and expanded module APIs
- Update upgrade matrix for v5.0.0 (Redis 6.0.21/7.2.12/8.4.2, ACP v4.1/v4.2/v4.3)
- Add ACP v4.3 compatibility note recommending v5.0.0 upgrade first
- Restructure lifecycle policy into Full Support and Maintenance phases
- Add v5.0.0 query templates to doom.config.yml
* fix: add explicit anchor id to upgrade steps heading
Resolves doom-lint-no-unmatched-anchor error for the in-page link
from the Major Version Upgrade section.
* fix: drop in-page anchor for upgrade steps to avoid MDX parse error
The {#upgrade-steps} syntax is interpreted as a JSX expression by acorn
and fails to parse. Replace the in-page anchor link with a textual
reference since the section is immediately below.
Add a v5.0.1 version section with its own Fixed Issues, Known Issues, and
Security Fixes subsections, plus the three per-patch queryTemplates
(mw-redis-v5.0.1-{fixed,known,security}).
The Security Fixes section renders the curated, PUBLISHED advisories for
Redis-v5.0.1 (gated on ReleaseNotesStatus = Publish); the full fixed-CVE list
ships in the security errata:
- CVE-2026-25243 Redis RESTORE invalid memory access (MIDDLEWARE-31564)
- CVE-2026-31789 OpenSSL libssl3/libcrypto3, Redis 6.0/7.2/8.4 + exporter (MIDDLEWARE-31734)
- CVE-2026-40200 musl-utils, redis-tools image (MIDDLEWARE-31726)
#45 merged the v5.0.1 release-notes section + queryTemplates but landed before the compatibility-matrix row was added. This adds the missing row: v5.0.1 | 6.0.21, 7.2.14, 8.4.3 | v4.1, v4.2, v4.3 (the security fix bumped Redis 7.2->7.2.14 and 8.4->8.4.3; 6.0 unaffected).
…rade (#47) - Set supported Redis versions to 6.0/7.2/8.4 (remove Redis 5.0) across intro, create-instance, user, and parameter docs; drop the obsolete Redis 5.0 CLI tab - Fix Supported Upgrade Paths table: add the v5.0.1 row and correct the v4.1.x ACP versions - Warn that operator upgrades do not auto-upgrade instances and that Redis 5.0 instances must be migrated to a supported version before upgrading ACP to v4.3 (upgrade and instance-upgrade guides) - Clarify that ACP v4.3 requires Alauda Cache Service for Redis OSS v5.0.0 or later
Contributor
WalkthroughThis PR updates documentation for the ACP v5.0 / Redis OSS operator v5.0.x release. Changes include dropping Redis 5.0 support, adding Redis 8.4 support, introducing structured lifecycle policy documentation, adding release note infrastructure, and completely restructuring the upgrade guide with new ACP v4.3 migration requirements and step-by-step procedures. ChangesACP v5.0 Release Documentation Update
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
There was a problem hiding this comment.
Pull request overview
Ports the release-5.0 documentation set onto master, adding Redis OSS service v5.0.0/v5.0.1 release documentation and aligning the docs with the supported Redis versions (dropping Redis 5.0) and ACP v4.3 upgrade guidance.
Changes:
- Adds v5.0.0 and v5.0.1 release notes content and supporting JIRA query templates.
- Updates compatibility/support matrices and upgrade guidance (including ACP v4.3 warnings and supported upgrade paths).
- Removes/updates stale Redis 5.0 references across intro and functional guides, reflecting supported Redis
6.0 / 7.2 / 8.4.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
sites.yaml |
Bumps the acp site version reference to 5.0. |
doom.config.yml |
Adds v5.0.0 and v5.0.1 release-notes query templates. |
docs/en/upgrade.mdx |
Reworks upgrade guidance, adds compatibility matrix + ACP v4.3 warnings + operator upgrade steps. |
docs/en/release_notes.mdx |
Adds v5.0.0/v5.0.1 sections and updates the compatibility matrix. |
docs/en/lifecycle_policy.mdx |
Updates lifecycle table to Full Support/Maintenance phases and adds v5.0.x row. |
docs/en/intro.mdx |
Updates supported Redis versions to 6.0 / 7.2 / 8.4 and removes Redis 5.0-specific notes. |
docs/en/how_to/30-upgrade.mdx |
Adds ACP v4.3 / Redis 5.0 migration warning for instance upgrades. |
docs/en/functions/30-parameter.mdx |
Removes Redis 5.0 parameter-template references. |
docs/en/functions/20-user.mdx |
Removes Redis 5.0 user-management tab and refocuses on ACL-based flows (6.0+). |
docs/en/functions/10-create-instance.mdx |
Updates supported Redis versions and example output to include Redis 8.4 and remove Redis 5.0. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| $ kubectl -n redis-system get subscriptions.operators.coreos.com redis-operator -o jsonpath='{.status.installplan.name}' | ||
|
|
||
| # Approve the InstallPlan to proceed with the upgrade | ||
| $ kubectl -n redis-system patch --type='json' -p='[{"op":"replace","path":"/spec/approved","value":true}]' |
|
|
||
| <Directive type="tip" title="Version suggestion"> | ||
| When used in a production environment, it is recommended to prioritize the `7.2` version, followed by `6.0`. | ||
| When used in a production environment, it is recommended to prioritize the `7.2` or `8.4` version, followed by `6.0`. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/en/upgrade.mdx`:
- Around line 89-93: The second command currently patches no resource; change
the patch to target the InstallPlan obtained earlier by name (the output of
kubectl -n redis-system get subscriptions.operators.coreos.com redis-operator -o
jsonpath='{.status.installplan.name}'). Replace the generic patch with one that
patches installplan/<installplan-name> (or uses command substitution like
$(...)) so the patch applies to the InstallPlan resource and sets /spec/approved
to true (keep --type='json' and the same JSON patch payload).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 4822e099-5511-4541-bb7a-cf0a7f856aa3
📒 Files selected for processing (10)
docs/en/functions/10-create-instance.mdxdocs/en/functions/20-user.mdxdocs/en/functions/30-parameter.mdxdocs/en/how_to/30-upgrade.mdxdocs/en/intro.mdxdocs/en/lifecycle_policy.mdxdocs/en/release_notes.mdxdocs/en/upgrade.mdxdoom.config.ymlsites.yaml
Comment on lines
+89
to
+93
| $ kubectl -n redis-system get subscriptions.operators.coreos.com redis-operator -o jsonpath='{.status.installplan.name}' | ||
|
|
||
| # Approve the InstallPlan to proceed with the upgrade | ||
| $ kubectl -n redis-system patch --type='json' -p='[{"op":"replace","path":"/spec/approved","value":true}]' | ||
| ``` |
Contributor
There was a problem hiding this comment.
Fix the InstallPlan approval command in manual upgrade steps.
Line 92 is missing the resource and target name, so the command will fail. Reuse the InstallPlan name obtained at Line 89 and patch that object explicitly.
Suggested fix
- # If an upgrade is available, find the corresponding InstallPlan for the Subscription
- $ kubectl -n redis-system get subscriptions.operators.coreos.com redis-operator -o jsonpath='{.status.installplan.name}'
+ # If an upgrade is available, capture the corresponding InstallPlan for the Subscription
+ $ INSTALLPLAN=$(kubectl -n redis-system get subscriptions.operators.coreos.com redis-operator -o jsonpath='{.status.installplan.name}')
# Approve the InstallPlan to proceed with the upgrade
- $ kubectl -n redis-system patch --type='json' -p='[{"op":"replace","path":"/spec/approved","value":true}]'
+ $ kubectl -n redis-system patch installplan "$INSTALLPLAN" --type='json' -p='[{"op":"replace","path":"/spec/approved","value":true}]'🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/en/upgrade.mdx` around lines 89 - 93, The second command currently
patches no resource; change the patch to target the InstallPlan obtained earlier
by name (the output of kubectl -n redis-system get
subscriptions.operators.coreos.com redis-operator -o
jsonpath='{.status.installplan.name}'). Replace the generic patch with one that
patches installplan/<installplan-name> (or uses command substitution like
$(...)) so the patch applies to the InstallPlan resource and sets /spec/approved
to true (keep --type='json' and the same JSON patch payload).
Deploying alauda-redis with
|
| Latest commit: |
737732c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://e9f05b3a.alauda-redis.pages.dev |
| Branch Preview URL: | https://cherry-pick-release-5-0-to-m.alauda-redis.pages.dev |
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-picks all of
release-5.0's changes ontomaster(based on the currentmastertip, which already carries#40 llms.txt). Zero conflicts;docs/enis byte-identical torelease-5.0.Commits brought over (oldest → newest)
Update sites.yaml version to 5.0fix: update release note(fix: update releae note #39)What this lands on master
upgrade.mdx"Supported Upgrade Paths" table fixed (v5.0.1 row added, v4.1.x ACP corrected).upgrade.mdxand the instance-upgrade guide.🤖 Generated with Claude Code
Summary by CodeRabbit