Skip to main content
Version: v1.10

FederatedResourceQuota v1alpha1

apiVersion: policy.karmada.io/v1alpha1

import "github.com/karmada-io/karmada/pkg/apis/policy/v1alpha1"

FederatedResourceQuotaโ€‹

FederatedResourceQuota sets aggregate quota restrictions enforced per namespace across all clusters.


FederatedResourceQuotaSpecโ€‹

FederatedResourceQuotaSpec defines the desired hard limits to enforce for Quota.


  • overall (map[string][Quantity](../common-definitions/quantity#quantity)), required

    Overall is the set of desired hard limits for each named resource.

  • staticAssignments ([]StaticClusterAssignment)

    StaticAssignments represents the subset of desired hard limits for each cluster. Note: for clusters not present in this list, Karmada will set an empty ResourceQuota to them, which means these clusters will have no quotas in the referencing namespace.

    StaticClusterAssignment represents the set of desired hard limits for a specific cluster.

    • staticAssignments.clusterName (string), required

      ClusterName is the name of the cluster the limits enforce to.

    • staticAssignments.hard (map[string][Quantity](../common-definitions/quantity#quantity)), required

      Hard is the set of desired hard limits for each named resource.

FederatedResourceQuotaStatusโ€‹

FederatedResourceQuotaStatus defines the enforced hard limits and observed use.


  • aggregatedStatus ([]ClusterQuotaStatus)

    AggregatedStatus is the observed quota usage of each cluster.

    ClusterQuotaStatus represents the set of desired limits and observed usage for a specific cluster.

    • aggregatedStatus.clusterName (string), required

      ClusterName is the name of the cluster the limits enforce to.

    • aggregatedStatus.hard (map[string][Quantity](../common-definitions/quantity#quantity))

      Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

    • aggregatedStatus.used (map[string][Quantity](../common-definitions/quantity#quantity))

      Used is the current observed total usage of the resource in the namespace.

  • overall (map[string][Quantity](../common-definitions/quantity#quantity))

    Overall is the set of enforced hard limits for each named resource.

  • overallUsed (map[string][Quantity](../common-definitions/quantity#quantity))

    OverallUsed is the current observed total usage of the resource in the namespace.

FederatedResourceQuotaListโ€‹

FederatedResourceQuotaList contains a list of FederatedResourceQuota.


  • apiVersion: policy.karmada.io/v1alpha1

  • kind: FederatedResourceQuotaList

  • metadata (ListMeta)

  • items ([][FederatedResourceQuota](../policy-resources/federated-resource-quota-v1alpha1#federatedresourcequota)), required

Operationsโ€‹


get read the specified FederatedResourceQuotaโ€‹

HTTP Requestโ€‹

GET /apis/policy.karmada.io/v1alpha1/namespaces/{namespace}/federatedresourcequotas/{name}

Parametersโ€‹

  • name (in path): string, required

    name of the FederatedResourceQuota

  • namespace (in path): string, required

    namespace

  • pretty (in query): string

    pretty

Responseโ€‹

200 (FederatedResourceQuota): OK

get read status of the specified FederatedResourceQuotaโ€‹

HTTP Requestโ€‹

GET /apis/policy.karmada.io/v1alpha1/namespaces/{namespace}/federatedresourcequotas/{name}/status

Parametersโ€‹

  • name (in path): string, required

    name of the FederatedResourceQuota

  • namespace (in path): string, required

    namespace

  • pretty (in query): string

    pretty

Responseโ€‹

200 (FederatedResourceQuota): OK

list list or watch objects of kind FederatedResourceQuotaโ€‹

HTTP Requestโ€‹

GET /apis/policy.karmada.io/v1alpha1/namespaces/{namespace}/federatedresourcequotas

Parametersโ€‹

Responseโ€‹

200 (FederatedResourceQuotaList): OK

list list or watch objects of kind FederatedResourceQuotaโ€‹

HTTP Requestโ€‹

GET /apis/policy.karmada.io/v1alpha1/federatedresourcequotas

Parametersโ€‹

Responseโ€‹

200 (FederatedResourceQuotaList): OK

create create a FederatedResourceQuotaโ€‹

HTTP Requestโ€‹

POST /apis/policy.karmada.io/v1alpha1/namespaces/{namespace}/federatedresourcequotas

Parametersโ€‹

Responseโ€‹

200 (FederatedResourceQuota): OK

201 (FederatedResourceQuota): Created

202 (FederatedResourceQuota): Accepted

update replace the specified FederatedResourceQuotaโ€‹

HTTP Requestโ€‹

PUT /apis/policy.karmada.io/v1alpha1/namespaces/{namespace}/federatedresourcequotas/{name}

Parametersโ€‹

Responseโ€‹

200 (FederatedResourceQuota): OK

201 (FederatedResourceQuota): Created

update replace status of the specified FederatedResourceQuotaโ€‹

HTTP Requestโ€‹

PUT /apis/policy.karmada.io/v1alpha1/namespaces/{namespace}/federatedresourcequotas/{name}/status

Parametersโ€‹

Responseโ€‹

200 (FederatedResourceQuota): OK

201 (FederatedResourceQuota): Created

patch partially update the specified FederatedResourceQuotaโ€‹

HTTP Requestโ€‹

PATCH /apis/policy.karmada.io/v1alpha1/namespaces/{namespace}/federatedresourcequotas/{name}

Parametersโ€‹

  • name (in path): string, required

    name of the FederatedResourceQuota

  • namespace (in path): string, required

    namespace

  • body: Patch, required

Responseโ€‹

200 (FederatedResourceQuota): OK

201 (FederatedResourceQuota): Created

patch partially update status of the specified FederatedResourceQuotaโ€‹

HTTP Requestโ€‹

PATCH /apis/policy.karmada.io/v1alpha1/namespaces/{namespace}/federatedresourcequotas/{name}/status

Parametersโ€‹

  • name (in path): string, required

    name of the FederatedResourceQuota

  • namespace (in path): string, required

    namespace

  • body: Patch, required

Responseโ€‹

200 (FederatedResourceQuota): OK

201 (FederatedResourceQuota): Created

delete delete a FederatedResourceQuotaโ€‹

HTTP Requestโ€‹

DELETE /apis/policy.karmada.io/v1alpha1/namespaces/{namespace}/federatedresourcequotas/{name}

Parametersโ€‹

  • name (in path): string, required

    name of the FederatedResourceQuota

  • namespace (in path): string, required

    namespace

  • body: DeleteOptions

Responseโ€‹

200 (Status): OK

202 (Status): Accepted

deletecollection delete collection of FederatedResourceQuotaโ€‹

HTTP Requestโ€‹

DELETE /apis/policy.karmada.io/v1alpha1/namespaces/{namespace}/federatedresourcequotas

Parametersโ€‹

Responseโ€‹

200 (Status): OK