Skip to content

storage_v1alpha1

VolumeAttachment

class lightkube.models.storage_v1alpha1.VolumeAttachment(spec, apiVersion=None, kind=None, metadata=None, status=None)

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

VolumeAttachment objects are non-namespaced.

parameters

  • spec VolumeAttachmentSpec - Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ObjectMeta - (optional) Standard object metadata. More info
  • status VolumeAttachmentStatus - (optional) Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.

VolumeAttachmentList

class lightkube.models.storage_v1alpha1.VolumeAttachmentList(items, apiVersion=None, kind=None, metadata=None)

VolumeAttachmentList is a collection of VolumeAttachment objects.

parameters

  • items VolumeAttachment - Items is the list of VolumeAttachments
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ListMeta - (optional) Standard list metadata More info

VolumeAttachmentSource

class lightkube.models.storage_v1alpha1.VolumeAttachmentSource(inlineVolumeSpec=None, persistentVolumeName=None)

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.

parameters

  • inlineVolumeSpec core_v1.PersistentVolumeSpec - (optional) inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is alpha-level and is only honored by servers that enabled the CSIMigration feature.
  • persistentVolumeName str - (optional) Name of the persistent volume to attach.

VolumeAttachmentSpec

class lightkube.models.storage_v1alpha1.VolumeAttachmentSpec(attacher, nodeName, source)

VolumeAttachmentSpec is the specification of a VolumeAttachment request.

parameters

  • attacher str - Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
  • nodeName str - The node that the volume should be attached to.
  • source VolumeAttachmentSource - Source represents the volume that should be attached.

VolumeAttachmentStatus

class lightkube.models.storage_v1alpha1.VolumeAttachmentStatus(attached, attachError=None, attachmentMetadata=None, detachError=None)

VolumeAttachmentStatus is the status of a VolumeAttachment request.

parameters

  • attached bool - Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
  • attachError VolumeError - (optional) The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
  • attachmentMetadata dict - (optional) 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.
  • detachError VolumeError - (optional) The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.

VolumeError

class lightkube.models.storage_v1alpha1.VolumeError(message=None, time=None)

VolumeError captures an error encountered during a volume operation.

parameters

  • message str - (optional) String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.
  • time meta_v1.Time - (optional) Time the error was encountered.