Upgrade 4.1.3 by chideat · Pull Request #35 · alauda/redis-docs

chideat · 2026-03-30T09:02:03Z

Summary by CodeRabbit

Documentation
- Added comprehensive Best Practices Guide for production Redis deployments in Kubernetes.
- Updated release notes with versions 4.1.3, 4.1.2, and 4.1.1.
- Enhanced upgrade documentation with CLI and web console instructions.
- Improved disaster recovery, cluster access, and Sentinel guidance.
Chores
- Updated development dependencies and package manager versions.

feat: added command to update the permission for activeredis

Co-authored-by: idp-bot <idp-bot@alauda.io>

…-4.1 Auto-update doc build config

* backup * feat: added redis best practices * Update docs/en/how_to/redis-best-practices.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/en/how_to/redis-best-practices.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/en/how_to/redis-best-practices.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix: fix affinity label error * Update docs/en/how_to/redis-best-practices.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

This reverts commit bacf4d4.

…-4.1 Auto-update doc build config

* backup * feat: added redis best practices * Update docs/en/how_to/redis-best-practices.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/en/how_to/redis-best-practices.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/en/how_to/redis-best-practices.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix: fix affinity label error * Update docs/en/how_to/redis-best-practices.mdx Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix: fix lint * fix: updated the references * chore: trigger pipeline * docs: rename title --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* feat: added release notes for 4.1.2 * fix: updated filter

* fix: fix example code bug * fix: removed quote from port placeholder

coderabbitai · 2026-03-30T09:02:18Z

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

Redis documentation updated with operational guides, build pipeline restructuring, and release notes. Disaster recovery and upgrade documentation reorganized with heading restructuring. Build pipelines split into separate IO and CN variant tasks. Development dependencies updated to Yarn 4.9.4 and Doom 1.12.1. New Tekton PipelineRun manifests added for documentation builds.

Changes

Cohort / File(s)	Summary
Build & Pipeline Configuration `.builds/doc-build.yaml`, `.tekton/doc-build.yaml`, `.tekton/doc-pr-build.yaml`	Split documentation build tasks into `build-online-docs-io` and `build-online-docs-cn` variants with resource override specifications. Added new Tekton PipelineRun manifests (`doc-build-redis`, `doc-pr-build-redis`) with workspace and task configurations, including security contexts and compute resource limits for documentation build stages.
Package & Dependency Management `package.json`, `.yarnrc.yml`	Updated Yarn from 4.9.2 to 4.9.4, bumped `@alauda/doom` from 1.10.9 to 1.12.1, and removed `minimatch` from dev dependencies.
Release Notes & Configuration `doom.config.yml`, `sites.yaml`, `.cspell/compound.txt`	Updated release notes query templates for Redis v4.1.1/v4.1.2/v4.1.3 in Doom configuration, upgraded ACP version from 4.0 to 4.1 in sites configuration, and added "oplog" to spellchecker compound words.
Disaster Recovery Documentation `docs/en/functions/95-disaster-recovery/10-intro.mdx`, `docs/en/functions/95-disaster-recovery/20-setup.mdx`, `docs/en/functions/95-disaster-recovery/30-failover.mdx`, `docs/en/functions/95-disaster-recovery/90-limitations.mdx`	Restructured markdown heading hierarchy across disaster recovery guides; added ACP 4.1.0-specific kubectl patch command and permission update note in setup documentation with lint-ignore directive for duplicate heading checks.
Upgrade & Access Documentation `docs/en/how_to/30-upgrade.mdx`, `docs/en/how_to/access/10-sentinel.mdx`, `docs/en/how_to/access/20-cluster.mdx`	Added CLI tabs with `kubectl` commands for upgrade strategy, instance patching, and version queries. Updated Java code examples (Jedis, Lettuce) to use unquoted port placeholders and refactored Jedis Cluster example to replace sentinel pool usage with direct `JedisCluster` connection.
New Best Practices Guide `docs/en/how_to/best-practices.mdx`	Comprehensive new documentation covering production Redis deployment architecture selection, resource planning (kernel, memory, CPU, storage), persistence modes, parameter update categories, scheduling/anti-affinity configuration, user management and ACL practices, client access patterns, and operational guidance for backup/restore, upgrades, metrics, alerting, and troubleshooting.
Release Notes & Upgrade Guides `docs/en/release_notes.mdx`, `docs/en/upgrade.mdx`	Updated release notes with new v4.1.3/v4.1.2/v4.1.1 compatibility matrix entries and corresponding release sections. Rewrote upgrade guide with emphasis on data security, adjusted version compatibility principles, updated upgrade paths table with new ACP versions, and introduced detailed upgrade steps with plugin upload and manual approval workflows.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Auto-update doc build config #10 — Modifies .builds/doc-build.yaml taskRunSpecs with identical build pipeline task splitting and resource overrides.
Auto-update doc build config #20 — Updates .tekton/doc-build.yaml with the same doc-build-redis PipelineRun manifest and task resource specifications.
feat: enable and fix doom lint issues #3 — Updates package manager configuration and @alauda/doom dependency versions in parallel.

Suggested reviewers

sinbadonline

Poem

🐰 Hops with joy through docs so grand,
Redis pipelines now take their stand,
Doom and Yarn leap up with pride,
Best practices as a trusty guide,
Build and ships with tech-tuned care! 🚀

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Upgrade 4.1.3' directly reflects the main objective of this pull request, which adds support for version 4.1.3 across documentation, build configurations, and release notes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch upgrade-4.1.3

⚔️ Resolve merge conflicts

Resolve merge conflict in branch upgrade-4.1.3

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Copilot

Pull request overview

Updates the Redis OSS product docs/tooling to align with ACP 4.1.x (and the v4.1.3 release notes flow), including dependency/toolchain upgrades and new/expanded English documentation.

Changes:

Upgraded the docs build toolchain (Yarn + @alauda/doom) and refreshed yarn.lock.
Added/updated release notes + upgrade documentation and introduced additional “best practices” guidance.
Added Tekton PipelineRun definitions for doc builds and adjusted build task resource overrides.

Reviewed changes

Copilot reviewed 18 out of 20 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
`yarn.lock`	Dependency lock refresh for the upgraded toolchain.
`package.json`	Bumps `@alauda/doom` and Yarn package manager version.
`.yarnrc.yml`	Points repo to Yarn 4.9.4 release artifact.
`sites.yaml`	Updates ACP site version from 4.0 to 4.1.
`doom.config.yml`	Adds/adjusts release notes query templates for 4.1.x streams.
`docs/en/upgrade.mdx`	Rewrites upgrade guidance and adds operator upgrade steps.
`docs/en/release_notes.mdx`	Adds v4.1.1–v4.1.3 sections and updates compatibility matrix.
`docs/en/how_to/best-practices.mdx`	New best-practices guide content.
`docs/en/how_to/access/10-sentinel.mdx`	Updates client examples/placeholders.
`docs/en/how_to/access/20-cluster.mdx`	Updates client examples/placeholders, incl. Jedis cluster sample.
`docs/en/how_to/30-upgrade.mdx`	Expands patch-upgrade instructions (adds CLI tabs).
`docs/en/functions/95-disaster-recovery/*`	Heading/structure edits + added ACP 4.1.0 permission note.
`.tekton/doc-pr-build.yaml`	New PR doc build PipelineRun definition.
`.tekton/doc-build.yaml`	New push doc build PipelineRun definition.
`.builds/doc-build.yaml`	Updates build task names and per-task build resources.
`.cspell/compound.txt`	Adds `oplog` to spelling dictionary.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-30T09:07:44Z

+           $ 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}]'


In the CLI steps for manual operator upgrades, the command to approve an InstallPlan is missing the resource kind/name. kubectl patch requires a target (e.g., installplan <name>); as written, the command will fail even if the user has already fetched .status.installplan.name. Please update the command to patch the specific InstallPlan returned in the previous step.

Suggested change

$ kubectl -n redis-system patch --type='json' -p='[{"op":"replace","path":"/spec/approved","value":true}]'

$ kubectl -n redis-system patch installplan $(kubectl -n redis-system get subscriptions.operators.coreos.com redis-operator -o jsonpath='{.status.installplan.name}') --type='json' -p='[{"op":"replace","path":"/spec/approved","value":true}]'

Copilot · 2026-03-30T09:07:44Z

+| Alauda Cache Service for Redis OSS Version | Redis Server Versions      | ACP Version |
+|:-------------------------------------------|:---------------------------|:------------|
+| v4.1.2                                     | 5.0.15, 6.0.21, 7.2.12     | v4.1, v4.2  |
+| v4.1.1                                     | 5.0.15, 6.0.21, 7.2.12     | v4.1        |
+| v4.1.0                                     | 5.0.14, 6.0.20, 7.2.10     | v4.1        |
+| v4.0.x                                     | 5.0.14, 6.0.20, 7.2.x      | v4.0        |


The supported upgrade-path matrix doesn’t include v4.1.3, but this PR is introducing v4.1.3 release notes and query templates. To keep the upgrade guidance in sync with the newly documented release, please add a v4.1.3 row (or otherwise clarify why it’s intentionally omitted).

Copilot · 2026-03-30T09:07:44Z

@@ -1,69 +1,87 @@
 ---


This file’s frontmatter previously defined title and an i18n.title.zh value (matching other top-level docs like architecture.mdx, installation.mdx, etc.). Removing those fields may degrade sidebar/nav labeling and multilingual title rendering. If this page is still meant to be part of the main navigation, consider restoring title and i18n metadata for consistency.

Suggested change

---

---

title: Upgrade

i18n:

title:

zh: 升级

Copilot · 2026-03-30T09:07:45Z

 ---
 weight: 11


This file’s frontmatter previously defined title and an i18n.title.zh value (matching other top-level docs like architecture.mdx, installation.mdx, etc.). Removing those fields may degrade sidebar/nav labeling and multilingual title rendering. If this page is still meant to be part of the main navigation, consider restoring title and i18n metadata for consistency.

Suggested change

