-
Notifications
You must be signed in to change notification settings - Fork 20
docs(storage): simplify NFS driver setup instructions #399
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Replace manual HelmRelease manifest with simple bundle-enable option. Add note about waiting for platform chart reconciliation. 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. 📝 WalkthroughWalkthroughDocumentation update to the NFS storage setup guide that removes embedded Kubernetes YAML resources and replaces them with Cozystack configuration directives, streamlines verification steps, and adds practical NFS export share setup instructions. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
✏️ Tip: You can disable this entire section by setting 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 refines the documentation for setting up the NFS driver by simplifying the configuration process. It transitions from a verbose, manual HelmRelease manifest to a more declarative 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. 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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request simplifies the documentation for setting up the NFS driver by replacing a manual HelmRelease manifest with a bundle-enable configuration option. The changes make the process much more straightforward for users. My feedback focuses on improving the clarity of the new instructions to ensure users can easily locate and update their Cozystack configuration.
| Add `bundle-enable: nfs-driver` to your Cozystack configuration: | ||
|
|
||
| ```yaml | ||
| --- | ||
| apiVersion: v1 | ||
| kind: Namespace | ||
| metadata: | ||
| labels: | ||
| cozystack.io/system: "true" | ||
| pod-security.kubernetes.io/enforce: privileged | ||
| name: cozy-nfs-driver | ||
| spec: | ||
| finalizers: | ||
| - kubernetes | ||
| --- | ||
| apiVersion: helm.toolkit.fluxcd.io/v2 | ||
| kind: HelmRelease | ||
| metadata: | ||
| labels: | ||
| cozystack.io/repository: system | ||
| cozystack.io/system-app: "true" | ||
| name: nfs-driver | ||
| namespace: cozy-nfs-driver | ||
| spec: | ||
| chart: | ||
| spec: | ||
| chart: cozy-nfs-driver | ||
| reconcileStrategy: Revision | ||
| sourceRef: | ||
| kind: HelmRepository | ||
| name: cozystack-system | ||
| namespace: cozy-system | ||
| version: '>= 0.0.0-0' | ||
| dependsOn: | ||
| - name: cilium | ||
| namespace: cozy-cilium | ||
| - name: kubeovn | ||
| namespace: cozy-kubeovn | ||
| install: | ||
| crds: CreateReplace | ||
| remediation: | ||
| retries: -1 | ||
| interval: 5m | ||
| releaseName: nfs-driver | ||
| suspend: true | ||
| upgrade: | ||
| crds: CreateReplace | ||
| remediation: | ||
| retries: -1 | ||
| bundle-enable: nfs-driver | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The instruction to add bundle-enable: nfs-driver to the Cozystack configuration is a great simplification. However, it might be unclear for some users exactly where this configuration should be added. To improve clarity, could you please provide a more complete example showing this line within its parent configuration structure, or at least mention the name of the configuration file and the section where this should be added? This will help users apply the configuration correctly without guesswork.
Summary
bundle-enable: nfs-driverconfiguration optionTest plan
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.