zio-k8s-client
API
Generated with
zio-k8s-client/com.coralogix.zio.k8s/com.coralogix.zio.k8s.model/com.coralogix.zio.k8s.model.storage/com.coralogix.zio.k8s.model.storage.v1

com.coralogix.zio.k8s.model.storage.v1

package com.coralogix.zio.k8s.model.storage.v1

Members list

Type members

Classlikes

case class CSIDriver(metadata: Optional[ObjectMeta], spec: CSIDriverSpec)

CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. 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.

CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. 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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CSIDriver extends CSIDriverFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
CSIDriver.type
class CSIDriverFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CSIDriver.type
case class CSIDriverSpec(attachRequired: Optional[Boolean], fsGroupPolicy: Optional[String], podInfoOnMount: Optional[Boolean], requiresRepublish: Optional[Boolean], storageCapacity: Optional[Boolean], tokenRequests: Optional[Vector[TokenRequest]], volumeLifecycleModes: Optional[Vector[String]])

CSIDriverSpec is the specification of a CSIDriver.

CSIDriverSpec is the specification of a CSIDriver.

Value parameters

attachRequired

attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. This field is immutable.

fsGroupPolicy

Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. This field is immutable. Defaults to ReadWriteOnceWithFSType, which will examine each volume to determine if Kubernetes should modify ownership and permissions of the volume. With the default policy the defined fsGroup will only be applied if a fstype is defined and the volume's access mode contains ReadWriteOnce.

podInfoOnMount

If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume defined by a CSIVolumeSource, otherwise "false" "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. This field is immutable.

requiresRepublish

RequiresRepublish indicates the CSI driver wants NodePublishVolume being periodically called to reflect any possible change in the mounted volume. This field defaults to false. Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container.

storageCapacity

If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information. The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object. Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published. This field was immutable in Kubernetes <= 1.22 and now is mutable. This is a beta field and only available when the CSIStorageCapacity feature is enabled. The default is false.

tokenRequests

TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": { " ": { "token": , "expirationTimestamp": , }, ... } Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically.

volumeLifecycleModes

volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. This field is beta. This field is immutable.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CSIDriverSpec extends CSIDriverSpecFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class CSIDriverSpecFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CSIDriverSpec.type
case class CSINode(metadata: Optional[ObjectMeta], spec: CSINodeSpec)

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.

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CSINode extends CSINodeFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
CSINode.type
case class CSINodeDriver(allocatable: Optional[VolumeNodeResources], name: String, nodeID: String, topologyKeys: Optional[Vector[String]])

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

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

Value parameters

name

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.

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.

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CSINodeDriver extends CSINodeDriverFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class CSINodeDriverFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CSINodeDriver.type
class CSINodeFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CSINode.type
case class CSINodeSpec(drivers: Vector[CSINodeDriver])

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

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

Value parameters

drivers

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CSINodeSpec extends CSINodeSpecFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class CSINodeSpecFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CSINodeSpec.type
case class StorageClass(allowVolumeExpansion: Optional[Boolean], allowedTopologies: Optional[Vector[TopologySelectorTerm]], metadata: Optional[ObjectMeta], mountOptions: Optional[Vector[String]], parameters: Optional[Map[String, String]], provisioner: String, reclaimPolicy: Optional[String], volumeBindingMode: Optional[String])

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

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.

Value parameters

allowVolumeExpansion

AllowVolumeExpansion shows whether the storage class allow volume expand

allowedTopologies

Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.

mountOptions

Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid.

parameters

Parameters holds the parameters for the provisioner that should create volumes of this storage class.

provisioner

Provisioner indicates the type of the provisioner.

reclaimPolicy

Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete.

volumeBindingMode

VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object StorageClass extends StorageClassFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class StorageClassFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object StorageClass.type
case class TokenRequest(audience: String, expirationSeconds: Optional[Long])

TokenRequest contains parameters of a service account token.

TokenRequest contains parameters of a service account token.

Value parameters

audience

Audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver.

expirationSeconds

ExpirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec".

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TokenRequest extends TokenRequestFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class TokenRequestFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object TokenRequest.type
case class VolumeAttachment(metadata: Optional[ObjectMeta], spec: VolumeAttachmentSpec, status: Optional[VolumeAttachmentStatus])

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

VolumeAttachment objects are non-namespaced.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VolumeAttachment extends VolumeAttachmentFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class VolumeAttachmentFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object VolumeAttachment.type
case class VolumeAttachmentSource(inlineVolumeSpec: Optional[PersistentVolumeSpec], persistentVolumeName: Optional[String])

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.

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.

Value parameters

persistentVolumeName

Name of the persistent volume to attach.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VolumeAttachmentSource extends VolumeAttachmentSourceFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class VolumeAttachmentSourceFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class VolumeAttachmentSpec(attacher: String, nodeName: String, source: VolumeAttachmentSource)

VolumeAttachmentSpec is the specification of a VolumeAttachment request.

VolumeAttachmentSpec is the specification of a VolumeAttachment request.

Value parameters

attacher

Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().

nodeName

The node that the volume should be attached to.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VolumeAttachmentSpec extends VolumeAttachmentSpecFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class VolumeAttachmentSpecFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object VolumeAttachmentSpec.type
case class VolumeAttachmentStatus(attachError: Optional[VolumeError], attached: Boolean, attachmentMetadata: Optional[Map[String, String]], detachError: Optional[VolumeError])

VolumeAttachmentStatus is the status of a VolumeAttachment request.

VolumeAttachmentStatus is the status of a VolumeAttachment request.

Value parameters

attached

Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.

attachmentMetadata

Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VolumeAttachmentStatus extends VolumeAttachmentStatusFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class VolumeAttachmentStatusFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class VolumeError(message: Optional[String], time: Optional[Time])

VolumeError captures an error encountered during a volume operation.

VolumeError captures an error encountered during a volume operation.

Value parameters

message

String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VolumeError extends VolumeErrorFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class VolumeErrorFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object VolumeError.type
case class VolumeNodeResources(count: Optional[Int])

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

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

Value parameters

count

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VolumeNodeResources extends VolumeNodeResourcesFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class VolumeNodeResourcesFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object VolumeNodeResources.type
Generated with