Skip to content

resource_v1alpha3

AllocatedDeviceStatus

class lightkube.models.resource_v1alpha3.AllocatedDeviceStatus(device, driver, pool, conditions=None, data=None, networkData=None)

AllocatedDeviceStatus contains the status of an allocated device, if the driver chooses to report it. This may include driver-specific information.

parameters

  • device str - Device references one device instance via its name in the driver's resource pool. It must be a DNS label.
  • driver str - Driver specifies the name of the DRA driver whose kubelet plugin should be invoked to process the allocation once the claim is needed on a node. Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver.
  • pool str - This name together with the driver name and the device name field identify which device was allocated (<driver name>/<pool name>/<device name>). Must not be longer than 253 characters and may contain one or more DNS sub-domains separated by slashes.
  • conditions Optional[List[meta_v1.Condition]] - Conditions contains the latest observation of the device's state. If the device has been configured according to the class and claim config references, the Ready condition should be True.
  • data Optional[runtime.RawExtension] - Data contains arbitrary driver-specific data. The length of the raw data must be smaller or equal to 10 Ki.
  • networkData Optional[NetworkDeviceData] - NetworkData contains network-related information specific to the device.

AllocationResult

class lightkube.models.resource_v1alpha3.AllocationResult(devices=None, nodeSelector=None)

AllocationResult contains attributes of an allocated resource.

parameters

  • devices Optional[DeviceAllocationResult] - Devices is the result of allocating devices.
  • nodeSelector Optional[core_v1.NodeSelector] - NodeSelector defines where the allocated resources are available. If unset, they are available everywhere.

BasicDevice

class lightkube.models.resource_v1alpha3.BasicDevice(attributes=None, capacity=None)

BasicDevice defines one device instance.

parameters

  • attributes Optional[dict] - Attributes defines the set of attributes for this device. The name of each attribute must be unique in that set. The maximum number of attributes and capacities combined is 32.
  • capacity Optional[dict] - Capacity defines the set of capacities for this device. The name of each capacity must be unique in that set. The maximum number of attributes and capacities combined is 32.

CELDeviceSelector

class lightkube.models.resource_v1alpha3.CELDeviceSelector(expression)

CELDeviceSelector contains a CEL expression for selecting a device.

parameters

  • expression str - Expression is a CEL expression which evaluates a single device. It must evaluate to true when the device under consideration satisfies the desired criteria, and false when it does not. Any other result is an error and causes allocation of devices to abort. The expression's input is an object named "device", which carries the following properties:
  • driver (string): the name of the driver which defines this device.
  • attributes (map[string]object): the device's attributes, grouped by prefix (e.g. device.attributes["dra.example.com"] evaluates to an object with all of the attributes which were prefixed by "dra.example.com".
  • capacity (map[string]object): the device's capacities, grouped by prefix. Example: Consider a device with driver="dra.example.com", which exposes two attributes named "model" and "ext.example.com/family" and which exposes one capacity named "modules". This input to this expression would have the following fields: device.driver device.attributes["dra.example.com"].model device.attributes["ext.example.com"].family device.capacity["dra.example.com"].modules The device.driver field can be used to check for a specific driver, either as a high-level precondition (i.e. you only want to consider devices from this driver) or as part of a multi-clause expression that is meant to consider devices from different drivers. The value type of each attribute is defined by the device definition, and users who write these expressions must consult the documentation for their specific drivers. The value type of each capacity is Quantity. If an unknown prefix is used as a lookup in either device.attributes or device.capacity, an empty map will be returned. Any reference to an unknown field will cause an evaluation error and allocation to abort. A robust expression should check for the existence of attributes before referencing them. For ease of use, the cel.bind() function is enabled, and can be used to simplify expressions that access multiple attributes with the same domain. For example: cel.bind(dra, device.attributes["dra.example.com"], dra.someBool && dra.anotherBool) The length of the expression must be smaller or equal to 10 Ki. The cost of evaluating it is also limited based on the estimated number of logical steps.

Device

class lightkube.models.resource_v1alpha3.Device(name, basic=None)

Device represents one individual hardware instance that can be selected based on its attributes. Besides the name, exactly one field must be set.

parameters

  • name str - Name is unique identifier among all devices managed by the driver in the pool. It must be a DNS label.
  • basic Optional[BasicDevice] - Basic defines one device instance.

DeviceAllocationConfiguration

class lightkube.models.resource_v1alpha3.DeviceAllocationConfiguration(source, opaque=None, requests=None)

DeviceAllocationConfiguration gets embedded in an AllocationResult.

parameters

  • source str - Source records whether the configuration comes from a class and thus is not something that a normal user would have been able to set or from a claim.
  • opaque Optional[OpaqueDeviceConfiguration] - Opaque provides driver-specific configuration parameters.
  • requests Optional[List[str]] - Requests lists the names of requests where the configuration applies. If empty, its applies to all requests.

DeviceAllocationResult

class lightkube.models.resource_v1alpha3.DeviceAllocationResult(config=None, results=None)

DeviceAllocationResult is the result of allocating devices.

parameters

  • config Optional[List[DeviceAllocationConfiguration]] - This field is a combination of all the claim and class configuration parameters. Drivers can distinguish between those based on a flag. This includes configuration parameters for drivers which have no allocated devices in the result because it is up to the drivers which configuration parameters they support. They can silently ignore unknown configuration parameters.
  • results Optional[List[DeviceRequestAllocationResult]] - Results lists all allocated devices.

DeviceAttribute

class lightkube.models.resource_v1alpha3.DeviceAttribute(bool=None, int=None, string=None, version=None)

DeviceAttribute must have exactly one field set.

parameters

  • bool Optional[bool] - BoolValue is a true/false value.
  • int Optional[int] - IntValue is a number.
  • string Optional[str] - StringValue is a string. Must not be longer than 64 characters.
  • version Optional[str] - VersionValue is a semantic version according to semver.org spec 2.0.0. Must not be longer than 64 characters.

DeviceClaim

class lightkube.models.resource_v1alpha3.DeviceClaim(config=None, constraints=None, requests=None)

DeviceClaim defines how to request devices with a ResourceClaim.

parameters

  • config Optional[List[DeviceClaimConfiguration]] - This field holds configuration for multiple potential drivers which could satisfy requests in this claim. It is ignored while allocating the claim.
  • constraints Optional[List[DeviceConstraint]] - These constraints must be satisfied by the set of devices that get allocated for the claim.
  • requests Optional[List[DeviceRequest]] - Requests represent individual requests for distinct devices which must all be satisfied. If empty, nothing needs to be allocated.

DeviceClaimConfiguration

class lightkube.models.resource_v1alpha3.DeviceClaimConfiguration(opaque=None, requests=None)

DeviceClaimConfiguration is used for configuration parameters in DeviceClaim.

parameters

  • opaque Optional[OpaqueDeviceConfiguration] - Opaque provides driver-specific configuration parameters.
  • requests Optional[List[str]] - Requests lists the names of requests where the configuration applies. If empty, it applies to all requests.

DeviceClass

class lightkube.models.resource_v1alpha3.DeviceClass(spec, apiVersion=None, kind=None, metadata=None)

DeviceClass is a vendor- or admin-provided resource that contains device configuration and selectors. It can be referenced in the device requests of a claim to apply these presets. Cluster scoped.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

parameters

  • spec DeviceClassSpec - Spec defines what can be allocated and how to configure it. This is mutable. Consumers have to be prepared for classes changing at any time, either because they get updated or replaced. Claim allocations are done once based on whatever was set in classes at the time of allocation. Changing the spec automatically increments the metadata.generation number.
  • apiVersion Optional[str] - APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind Optional[str] - Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata Optional[meta_v1.ObjectMeta] - Standard object metadata

DeviceClassConfiguration

class lightkube.models.resource_v1alpha3.DeviceClassConfiguration(opaque=None)

DeviceClassConfiguration is used in DeviceClass.

parameters

DeviceClassList

class lightkube.models.resource_v1alpha3.DeviceClassList(items, apiVersion=None, kind=None, metadata=None)

DeviceClassList is a collection of classes.

parameters

  • items List[DeviceClass] - Items is the list of resource classes.
  • apiVersion Optional[str] - APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind Optional[str] - Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata Optional[meta_v1.ListMeta] - Standard list metadata

DeviceClassSpec

class lightkube.models.resource_v1alpha3.DeviceClassSpec(config=None, selectors=None)

DeviceClassSpec is used in a [DeviceClass] to define what can be allocated and how to configure it.

parameters

  • config Optional[List[DeviceClassConfiguration]] - Config defines configuration parameters that apply to each device that is claimed via this class. Some classses may potentially be satisfied by multiple drivers, so each instance of a vendor configuration applies to exactly one driver. They are passed to the driver, but are not considered while allocating the claim.
  • selectors Optional[List[DeviceSelector]] - Each selector must be satisfied by a device which is claimed via this class.

DeviceConstraint

