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

docs: guidance for pod memory allocation #1195

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

burgerdev
Copy link
Contributor

No description provided.

@burgerdev burgerdev added the documentation Improvements for user docs label Jan 29, 2025
Copy link

github-actions bot commented Jan 29, 2025

PR Preview Action v1.6.0

🚀 View preview at
https://edgelesssys.github.io/contrast/pr-preview/pr-1195/

Built to branch gh-pages at 2025-01-29 16:26 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@burgerdev burgerdev force-pushed the burgerdev/memory branch 2 times, most recently from 594a143 to 4c1cbde Compare January 29, 2025 16:23
@burgerdev burgerdev requested a review from m1ghtym0 January 29, 2025 16:31
@burgerdev burgerdev marked this pull request as ready for review January 29, 2025 16:31
Comment on lines +157 to +158
requests:
memory: 50Mi
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Document that request should be equal to limit.

@burgerdev burgerdev requested a review from katexochen January 30, 2025 08:00

Since pod VMs are statically sized, it's easier to run out of memory due to misconfigurations.
Setting the right memory limits is even more important on bare metal, where the image layers need to be stored in the guest memory, too.
If the guest pull fails due to lack of memory, you might see an error message like this:
Copy link
Member

Choose a reason for hiding this comment

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

Would turn that sentence around: if you see the error, it might be failing cos of memory.

Comment on lines +136 to +137
The CVM memory is calculated from the sum of the memory limits of the containers and a static overhead for daemons.
InitContainers aren't taken into account.
Copy link
Member

Choose a reason for hiding this comment

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

From reading these two sentences, it's still not clear to me how this is working. What daemons are we talking about? And what does the initContainer thing mean for me as a user?

Copy link
Member

@m1ghtym0 m1ghtym0 left a comment

Choose a reason for hiding this comment

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

Agree with Paul's comments, otherwise lgtm:-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements for user docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants