Package org.cdk8s.plus24.k8s

Interface CsiNodeDriver

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CsiNodeDriver.Jsii$Proxy

@Generated(value="jsii-pacmak/1.72.0 (build 4b8828b)",
           date="2023-01-01T02:39:48.036Z")
@Stability(Stable)
public interface CsiNodeDriver
extends software.amazon.jsii.JsiiSerializable

CSINodeDriver holds information about the specification of one CSI driver installed on a node.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CsiNodeDriver.Builder	A builder for CsiNodeDriver
static class	CsiNodeDriver.Jsii$Proxy	An implementation for CsiNodeDriver

Method Summary

Modifier and Type	Method	Description
static CsiNodeDriver.Builder	builder()
default VolumeNodeResources	getAllocatable()	allocatable represents the volume resources of a node that are available for scheduling.
String	getName()	This is the name of the CSI driver that this object refers to.
String	getNodeId()	nodeID of the node from the driver point of view.
default List<String>	getTopologyKeys()	topologyKeys is the list of keys supported by the driver.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(Stable)
@NotNull
String getName()

This is the name of the CSI driver that this object refers to.

This MUST be the same name returned by the CSI GetPluginName() call for that driver.

getNodeId

@Stability(Stable)
@NotNull
String getNodeId()

nodeID of the node from the driver point of view.

This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required.

getAllocatable

@Stability(Stable)
@Nullable
default VolumeNodeResources getAllocatable()

allocatable represents the volume resources of a node that are available for scheduling.

This field is beta.

getTopologyKeys

@Stability(Stable)
@Nullable
default List<String> getTopologyKeys()

topologyKeys is the list of keys supported by the driver.

When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology.

builder

@Stability(Stable)
static CsiNodeDriver.Builder builder()

Returns:

a CsiNodeDriver.Builder of CsiNodeDriver