Skip to content

Conversation

nicktrn
Copy link
Collaborator

@nicktrn nicktrn commented Sep 3, 2025

Adds environment variables to configure Kubernetes resource requests with customizable CPU/memory ratios and minimum values. Defaults preserve existing behavior when not configured.

Environment Variables

Supervisor

  • KUBERNETES_CPU_REQUEST_MIN_CORES - Minimum CPU cores to request (e.g. 0.5), defaults to 0
  • KUBERNETES_MEMORY_REQUEST_MIN_GB - Minimum memory GB to request (e.g. 2), defaults to 0
  • KUBERNETES_CPU_REQUEST_RATIO - Ratio of CPU limit to request (e.g. 0.75 for 75%), defaults to 0.75
  • KUBERNETES_MEMORY_REQUEST_RATIO - Ratio of memory limit to request (e.g. 1 for 100%), defaults to 1

Copy link

changeset-bot bot commented Sep 3, 2025

⚠️ No Changeset found

Latest commit: 66dd0c9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Sep 3, 2025

Walkthrough

Adds four new Kubernetes resource request environment variables to the Env Zod schema: KUBERNETES_CPU_REQUEST_MIN_CORES, KUBERNETES_CPU_REQUEST_RATIO, KUBERNETES_MEMORY_REQUEST_MIN_GB, and KUBERNETES_MEMORY_REQUEST_RATIO with specified defaults and bounds. Updates Kubernetes workload manager to compute CPU and memory requests from machine presets using the new ratios and minimums. Introduces a private clamp helper and private constants sourced from Env. Resource requests are now calculated as ratio-based values clamped between configured minimums and preset limits, returning CPU (numeric) and memory as a string with "G".

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/configurable-resource-requests

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
apps/supervisor/src/env.ts (1)

88-91: Harden env parsing for robustness (.finite) and clarify intent of zero ratios.

  • Add .finite() so Infinity/NaN are rejected early.
  • If *_RATIO is set to 0, requests can be 0 CPU/memory; confirm this is intentional for your clusters and policies. If not, consider .gt(0) or a small positive minimum.
-  KUBERNETES_CPU_REQUEST_MIN_CORES: z.coerce.number().min(0).default(0),
-  KUBERNETES_CPU_REQUEST_RATIO: z.coerce.number().min(0).max(1).default(0.75), // Ratio of CPU limit, so 0.75 = 75% of CPU limit
-  KUBERNETES_MEMORY_REQUEST_MIN_GB: z.coerce.number().min(0).default(0),
-  KUBERNETES_MEMORY_REQUEST_RATIO: z.coerce.number().min(0).max(1).default(1), // Ratio of memory limit, so 1 = 100% of memory limit
+  KUBERNETES_CPU_REQUEST_MIN_CORES: z.coerce.number().finite().min(0).default(0),
+  KUBERNETES_CPU_REQUEST_RATIO: z.coerce.number().finite().min(0).max(1).default(0.75), // Ratio of CPU limit, so 0.75 = 75% of CPU limit
+  KUBERNETES_MEMORY_REQUEST_MIN_GB: z.coerce.number().finite().min(0).default(0),
+  KUBERNETES_MEMORY_REQUEST_RATIO: z.coerce.number().finite().min(0).max(1).default(1), // Ratio of memory limit, so 1 = 100% of memory limit
apps/supervisor/src/workloadManager/kubernetes.ts (1)

307-318: Standardize memory units and tame float noise.

  • Consider using Gi to match other k8s quantities (ephemeral storage uses Gi) and avoid SI/binary confusion.
  • Round to a few decimals to prevent values like 0.30000000000000004.
   #getResourceRequestsForMachine(preset: MachinePreset): ResourceQuantities {
-    const cpuRequest = preset.cpu * this.cpuRequestRatio;
-    const memoryRequest = preset.memory * this.memoryRequestRatio;
+    const cpuRequest = preset.cpu * this.cpuRequestRatio;
+    const memoryRequest = preset.memory * this.memoryRequestRatio;
 
-    // Clamp between min and max
-    const clampedCpu = this.clamp(cpuRequest, this.cpuRequestMinCores, preset.cpu);
-    const clampedMemory = this.clamp(memoryRequest, this.memoryRequestMinGb, preset.memory);
+    // Clamp between min and max, then round to avoid float artifacts
+    const round = (n: number, dp = 3) => Number.parseFloat(n.toFixed(dp));
+    const clampedCpu = round(this.clamp(cpuRequest, this.cpuRequestMinCores, preset.cpu));
+    const clampedMemory = round(this.clamp(memoryRequest, this.memoryRequestMinGb, preset.memory));
 
     return {
-      cpu: `${clampedCpu}`,
-      memory: `${clampedMemory}G`,
+      cpu: `${clampedCpu}`,
+      memory: `${clampedMemory}Gi`,
     };
   }

If you switch requests to Gi, mirror the change in limits for consistency:

// outside the changed hunk (suggestion)
#getResourceLimitsForMachine(preset: MachinePreset): ResourceQuantities {
  return {
    cpu: `${preset.cpu}`,
    memory: `${preset.memory}Gi`,
  };
}

Please confirm whether existing consumers or dashboards assume G units; if so, plan a coordinated change or keep G for now.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between ed23615 and 66dd0c9.

📒 Files selected for processing (2)
  • apps/supervisor/src/env.ts (1 hunks)
  • apps/supervisor/src/workloadManager/kubernetes.ts (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{ts,tsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

**/*.{ts,tsx}: Always prefer using isomorphic code like fetch, ReadableStream, etc. instead of Node.js specific code
For TypeScript, we usually use types over interfaces
Avoid enums
No default exports, use function declarations

Files:

  • apps/supervisor/src/workloadManager/kubernetes.ts
  • apps/supervisor/src/env.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (23)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 8)
  • GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
  • GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
  • GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
  • GitHub Check: typecheck / typecheck
  • GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
apps/supervisor/src/workloadManager/kubernetes.ts (2)

23-27: Nice: env-driven resource knobs are clean and scoped.


72-74: Clamp utility looks good.

Behavior when min > max still yields max, which is acceptable for misconfig safeguards.

@nicktrn nicktrn merged commit 9966011 into main Sep 4, 2025
31 checks passed
@nicktrn nicktrn deleted the feat/configurable-resource-requests branch September 4, 2025 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants