Repository navigation
K8s: use spec.upgradeSpec.autoUpgradeRedisEnterprise in upgrade docs - #4232
Open
SatvikMishra08 wants to merge 1 commit into
Open
SatvikMishra08 wants to merge 1 commit into
SatvikMishra08 wants to merge 1 commit into
Conversation
|
|
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
2 participants
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.
Fixes #4224.
autoUpgradeRedisEnterpriseisn't a top-level REC field. The REC API reference lists it underspec.upgradeSpec, so settingautoUpgradeRedisEnterprise: truedirectly in the REC spec, as the upgrade pages say, doesn't match the CRD.This updates the current (unversioned) Kubernetes pages to use the full path
spec.upgradeSpec.autoUpgradeRedisEnterprisewherever they tell the reader to set the field:upgrade/upgrade-olm.md,upgrade/upgrade-redis-cluster.md,upgrade/openshift-cli.md: the "To trigger automatic upgrade of the REC..." sentence and the "set ... tofalsebefore upgrading the operator" notesupgrade/upgrade-redis-cluster.md: thekubectl get rec ... -o jsonpathcheck, which read{.spec.autoUpgradeRedisEnterprise}and so would always print nothingre-databases/modules.md: the user-defined modules upgrade stepSentences that only mention the field by name are unchanged, and I left the versioned archive folders alone.
Note
Low Risk
Documentation-only alignment with the REC API; no runtime or code changes.
Overview
Documentation fix: Kubernetes upgrade and modules docs previously told readers to set
autoUpgradeRedisEnterpriseat the top level of the REC spec, which does not match the CRD (spec.upgradeSpec).The PR replaces those instructions with
spec.upgradeSpec.autoUpgradeRedisEnterpriseacross unversioned pages:upgrade-redis-cluster.md,upgrade-olm.md,openshift-cli.md, andre-databases/modules.md. That covers prerequisites, operator upgrade warnings, automatic REC upgrade guidance, digest-hash troubleshooting, and the user-defined modules upgrade step.It also fixes the troubleshooting
kubectljsonpath from{.spec.autoUpgradeRedisEnterprise}to{.spec.upgradeSpec.autoUpgradeRedisEnterprise}so the check returns the real value instead of empty output.Reviewed by Cursor Bugbot for commit 2b2570b. Bugbot is set up for automated code reviews on this repo. Configure here.