Merge pull request #3084 from markturansky/add_storage_limits

Added storage to limits and quota

Author: Brice Fallon-Freeman

admin_guide/limits.adoc

@@ -17,8 +17,8 @@ toc::[]
 A limit range, defined by a `*LimitRange*` object, enumerates
 xref:../dev_guide/compute_resources.adoc#dev-compute-resources[compute resource
 constraints] in a xref:../dev_guide/projects.adoc#dev-guide-projects[project] at the pod,
-container, image and image stream level, and specifies the amount of resources
-that a pod, container, image or image stream can consume.
+container, image, image stream, and persistent volume claim level, and specifies the amount of resources
+that a pod, container, image, image stream, or persistent volume claim can consume.
 
 All resource create and modification requests are evaluated against each
 `*LimitRange*` object in the project. If the resource violates any of the
@@ -314,6 +314,68 @@ distinguished.
 
 // end::admin_limits_image_stream_limits[]
 
+
+[[claim-limits]]
+=== PersistentVolumeClaim Limits
+
+// tag::admin_limits_claim_limits[]
+*Supported Resources:*
+
+* Storage
+
+*Supported Constraints:*
+
+Across all persistent volume claims in a project, the following must hold true:
+
+.Pod
+[cols="3a,8a",options="header"]
+|===
+
+|Constraint |Enforced Behavior
+
+|`*Min*`
+|Min[resource] <= claim.spec.resources.requests[resource] (required)
+
+|`*Max*`
+|claim.spec.resources.requests[resource] (required) <= Max[resource]
+
+[[limit-range-def]]
+
+.Limit Range Object Definition
+====
+
+|===
+
+[source,json]
+----
+{
+  "apiVersion": "v1",
+  "kind": "LimitRange",
+  "metadata": {
+    "name": "pvcs" <1>
+  },
+  "spec": {
+    "limits": [{
+        "type": "PersistentVolumeClaim",
+        "min": {
+          "storage": "2Gi", <2>
+        },
+        "max": {
+          "storage": "50Gim", <3>
+        }
+      },
+    }]
+  }
+}
+----
+<1> The name of the limit range document.
+<2> The minimum amount of storage that can be requested in a persistent volume claim
+<3> The maximum amount of storage that can be requested in a persistent volume claim
+====
+
+// end::admin_limits_claim_limits[]
+
+
 [[creating-a-limit-range]]
 == Creating a Limit Range
 

admin_guide/quota.adoc

@@ -17,7 +17,7 @@ toc::[]
 A resource quota, defined by a `*ResourceQuota*` object, provides constraints
 that limit aggregate resource consumption per project. It can limit the quantity
 of objects that can be created in a project by type, as well as the total amount
-of compute resources that may be consumed by resources in that project.
+of compute resources and storage that may be consumed by resources in that project.
 // end::admin_quota_overview[]
 
 ifdef::openshift-origin,openshift-enterprise,openshift-dedicated[]
@@ -61,6 +61,11 @@ interchangeably.
 exceed this value. `*memory*` and `*requests.memory*` are the same value and can
 be used interchangeably.
 
+|`*requests.storage*`
+|Across all persistent volume claim in any state, the sum of storage requests cannot
+exceed this value. `*storage*` and `*requests.storage*` are the same value and can
+be used interchangeably.
+
 |`*limits.cpu*`
 |Across all pods in a non-terminal state, the sum of CPU limits cannot exceed
 this value.
@@ -339,6 +344,24 @@ spec:
 <4> Restricts the quota to only matching pods where `spec.activeDeadlineSeconds >=0`.  For example,
 this quota would charge for build or deployer pods, but not long running pods like a web server or database.
 ====
+
+.*storage-consumption.yaml*
+====
+----
+apiVersion: v1
+kind: ResourceQuota
+metadata:
+  name: storage-consumption
+spec:
+  hard:
+    persistentvolumeclaims: "10" <1>
+    requests.storage: "50Gi" <2>
+----
+<1> The total number of persistent volume claims in a project
+<2> Across all persistent volume claims in a project, the sum of storage requested cannot exceed this value.
+====
+
+
 // end::admin_quota_sample_definitions[]
 
 [[create-a-quota]]