Resource Limits | Developer Guide | OpenShift Enterprise 3.1

Overview
Setting Limit Range Constraints
- Container Limits
- Pod Limits
Creating a Limit Range
Viewing Limits
Deleting Limits

Overview

A LimitRange object enumerates compute resource constraints in a project at the pod and container level. This allows you to specify the amount of resources that a pod or container can consume.

Setting Limit Range Constraints

All resource create and modification requests are evaluated against each LimitRange object in the project. If the resource violates any of the enumerated constraints, then the resource is rejected. If the resource does not set an explicit value, and if the constraint supports a default value, then the default value is applied to the resource.

Example 1. Limit Range Object Definition

apiVersion: "v1"
kind: "LimitRange"
metadata:
  name: "limits" (1)
spec:
  limits:
    -
      type: "Pod"
      max:
        cpu: "2" (2)
        memory: "1Gi" (3)
      min:
        cpu: "200m" (4)
        memory: "6Mi" (5)
    -
      type: "Container"
      max:
        cpu: "2" (6)
        memory: "1Gi" (7)
      min:
        cpu: "100m" (8)
        memory: "4Mi" (9)
      default:
        cpu: "300m" (10)
        memory: "200Mi" (11)
      defaultRequest:
        cpu: "200m" (12)
        memory: "100Mi" (13)
      maxLimitRequestRatio:
        cpu: "10" (14)

1	The name of the limit range document.
2	The maximum amount of CPU that a pod can request on a node across all containers.
3	The maximum amount of memory that a pod can request on a node across all containers.
4	The minimum amount of CPU that a pod can request on a node across all containers.
5	The minimum amount of memory that a pod can request on a node across all containers.
6	The maximum amount of CPU that a single container in a pod can request.
7	The maximum amount of memory that a single container in a pod can request.
8	The minimum amount of CPU that a single container in a pod can request.
9	The minimum amount of memory that a single container in a pod can request.
10	The default amount of CPU that a container will be limited to use if not specified.
11	The default amount of memory that a container will be limited to use if not specified.
12	The default amount of CPU that a container will request to use if not specified.
13	The default amount of memory that a container will request to use if not specified.
14	The maximum amount of CPU burst that a container can make as a ratio of its limit over request.

Container Limits

Supported Resources:

CPU
Memory

Supported Constraints:

Per container, the following must hold true if specified:

Table 1. Container
Constraint	Behavior
`Min`	Min[resource] ⇐ container.resources.requests[resource] (required) ⇐ container/resources.limits[resource] (optional) If the configuration defines a `min` CPU, then the request value must be greater than the CPU value. A limit value does not need to be specified.
`Max`	container.resources.limits[resource] (required) ⇐ Max[resource] If the configuration defines a `max` CPU, then you do not need to define a request value, but a limit value does need to be set that satisfies the maximum CPU constraint.
`MaxLimitRequestRatio`	MaxLimitRequestRatio[resource] ⇐ ( container.resources.limits[resource] / container.resources.requests[resource]) If a configuration defines a `maxLimitRequestRatio` value, then any new containers must have both a request and limit value. Additionally, OpenShift calculates a limit to request ratio by dividing the limit by the request. For example, if a container has `cpu: 500` in the `limit` value, and `cpu: 100` in the `request` value, then its limit to request ratio for `cpu` is `5`. This ratio must be less than or equal to the `maxLimitRequestRatio`.

Supported Defaults:

Default[resource] - defaults container.resources.limit[resource] to specified value if none
Default Requests[resource] - defaults container.resources.requests[resource] to specified value if none

Pod Limits

Supported Resources:

CPU
Memory

Supported Constraints:

Across all containers in a pod, the following must hold true:

Table 2. Pod
Constraint	Enforced Behavior
`Min`	Min[resource] less than or equal to container.resources.requests[resource] (required) less than or equal to container.resources.limits[resource] (optional)
`Max`	container.resources.limits[resource] (required) less than or equal to Max[resource]
`MaxLimitRequestRatio`	MaxLimitRequestRatio[resource] less than or equal to ( container.resources.limits[resource] / container.resources.requests[resource])

Creating a Limit Range

To apply a limit range to a project, create a limit range object definition on your file system to your desired specifications, then run:

$ oc create -f <limit_range_file>

Viewing Limits

To view limits enforced in a project:

$ oc get limits
NAME
limits

$ oc describe limits limits
Name:        limits
Namespace:   default
Type         Resource  Min Max Request Limit Limit/Request
----         --------  --- --- ------- ----- -------------
Pod          memory    6Mi 1Gi -       -     -
Pod          cpu       200m  2 -       -     -
Container    cpu       100m  2 200m    300m  10
Container    memory    4Mi 1Gi 100Mi   200Mi -

Deleting Limits

Remove any active limit range to no longer enforce the limits of a project:

$ oc delete limits <limit_name>