---

weight: 11

---

title: Release Notes

weight: 11

i18n:

title:

zh: 发行说明

Copilot · 2026-03-30T09:07:45Z

    mw-redis-v4.1-fixed: |
-      filter = project = MiddleWare AND type = Bug AND ReleaseNotesStatus = Publish AND Feature in ("MiddleWare - Redis") AND fixVersion = Redis-v4.1.0
+      project = MiddleWare AND type = Bug AND ReleaseNotesStatus = Publish AND Feature in ("MiddleWare - Redis") AND fixVersion = Redis-v4.1.0
    mw-redis-v4.1-known: |
-      filter = project = MiddleWare AND type = Bug AND ReleaseNotesStatus = Publish AND Feature = "MiddleWare - Redis" AND affectedVersion in (Redis-v4.1.0) AND fixVersion is EMPTY
+      project = MiddleWare AND type = Bug AND ReleaseNotesStatus = Publish AND Feature = "MiddleWare - Redis" AND affectedVersion in (Redis-v4.1.0) AND fixVersion is EMPTY
+    mw-redis-v4.1.1-fixed: |
+      project = MiddleWare AND type in (Bug, Vulnerability) AND ReleaseNotesStatus = Publish AND fixVersion = Redis-v4.1.1
+    mw-redis-v4.1.2-fixed: |
+      status in (Done, Resolved) AND (labels not in (安全问题) OR labels is EMPTY) AND project = MIDDLEWARE AND Feature = "MiddleWare - Redis" AND fixVersion = Redis-v4.1.2 AND ReleaseNotesStatus = Publish
+    mw-redis-v4.1.3-fixed: |
+      status in (Done, Resolved) AND (labels not in (安全问题) OR labels is EMPTY) AND project = MIDDLEWARE AND Feature = "MiddleWare - Redis" AND fixVersion = Redis-v4.1.3 AND ReleaseNotesStatus = Publish


The new query templates under releaseNotes.queryTemplates (v4.1.0+ / v4.1.1+ / v4.1.2+ / v4.1.3+) no longer start with filter =, while the existing v4.0 templates do. If the release-notes generator expects the filter = ... form (as used in the other templates in this file), these templates will be parsed differently and may cause the release-notes-for-bugs blocks to fail to resolve. Please make the template format consistent (either add filter = back or update all templates to the new expected syntax).

github-actions Bot and others added 19 commits August 29, 2025 02:40

Update sites.yaml version to 4.1

1094eb7

chore: lint fix

bc4e2db

fix: updated jql

753a566

feat: added command to update the permission for activeredis

52a38fc

fix: fix lint

94e35cc

Merge pull request #9 from alauda/fix-redis-disaster-recovery

c98ef1d

feat: added command to update the permission for activeredis

refactor: refactor docs of redis upgrade (#14)

3d423ba

auto update doc build config for doc pipeline (#12)

eea5aaa

Co-authored-by: idp-bot <idp-bot@alauda.io>

feat: added redis 4.1.1 release notes (#15)

676d5c9

auto update doc build config for doc pipeline

6328bdd

Merge pull request #19 from alauda/feat/auto-update-doc-build-release…

5e867b7

…-4.1 Auto-update doc build config

Revert "Feat/redis best practices (#21)" (#22)

55999d3

This reverts commit bacf4d4.

auto update doc build config for doc pipeline

0cd5607

Merge pull request #27 from alauda/feat/auto-update-doc-build-release…

6c8fe58

…-4.1 Auto-update doc build config

feat: added release notes for 4.1.2 (#28)

a60d8ec

* feat: added release notes for 4.1.2 * fix: updated filter

fix: fix example code bug (#29)

e06dcd8

* fix: fix example code bug * fix: removed quote from port placeholder

feat: add redis 4.1.3

444e582

Copilot AI review requested due to automatic review settings March 30, 2026 09:02

Copilot started reviewing on behalf of chideat March 30, 2026 09:02 View session

chideat closed this Mar 30, 2026

Copilot AI reviewed Mar 30, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade 4.1.3#35

Upgrade 4.1.3#35
chideat wants to merge 19 commits into
masterfrom
upgrade-4.1.3

chideat commented Mar 30, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Mar 30, 2026 •

edited

Loading

Review failed

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 30, 2026

Uh oh!

Copilot AI Mar 30, 2026

Uh oh!

Copilot AI Mar 30, 2026

Uh oh!

Copilot AI Mar 30, 2026

Uh oh!

Copilot AI Mar 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	$ kubectl -n redis-system patch --type='json' -p='[{"op":"replace","path":"/spec/approved","value":true}]'
	$ kubectl -n redis-system patch installplan $(kubectl -n redis-system get subscriptions.operators.coreos.com redis-operator -o jsonpath='{.status.installplan.name}') --type='json' -p='[{"op":"replace","path":"/spec/approved","value":true}]'

----
+---
+title: Upgrade
+i18n:
+  title:
+    zh: 升级

Conversation

chideat commented Mar 30, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

chideat commented Mar 30, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Mar 30, 2026 •

edited

Loading