Add guides for the storage version migration library - #719
Merged
Conversation
Signed-off-by: Sergen Yalçın <yalcinsergen97@gmail.com>
📝 WalkthroughWalkthroughChangesStorage Version Migration
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 7✅ Passed checks (7 passed)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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/applying-storage-version-migration.md`:
- Around line 173-188: Update Step 5 to instruct users to remove or change the
Provider’s spec.runtimeConfigRef.name reference, apply the change, and wait for
the provider to become healthy before deleting the temporary
DeploymentRuntimeConfig. Clarify that shared RBAC resources must remain until
every migration sub-provider using them has completed.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 6aabf01a-812c-44fc-b86f-73b18434934a
📒 Files selected for processing (2)
docs/applying-storage-version-migration.mddocs/storage-version-migration.md
jonasz-lasut
approved these changes
Jul 31, 2026
jonasz-lasut
left a comment
jonasz-lasut
left a comment
Collaborator
There was a problem hiding this comment.
One small nit, commented under coderabbit's analysis. Other than that LGTM! Thank you @sergenyalcin
Signed-off-by: Sergen Yalçın <yalcinsergen97@gmail.com>
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/applying-storage-version-migration.md`:
- Around line 189-195: Update the runtimeConfigRef restoration instructions
following the provider migration to use the provider’s recorded pre-migration
DeploymentRuntimeConfig name instead of hardcoding "default". Preserve the
kubectl patch example while making clear that the original runtime configuration
name captured before migration must be substituted, including for providers
using custom configurations.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 9956fac8-e2dc-485b-9fa3-2ab9ff27a10b
📒 Files selected for processing (1)
docs/applying-storage-version-migration.md
Comment on lines
+189
to
+195
| If the provider normally uses another DeploymentRuntimeConfig, update the | ||
| reference to point back to it: | ||
|
|
||
| ```shell | ||
| kubectl patch provider provider-gcp-storage --type=merge \ | ||
| -p '{"spec":{"runtimeConfigRef":{"name":"default"}}}' | ||
| ``` |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
Restore the provider’s actual previous runtime configuration.
The text says to restore the provider’s previous DeploymentRuntimeConfig, but the command always sets runtimeConfigRef.name to default. If the provider used a custom configuration, this changes its runtime behavior after migration. Record the original name before migration and use that name here.
Proposed adjustment
kubectl patch provider provider-gcp-storage --type=merge \
- -p '{"spec":{"runtimeConfigRef":{"name":"default"}}}'
+ -p '{"spec":{"runtimeConfigRef":{"name":"<previous-runtime-config-name>"}}}'📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| If the provider normally uses another DeploymentRuntimeConfig, update the | |
| reference to point back to it: | |
| ```shell | |
| kubectl patch provider provider-gcp-storage --type=merge \ | |
| -p '{"spec":{"runtimeConfigRef":{"name":"default"}}}' | |
| ``` | |
| If the provider normally uses another DeploymentRuntimeConfig, update the | |
| reference to point back to it: | |
🤖 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/applying-storage-version-migration.md` around lines 189 - 195, Update
the runtimeConfigRef restoration instructions following the provider migration
to use the provider’s recorded pre-migration DeploymentRuntimeConfig name
instead of hardcoding "default". Preserve the kubectl patch example while making
clear that the original runtime configuration name captured before migration
must be substituted, including for providers using custom configurations.
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.
Description of your changes
This PR adds guides for the storage version migration library. They describe what is the flow and usage.
I have:
make reviewableto ensure this PR is ready for review.backport release-x.ylabels to auto-backport this PR if necessary.How has this code been tested