docs(redis): PVC backup on node-local storage; refresh CRDs (cherry-pick of #57) - #58
Merged
Merged
Conversation
Backup no longer needs a ReadWriteMany provider. The backup PVC is created ReadWriteOnce by default (spec.accessModes on RedisBackup / RedisClusterBackup), and restore no longer mounts that PVC into every Redis pod: a transient in-cluster source serves it read-only and each pod pulls its own data over the network. Verified against redis-operator 4f13d6c1 and f1eff1e6, both carried by tag v5.1. - release_notes: new 5.1.0 entry, with the two limits that apply — the path is chosen by bundle version, not by the backup's access mode, and picking a node-local StorageClass in the console needs Data Services Essentials v4.4.1 or later (chart-middleware 320c9cc, first tagged in v4.4.1) - 70-backup-restore: drop the stale "requires node migration and ReadWriteMany, such as NFS or Ceph" claim and the "network-based StorageClass" prerequisite; document the provisioner allow-list the console filters on (middleware-sc-cm-base merged with middleware-sc-cm) and the restore caveat for instances held on an older bundle version Refresh docs/shared/crds from redis-operator release-5.1 (9b8d1fbc), which carries two breaking API changes made after the docs were written (9630abfa, 77851bdc): redisUserName -> redisUserRef on Redis and ActiveRedis, secretName -> redisUserRef on ActiveRedisInspection, ActiveRedisConnection.secretName removed, and peerPort's schema default dropped. The prose still uses the old names in five pages under functions/95-disaster-recovery — a separate pass, since the 6.0 link-auth flow changed behavior and not just field names. Also carries two working-tree edits that predate this work: the "Redesigned" prefix dropped from the Cross-Datacenter Replication heading, and the &project=Middleware parameter removed from the three v5.1.0 release-notes-for-bugs templates.
`doom lint` resolves in-page anchors against explicit ids, not against slugs derived from heading text, so four links resolved to nothing: - architecture.mdx `## Sentinel Mode` had no id, breaking the link from the Disaster Recovery architecture page - the Active-Active architecture page linked to two of its own headings that carried no id - the Active-Active setup page pointed `tuning` at a same-page `#tuning` section that lives in 30-operations.mdx Add the three ids and repoint the fourth link at the page that owns the section. Every remaining in-repo anchor link resolves.
Deploying alauda-redis with
|
| Latest commit: |
9bb292e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f794d92d.alauda-redis.pages.dev |
| Branch Preview URL: | https://cherry-pick-backup-node-loca.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
1 participant
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 #57 (
release-5.1→master), applied clean —masterandrelease-5.1shared the same tip (eb68068) at the branch point, so the resulting tree is byte-identical to #57's.What
PVC backup no longer requires a
ReadWriteManystorage provider, and the docs said it did. This documents the change and refreshes the CRD reference.Backup on node-local storage
The backup PVC is now created
ReadWriteOnceby default (spec.accessModesonRedisBackup/RedisClusterBackup), and restore no longer mounts that PVC into every Redis pod — a transient in-cluster source serves it read-only and each pod pulls its own data over the network. Verified againstredis-operator4f13d6c1andf1eff1e6, both carried by tagv5.1and absent from everyv5.0.xtag.docs/en/release_notes.mdx— new v5.1.0 entry, with the two limits that actually apply: the restore path is chosen by the instance's bundle version rather than by the backup's access mode, and selecting a node-localStorageClassin the console needs Data Services Essentialsv4.4.1or later (chart-middleware320c9cc, first tagged inv4.4.1).docs/en/functions/70-backup-restore.mdx— drops the stale "requires node migration and the ReadWriteMany access mode, such as NFS or Ceph" claim and the "network-basedStorageClass" prerequisite. Adds the provisioner allow-list the console filters on (middleware-sc-cm-baseunionmiddleware-sc-cm) and the restore caveat for instances held on an older bundle version.TERMINOLOGY_CANDIDATES.md— new unconfirmed terms with code provenance.CRD refresh
docs/shared/crdsre-synced fromredis-operatorrelease-5.1(9b8d1fbc), which carries two breaking API changes made on 2026-09-03:Redisspec.activeRedis.redisUserName→redisUserRef9630abfaActiveRedisspec.redisUserName→redisUserRef9630abfaActiveRedisInspectionspec.secretName→spec.redisUserRef77851bdcActiveRedisConnectionspec.secretNameremoved;spec.peerPortschema default dropped77851bdcAnchor fixes
doom lintresolves in-page anchors against explicit ids rather than slugs derived from heading text, and four links resolved to nothing. Three headings get their id; the fourth link is repointed at30-operations.mdx#tuning, the page that owns the section.Follow-ups, deliberately not in this PR
redisUserNameacrossrelease_notes.mdxand four pages underfunctions/95-disaster-recovery/, plusActiveRedisConnectionYAML examples that set the now-removedsecretName(20-disaster-recovery/20-setup.mdx:295,328,30-failover.mdx:80) andpeerPortguidance that still cites the removed7379default (20-setup.mdx:144,153).77851bdcchanged the Redis6.0link-auth behavior — it binds its default account now — so this is a rewrite of that flow, not a rename pass.RedisBackup/RedisClusterBackupare not indocs/shared/crds. This PR references theirspec.accessModes; a reader cannot find them in the API section.Notes
5.1.0, chosen deliberately over the code boundary of4.1.2(the frozenv5.0actor tier serves[4.1.2, 5.1.0)and also takes the network path). Recorded inTERMINOLOGY_CANDIDATES.md.release_notes.mdx: the "Redesigned" prefix dropped from the Cross-Datacenter Replication heading, and&project=Middlewareremoved from the three v5.1.0release-notes-for-bugstemplates.yarn buildpasses; every in-repo anchor link resolves.yarn lintreports 37 pre-existing cspell errors (Alauda,Oplog,Jedis,Redisson— the shared terms list is not reachable from this sandbox); 0 in the files touched here.🤖 Generated with Claude Code