kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
website/content/en/docs/tasks/administer-cluster/manage-resources/quota-pod-namespace.md

4.0 KiB
Raw Blame History

title content_type weight description
Configure a Pod Quota for a Namespace task 60 Restrict how many Pods you can create within a namespace.

This page shows how to set a quota for the total number of Pods that can run in a {{< glossary_tooltip text="Namespace" term_id="namespace" >}}. You specify quotas in a ResourceQuota object.

{{% heading "prerequisites" %}}

{{< include "task-tutorial-prereqs.md" >}}

You must have access to create namespaces in your cluster.

Create a namespace

Create a namespace so that the resources you create in this exercise are isolated from the rest of your cluster.

kubectl create namespace quota-pod-example

Create a ResourceQuota

Here is an example manifest for a ResourceQuota:

{{% code file="admin/resource/quota-pod.yaml" %}}

Create the ResourceQuota:

kubectl apply -f https://k8s.io/examples/admin/resource/quota-pod.yaml --namespace=quota-pod-example

View detailed information about the ResourceQuota:

kubectl get resourcequota pod-demo --namespace=quota-pod-example --output=yaml

The output shows that the namespace has a quota of two Pods, and that currently there are no Pods; that is, none of the quota is used.

spec:
  hard:
    pods: "2"
status:
  hard:
    pods: "2"
  used:
    pods: "0"

Here is an example manifest for a {{< glossary_tooltip term_id="deployment" >}}:

{{% code file="admin/resource/quota-pod-deployment.yaml" %}}

In that manifest, replicas: 3 tells Kubernetes to attempt to create three new Pods, all running the same application.

Create the Deployment:

kubectl apply -f https://k8s.io/examples/admin/resource/quota-pod-deployment.yaml --namespace=quota-pod-example

View detailed information about the Deployment:

kubectl get deployment pod-quota-demo --namespace=quota-pod-example --output=yaml

The output shows that even though the Deployment specifies three replicas, only two Pods were created because of the quota you defined earlier:

spec:
  ...
  replicas: 3
...
status:
  availableReplicas: 2
...
lastUpdateTime: 2021-04-02T20:57:05Z
    message: 'unable to create pods: pods "pod-quota-demo-1650323038-" is forbidden:
      exceeded quota: pod-demo, requested: pods=1, used: pods=2, limited: pods=2'

Choice of resource

In this task you have defined a ResourceQuota that limited the total number of Pods, but you could also limit the total number of other kinds of object. For example, you might decide to limit how many {{< glossary_tooltip text="CronJobs" term_id="cronjob" >}} that can live in a single namespace.

Clean up

Delete your namespace:

kubectl delete namespace quota-pod-example

{{% heading "whatsnext" %}}

For cluster administrators

For app developers