Chapter 2. AppliedClusterResourceQuota [quota.openshift.io/v1]
- Description
AppliedClusterResourceQuota mirrors ClusterResourceQuota at a project scope, for projection into a project. It allows a project-admin to know which ClusterResourceQuotas are applied to his project and their associated usage.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- Type
-
object - Required
-
metadata -
spec
-
2.1. Specification
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| ClusterResourceQuotaSpec defines the desired quota restrictions |
|
|
| ClusterResourceQuotaStatus defines the actual enforced quota and its current usage |
2.1.1. .spec
- Description
- ClusterResourceQuotaSpec defines the desired quota restrictions
- Type
-
object - Required
-
selector -
quota
-
| Property | Type | Description |
|---|---|---|
|
| Quota defines the desired quota | |
|
|
| ClusterResourceQuotaSelector is used to select projects. At least one of LabelSelector or AnnotationSelector must present. If only one is present, it is the only selection criteria. If both are specified, the project must match both restrictions. |
2.1.2. .spec.selector
- Description
- ClusterResourceQuotaSelector is used to select projects. At least one of LabelSelector or AnnotationSelector must present. If only one is present, it is the only selection criteria. If both are specified, the project must match both restrictions.
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| AnnotationSelector is used to select projects by annotation. |
|
| LabelSelector is used to select projects by label. |
2.1.3. .status
- Description
- ClusterResourceQuotaStatus defines the actual enforced quota and its current usage
- Type
-
object - Required
-
total
-
| Property | Type | Description |
|---|---|---|
|
|
| Namespaces slices the usage by project. This division allows for quick resolution of deletion reconciliation inside of a single project without requiring a recalculation across all projects. This can be used to pull the deltas for a given project. |
|
|
| ResourceQuotaStatusByNamespace gives status for a particular project |
|
| Total defines the actual enforced quota and its current usage across all projects |
2.1.4. .status.namespaces
- Description
- Namespaces slices the usage by project. This division allows for quick resolution of deletion reconciliation inside of a single project without requiring a recalculation across all projects. This can be used to pull the deltas for a given project.
- Type
-
array
2.1.5. .status.namespaces[]
- Description
- ResourceQuotaStatusByNamespace gives status for a particular project
- Type
-
object - Required
-
namespace -
status
-
| Property | Type | Description |
|---|---|---|
|
|
| Namespace the project this status applies to |
|
| Status indicates how many resources have been consumed by this project |
2.2. API endpoints
The following API endpoints are available:
/apis/quota.openshift.io/v1/appliedclusterresourcequotas-
GET: list objects of kind AppliedClusterResourceQuota
-
/apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas-
GET: list objects of kind AppliedClusterResourceQuota
-
/apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas/{name}-
GET: read the specified AppliedClusterResourceQuota
-
2.2.1. /apis/quota.openshift.io/v1/appliedclusterresourcequotas
- HTTP method
-
GET - Description
- list objects of kind AppliedClusterResourceQuota
| HTTP code | Reponse body |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | Empty |
2.2.2. /apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas
- HTTP method
-
GET - Description
- list objects of kind AppliedClusterResourceQuota
| HTTP code | Reponse body |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | Empty |
2.2.3. /apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas/{name}
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the AppliedClusterResourceQuota |
- HTTP method
-
GET - Description
- read the specified AppliedClusterResourceQuota
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
