Repository navigation
docs(tenant): add resourceQuotas configuration documentation - #1902
Conversation
|
Caution Review failedThe pull request is closed. Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. 📝 WalkthroughWalkthroughThe pull request adds a new "Configuration" section to the tenant README documenting resourceQuotas, including compute resources (cpu, memory, ephemeral-storage, storage) and object count quotas, with a corresponding YAML example. This is purely documentation with no code logic modifications. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
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 Andrei Kvapil (@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 improves the documentation for the 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 (@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
|
Add documentation for the resourceQuotas parameter explaining supported resource types and their usage. Co-Authored-By: Claude <[email protected]> Signed-off-by: Andrei Kvapil <[email protected]>
ec10ae8 to
b4271c4
Compare
There was a problem hiding this comment.
Code Review
This pull request adds valuable documentation for the resourceQuotas parameter. The changes are clear and well-structured. I've identified a couple of areas where the documentation could be more precise and complete. Specifically, the explanation for the storage resource quota could be clarified, and the list of supported object count quotas could be extended to include all supported keys. I've provided suggestions to address these points.
|
|
||
| **Compute resources** (converted to `requests.X` and `limits.X`): | ||
| - `cpu` - Total CPU cores (e.g., `"4"` or `"500m"`) | ||
| - `memory` - Total memory (e.g., `"4Gi"` or `"512Mi"`) | ||
| - `ephemeral-storage` - Ephemeral storage limit (e.g., `"10Gi"`) |
There was a problem hiding this comment.
The documentation for storage is slightly misleading. It's listed under 'Compute resources' which are described as being converted to requests.X and limits.X. However, based on the implementation in packages/library/cozy-lib/templates/_resources.tpl, storage is only converted to requests.storage. To improve clarity, I suggest separating storage resources from compute resources.
| **Compute resources** (converted to `requests.X` and `limits.X`): | |
| - `cpu` - Total CPU cores (e.g., `"4"` or `"500m"`) | |
| - `memory` - Total memory (e.g., `"4Gi"` or `"512Mi"`) | |
| - `ephemeral-storage` - Ephemeral storage limit (e.g., `"10Gi"`) | |
| **Compute resources** (converted to `requests.X` and `limits.X`): | |
| - `cpu` - Total CPU cores (e.g., `"4"` or `"500m"`) | |
| - `memory` - Total memory (e.g., `"4Gi"` or `"512Mi"`) | |
| - `ephemeral-storage` - Ephemeral storage limit (e.g., `"10Gi"`) | |
| **Storage resources**: | |
| - `storage` - Total persistent storage (e.g., `"100Gi"`), which is converted to `requests.storage` |
| **Object count quotas** (passed as-is): | ||
| - `pods` - Maximum number of pods | ||
| - `services` - Maximum number of services | ||
| - `services.loadbalancers` - Maximum number of LoadBalancer services | ||
| - `services.nodeports` - Maximum number of NodePort services | ||
| - `configmaps` - Maximum number of ConfigMaps | ||
| - `secrets` - Maximum number of Secrets |
There was a problem hiding this comment.
The list of object count quotas seems to be incomplete. The implementation in packages/library/cozy-lib/templates/_resources.tpl supports additional keys: services.clusterip, replicationcontrollers, and resourcequotas. It would be beneficial to include them in the documentation for completeness.
| **Object count quotas** (passed as-is): | |
| - `pods` - Maximum number of pods | |
| - `services` - Maximum number of services | |
| - `services.loadbalancers` - Maximum number of LoadBalancer services | |
| - `services.nodeports` - Maximum number of NodePort services | |
| - `configmaps` - Maximum number of ConfigMaps | |
| - `secrets` - Maximum number of Secrets | |
| - `pods` - Maximum number of pods | |
| - `services` - Maximum number of services | |
| - `services.loadbalancers` - Maximum number of LoadBalancer services | |
| - `services.nodeports` - Maximum number of NodePort services | |
| - `services.clusterip` - Maximum number of ClusterIP services | |
| - `configmaps` - Maximum number of ConfigMaps | |
| - `secrets` - Maximum number of Secrets | |
| - `persistentvolumeclaims` - Maximum number of PVCs | |
| - `replicationcontrollers` - Maximum number of ReplicationControllers | |
| - `resourcequotas` - Maximum number of ResourceQuotas |
Summary
resourceQuotasparameter in tenant READMESummary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.