Package-level declarations

Types

Link copied to clipboard
data class CSIDriverArgs(val apiVersion: Output<String>? = null, val kind: Output<String>? = null, val metadata: Output<ObjectMetaArgs>? = null, val spec: Output<CSIDriverSpecArgs>) : ConvertibleToJava<CSIDriverArgs>

CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced.

Link copied to clipboard
Link copied to clipboard
data class CSIDriverSpecArgs(val attachRequired: Output<Boolean>? = null, val fsGroupPolicy: Output<String>? = null, val podInfoOnMount: Output<Boolean>? = null, val requiresRepublish: Output<Boolean>? = null, val storageCapacity: Output<Boolean>? = null, val tokenRequests: Output<List<TokenRequestArgs>>? = null, val volumeLifecycleModes: Output<List<String>>? = null) : ConvertibleToJava<CSIDriverSpecArgs>

CSIDriverSpec is the specification of a CSIDriver.

Link copied to clipboard
Link copied to clipboard
data class CSIDriverSpecPatchArgs(val attachRequired: Output<Boolean>? = null, val fsGroupPolicy: Output<String>? = null, val podInfoOnMount: Output<Boolean>? = null, val requiresRepublish: Output<Boolean>? = null, val storageCapacity: Output<Boolean>? = null, val tokenRequests: Output<List<TokenRequestPatchArgs>>? = null, val volumeLifecycleModes: Output<List<String>>? = null) : ConvertibleToJava<CSIDriverSpecPatchArgs>

CSIDriverSpec is the specification of a CSIDriver.

Link copied to clipboard
data class CSINodeArgs(val apiVersion: Output<String>? = null, val kind: Output<String>? = null, val metadata: Output<ObjectMetaArgs>? = null, val spec: Output<CSINodeSpecArgs>) : ConvertibleToJava<CSINodeArgs>

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

Link copied to clipboard
Link copied to clipboard
data class CSINodeDriverArgs(val allocatable: Output<VolumeNodeResourcesArgs>? = null, val name: Output<String>, val nodeID: Output<String>, val topologyKeys: Output<List<String>>? = null) : ConvertibleToJava<CSINodeDriverArgs>

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

Link copied to clipboard
Link copied to clipboard
data class CSINodeDriverPatchArgs(val allocatable: Output<VolumeNodeResourcesPatchArgs>? = null, val name: Output<String>? = null, val nodeID: Output<String>? = null, val topologyKeys: Output<List<String>>? = null) : ConvertibleToJava<CSINodeDriverPatchArgs>

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

Link copied to clipboard
data class CSINodeSpecArgs(val drivers: Output<List<CSINodeDriverArgs>>) : ConvertibleToJava<CSINodeSpecArgs>

CSINodeSpec holds information about the specification of all CSI drivers installed on a node

Link copied to clipboard
Link copied to clipboard
data class CSINodeSpecPatchArgs(val drivers: Output<List<CSINodeDriverPatchArgs>>? = null) : ConvertibleToJava<CSINodeSpecPatchArgs>

CSINodeSpec holds information about the specification of all CSI drivers installed on a node

Link copied to clipboard
data class CSIStorageCapacityArgs(val apiVersion: Output<String>? = null, val capacity: Output<String>? = null, val kind: Output<String>? = null, val maximumVolumeSize: Output<String>? = null, val metadata: Output<ObjectMetaArgs>? = null, val nodeTopology: Output<LabelSelectorArgs>? = null, val storageClassName: Output<String>) : ConvertibleToJava<CSIStorageCapacityArgs>

CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes. For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123" The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero The producer of these objects can decide which approach is more suitable. They are consumed by the kube-scheduler when a CSI driver opts into capacity-aware scheduling with CSIDriverSpec.StorageCapacity. The scheduler compares the MaximumVolumeSize against the requested size of pending volumes to filter out unsuitable nodes. If MaximumVolumeSize is unset, it falls back to a comparison against the less precise Capacity. If that is also unset, the scheduler assumes that capacity is insufficient and tries some other node.

