Skip to content

docs(tenant): add resourceQuotas configuration documentation - #1902

Merged
Andrei Kvapil (kvaps) merged 1 commit into
mainfrom
docs/tenant-resource-quotas
Jan 22, 2026
Merged

Andrei Kvapil (kvaps) merged 1 commit into
mainfrom
docs/tenant-resource-quotas

Conversation

@kvaps

@kvaps Andrei Kvapil (kvaps) commented Jan 22, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Add documentation for the resourceQuotas parameter in tenant README
  • Document supported compute resources (cpu, memory, ephemeral-storage, storage)
  • Document object count quotas (pods, services, configmaps, secrets, etc.)
  • Include usage example

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Configuration section describing resource quotas, including compute resource mappings (CPU, memory, storage), object count restrictions (pods, services, configmaps, secrets, persistent volumes), and example YAML configurations.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai

coderabbitai Bot commented Jan 22, 2026 •

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

Note

Other AI code review bot(s) detected

CodeRabbit 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.

📝 Walkthrough

Walkthrough

The 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

Cohort / File(s) Summary
Documentation
packages/apps/tenant/README.md
Added "Configuration" section describing resourceQuotas, including compute resource mappings to Kubernetes limits/requests and object count quota types with a YAML configuration example (+31 lines).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

📚 A rabbit hops with glee,
Through words of quotas, wild and free,
Resource limits now plain to see,
Configuration blooms from a README tree! 🐰✨


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello 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 tenant application by adding a dedicated section on resourceQuotas. It clarifies how users can define and apply resource limits for tenants, covering both computational resources and the maximum number of specific Kubernetes objects, thereby enhancing clarity and usability for tenant configuration.

Highlights

  • Documentation Update: Added comprehensive documentation for the resourceQuotas parameter within the tenant README.
  • Compute Resources: Detailed the supported compute resources for quotas, including CPU, memory, ephemeral storage, and persistent storage.
  • Object Count Quotas: Documented various object count quotas such as pods, services, configmaps, and secrets.
  • Usage Example: Included a practical YAML example demonstrating how to configure resourceQuotas.

🧠 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 Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment Gemini (@gemini-code-assist) Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

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]>
@kvaps
Andrei Kvapil (kvaps) force-pushed the docs/tenant-resource-quotas branch from ec10ae8 to b4271c4 Compare January 22, 2026 19:33

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

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 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.

Comment on lines +88 to +92

**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"`)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
**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`

Comment on lines +95 to +101
**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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
**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

@kvaps
Andrei Kvapil (kvaps) marked this pull request as ready for review January 22, 2026 22:19
@dosubot dosubot Bot added the size/M This PR changes 30-99 lines, ignoring generated files label Jan 22, 2026
@kvaps
Andrei Kvapil (kvaps) merged commit bda9030 into main Jan 22, 2026
5 of 6 checks passed
@kvaps
Andrei Kvapil (kvaps) deleted the docs/tenant-resource-quotas branch January 22, 2026 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M This PR changes 30-99 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant