docs(v1): add breaking changes section to upgrade guide#428
Conversation
Document all user-facing breaking changes for v1.0 including MySQL→MariaDB rename, FerretDB removal, virtual-machine split into vm-disk/vm-instance, monitoring restructuring, VPC subnets format change, MongoDB configuration update, tenant isolation enforcement, and internal architecture changes. Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: Andrei Kvapil <kvapss@gmail.com>
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughUpdated the v1.0 upgrade guide documentation to include a comprehensive Breaking Changes section covering FerretDB removal, MariaDB migration, VM restructuring, monitoring updates, VPC subnet changes, MongoDB configuration restructuring, and tenant isolation flag removal. Also marked cozyhr as an optional prerequisite tool. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
✨ 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 |
Summary of ChangesHello @kvaps, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the documentation for the v0.41 to v1.0 upgrade by introducing a detailed 'Breaking Changes' section. This new content aims to provide users with a clear understanding of all user-facing changes, including application renames, removals, structural modifications, and configuration format updates, ensuring a smoother upgrade process by highlighting necessary manual interventions and automatic migrations. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
The pull request adds a vital 'Breaking Changes' section to the v1.0 upgrade guide. The content is detailed and provides helpful migration examples. However, there are several inconsistencies between this guide and the component-specific documentation for v1.0 (e.g., VPC, MongoDB, VM, and FerretDB). These files appear to be autogenerated, so the source packages in the main repository likely need to be updated to reflect these changes and ensure the documentation remains consistent across the site.
| ### FerretDB removed | ||
|
|
||
| The FerretDB application has been completely removed from the platform. There is no automatic migration. |
There was a problem hiding this comment.
The v1 documentation still contains a page for FerretDB at content/en/docs/v1/applications/ferretdb.md. Since this application is removed in v1.0, that file should be deleted or updated to reflect its removal to avoid confusing users.
| - Kube-OVN IP and MAC addresses. | ||
| - LoadBalancer IPs for externally exposed VMs. | ||
|
|
||
| Additionally, the `running` boolean field has been replaced by `runStrategy`: |
There was a problem hiding this comment.
The v1 documentation for VM Instance at content/en/docs/v1/virtualization/vm-instance.md (line 59) still references the running boolean field. It should be updated to use runStrategy as described here to maintain consistency.
| The migration is automatic — all monitoring resources (VictoriaMetrics, Grafana, Alerta, | ||
| VLogs) are re-labeled and adopted by the new HelmRelease. | ||
|
|
||
| ### VPC subnets format changed from map to array |
There was a problem hiding this comment.
The v1 documentation for VPC at content/en/docs/v1/networking/vpc.md (line 46) still defines subnets as a map and uses the old format in examples. It should be updated to the new array format to match this guide.
1 participant
Summary
Test plan
Summary by CodeRabbit