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

Update installation docs with guidance on how to patch controller-manager resource requests for prod deployments #481

Closed
danielvegamyhre opened this issue Mar 27, 2024 · 3 comments · Fixed by #558
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@danielvegamyhre
Copy link
Contributor

What would you like to be added:
For production deployments the JobSet controller manager resource requests and limits should be configured to align with the specific infrastructure it will be deployed on.

We should add guidance in the installation docs showing the user how to patch the deployment resource requests/limits for prod deployments: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/#use-a-strategic-merge-patch-to-update-a-deployment

Why is this needed:
We need to lower the default resource requests to address a widespread usability issue users encounter when trying out JobSet for the first time and getting confused when they can't create JobSets after installing the CRD (controller manager pod stays pending due to not fitting on default cloud VM nodes). However, for production deployments users should not rely on the defaults and should patch them to be optimized for their prod deployment infrastructure.

@danielvegamyhre danielvegamyhre added the documentation Improvements or additions to documentation label Mar 27, 2024
@kannon92
Copy link
Contributor

I think the doc should be more about how to use kustomize to deploy to a cluster and change the resource/requests.

I don't think patching the deployment is the right approch.

@danielvegamyhre
Copy link
Contributor Author

Sure, Kustomize is fine as well

@omerap12
Copy link
Member

Ill take it.
/assign

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

Successfully merging a pull request may close this issue.

3 participants