Skip to main content
Version: Next

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 specifies ResourceQuota settings for specific clusters. If non-empty, Karmada will create ResourceQuotas in the corresponding clusters. Clusters not listed here or when StaticAssignments is empty will have no ResourceQuotas created.

    This field addresses multi-cluster configuration management challenges by allowing centralized control over ResourceQuotas across clusters.

    Note: The Karmada scheduler currently does NOT use this configuration for scheduling decisions. Future updates may integrate it into the scheduling logic.

    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