class lightkube.models.resource_v1alpha3.DeviceConstraint(matchAttribute=None, requests=None)

DeviceConstraint must have exactly one field set besides Requests.

parameters

  • matchAttribute Optional[str] - MatchAttribute requires that all devices in question have this attribute and that its type and value are the same across those devices. For example, if you specified "dra.example.com/numa" (a hypothetical example!), then only devices in the same NUMA node will be chosen. A device which does not have that attribute will not be chosen. All devices should use a value of the same type for this attribute because that is part of its specification, but if one device doesn't, then it also will not be chosen. Must include the domain qualifier.
  • requests Optional[List[str]] - Requests is a list of the one or more requests in this claim which must co-satisfy this constraint. If a request is fulfilled by multiple devices, then all of the devices must satisfy the constraint. If this is not specified, this constraint applies to all requests in this claim.

DeviceRequest

class lightkube.models.resource_v1alpha3.DeviceRequest(deviceClassName, name, adminAccess=None, allocationMode=None, count=None, selectors=None)

DeviceRequest is a request for devices required for a claim. This is typically a request for a single resource like a device, but can also ask for several identical devices.

A DeviceClassName is currently required. Clients must check that it is indeed set. It's absence indicates that something changed in a way that is not supported by the client yet, in which case it must refuse to handle the request.

parameters

  • deviceClassName str - DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request. A class is required. Which classes are available depends on the cluster. Administrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference.
  • name str - Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim. Must be a DNS label.
  • adminAccess Optional[bool] - AdminAccess indicates that this is a claim for administrative access to the device(s). Claims with AdminAccess are expected to be used for monitoring or other management services for a device. They ignore all ordinary claims to the device with respect to access modes and any resource allocations. This is an alpha field and requires enabling the DRAAdminAccess feature gate. Admin access is disabled if this field is unset or set to false, otherwise it is enabled.
  • allocationMode Optional[str] - AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:
  • ExactCount: This request is for a specific number of devices. This is the default. The exact number is provided in the count field.
  • All: This request is for all of the matching devices in a pool. Allocation will fail if some devices are already allocated, unless adminAccess is requested. If AlloctionMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other requests must specify this field. More modes may get added in the future. Clients must refuse to handle requests with unknown modes.
  • count Optional[int] - Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.
  • selectors Optional[List[DeviceSelector]] - Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.

DeviceRequestAllocationResult

class lightkube.models.resource_v1alpha3.DeviceRequestAllocationResult(device, driver, pool, request, adminAccess=None)

DeviceRequestAllocationResult contains the allocation result for one request.

parameters

  • device str - Device references one device instance via its name in the driver's resource pool. It must be a DNS label.
  • driver str - Driver specifies the name of the DRA driver whose kubelet plugin should be invoked to process the allocation once the claim is needed on a node. Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver.
  • pool str - This name together with the driver name and the device name field identify which device was allocated (<driver name>/<pool name>/<device name>). Must not be longer than 253 characters and may contain one or more DNS sub-domains separated by slashes.
  • request str - Request is the name of the request in the claim which caused this device to be allocated. Multiple devices may have been allocated per request.
  • adminAccess Optional[bool] - AdminAccess indicates that this device was allocated for administrative access. See the corresponding request field for a definition of mode. This is an alpha field and requires enabling the DRAAdminAccess feature gate. Admin access is disabled if this field is unset or set to false, otherwise it is enabled.

DeviceSelector

class lightkube.models.resource_v1alpha3.DeviceSelector(cel=None)

DeviceSelector must have exactly one field set.

parameters

  • cel Optional[CELDeviceSelector] - CEL contains a CEL expression for selecting a device.

NetworkDeviceData

class lightkube.models.resource_v1alpha3.NetworkDeviceData(hardwareAddress=None, interfaceName=None, ips=None)

NetworkDeviceData provides network-related details for the allocated device. This information may be filled by drivers or other components to configure or identify the device within a network context.

parameters

  • hardwareAddress Optional[str] - HardwareAddress represents the hardware address (e.g. MAC Address) of the device's network interface. Must not be longer than 128 characters.
  • interfaceName Optional[str] - InterfaceName specifies the name of the network interface associated with the allocated device. This might be the name of a physical or virtual network interface being configured in the pod. Must not be longer than 256 characters.
  • ips Optional[List[str]] - IPs lists the network addresses assigned to the device's network interface. This can include both IPv4 and IPv6 addresses. The IPs are in the CIDR notation, which includes both the address and the associated subnet mask. e.g.: "192.0.2.5/24" for IPv4 and "2001:db8::5/64" for IPv6.

