Files
polaris/docs/check-documentation/resources.md
Robert Brennan bd14ab8bc1 Release 1.0.0 (#300)
* Release 1.0.0

* update deploy files

* remove docs for old capabilities

* update images

* update image

* update docs

* remove capabilities language

* add CLI changes to changelog

* reorg changelog
2020-05-20 09:00:41 -04:00

2.1 KiB

Resources

Polaris supports a number of checks related to CPU and Memory requests and limits.

Presence Checks

To simplify ensure that these values have been set, the following attributes are available:

key default description
resources.cpuRequestsMissing danger Fails when resources.requests.cpu attribute is not configured.
resources.memoryRequestsMissing danger Fails when resources.requests.memory attribute is not configured.
resources.cpuLimitsMissing danger Fails when resources.limits.cpu attribute is not configured.
resources.memoryLimitsMissing danger Fails when resources.limits.memory attribute is not configured.

Background

Configuring resource requests and limits for containers running in Kubernetes is an important best practice to follow. Setting appropriate resource requests will ensure that all your applications have sufficient compute resources. Setting appropriate resource limits will ensure that your applications do not consume too many resources.

Having these values appropriately configured ensures that:

  • Cluster autoscaling can function as intended. New nodes are scheduled once pods are unable to be scheduled on an existing node due to insufficient resources. This will not happen if resource requests are not configured.

  • Each container has sufficient access to compute resources. Without resource requests, a pod may be scheduled on a node that is already overutilized. Without resource limits, a single poorly behaving pod could utilize the majority of resources on a node, significantly impacting the performance of other pods on the same node.

Further Reading