# CSINode

CSINodeCSINode holds information about all CSI drivers installed on a node.apiVersion: storage.k8s.io/v1import "k8s.io/api/storage/v1"CSINodeCSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object.apiVersion: storage.k8s.io/v1kind: CSINodemetadata (ObjectMeta)Standard object's metadata. metadata.name must be the Kubernetes node name.spec (CSINodeSpec), requiredspec is the specification of CSINodeCSINodeSpecCSINodeSpec holds information about the specification of all CSI drivers installed on a nodedrivers ([]CSINodeDriver), requiredPatch strategy: merge on key nameMap: unique values on key name will be kept during a mergedrivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty.CSINodeDriver holds information about the specification of one CSI driver installed on a nodedrivers.name (string), requiredname 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.drivers.nodeID (string), requirednodeID 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.drivers.allocatable (VolumeNodeResources)allocatable represents the volume resources of a node that are available for scheduling. This field is beta.VolumeNodeResources is a set of resource limits for scheduling of volumes.drivers.allocatable.count (int32)count indicates the maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded.drivers.topologyKeys ([]string)Atomic: will be replaced during a mergetopologyKeys 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.CSINodeListCSINodeList is a collection of CSINode objects.apiVersion: storage.k8s.io/v1kind: CSINodeListmetadata (ListMeta)Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataitems ([]CSINode), requireditems is the list of CSINodeOperationsget read the specified CSINodeHTTP RequestGET /apis/storage.k8s.io/v1/csinodes/{name}Parametersname (in path): string, requiredname of the CSINodepretty (in query): stringprettyResponse200 (CSINode): OK401: Unauthorizedlist list or watch objects of kind CSINodeHTTP RequestGET /apis/storage.k8s.io/v1/csinodesParametersallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (CSINodeList): OK401: Unauthorizedcreate create a CSINodeHTTP RequestPOST /apis/storage.k8s.io/v1/csinodesParametersbody: CSINode, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (CSINode): OK201 (CSINode): Created202 (CSINode): Accepted401: Unauthorizedupdate replace the specified CSINodeHTTP RequestPUT /apis/storage.k8s.io/v1/csinodes/{name}Parametersname (in path): string, requiredname of the CSINodebody: CSINode, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (CSINode): OK201 (CSINode): Created401: Unauthorizedpatch partially update the specified CSINodeHTTP RequestPATCH /apis/storage.k8s.io/v1/csinodes/{name}Parametersname (in path): string, requiredname of the CSINodebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (CSINode): OK201 (CSINode): Created401: Unauthorizeddelete delete a CSINodeHTTP RequestDELETE /apis/storage.k8s.io/v1/csinodes/{name}Parametersname (in path): string, requiredname of the CSINodebody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (CSINode): OK202 (CSINode): Accepted401: Unauthorizeddeletecollection delete collection of CSINodeHTTP RequestDELETE /apis/storage.k8s.io/v1/csinodesParametersbody: DeleteOptionscontinue (in query): stringcontinuedryRun (in query): stringdryRunfieldSelector (in query): stringfieldSelectorgracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentiallabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondsResponse200 (Status): OK401: UnauthorizedThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.