OpaqueDeviceConfiguration

class lightkube.models.resource_v1alpha3.OpaqueDeviceConfiguration(driver, parameters)

OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor.

parameters

  • driver str - Driver is used to determine which kubelet plugin needs to be passed these configuration parameters. An admission policy provided by the driver developer could use this to decide whether it needs to validate them. Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver.
  • parameters runtime.RawExtension - Parameters can contain arbitrary data. It is the responsibility of the driver developer to handle validation and versioning. Typically this includes self-identification and a version ("kind" + "apiVersion" for Kubernetes types), with conversion between different versions. The length of the raw data must be smaller or equal to 10 Ki.

ResourceClaim

class lightkube.models.resource_v1alpha3.ResourceClaim(spec, apiVersion=None, kind=None, metadata=None, status=None)

ResourceClaim describes a request for access to resources in the cluster, for use by workloads. For example, if a workload needs an accelerator device with specific properties, this is how that request is expressed. The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

parameters

  • spec ResourceClaimSpec - Spec describes what is being requested and how to configure it. The spec is immutable.
  • apiVersion Optional[str] - APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind Optional[str] - Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata Optional[meta_v1.ObjectMeta] - Standard object metadata
  • status Optional[ResourceClaimStatus] - Status describes whether the claim is ready to use and what has been allocated.

ResourceClaimConsumerReference

class lightkube.models.resource_v1alpha3.ResourceClaimConsumerReference(name, resource, uid, apiGroup=None)

ResourceClaimConsumerReference contains enough information to let you locate the consumer of a ResourceClaim. The user must be a resource in the same namespace as the ResourceClaim.

parameters

  • name str - Name is the name of resource being referenced.
  • resource str - Resource is the type of resource being referenced, for example "pods".
  • uid str - UID identifies exactly one incarnation of the resource.
  • apiGroup Optional[str] - APIGroup is the group for the resource being referenced. It is empty for the core API. This matches the group in the APIVersion that is used when creating the resources.

ResourceClaimList

class lightkube.models.resource_v1alpha3.ResourceClaimList(items, apiVersion=None, kind=None, metadata=None)

ResourceClaimList is a collection of claims.

parameters

  • items List[ResourceClaim] - Items is the list of resource claims.
  • apiVersion Optional[str] - APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind Optional[str] - Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata Optional[meta_v1.ListMeta] - Standard list metadata

ResourceClaimSpec

class lightkube.models.resource_v1alpha3.ResourceClaimSpec(devices=None)

ResourceClaimSpec defines what is being requested in a ResourceClaim and how to configure it.

parameters

  • devices Optional[DeviceClaim] - Devices defines how to request devices.

ResourceClaimStatus

class lightkube.models.resource_v1alpha3.ResourceClaimStatus(allocation=None, devices=None, reservedFor=None)

ResourceClaimStatus tracks whether the resource has been allocated and what the result of that was.

parameters

  • allocation Optional[AllocationResult] - Allocation is set once the claim has been allocated successfully.
  • devices Optional[List[AllocatedDeviceStatus]] - Devices contains the status of each device allocated for this claim, as reported by the driver. This can include driver-specific information. Entries are owned by their respective drivers.
  • reservedFor Optional[List[ResourceClaimConsumerReference]] - ReservedFor indicates which entities are currently allowed to use the claim. A Pod which references a ResourceClaim which is not reserved for that Pod will not be started. A claim that is in use or might be in use because it has been reserved must not get deallocated. In a cluster with multiple scheduler instances, two pods might get scheduled concurrently by different schedulers. When they reference the same ResourceClaim which already has reached its maximum number of consumers, only one pod can be scheduled. Both schedulers try to add their pod to the claim.status.reservedFor field, but only the update that reaches the API server first gets stored. The other one fails with an error and the scheduler which issued it knows that it must put the pod back into the queue, waiting for the ResourceClaim to become usable again. There can be at most 32 such reservations. This may get increased in the future, but not reduced.

ResourceClaimTemplate

class lightkube.models.resource_v1alpha3.ResourceClaimTemplate(spec, apiVersion=None, kind=None, metadata=None)

ResourceClaimTemplate is used to produce ResourceClaim objects.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

parameters

  • spec ResourceClaimTemplateSpec - Describes the ResourceClaim that is to be generated. This field is immutable. A ResourceClaim will get created by the control plane for a Pod when needed and then not get updated anymore.
  • apiVersion Optional[str] - APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind Optional[str] - Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata Optional[meta_v1.ObjectMeta] - Standard object metadata

