Package io.fabric8.kubernetes.api.model.storage

Class CSINodeDriver

java.lang.Object

io.fabric8.kubernetes.api.model.storage.CSINodeDriver

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<CSINodeDriverBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class CSINodeDriver
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<CSINodeDriverBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CSINodeDriver()	No args constructor for use in serialization
CSINodeDriver(VolumeNodeResources allocatable, String name, String nodeID, List<String> topologyKeys)

Method Summary

Modifier and Type	Method	Description
CSINodeDriverBuilder	edit()
Map<String,Object>	getAdditionalProperties()
VolumeNodeResources	getAllocatable()	CSINodeDriver holds information about the specification of one CSI driver installed on a node
String	getName()	name represents the name of the CSI driver that this object refers to.
String	getNodeID()	nodeID of the node from the driver point of view.
List<String>	getTopologyKeys()	topologyKeys is the list of keys supported by the driver.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setAllocatable(VolumeNodeResources allocatable)	CSINodeDriver holds information about the specification of one CSI driver installed on a node
void	setName(String name)	name represents the name of the CSI driver that this object refers to.
void	setNodeID(String nodeID)	nodeID of the node from the driver point of view.
void	setTopologyKeys(List<String> topologyKeys)	topologyKeys is the list of keys supported by the driver.
CSINodeDriverBuilder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CSINodeDriver

public CSINodeDriver()

No args constructor for use in serialization

CSINodeDriver

public CSINodeDriver(VolumeNodeResources allocatable,
                     String name,
                     String nodeID,
                     List<String> topologyKeys)

Method Detail

getAllocatable

public VolumeNodeResources getAllocatable()

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

setAllocatable

public void setAllocatable(VolumeNodeResources allocatable)

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

getName

public String getName()

name represents 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.

setName

public void setName(String name)

name represents 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

public 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.

setNodeID

public void setNodeID(String nodeID)

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.

getTopologyKeys

public 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.

setTopologyKeys

public void setTopologyKeys(List<String> topologyKeys)

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.

edit

public CSINodeDriverBuilder edit()

Specified by:

edit in interface io.fabric8.kubernetes.api.builder.Editable<CSINodeDriverBuilder>

toBuilder

public CSINodeDriverBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)