Link copied to clipboard
data class StorageClassArgs(val allowVolumeExpansion: Output<Boolean>? = null, val allowedTopologies: Output<List<TopologySelectorTermArgs>>? = null, val apiVersion: Output<String>? = null, val kind: Output<String>? = null, val metadata: Output<ObjectMetaArgs>? = null, val mountOptions: Output<List<String>>? = null, val parameters: Output<Map<String, String>>? = null, val provisioner: Output<String>, val reclaimPolicy: Output<String>? = null, val volumeBindingMode: Output<String>? = null) : ConvertibleToJava<StorageClassArgs>

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

Link copied to clipboard
Link copied to clipboard
data class TokenRequestArgs(val audience: Output<String>, val expirationSeconds: Output<Int>? = null) : ConvertibleToJava<TokenRequestArgs>

TokenRequest contains parameters of a service account token.

Link copied to clipboard
Link copied to clipboard
data class TokenRequestPatchArgs(val audience: Output<String>? = null, val expirationSeconds: Output<Int>? = null) : ConvertibleToJava<TokenRequestPatchArgs>

TokenRequest contains parameters of a service account token.

Link copied to clipboard
data class VolumeAttachmentArgs(val apiVersion: Output<String>? = null, val kind: Output<String>? = null, val metadata: Output<ObjectMetaArgs>? = null, val spec: Output<VolumeAttachmentSpecArgs>, val status: Output<VolumeAttachmentStatusArgs>? = null) : ConvertibleToJava<VolumeAttachmentArgs>

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. VolumeAttachment objects are non-namespaced.

Link copied to clipboard
data class VolumeAttachmentSourceArgs(val inlineVolumeSpec: Output<PersistentVolumeSpecArgs>? = null, val persistentVolumeName: Output<String>? = null) : ConvertibleToJava<VolumeAttachmentSourceArgs>

VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.

Link copied to clipboard
data class VolumeAttachmentSourcePatchArgs(val inlineVolumeSpec: Output<PersistentVolumeSpecPatchArgs>? = null, val persistentVolumeName: Output<String>? = null) : ConvertibleToJava<VolumeAttachmentSourcePatchArgs>

VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set.

Link copied to clipboard
data class VolumeAttachmentSpecArgs(val attacher: Output<String>, val nodeName: Output<String>, val source: Output<VolumeAttachmentSourceArgs>) : ConvertibleToJava<VolumeAttachmentSpecArgs>

VolumeAttachmentSpec is the specification of a VolumeAttachment request.

Link copied to clipboard
data class VolumeAttachmentSpecPatchArgs(val attacher: Output<String>? = null, val nodeName: Output<String>? = null, val source: Output<VolumeAttachmentSourcePatchArgs>? = null) : ConvertibleToJava<VolumeAttachmentSpecPatchArgs>

VolumeAttachmentSpec is the specification of a VolumeAttachment request.

Link copied to clipboard
data class VolumeAttachmentStatusArgs(val attachError: Output<VolumeErrorArgs>? = null, val attached: Output<Boolean>, val attachmentMetadata: Output<Map<String, String>>? = null, val detachError: Output<VolumeErrorArgs>? = null) : ConvertibleToJava<VolumeAttachmentStatusArgs>

VolumeAttachmentStatus is the status of a VolumeAttachment request.

Link copied to clipboard
data class VolumeAttributesClassArgs(val apiVersion: Output<String>? = null, val driverName: Output<String>, val kind: Output<String>? = null, val metadata: Output<ObjectMetaArgs>? = null, val parameters: Output<Map<String, String>>? = null) : ConvertibleToJava<VolumeAttributesClassArgs>

VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver. The class can be specified during dynamic provisioning of PersistentVolumeClaims, and changed in the PersistentVolumeClaim spec after provisioning.

Link copied to clipboard
data class VolumeErrorArgs(val message: Output<String>? = null, val time: Output<String>? = null) : ConvertibleToJava<VolumeErrorArgs>

VolumeError captures an error encountered during a volume operation.

Link copied to clipboard
Link copied to clipboard
data class VolumeNodeResourcesArgs(val count: Output<Int>? = null) : ConvertibleToJava<VolumeNodeResourcesArgs>

VolumeNodeResources is a set of resource limits for scheduling of volumes.

Link copied to clipboard
data class VolumeNodeResourcesPatchArgs(val count: Output<Int>? = null) : ConvertibleToJava<VolumeNodeResourcesPatchArgs>

VolumeNodeResources is a set of resource limits for scheduling of volumes.