ResourceClaimTemplateList

class lightkube.models.resource_v1alpha3.ResourceClaimTemplateList(items, apiVersion=None, kind=None, metadata=None)

ResourceClaimTemplateList is a collection of claim templates.

parameters

  • items List[ResourceClaimTemplate] - Items is the list of resource claim templates.
  • apiVersion Optional[str] - APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind Optional[str] - Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata Optional[meta_v1.ListMeta] - Standard list metadata

ResourceClaimTemplateSpec

class lightkube.models.resource_v1alpha3.ResourceClaimTemplateSpec(spec, metadata=None)

ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim.

parameters

  • spec ResourceClaimSpec - Spec for the ResourceClaim. The entire content is copied unchanged into the ResourceClaim that gets created from this template. The same fields as in a ResourceClaim are also valid here.
  • metadata Optional[meta_v1.ObjectMeta] - ObjectMeta may contain labels and annotations that will be copied into the ResourceClaim when creating it. No other fields are allowed and will be rejected during validation.

ResourcePool

class lightkube.models.resource_v1alpha3.ResourcePool(generation, name, resourceSliceCount)

ResourcePool describes the pool that ResourceSlices belong to.

parameters

  • generation int - Generation tracks the change in a pool over time. Whenever a driver changes something about one or more of the resources in a pool, it must change the generation in all ResourceSlices which are part of that pool. Consumers of ResourceSlices should only consider resources from the pool with the highest generation number. The generation may be reset by drivers, which should be fine for consumers, assuming that all ResourceSlices in a pool are updated to match or deleted. Combined with ResourceSliceCount, this mechanism enables consumers to detect pools which are comprised of multiple ResourceSlices and are in an incomplete state.
  • name str - Name is used to identify the pool. For node-local devices, this is often the node name, but this is not required. It must not be longer than 253 characters and must consist of one or more DNS sub-domains separated by slashes. This field is immutable.
  • resourceSliceCount int - ResourceSliceCount is the total number of ResourceSlices in the pool at this generation number. Must be greater than zero. Consumers can use this to check whether they have seen all ResourceSlices belonging to the same pool.

ResourceSlice

class lightkube.models.resource_v1alpha3.ResourceSlice(spec, apiVersion=None, kind=None, metadata=None)

ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver. A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver.

At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple , , .

Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others.

When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool.

For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available.

This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

parameters

  • spec ResourceSliceSpec - Contains the information published by the driver. Changing the spec automatically increments the metadata.generation number.
  • apiVersion Optional[str] - APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind Optional[str] - Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata Optional[meta_v1.ObjectMeta] - Standard object metadata

ResourceSliceList

class lightkube.models.resource_v1alpha3.ResourceSliceList(items, apiVersion=None, kind=None, metadata=None)

ResourceSliceList is a collection of ResourceSlices.

parameters

  • items List[ResourceSlice] - Items is the list of resource ResourceSlices.
  • apiVersion Optional[str] - APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind Optional[str] - Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata Optional[meta_v1.ListMeta] - Standard list metadata

ResourceSliceSpec

class lightkube.models.resource_v1alpha3.ResourceSliceSpec(driver, pool, allNodes=None, devices=None, nodeName=None, nodeSelector=None)

ResourceSliceSpec contains the information published by the driver in one ResourceSlice.

parameters

  • driver str - Driver identifies the DRA driver providing the capacity information. A field selector can be used to list only ResourceSlice objects with a certain driver name. Must be a DNS subdomain and should end with a DNS domain owned by the vendor of the driver. This field is immutable.
  • pool ResourcePool - Pool describes the pool that this ResourceSlice belongs to.
  • allNodes Optional[bool] - AllNodes indicates that all nodes have access to the resources in the pool. Exactly one of NodeName, NodeSelector and AllNodes must be set.
  • devices Optional[List[Device]] - Devices lists some or all of the devices in this pool. Must not have more than 128 entries.
  • nodeName Optional[str] - NodeName identifies the node which provides the resources in this pool. A field selector can be used to list only ResourceSlice objects belonging to a certain node. This field can be used to limit access from nodes to ResourceSlices with the same node name. It also indicates to autoscalers that adding new nodes of the same type as some old node might also make new resources available. Exactly one of NodeName, NodeSelector and AllNodes must be set. This field is immutable.
  • nodeSelector Optional[core_v1.NodeSelector] - NodeSelector defines which nodes have access to the resources in the pool, when that pool is not limited to a single node. Must use exactly one term. Exactly one of NodeName, NodeSelector and AllNodes must be set.