scala-k8s-docs
0.16.2
API
Generated with
scala-k8s-docs/io.k8s/io.k8s.api/io.k8s.api.storage/io.k8s.api.storage.v1

io.k8s.api.storage.v1

package io.k8s.api.storage.v1

Members list

Type members

Classlikes

final case class CSIDriver(spec: CSIDriverSpec, metadata: Option[ObjectMeta]) extends KObject

CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster.

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
Source
CSIDriver.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object CSIDriver

Attributes

Companion
class
Source
CSIDriver.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
CSIDriver.type
final case class CSIDriverList(items: Seq[CSIDriver], metadata: Option[ListMeta]) extends KObject

CSIDriverList is a collection of CSIDriver objects.

CSIDriverList is a collection of CSIDriver objects.

Attributes

Companion
object
Source
CSIDriverList.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object CSIDriverList

Attributes

Companion
class
Source
CSIDriverList.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CSIDriverListPointer(currentPath: PointerPath) extends Pointer[CSIDriverList]

Pointer for CSIDriverList

Pointer for CSIDriverList

Attributes

Source
CSIDriverListPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class CSIDriverPointer(currentPath: PointerPath) extends Pointer[CSIDriver]

Pointer for CSIDriver

Pointer for CSIDriver

Attributes

Source
CSIDriverPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class CSIDriverSpec(volumeLifecycleModes: Option[Seq[String]], podInfoOnMount: Option[Boolean], attachRequired: Option[Boolean], requiresRepublish: Option[Boolean], fsGroupPolicy: Option[String], storageCapacity: Option[Boolean], tokenRequests: Option[Seq[TokenRequest]], seLinuxMount: Option[Boolean])

CSIDriverSpec is the specification of a CSIDriver.

CSIDriverSpec is the specification of a CSIDriver.

Attributes

Companion
object
Source
CSIDriverSpec.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CSIDriverSpec

Attributes

Companion
class
Source
CSIDriverSpec.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CSIDriverSpecPointer(currentPath: PointerPath) extends Pointer[CSIDriverSpec]

Pointer for CSIDriverSpec

Pointer for CSIDriverSpec

Attributes

Source
CSIDriverSpecPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class CSINode(spec: CSINodeSpec, metadata: Option[ObjectMeta]) extends KObject

CSINode holds information about all CSI drivers installed on a node.

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
Source
CSINode.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object CSINode

Attributes

