v1alpha1

Documentation

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type VolumeAttachment
  • func (v *VolumeAttachment) GroupVersionKind() schema.GroupVersionKind
• type VolumeAttachmentList
  • func (v *VolumeAttachmentList) GroupVersionKind() schema.GroupVersionKind
• type VolumeAttachmentSource
• type VolumeAttachmentSpec
• type VolumeAttachmentStatus
• type VolumeError

Constants

const GroupName = "storage.k8s.io"

GroupName is the group name use in this package

Variables

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type VolumeAttachment

type VolumeAttachment struct {

	// 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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// 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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
	// Required: true
	Spec *VolumeAttachmentSpec `json:"spec"`

	// Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
	Status *VolumeAttachmentStatus `json:"status,omitempty"`
}

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

VolumeAttachment objects are non-namespaced.

swagger:model VolumeAttachment

func (*VolumeAttachment) GroupVersionKind

func (v *VolumeAttachment) GroupVersionKind() schema.GroupVersionKind

type VolumeAttachmentList

type VolumeAttachmentList struct {

	// 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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Items is the list of VolumeAttachments
	// Required: true
	Items []*VolumeAttachment `json:"items"`

	// 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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"`
}

VolumeAttachmentList VolumeAttachmentList is a collection of VolumeAttachment objects.

swagger:model VolumeAttachmentList

func (*VolumeAttachmentList) GroupVersionKind

func (v *VolumeAttachmentList) GroupVersionKind() schema.GroupVersionKind

type VolumeAttachmentSource

type VolumeAttachmentSource struct {

	// 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.
	InlineVolumeSpec *api_core_v1.PersistentVolumeSpec `json:"inlineVolumeSpec,omitempty"`

	// Name of the persistent volume to attach.
	PersistentVolumeName string `json:"persistentVolumeName,omitempty"`
}

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

swagger:model VolumeAttachmentSource

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().
	// Required: true
	Attacher *string `json:"attacher"`

	// The node that the volume should be attached to.
	// Required: true
	NodeName *string `json:"nodeName"`

	// Source represents the volume that should be attached.
	// Required: true
	Source *VolumeAttachmentSource `json:"source"`
}

VolumeAttachmentSpec VolumeAttachmentSpec is the specification of a VolumeAttachment request.

swagger:model VolumeAttachmentSpec

type VolumeAttachmentStatus

type VolumeAttachmentStatus struct {

	// 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.
	AttachError *VolumeError `json:"attachError,omitempty"`

	// Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
	// Required: true
	Attached *bool `json:"attached"`

	// 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.
	AttachmentMetadata map[string]string `json:"attachmentMetadata,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.
	DetachError *VolumeError `json:"detachError,omitempty"`
}

VolumeAttachmentStatus VolumeAttachmentStatus is the status of a VolumeAttachment request.

swagger:model VolumeAttachmentStatus

type VolumeError

type VolumeError struct {

	// String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.
	Message string `json:"message,omitempty"`

	// Time the error was encountered.
	Time *apimachinery_pkg_apis_meta_v1.Time `json:"time,omitempty"`
}

VolumeError VolumeError captures an error encountered during a volume operation.

swagger:model VolumeError