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.
apiVersion: policy.karmada.io/v1alpha1
kind: FederatedResourceQuota
metadata (ObjectMeta)
spec (FederatedResourceQuotaSpec), required
Spec defines the desired quota.
status (FederatedResourceQuotaStatus)
Status defines the actual enforced quota and its current usage.
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
pretty (in query): string
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
pretty (in query): string
Responseโ
200 (FederatedResourceQuota): OK
list list or watch objects of kind FederatedResourceQuotaโ
HTTP Requestโ
GET /apis/policy.karmada.io/v1alpha1/namespaces/{namespace}/federatedresourcequotas
Parametersโ
namespace (in path): string, required
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
sendInitialEvents (in query): boolean
timeoutSeconds (in query): integer
watch (in query): boolean
Responseโ
200 (FederatedResourceQuotaList): OK
list list or watch objects of kind FederatedResourceQuotaโ
HTTP Requestโ
GET /apis/policy.karmada.io/v1alpha1/federatedresourcequotas
Parametersโ
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
sendInitialEvents (in query): boolean
timeoutSeconds (in query): integer
watch (in query): boolean
Responseโ
200 (FederatedResourceQuotaList): OK
create create a FederatedResourceQuotaโ
HTTP Requestโ
POST /apis/policy.karmada.io/v1alpha1/namespaces/{namespace}/federatedresourcequotas
Parametersโ
namespace (in path): string, required
body: FederatedResourceQuota, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
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โ
name (in path): string, required
name of the FederatedResourceQuota
namespace (in path): string, required
body: FederatedResourceQuota, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
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โ
name (in path): string, required
name of the FederatedResourceQuota
namespace (in path): string, required
body: FederatedResourceQuota, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
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
body: Patch, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
force (in query): boolean
pretty (in query): string
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
body: Patch, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
force (in query): boolean
pretty (in query): string
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
body: DeleteOptions
dryRun (in query): string
gracePeriodSeconds (in query): integer
ignoreStoreReadErrorWithClusterBreakingPotential (in query): boolean
pretty (in query): string
propagationPolicy (in query): string
Responseโ
200 (Status): OK
202 (Status): Accepted
deletecollection delete collection of FederatedResourceQuotaโ
HTTP Requestโ
DELETE /apis/policy.karmada.io/v1alpha1/namespaces/{namespace}/federatedresourcequotas
Parametersโ
namespace (in path): string, required
body: DeleteOptions
continue (in query): string
dryRun (in query): string
fieldSelector (in query): string
gracePeriodSeconds (in query): integer
ignoreStoreReadErrorWithClusterBreakingPotential (in query): boolean
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
propagationPolicy (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
sendInitialEvents (in query): boolean
timeoutSeconds (in query): integer
Responseโ
200 (Status): OK