Companion
class
Source
CSINode.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
CSINode.type
final case class CSINodeDriver(name: String, nodeID: String, allocatable: Option[VolumeNodeResources], topologyKeys: Option[Seq[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

Attributes

Companion
object
Source
CSINodeDriver.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CSINodeDriver

Attributes

Companion
class
Source
CSINodeDriver.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CSINodeDriverPointer(currentPath: PointerPath) extends Pointer[CSINodeDriver]

Pointer for CSINodeDriver

Pointer for CSINodeDriver

Attributes

Source
CSINodeDriverPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class CSINodeList(items: Seq[CSINode], metadata: Option[ListMeta]) extends KObject

CSINodeList is a collection of CSINode objects.

CSINodeList is a collection of CSINode objects.

Attributes

Companion
object
Source
CSINodeList.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object CSINodeList

Attributes

Companion
class
Source
CSINodeList.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CSINodeListPointer(currentPath: PointerPath) extends Pointer[CSINodeList]

Pointer for CSINodeList

Pointer for CSINodeList

Attributes

Source
CSINodeListPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class CSINodePointer(currentPath: PointerPath) extends Pointer[CSINode]

Pointer for CSINode

Pointer for CSINode

Attributes

Source
CSINodePointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Pointer[CSINode]
class Object
trait Matchable
class Any
Show all
final case class CSINodeSpec(drivers: Seq[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

Attributes

Companion
object
Source
CSINodeSpec.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CSINodeSpec

Attributes

Companion
class
Source
CSINodeSpec.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CSINodeSpecPointer(currentPath: PointerPath) extends Pointer[CSINodeSpec]

Pointer for CSINodeSpec

Pointer for CSINodeSpec

Attributes

Source
CSINodeSpecPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class CSIStorageCapacity(storageClassName: String, maximumVolumeSize: Option[Quantity], nodeTopology: Option[LabelSelector], metadata: Option[ObjectMeta], capacity: Option[Quantity]) extends KObject

CSIStorageCapacity stores the result of one CSI GetCapacity call.

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.

Attributes

Companion
object
Source
CSIStorageCapacity.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object CSIStorageCapacity

Attributes

Companion
class
Source
CSIStorageCapacity.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CSIStorageCapacityList(items: Seq[CSIStorageCapacity], metadata: Option[ListMeta]) extends KObject

CSIStorageCapacityList is a collection of CSIStorageCapacity objects.

CSIStorageCapacityList is a collection of CSIStorageCapacity objects.

Attributes

Companion
object
Source
CSIStorageCapacityList.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object CSIStorageCapacityList

Attributes

Companion
class
Source
CSIStorageCapacityList.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CSIStorageCapacityListPointer(currentPath: PointerPath) extends Pointer[CSIStorageCapacityList]

Pointer for CSIStorageCapacityList

Pointer for CSIStorageCapacityList

Attributes

Source
CSIStorageCapacityListPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class CSIStorageCapacityPointer(currentPath: PointerPath) extends Pointer[CSIStorageCapacity]

Pointer for CSIStorageCapacity

Pointer for CSIStorageCapacity

Attributes

Source
CSIStorageCapacityPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class StorageClass(provisioner: String, mountOptions: Option[Seq[String]], reclaimPolicy: Option[String], volumeBindingMode: Option[String], metadata: Option[ObjectMeta], allowVolumeExpansion: Option[Boolean], allowedTopologies: Option[Seq[TopologySelectorTerm]], parameters: Option[Map[String, String]]) extends KObject

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.

Attributes

Companion
object
Source
StorageClass.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object StorageClass

Attributes

Companion
class
Source
StorageClass.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class StorageClassList(items: Seq[StorageClass], metadata: Option[ListMeta]) extends KObject

StorageClassList is a collection of storage classes.

StorageClassList is a collection of storage classes.

Attributes

Companion
object
Source
StorageClassList.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object StorageClassList

Attributes

Companion
class
Source
StorageClassList.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class StorageClassListPointer(currentPath: PointerPath) extends Pointer[StorageClassList]

Pointer for StorageClassList

Pointer for StorageClassList

Attributes

Source
StorageClassListPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class StorageClassPointer(currentPath: PointerPath) extends Pointer[StorageClass]

Pointer for StorageClass

Pointer for StorageClass

Attributes

Source
StorageClassPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class TokenRequest(audience: String, expirationSeconds: Option[Long])

TokenRequest contains parameters of a service account token.

TokenRequest contains parameters of a service account token.

Attributes

Companion
object
Source
TokenRequest.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TokenRequest

Attributes

Companion
class
Source
TokenRequest.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class TokenRequestPointer(currentPath: PointerPath) extends Pointer[TokenRequest]

Pointer for TokenRequest

Pointer for TokenRequest

Attributes

Source
TokenRequestPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class VolumeAttachment(spec: VolumeAttachmentSpec, status: Option[VolumeAttachmentStatus], metadata: Option[ObjectMeta]) extends KObject

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
Source
VolumeAttachment.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object VolumeAttachment

Attributes

Companion
class
Source
VolumeAttachment.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class VolumeAttachmentList(items: Seq[VolumeAttachment], metadata: Option[ListMeta]) extends KObject

VolumeAttachmentList is a collection of VolumeAttachment objects.

VolumeAttachmentList is a collection of VolumeAttachment objects.

Attributes

Companion
object
Source
VolumeAttachmentList.scala
Supertypes
trait KObject
trait Product
trait Equals
trait Serializable
class Object
trait Matchable
class Any
Show all
object VolumeAttachmentList

Attributes

Companion
class
Source
VolumeAttachmentList.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class VolumeAttachmentListPointer(currentPath: PointerPath) extends Pointer[VolumeAttachmentList]

Pointer for VolumeAttachmentList

Pointer for VolumeAttachmentList

Attributes

Source
VolumeAttachmentListPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class VolumeAttachmentPointer(currentPath: PointerPath) extends Pointer[VolumeAttachment]

Pointer for VolumeAttachment

Pointer for VolumeAttachment

Attributes

Source
VolumeAttachmentPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class VolumeAttachmentSource(inlineVolumeSpec: Option[PersistentVolumeSpec], persistentVolumeName: Option[String])

VolumeAttachmentSource represents a volume that should be attached.

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.

Attributes

Companion
object
Source
VolumeAttachmentSource.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VolumeAttachmentSource

Attributes

Companion
class
Source
VolumeAttachmentSource.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class VolumeAttachmentSourcePointer(currentPath: PointerPath) extends Pointer[VolumeAttachmentSource]

Pointer for VolumeAttachmentSource

Pointer for VolumeAttachmentSource

Attributes

Source
VolumeAttachmentSourcePointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final 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.

Attributes

Companion
object
Source
VolumeAttachmentSpec.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VolumeAttachmentSpec

Attributes

Companion
class
Source
VolumeAttachmentSpec.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class VolumeAttachmentSpecPointer(currentPath: PointerPath) extends Pointer[VolumeAttachmentSpec]

Pointer for VolumeAttachmentSpec

Pointer for VolumeAttachmentSpec

Attributes

Source
VolumeAttachmentSpecPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class VolumeAttachmentStatus(attached: Boolean, attachError: Option[VolumeError], attachmentMetadata: Option[Map[String, String]], detachError: Option[VolumeError])

VolumeAttachmentStatus is the status of a VolumeAttachment request.

VolumeAttachmentStatus is the status of a VolumeAttachment request.

Attributes

Companion
object
Source
VolumeAttachmentStatus.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VolumeAttachmentStatus

Attributes

Companion
class
Source
VolumeAttachmentStatus.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class VolumeAttachmentStatusPointer(currentPath: PointerPath) extends Pointer[VolumeAttachmentStatus]

Pointer for VolumeAttachmentStatus

Pointer for VolumeAttachmentStatus

Attributes

Source
VolumeAttachmentStatusPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class VolumeError(message: Option[String], time: Option[Time])

VolumeError captures an error encountered during a volume operation.

VolumeError captures an error encountered during a volume operation.

Attributes

Companion
object
Source
VolumeError.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VolumeError

Attributes

Companion
class
Source
VolumeError.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class VolumeErrorPointer(currentPath: PointerPath) extends Pointer[VolumeError]

Pointer for VolumeError

Pointer for VolumeError

Attributes

Source
VolumeErrorPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class VolumeNodeResources(count: Option[Int])

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

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

Attributes

Companion
object
Source
VolumeNodeResources.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VolumeNodeResources

Attributes

Companion
class
Source
VolumeNodeResources.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class VolumeNodeResourcesPointer(currentPath: PointerPath) extends Pointer[VolumeNodeResources]

Pointer for VolumeNodeResources

Pointer for VolumeNodeResources

Attributes

Source
VolumeNodeResourcesPointer.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Generated with