Allocate Devices to Workloads with DRA
Kubernetes Docs · نسخهٔ f284a9e7c87f · CC BY 4.0 برای مستندات و مجوزهای همراه
{{< feature-state feature_gate_name="DynamicResourceAllocation" >}}
<!-- overview -->
This page shows you how to allocate devices to your Pods by using _dynamic resource allocation (DRA)_. These instructions are for workload operators. Before reading this page, familiarize yourself with how DRA works and with DRA terminology like {{< glossary_tooltip text="ResourceClaims" term_id="resourceclaim" >}} and {{< glossary_tooltip text="ResourceClaimTemplates" term_id="resourceclaimtemplate" >}}. For more information, see Dynamic Resource Allocation (DRA).
<!-- body -->
About device allocation with DRA {#about-device-allocation-dra}
As a workload operator, you can _claim_ devices for your workloads by creating ResourceClaims or ResourceClaimTemplates. When you deploy your workload, Kubernetes and the device drivers find available devices, allocate them to your Pods, and place the Pods on nodes that can access those devices.
<!-- prerequisites -->
{{% heading "prerequisites" %}}
{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}}
- Ensure that your cluster admin has set up DRA, attached devices, and installed
drivers. For more information, see Set Up DRA in a Cluster.
<!-- steps -->
Identify devices to claim {#identify-devices}
Your cluster administrator or the device drivers create _{{< glossary_tooltip term_id="deviceclass" text="DeviceClasses" >}}_ that define categories of devices. You can claim devices by using {{< glossary_tooltip term_id="cel" >}} to filter for specific device properties.
Get a list of DeviceClasses in the cluster:
kubectl get deviceclassesThe output is similar to the following:
NAME AGE
driver.example.com 16mIf you get a permission error, you might not have access to get DeviceClasses. Check with your cluster administrator or with the driver provider for available device properties.
Claim resources {#claim-resources}
You can request resources from a DeviceClass by using {{< glossary_tooltip text="ResourceClaims" term_id="resourceclaim" >}}. To create a ResourceClaim, do one of the following:
- Manually create a ResourceClaim if you want multiple Pods to share access to
the same devices, or if you want a claim to exist beyond the lifetime of a Pod.
- Use a
{{< glossary_tooltip text="ResourceClaimTemplate" term_id="resourceclaimtemplate" >}} to let Kubernetes generate and manage per-Pod ResourceClaims. Create a ResourceClaimTemplate if you want every Pod to have access to separate devices that have similar configurations. For example, you might want simultaneous access to devices for Pods in a Job that uses parallel execution.
If you directly reference a specific ResourceClaim in a Pod, that ResourceClaim must already exist in the cluster. If a referenced ResourceClaim doesn't exist, the Pod remains in a pending state until the ResourceClaim is created. You can reference an auto-generated ResourceClaim in a Pod, but this isn't recommended because auto-generated ResourceClaims are bound to the lifetime of the Pod that triggered the generation.
To create a workload that claims resources, select one of the following options:
{{< tabs name="claim-resources" >}} {{% tab name="ResourceClaimTemplate" %}}
Review the following example manifest:
{{% code_sample file="dra/resourceclaimtemplate.yaml" %}}
This manifest creates a ResourceClaimTemplate that requests devices in the example-device-class DeviceClass that match both of the following parameters:
- Devices that have a
driver.example.com/typeattribute with a value of
gpu.
- Devices that have
64Giof capacity.
To create the ResourceClaimTemplate, run the following command:
kubectl apply -f https://k8s.io/examples/dra/resourceclaimtemplate.yaml{{% /tab %}} {{% tab name="ResourceClaim" %}}
Review the following example manifest:
{{% code_sample file="dra/resourceclaim.yaml" %}}
This manifest creates ResourceClaim that requests devices in the example-device-class DeviceClass that match both of the following parameters:
- Devices that have a
driver.example.com/typeattribute with a value of
gpu.
- Devices that have
64Giof capacity.
To create the ResourceClaim, run the following command:
kubectl apply -f https://k8s.io/examples/dra/resourceclaim.yaml{{% /tab %}} {{< /tabs >}}
Request devices in workloads using DRA {#request-devices-workloads}
To request device allocation, specify a ResourceClaim or a ResourceClaimTemplate in the resourceClaims field of the Pod specification. Then, request a specific claim by name in the resources.claims field of a container in that Pod. You can specify multiple entries in the resourceClaims field and use specific claims in different containers.
- Review the following example Job:
{{% code_sample file="dra/dra-example-job.yaml" %}}
Each Pod in this Job has the following properties:
- Makes a ResourceClaimTemplate named
separate-gpu-claimand a
ResourceClaim named shared-gpu-claim available to containers.
- Runs the following containers:
container0requests the devices from theseparate-gpu-claim
ResourceClaimTemplate.
container1andcontainer2share access to the devices from the
shared-gpu-claim ResourceClaim.
- Create the Job:
kubectl apply -f https://k8s.io/examples/dra/dra-example-job.yamlTry the following troubleshooting steps:
- When the workload does not start as expected, drill down from Job
to Pods to ResourceClaims and check the objects at each level with kubectl describe to see whether there are any status fields or events which might explain why the workload is not starting.
- When creating a Pod fails with `must specify one of: resourceClaimName,
resourceClaimTemplateName, check that all entries in pod.spec.resourceClaims` have exactly one of those fields set. If they do, then it is possible that the cluster has a mutating Pod webhook installed which was built against APIs from Kubernetes < 1.32. Work with your cluster administrator to check this.
Clean up {#clean-up}
To delete the Kubernetes objects that you created in this task, follow these steps:
- Delete the example Job:
kubectl delete -f https://k8s.io/examples/dra/dra-example-job.yaml- To delete your resource claims, run one of the following commands:
- Delete the ResourceClaimTemplate:
kubectl delete -f https://k8s.io/examples/dra/resourceclaimtemplate.yaml- Delete the ResourceClaim:
kubectl delete -f https://k8s.io/examples/dra/resourceclaim.yaml{{% heading "whatsnext" %}}
- Learn more about DRA