kubernetes-models
Version:
34 lines (33 loc) • 2.32 kB
TypeScript
import { IIoK8sApimachineryPkgApiResourceQuantity } from "@kubernetes-models/apimachinery/api/resource/Quantity";
import { ModelData, Model } from "@kubernetes-models/base";
/**
* CapacityRequirements defines the capacity requirements for a specific device request.
*/
export interface ICapacityRequirements {
/**
* Requests represent individual device resource requests for distinct resources, all of which must be provided by the device.
*
* This value is used as an additional filtering condition against the available capacity on the device. This is semantically equivalent to a CEL selector with `device.capacity[<domain>].<name>.compareTo(quantity(<request quantity>)) >= 0`. For example, device.capacity['test-driver.cdi.k8s.io'].counters.compareTo(quantity('2')) >= 0.
*
* When a requestPolicy is defined, the requested amount is adjusted upward to the nearest valid value based on the policy. If the requested amount cannot be adjusted to a valid value—because it exceeds what the requestPolicy allows— the device is considered ineligible for allocation.
*
* For any capacity that is not explicitly requested: - If no requestPolicy is set, the default consumed capacity is equal to the full device capacity
* (i.e., the whole device is claimed).
* - If a requestPolicy is set, the default consumed capacity is determined according to that policy.
*
* If the device allows multiple allocation, the aggregated amount across all requests must not exceed the capacity value. The consumed capacity, which may be adjusted based on the requestPolicy if defined, is recorded in the resource claim’s status.devices[\*].consumedCapacity field.
*/
"requests"?: {
[key: string]: IIoK8sApimachineryPkgApiResourceQuantity;
};
}
/**
* CapacityRequirements defines the capacity requirements for a specific device request.
*/
export declare class CapacityRequirements extends Model<ICapacityRequirements> implements ICapacityRequirements {
"requests"?: {
[key: string]: IIoK8sApimachineryPkgApiResourceQuantity;
};
constructor(data?: ModelData<ICapacityRequirements>);
}
export type { ICapacityRequirements as IIoK8sApiResourceV1CapacityRequirements, CapacityRequirements as IoK8sApiResourceV1CapacityRequirements };