v1alpha1

package
v1.2.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 25, 2022 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_k8s_io_api_storage_v1alpha1_generated_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CSIStorageCapacity added in v1.2.4 

type CSIStorageCapacity struct {

	// Standard object's metadata. The name has no particular meaning. It must be
	// be a DNS subdomain (dots allowed, 253 characters). To ensure that
	// there are no conflicts with other CSI drivers on the cluster, the recommendation
	// is to use csisc-<uuid>, a generated name, or a reverse-domain name which ends
	// with the unique CSI driver name.
	//
	// Objects are namespaced.
	//
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	Metadata *v1.ObjectMeta `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"`
	// NodeTopology defines which nodes have access to the storage
	// for which capacity was reported. If not set, the storage is
	// not accessible from any node in the cluster. If empty, the
	// storage is accessible from all nodes. This field is
	// immutable.
	//
	// +optional
	NodeTopology *v1.LabelSelector `protobuf:"bytes,2,opt,name=nodeTopology" json:"nodeTopology,omitempty"`
	// 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.
	StorageClassName *string `protobuf:"bytes,3,opt,name=storageClassName" json:"storageClassName,omitempty"`
	// Capacity is the value reported by the CSI driver in its GetCapacityResponse
	// for a GetCapacityRequest with topology and parameters that match the
	// previous fields.
	//
	// The semantic is currently (CSI spec 1.2) defined as:
	// The available capacity, in bytes, of the storage that can be used
	// to provision volumes. If not set, that information is currently
	// unavailable and treated like zero capacity.
	//
	// +optional
	Capacity *resource.Quantity `protobuf:"bytes,4,opt,name=capacity" json:"capacity,omitempty"`
	// contains filtered or unexported fields
}

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.

This is an alpha feature and only available when the CSIStorageCapacity feature is enabled.

func (*CSIStorageCapacity) Descriptor deprecated added in v1.2.4 

func (*CSIStorageCapacity) Descriptor() ([]byte, []int)

Deprecated: Use CSIStorageCapacity.ProtoReflect.Descriptor instead.

func (*CSIStorageCapacity) GetCapacity added in v1.2.4 

func (x *CSIStorageCapacity) GetCapacity() *resource.Quantity

func (*CSIStorageCapacity) GetMetadata added in v1.2.4 

func (x *CSIStorageCapacity) GetMetadata() *v1.ObjectMeta

func (*CSIStorageCapacity) GetNodeTopology added in v1.2.4 

func (x *CSIStorageCapacity) GetNodeTopology() *v1.LabelSelector

func (*CSIStorageCapacity) GetStorageClassName added in v1.2.4 

func (x *CSIStorageCapacity) GetStorageClassName() string

func (*CSIStorageCapacity) ProtoMessage added in v1.2.4 

func (*CSIStorageCapacity) ProtoMessage()

func (*CSIStorageCapacity) ProtoReflect added in v1.2.4 

func (x *CSIStorageCapacity) ProtoReflect() protoreflect.Message

func (*CSIStorageCapacity) Reset added in v1.2.4 

func (x *CSIStorageCapacity) Reset()

func (*CSIStorageCapacity) String added in v1.2.4 

func (x *CSIStorageCapacity) String() string

type CSIStorageCapacityList added in v1.2.4 

type CSIStorageCapacityList struct {

	// Standard list metadata
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	Metadata *v1.ListMeta `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"`
	// Items is the list of CSIStorageCapacity objects.
	// +listType=map
	// +listMapKey=name
	Items []*CSIStorageCapacity `protobuf:"bytes,2,rep,name=items" json:"items,omitempty"`
	// contains filtered or unexported fields
}

CSIStorageCapacityList is a collection of CSIStorageCapacity objects.

func (*CSIStorageCapacityList) Descriptor deprecated added in v1.2.4 

func (*CSIStorageCapacityList) Descriptor() ([]byte, []int)

Deprecated: Use CSIStorageCapacityList.ProtoReflect.Descriptor instead.

func (*CSIStorageCapacityList) GetItems added in v1.2.4 

func (x *CSIStorageCapacityList) GetItems() []*CSIStorageCapacity

func (*CSIStorageCapacityList) GetMetadata added in v1.2.4 

func (x *CSIStorageCapacityList) GetMetadata() *v1.ListMeta

func (*CSIStorageCapacityList) ProtoMessage added in v1.2.4 

func (*CSIStorageCapacityList) ProtoMessage()

func (*CSIStorageCapacityList) ProtoReflect added in v1.2.4 

func (x *CSIStorageCapacityList) ProtoReflect() protoreflect.Message

func (*CSIStorageCapacityList) Reset added in v1.2.4 

func (x *CSIStorageCapacityList) Reset()

func (*CSIStorageCapacityList) String added in v1.2.4 

func (x *CSIStorageCapacityList) String() string

type VolumeAttachment 

type VolumeAttachment struct {

	// Standard object metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	Metadata *v1.ObjectMeta `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"`
	// Specification of the desired attach/detach volume behavior.
	// Populated by the Kubernetes system.
	Spec *VolumeAttachmentSpec `protobuf:"bytes,2,opt,name=spec" json:"spec,omitempty"`
	// Status of the VolumeAttachment request.
	// Populated by the entity completing the attach or detach
	// operation, i.e. the external-attacher.
	// +optional
	Status *VolumeAttachmentStatus `protobuf:"bytes,3,opt,name=status" json:"status,omitempty"`
	// contains filtered or unexported fields
}

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

VolumeAttachment objects are non-namespaced.

func (*VolumeAttachment) Descriptor deprecated 

func (*VolumeAttachment) Descriptor() ([]byte, []int)

Deprecated: Use VolumeAttachment.ProtoReflect.Descriptor instead.

func (*VolumeAttachment) GetMetadata 

func (x *VolumeAttachment) GetMetadata() *v1.ObjectMeta

func (*VolumeAttachment) GetSpec 

func (x *VolumeAttachment) GetSpec() *VolumeAttachmentSpec

func (*VolumeAttachment) GetStatus 

func (x *VolumeAttachment) GetStatus() *VolumeAttachmentStatus

func (*VolumeAttachment) ProtoMessage 

func (*VolumeAttachment) ProtoMessage()

func (*VolumeAttachment) ProtoReflect added in v1.2.4 

func (x *VolumeAttachment) ProtoReflect() protoreflect.Message

func (*VolumeAttachment) Reset 

func (x *VolumeAttachment) Reset()

func (*VolumeAttachment) String 

func (x *VolumeAttachment) String() string

type VolumeAttachmentList 

type VolumeAttachmentList struct {

	// Standard list metadata
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	Metadata *v1.ListMeta `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"`
	// Items is the list of VolumeAttachments
	Items []*VolumeAttachment `protobuf:"bytes,2,rep,name=items" json:"items,omitempty"`
	// contains filtered or unexported fields
}

VolumeAttachmentList is a collection of VolumeAttachment objects.

func (*VolumeAttachmentList) Descriptor deprecated 

func (*VolumeAttachmentList) Descriptor() ([]byte, []int)

Deprecated: Use VolumeAttachmentList.ProtoReflect.Descriptor instead.

func (*VolumeAttachmentList) GetItems 

func (x *VolumeAttachmentList) GetItems() []*VolumeAttachment

func (*VolumeAttachmentList) GetMetadata 

func (x *VolumeAttachmentList) GetMetadata() *v1.ListMeta

func (*VolumeAttachmentList) ProtoMessage 

func (*VolumeAttachmentList) ProtoMessage()

func (*VolumeAttachmentList) ProtoReflect added in v1.2.4 

func (x *VolumeAttachmentList) ProtoReflect() protoreflect.Message

func (*VolumeAttachmentList) Reset 

func (x *VolumeAttachmentList) Reset()

func (*VolumeAttachmentList) String 

func (x *VolumeAttachmentList) String() string

type VolumeAttachmentSource 

