Chapter 8. ResourceQuota [v1] Description ResourceQuota sets aggregate quota restrictions enforced per namespace Type object 8.1. Specification Property Type Description apiVersion string APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources kind string Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds metadata ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata spec object ResourceQuotaSpec defines the desired hard limits to enforce for Quota. status object ResourceQuotaStatus defines the enforced hard limits and observed use. 8.1.1. .spec Description ResourceQuotaSpec defines the desired hard limits to enforce for Quota. Type object Property Type Description hard object (Quantity) hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ scopeSelector object A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements. scopes array (string) A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. 8.1.2. .spec.scopeSelector Description A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements. Type object Property Type Description matchExpressions array A list of scope selector requirements by scope of the resources. matchExpressions[] object A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values. 8.1.3. .spec.scopeSelector.matchExpressions Description A list of scope selector requirements by scope of the resources. Type array 8.1.4. .spec.scopeSelector.matchExpressions[] Description A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values. Type object Required scopeName operator Property Type Description operator string Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Possible enum values: - "DoesNotExist" - "Exists" - "In" - "NotIn" scopeName string The name of the scope that the selector applies to. Possible enum values: - "BestEffort" Match all pod objects that have best effort quality of service - "CrossNamespacePodAffinity" Match all pod objects that have cross-namespace pod (anti)affinity mentioned. - "NotBestEffort" Match all pod objects that do not have best effort quality of service - "NotTerminating" Match all pod objects where spec.activeDeadlineSeconds is nil - "PriorityClass" Match all pod objects that have priority class mentioned - "Terminating" Match all pod objects where spec.activeDeadlineSeconds >=0 values array (string) An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. 8.1.5. .status Description ResourceQuotaStatus defines the enforced hard limits and observed use. Type object Property Type Description hard object (Quantity) Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ used object (Quantity) Used is the current observed total usage of the resource in the namespace. 8.2. API endpoints The following API endpoints are available: /api/v1/resourcequotas GET : list or watch objects of kind ResourceQuota /api/v1/watch/resourcequotas GET : watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead. /api/v1/namespaces/{namespace}/resourcequotas DELETE : delete collection of ResourceQuota GET : list or watch objects of kind ResourceQuota POST : create a ResourceQuota /api/v1/watch/namespaces/{namespace}/resourcequotas GET : watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead. /api/v1/namespaces/{namespace}/resourcequotas/{name} DELETE : delete a ResourceQuota GET : read the specified ResourceQuota PATCH : partially update the specified ResourceQuota PUT : replace the specified ResourceQuota /api/v1/watch/namespaces/{namespace}/resourcequotas/{name} GET : watch changes to an object of kind ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. /api/v1/namespaces/{namespace}/resourcequotas/{name}/status GET : read status of the specified ResourceQuota PATCH : partially update status of the specified ResourceQuota PUT : replace status of the specified ResourceQuota 8.2.1. /api/v1/resourcequotas HTTP method GET Description list or watch objects of kind ResourceQuota Table 8.1. HTTP responses HTTP code Reponse body 200 - OK ResourceQuotaList schema 401 - Unauthorized Empty 8.2.2. /api/v1/watch/resourcequotas HTTP method GET Description watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead. Table 8.2. HTTP responses HTTP code Reponse body 200 - OK WatchEvent schema 401 - Unauthorized Empty 8.2.3. /api/v1/namespaces/{namespace}/resourcequotas HTTP method DELETE Description delete collection of ResourceQuota Table 8.3. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed Table 8.4. HTTP responses HTTP code Reponse body 200 - OK Status schema 401 - Unauthorized Empty HTTP method GET Description list or watch objects of kind ResourceQuota Table 8.5. HTTP responses HTTP code Reponse body 200 - OK ResourceQuotaList schema 401 - Unauthorized Empty HTTP method POST Description create a ResourceQuota Table 8.6. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 8.7. Body parameters Parameter Type Description body ResourceQuota schema Table 8.8. HTTP responses HTTP code Reponse body 200 - OK ResourceQuota schema 201 - Created ResourceQuota schema 202 - Accepted ResourceQuota schema 401 - Unauthorized Empty 8.2.4. /api/v1/watch/namespaces/{namespace}/resourcequotas HTTP method GET Description watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead. Table 8.9. HTTP responses HTTP code Reponse body 200 - OK WatchEvent schema 401 - Unauthorized Empty 8.2.5. /api/v1/namespaces/{namespace}/resourcequotas/{name} Table 8.10. Global path parameters Parameter Type Description name string name of the ResourceQuota HTTP method DELETE Description delete a ResourceQuota Table 8.11. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed Table 8.12. HTTP responses HTTP code Reponse body 200 - OK ResourceQuota schema 202 - Accepted ResourceQuota schema 401 - Unauthorized Empty HTTP method GET Description read the specified ResourceQuota Table 8.13. HTTP responses HTTP code Reponse body 200 - OK ResourceQuota schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified ResourceQuota Table 8.14. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 8.15. HTTP responses HTTP code Reponse body 200 - OK ResourceQuota schema 201 - Created ResourceQuota schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified ResourceQuota Table 8.16. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 8.17. Body parameters Parameter Type Description body ResourceQuota schema Table 8.18. HTTP responses HTTP code Reponse body 200 - OK ResourceQuota schema 201 - Created ResourceQuota schema 401 - Unauthorized Empty 8.2.6. /api/v1/watch/namespaces/{namespace}/resourcequotas/{name} Table 8.19. Global path parameters Parameter Type Description name string name of the ResourceQuota HTTP method GET Description watch changes to an object of kind ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. Table 8.20. HTTP responses HTTP code Reponse body 200 - OK WatchEvent schema 401 - Unauthorized Empty 8.2.7. /api/v1/namespaces/{namespace}/resourcequotas/{name}/status Table 8.21. Global path parameters Parameter Type Description name string name of the ResourceQuota HTTP method GET Description read status of the specified ResourceQuota Table 8.22. HTTP responses HTTP code Reponse body 200 - OK ResourceQuota schema 401 - Unauthorized Empty HTTP method PATCH Description partially update status of the specified ResourceQuota Table 8.23. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 8.24. HTTP responses HTTP code Reponse body 200 - OK ResourceQuota schema 201 - Created ResourceQuota schema 401 - Unauthorized Empty HTTP method PUT Description replace status of the specified ResourceQuota Table 8.25. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 8.26. Body parameters Parameter Type Description body ResourceQuota schema Table 8.27. HTTP responses HTTP code Reponse body 200 - OK ResourceQuota schema 201 - Created ResourceQuota schema 401 - Unauthorized Empty

Commands: