Change Rook-Ceph Template from Kustomize to Helm Chart#50
Conversation
Summary of ChangesHello, 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 refactors the Rook-Ceph module deployment strategy by migrating from a Kustomize-driven configuration to a Helm chart-based approach. This change enhances the modularity and maintainability of the Rook-Ceph integration by leveraging Helm's package management capabilities and separating the operator and cluster deployments into distinct module templates. Highlights
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. 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
This pull request successfully migrates the Rook-Ceph module from a Kustomize-based deployment to a Helm-based one, which is a positive change for managing the application lifecycle. The separation of the operator and cluster deployments into distinct module templates is well-executed and follows best practices. My review focuses on improving the default configuration in the new rook-ceph-cluster template to ensure a more resilient setup out-of-the-box by adjusting the replica counts for key Ceph components.
|
|
||
| cephClusterSpec: | ||
| mon: | ||
| count: 1 |
There was a problem hiding this comment.
A mon.count of 1 creates a single point of failure for the Ceph control plane. For production or highly-available environments, it is strongly recommended to use a count of 3. While allowMultiplePerNode: true is useful for single-node test clusters, the default in a reusable template should promote a more resilient configuration.
count: 3| count: 1 | ||
| allowMultiplePerNode: true | ||
| mgr: | ||
| count: 1 |
There was a problem hiding this comment.
A mgr.count of 1 is not highly available. To ensure the Ceph manager is resilient, it's recommended to run an active/standby pair by setting the count to 2 for production workloads.
count: 2
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
This PR migrates the Rook-Ceph ModuleTemplate from a FluxCD Kustomization-based install (raw upstream YAMLs) to a FluxCD HelmRelease-based install, and introduces a separate Helm-based template for provisioning the CephCluster resources.
Changes:
- Switch
config/modules/rook-ceph/moduletemplate.yamlfromkustomizationtohelmReleaseusing the upstreamrook-cephHelm chart. - Add a new
rook-ceph-clusterModuleTemplate driven by therook-ceph-clusterHelm chart, plus a corresponding sample Module. - Add a Flux
HelmRepositoryfor Rook and wire these resources intoconfig/modules/kustomization.yaml; remove the old rook-cephkustomization.yaml.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| config/samples/module-rook-ceph-cluster.yaml | Adds a sample Module that references the new rook-ceph-cluster template. |
| config/modules/rook-ceph/moduletemplate.yaml | Migrates the operator install to a HelmRelease spec (rook-ceph chart). |
| config/modules/rook-ceph/moduletemplate-cluster.yaml | Introduces a HelmRelease-based cluster (CephCluster) template with a dependency on the operator. |
| config/modules/rook-ceph/kustomization.yaml | Removes the prior Kustomize-based upstream YAML installation. |
| config/modules/rook-ceph/helmrepository.yaml | Adds the Flux HelmRepository pointing to the upstream Rook chart repo. |
| config/modules/kustomization.yaml | Includes the new rook-ceph HelmRepository and ModuleTemplates in the installer build. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| dependsOn: | ||
| - name: rook-ceph | ||
| namespace: rook-ceph | ||
|
|
There was a problem hiding this comment.
helmRelease.dependsOn is hard-coded to name: rook-ceph in namespace: rook-ceph. Because the controller names HelmReleases after the Module (not the ModuleTemplate) and allows Module.spec.namespace overrides, this dependency will silently break if a user installs the operator Module under a different name and/or overrides its namespace. Consider (a) omitting dependsOn[].namespace so the dependency follows the HelmRelease namespace, and (b) documenting that the operator Module must be named rook-ceph (or otherwise make the naming/namespace coupling explicit).
No description provided.