type VolumeAttachmentSource struct {

	// Name of the persistent volume to attach.
	// +optional
	PersistentVolumeName *string `protobuf:"bytes,1,opt,name=persistentVolumeName" json:"persistentVolumeName,omitempty"`
	// 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.
	// +optional
	InlineVolumeSpec *v11.PersistentVolumeSpec `protobuf:"bytes,2,opt,name=inlineVolumeSpec" json:"inlineVolumeSpec,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*VolumeAttachmentSource) Descriptor deprecated 

func (*VolumeAttachmentSource) Descriptor() ([]byte, []int)

Deprecated: Use VolumeAttachmentSource.ProtoReflect.Descriptor instead.

func (*VolumeAttachmentSource) GetInlineVolumeSpec added in v1.2.4 

func (x *VolumeAttachmentSource) GetInlineVolumeSpec() *v11.PersistentVolumeSpec

func (*VolumeAttachmentSource) GetPersistentVolumeName 

func (x *VolumeAttachmentSource) GetPersistentVolumeName() string

func (*VolumeAttachmentSource) ProtoMessage 

func (*VolumeAttachmentSource) ProtoMessage()

func (*VolumeAttachmentSource) ProtoReflect added in v1.2.4 

func (x *VolumeAttachmentSource) ProtoReflect() protoreflect.Message

func (*VolumeAttachmentSource) Reset 

func (x *VolumeAttachmentSource) Reset()

func (*VolumeAttachmentSource) String 

func (x *VolumeAttachmentSource) String() string

type VolumeAttachmentSpec 

type VolumeAttachmentSpec struct {

	// Attacher indicates the name of the volume driver that MUST handle this
	// request. This is the name returned by GetPluginName().
	Attacher *string `protobuf:"bytes,1,opt,name=attacher" json:"attacher,omitempty"`
	// Source represents the volume that should be attached.
	Source *VolumeAttachmentSource `protobuf:"bytes,2,opt,name=source" json:"source,omitempty"`
	// The node that the volume should be attached to.
	NodeName *string `protobuf:"bytes,3,opt,name=nodeName" json:"nodeName,omitempty"`
	// contains filtered or unexported fields
}

VolumeAttachmentSpec is the specification of a VolumeAttachment request.

func (*VolumeAttachmentSpec) Descriptor deprecated 

func (*VolumeAttachmentSpec) Descriptor() ([]byte, []int)

Deprecated: Use VolumeAttachmentSpec.ProtoReflect.Descriptor instead.

func (*VolumeAttachmentSpec) GetAttacher 

func (x *VolumeAttachmentSpec) GetAttacher() string

func (*VolumeAttachmentSpec) GetNodeName 

func (x *VolumeAttachmentSpec) GetNodeName() string

func (*VolumeAttachmentSpec) GetSource 

func (x *VolumeAttachmentSpec) GetSource() *VolumeAttachmentSource

func (*VolumeAttachmentSpec) ProtoMessage 

func (*VolumeAttachmentSpec) ProtoMessage()

func (*VolumeAttachmentSpec) ProtoReflect added in v1.2.4 

func (x *VolumeAttachmentSpec) ProtoReflect() protoreflect.Message

func (*VolumeAttachmentSpec) Reset 

func (x *VolumeAttachmentSpec) Reset()

func (*VolumeAttachmentSpec) String 

func (x *VolumeAttachmentSpec) String() string

type VolumeAttachmentStatus 

type VolumeAttachmentStatus struct {

	// Indicates the volume is successfully attached.
	// This field must only be set by the entity completing the attach
	// operation, i.e. the external-attacher.
	Attached *bool `protobuf:"varint,1,opt,name=attached" json:"attached,omitempty"`
	// 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.
	// +optional
	AttachmentMetadata map[string]string `` /* 156-byte string literal not displayed */
	// 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.
	// +optional
	AttachError *VolumeError `protobuf:"bytes,3,opt,name=attachError" json:"attachError,omitempty"`
	// 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.
	// +optional
	DetachError *VolumeError `protobuf:"bytes,4,opt,name=detachError" json:"detachError,omitempty"`
	// contains filtered or unexported fields
}

VolumeAttachmentStatus is the status of a VolumeAttachment request.

func (*VolumeAttachmentStatus) Descriptor deprecated 

func (*VolumeAttachmentStatus) Descriptor() ([]byte, []int)

Deprecated: Use VolumeAttachmentStatus.ProtoReflect.Descriptor instead.

func (*VolumeAttachmentStatus) GetAttachError 

func (x *VolumeAttachmentStatus) GetAttachError() *VolumeError

func (*VolumeAttachmentStatus) GetAttached 

func (x *VolumeAttachmentStatus) GetAttached() bool

func (*VolumeAttachmentStatus) GetAttachmentMetadata 

func (x *VolumeAttachmentStatus) GetAttachmentMetadata() map[string]string

func (*VolumeAttachmentStatus) GetDetachError 

func (x *VolumeAttachmentStatus) GetDetachError() *VolumeError

func (*VolumeAttachmentStatus) ProtoMessage 

func (*VolumeAttachmentStatus) ProtoMessage()

func (*VolumeAttachmentStatus) ProtoReflect added in v1.2.4 

func (x *VolumeAttachmentStatus) ProtoReflect() protoreflect.Message

func (*VolumeAttachmentStatus) Reset 

func (x *VolumeAttachmentStatus) Reset()

func (*VolumeAttachmentStatus) String 

func (x *VolumeAttachmentStatus) String() string

type VolumeError 

type VolumeError struct {

	// Time the error was encountered.
	// +optional
	Time *v1.Time `protobuf:"bytes,1,opt,name=time" json:"time,omitempty"`
	// String detailing the error encountered during Attach or Detach operation.
	// This string maybe logged, so it should not contain sensitive
	// information.
	// +optional
	Message *string `protobuf:"bytes,2,opt,name=message" json:"message,omitempty"`
	// contains filtered or unexported fields
}

VolumeError captures an error encountered during a volume operation.

func (*VolumeError) Descriptor deprecated 

func (*VolumeError) Descriptor() ([]byte, []int)

Deprecated: Use VolumeError.ProtoReflect.Descriptor instead.

func (*VolumeError) GetMessage 

func (x *VolumeError) GetMessage() string

func (*VolumeError) GetTime 

func (x *VolumeError) GetTime() *v1.Time

func (*VolumeError) ProtoMessage 

func (*VolumeError) ProtoMessage()

func (*VolumeError) ProtoReflect added in v1.2.4 

func (x *VolumeError) ProtoReflect() protoreflect.Message

func (*VolumeError) Reset 

func (x *VolumeError) Reset()

func (*VolumeError) String 

func (x *VolumeError) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.