Make ephemeral storage defaults configurable via env vars #1407

iFlyinq · 2024-10-14T12:40:53Z

Added support for the env vars POD_EPHEMERAL_STORAGE_SIZE_LIMIT and POD_EPHEMERAL_STORAGE_SIZE_REQUEST

✅ Checklist

The PR title follows the convention.
I have followed every step in the contributing guide
I ran and tested the code works

Changelog

Added support for customized storage sizes on selfhosted kubernetes instances.

💯

Summary by CodeRabbit

New Features
- Introduced environment variables for configurable ephemeral storage limits and requests in Kubernetes pods.
- Enhanced flexibility by allowing storage settings to be defined via environment variables instead of hardcoded values.

… `POD_EPHEMERAL_STORAGE_SIZE_REQUEST`

changeset-bot · 2024-10-14T12:40:57Z

⚠️ No Changeset found

Latest commit: 4ab2134

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

coderabbitai · 2024-10-14T12:41:01Z

Walkthrough

The changes introduce two new constants, POD_EPHEMERAL_STORAGE_SIZE_LIMIT and POD_EPHEMERAL_STORAGE_SIZE_REQUEST, in the Kubernetes provider's codebase. These constants are designed to capture ephemeral storage limits and requests from environment variables. The code is updated to utilize these constants in various methods, enhancing the configurability of ephemeral storage settings for Kubernetes pods.

Changes

File Path	Change Summary
apps/kubernetes-provider/src/index.ts	Added constants `POD_EPHEMERAL_STORAGE_SIZE_LIMIT` and `POD_EPHEMERAL_STORAGE_SIZE_REQUEST`. Updated the `index` and `prePullDeployment` methods to use these constants instead of hardcoded values. Modified `#defaultResourceRequests` and `#defaultResourceLimits` getters to return values from the new constants.

Possibly related PRs

Added multiple env variables to kubernetes-provider #1305: This PR introduces new environment variables for the kubernetes-provider, which aligns with the main PR's focus on adding environment variables for managing ephemeral storage in Kubernetes pods. Both PRs enhance configurability through environment variables in the same file.

Suggested reviewers

nicktrn

Poem

🐇 In the land of code where bunnies hop,
New limits and requests, we can't stop!
With storage so sweet, from env vars they flow,
Configurable pods, watch them grow!
Hooray for the changes, let’s give a cheer,
For ephemeral storage, we hold dear! 🌱

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
- Generate unit testing code for this file.
- 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. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
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 src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai 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

Documentation and Community

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.

coderabbitai

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

apps/kubernetes-provider/src/index.ts (1)
37-38: LGTM! Consider using uppercase for constant names.

The addition of these constants aligns well with the PR objectives to support customized storage sizes for Kubernetes pods. Using environment variables with default values is a good practice for configuration.

Consider using uppercase for constant names to follow JavaScript/TypeScript naming conventions for constants:
-const POD_EPHEMERAL_STORAGE_SIZE_LIMIT = process.env.POD_EPHEMERAL_STORAGE_SIZE_LIMIT || "10Gi";
-const POD_EPHEMERAL_STORAGE_SIZE_REQUEST = process.env.POD_EPHEMERAL_STORAGE_SIZE_REQUEST || "2Gi";
+const POD_EPHEMERAL_STORAGE_SIZE_LIMIT = process.env.POD_EPHEMERAL_STORAGE_SIZE_LIMIT || "10Gi";
+const POD_EPHEMERAL_STORAGE_SIZE_REQUEST = process.env.POD_EPHEMERAL_STORAGE_SIZE_REQUEST || "2Gi";

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1c80a74 and 98acc78.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (1)

apps/kubernetes-provider/src/index.ts (4 hunks)

🧰 Additional context used

🔇 Additional comments (4)

apps/kubernetes-provider/src/index.ts (4)

114-114: LGTM! Ephemeral storage limit correctly updated.

The change correctly implements the use of the new POD_EPHEMERAL_STORAGE_SIZE_LIMIT constant for the ephemeral storage limit in the job's container specification. This allows for customization of the storage limit as per the PR objectives.

344-347: LGTM! Ephemeral storage limits and requests correctly updated.

The changes correctly implement the use of both new constants POD_EPHEMERAL_STORAGE_SIZE_LIMIT and POD_EPHEMERAL_STORAGE_SIZE_REQUEST for ephemeral storage limits and requests in the prePullDeployment method. This allows for customization of both the storage limit and request as per the PR objectives. The use of different values for limits and requests is a good practice in Kubernetes resource management.

405-405: LGTM! Default resource requests and limits correctly updated.

The changes in the defaultResourceRequests and defaultResourceLimits getters correctly implement the use of POD_EPHEMERAL_STORAGE_SIZE_REQUEST and POD_EPHEMERAL_STORAGE_SIZE_LIMIT respectively. This ensures that the new constants are used consistently throughout the codebase. The separation of requests and limits is maintained, which is a good practice in Kubernetes resource management.

Also applies to: 411-411

37-38: Summary: Excellent implementation of customizable ephemeral storage settings

The changes introduce two new environment variables, POD_EPHEMERAL_STORAGE_SIZE_LIMIT and POD_EPHEMERAL_STORAGE_SIZE_REQUEST, which allow for customization of ephemeral storage settings in Kubernetes pods. These constants are consistently used throughout the codebase, including in the index method, prePullDeployment method, and the default resource getters.

Key points:

The implementation aligns perfectly with the PR objectives.

The use of environment variables with default values provides flexibility and ease of configuration.

The separation of limits and requests is maintained, following Kubernetes best practices.

The changes are consistent across different parts of the codebase.

These modifications will greatly enhance the flexibility of storage management in self-hosted Kubernetes instances, as intended by the PR.

Also applies to: 114-114, 344-347, 405-405, 411-411

pkg-pr-new · 2024-10-14T12:59:46Z

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/build@1407

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev@1407

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/core@1407

pnpm add https://pkg.pr.new/triggerdotdev/trigger.dev/@trigger.dev/sdk@1407

commit: 4ab2134

iFlyinq · 2024-10-14T13:50:52Z

I guess this would be something for @nicktrn :)

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 98acc78 and 82c9406.

📒 Files selected for processing (1)

apps/kubernetes-provider/src/index.ts (2 hunks)

🧰 Additional context used

🔇 Additional comments (2)

apps/kubernetes-provider/src/index.ts (2)

408-408: Consistent usage of resource limits and requests

Ensure that both #defaultResourceRequests and #defaultResourceLimits include all necessary resource types for consistency. Currently, cpu and memory are specified in other parts of the code. Verify that the ephemeral-storage settings are harmonized with cpu and memory to prevent unintended resource allocations.

Consider reviewing the resource specifications to confirm they align with expected defaults.

402-402: Ensure resource quantity strings comply with Kubernetes format

When specifying resource quantities for ephemeral-storage, it's important that the strings used are valid Kubernetes resource quantity formats. Since the values come from environment variables, consider validating them to ensure they are acceptable by Kubernetes. Invalid formats may cause runtime errors when creating pods.

To verify that the resource quantity strings are valid, you can run the following script:

apps/kubernetes-provider/src/index.ts

Added support for the env vars POD_EPHEMERAL_STORAGE_SIZE_LIMIT and…

98acc78

… `POD_EPHEMERAL_STORAGE_SIZE_REQUEST`

Reverted pnpm lockfile

4fa8076

coderabbitai bot reviewed Oct 14, 2024

View reviewed changes

iFlyinq added 3 commits October 14, 2024 14:44

Made sure there is no diff between the main lockfile & PR's lockfile

9ddfb77

Not touching the storage for the index containers

d8cca79

Not touching the storage for the prePull container

ee0fb7e

Merge branch 'triggerdotdev:main' into main

82c9406

coderabbitai bot reviewed Oct 15, 2024

View reviewed changes

apps/kubernetes-provider/src/index.ts Show resolved Hide resolved

apps/kubernetes-provider/src/index.ts Show resolved Hide resolved

Merge branch 'main' into main

4ab2134

nicktrn approved these changes Oct 16, 2024

View reviewed changes

nicktrn changed the title ~~Env vars POD_EPHEMERAL_STORAGE_SIZE_LIMIT and POD_EPHEMERAL_STORAGE_SIZE_REQUEST~~ Make ephemeral storage defaults configurable via env vars Oct 16, 2024

nicktrn merged commit e36e3d5 into triggerdotdev:main Oct 16, 2024
9 checks passed

coderabbitai bot mentioned this pull request Mar 21, 2025

Publish redis-worker and add graceful shutdown manager #1810

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Uh oh!

Make ephemeral storage defaults configurable via env vars #1407

Make ephemeral storage defaults configurable via env vars #1407

Uh oh!

iFlyinq commented Oct 14, 2024 •

edited

Loading

Uh oh!

changeset-bot bot commented Oct 14, 2024 •

edited

Loading

Uh oh!

coderabbitai bot commented Oct 14, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

pkg-pr-new bot commented Oct 14, 2024 •

edited

Loading

Uh oh!

iFlyinq commented Oct 14, 2024

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Make ephemeral storage defaults configurable via env vars #1407

Make ephemeral storage defaults configurable via env vars #1407

Uh oh!

Conversation

iFlyinq commented Oct 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Checklist

Changelog

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Oct 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

coderabbitai bot commented Oct 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

pkg-pr-new bot commented Oct 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iFlyinq commented Oct 14, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

iFlyinq commented Oct 14, 2024 •

edited

Loading

changeset-bot bot commented Oct 14, 2024 •

edited

Loading

coderabbitai bot commented Oct 14, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Oct 14, 2024 •

edited

Loading