Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docker resource limits for jobs #241

Merged
merged 4 commits into from
Jan 21, 2024
Merged

Add docker resource limits for jobs #241

merged 4 commits into from
Jan 21, 2024

Conversation

evanyeyeye
Copy link
Member

Adds the following resource limits to new jobs:

  • Number of CPU cores
  • Memory (in MB)

Addresses: @139

Resource limits can be verified using docker stats and htop.

Copy link

coderabbitai bot commented Dec 1, 2023

Warning

Rate Limit Exceeded

@evanyeyeye has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 27 minutes and 2 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 61cd508 and 1dc4112.

Walkthrough

The recent updates involve enhancing resource management for Docker containers in an autograding system. The changes allow for dynamic allocation of CPU cores and memory limits based on configurations or job-specific requirements. This is achieved by modifying method signatures to accept resource parameters and updating the logic to apply these constraints when creating and running Docker containers.

Changes

File Path Change Summary
restful_tango/tangoREST.py Modified createTangoMachine method to handle vmObj as an optional parameter and set cores and memory based on the vmObj if provided. Also retrieves cores and memory limits from the Config module.
vmms/localDocker.py Appended CPU and memory constraints to the args list used for running a Docker container in the runJob method.
config.template.py Added declarations for Docker autograding container resource limits (DOCKER_CORES_LIMIT and DOCKER_MEMORY_LIMIT) within the Config class.

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@damianhxy damianhxy linked an issue Dec 1, 2023 that may be closed by this pull request
Copy link
Member

@damianhxy damianhxy left a comment

Choose a reason for hiding this comment

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

Verified that limits are set (1GB memory, 1 CPU):

Screenshot 2023-12-30 at 02 57 44

(Ref https://phoenixnap.com/kb/docker-memory-and-cpu-limit)

However, need to avoid breaking existing installations -- see comment about getattr

Copy link
Member

@damianhxy damianhxy left a comment

Choose a reason for hiding this comment

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

Verified that autograding works when Config.py is outdated

LGTM

@evanyeyeye evanyeyeye merged commit 0b3b3bb into master Jan 21, 2024
1 check passed
@evanyeyeye evanyeyeye deleted the add-docker-limits branch January 21, 2024 19:57
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.

support for docker resource control
2 participants