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

com.coralogix.zio.k8s.model.storage.v1alpha1

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

Members list

Concise view

Type members

Classlikes

case class CSIStorageCapacity(capacity: Optional[Quantity], maximumVolumeSize: Optional[Quantity], metadata: Optional[ObjectMeta], nodeTopology: Optional[LabelSelector], storageClassName: String)

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.

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 if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity.

Attributes

storageClassName

The name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable.

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CSIStorageCapacity extends CSIStorageCapacityFields

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
class CSIStorageCapacityFields(_prefix: Chunk[String])

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CSIStorageCapacity.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
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object VolumeAttachment extends VolumeAttachmentFields

Attributes

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

Attributes

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

Attributes

persistentVolumeName

Name of the persistent volume to attach.

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object VolumeAttachmentSource extends VolumeAttachmentSourceFields

Attributes

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

Attributes

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

Attributes

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.

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object VolumeAttachmentSpec extends VolumeAttachmentSpecFields

Attributes

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

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
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.

Attributes

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.

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object VolumeAttachmentStatus extends VolumeAttachmentStatusFields

Attributes

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

Attributes

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

Attributes

message

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

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object VolumeError extends VolumeErrorFields

Attributes

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

Attributes

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