Search

Chapter 2. AppliedClusterResourceQuota [quota.openshift.io/v1]

download PDF
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

PropertyTypeDescription

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

metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

ClusterResourceQuotaSpec defines the desired quota restrictions

status

object

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
PropertyTypeDescription

quota

ResourceQuotaSpec

Quota defines the desired quota

selector

object

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
PropertyTypeDescription

annotations

object (string)

AnnotationSelector is used to select projects by annotation.

labels

LabelSelector

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
PropertyTypeDescription

namespaces

array

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.

namespaces[]

object

ResourceQuotaStatusByNamespace gives status for a particular project

total

ResourceQuotaStatus

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
PropertyTypeDescription

namespace

string

Namespace the project this status applies to

status

ResourceQuotaStatus

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
Table 2.1. HTTP responses
HTTP codeReponse body

200 - OK

AppliedClusterResourceQuotaList schema

401 - Unauthorized

Empty

2.2.2. /apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas

HTTP method
GET
Description
list objects of kind AppliedClusterResourceQuota
Table 2.2. HTTP responses
HTTP codeReponse body

200 - OK

AppliedClusterResourceQuotaList schema

401 - Unauthorized

Empty

2.2.3. /apis/quota.openshift.io/v1/namespaces/{namespace}/appliedclusterresourcequotas/{name}

Table 2.3. Global path parameters
ParameterTypeDescription

name

string

name of the AppliedClusterResourceQuota

HTTP method
GET
Description
read the specified AppliedClusterResourceQuota
Table 2.4. HTTP responses
HTTP codeReponse body

200 - OK

AppliedClusterResourceQuota schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.