User Guide Entry: Pod Resource General Guidelines

[sj-williams]

Background

We need to have a clear and prominent entry in the User Guide which outlines some general considerations and guidelines for workload requests / limits.

This is so that we have reference in place to help ensure we don't invite resource intensive / non scalable monolithic workloads.

Also there are other things related to this that we should put in place / investigate to obtain a good picture of the general state of things in the cluster in this respect. Things to think about:

• monitoring / alerting for general state of resource requests/limits across cluster
• Can we implement Gatekeeper policies for admission control level of excessive resource configurations, with some permissive controls that can be put in place for 'exceptions' if / when needed?
• best practice/K8s reference docs for requests and limits guidance that we can publish in user guide
• think about comms for any changes and potential disruption

Proposed user journey

Approach

Which part of the user docs does this impact

Communicate changes

• [ ] post for #cloud-platform-update
• [ ] Weeknotes item
• [ ] Show the Thing/P&A All Hands/User CoP
• [ ] Announcements channel

Questions / Assumptions

Definition of done

• [ ] readme has been updated
• [ ] user docs have been updated
• [ ] another team member has reviewed
• [ ] smoke tests are green
• [ ] prepare demo for the team

Reference

How to write good user stories