Documentation
¶
Index ¶
- Constants
- Variables
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type StorageClass
- type StorageClassList
- type VolumeAttachment
- type VolumeAttachmentList
- type VolumeAttachmentSource
- type VolumeAttachmentSpec
- type VolumeAttachmentStatus
- type VolumeBindingMode
- type VolumeError
Constants ¶
const GroupName = "storage.k8s.io"
GroupName is the group name use in this package
Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
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 StorageClass ¶
type StorageClass struct {
metav1.TypeMeta
// +optional
metav1.ObjectMeta
// provisioner is the driver expected to handle this StorageClass.
// This is an optionally-prefixed name, like a label key.
// For example: "kubernetes.io/gce-pd" or "kubernetes.io/aws-ebs".
// This value may not be empty.
Provisioner string
// parameters holds parameters for the provisioner.
// These values are opaque to the system and are passed directly
// to the provisioner. The only validation done on keys is that they are
// not empty. The maximum number of parameters is
// 512, with a cumulative max size of 256K
// +optional
Parameters map[string]string
// reclaimPolicy is the reclaim policy that dynamically provisioned
// PersistentVolumes of this storage class are created with
// +optional
ReclaimPolicy *api.PersistentVolumeReclaimPolicy
// mountOptions are the mount options that dynamically provisioned
// PersistentVolumes of this storage class are created with
// +optional
MountOptions []string
// AllowVolumeExpansion shows whether the storage class allow volume expand
// If the field is nil or not set, it would amount to expansion disabled
// for all PVs created from this storageclass.
// +optional
AllowVolumeExpansion *bool
// VolumeBindingMode indicates how PersistentVolumeClaims should be
// provisioned and bound. When unset, VolumeBindingImmediate is used.
// This field is only honored by servers that enable the VolumeScheduling feature.
// +optional
VolumeBindingMode *VolumeBindingMode
// Restrict the node topologies where volumes can be dynamically provisioned.
// Each volume plugin defines its own supported topology specifications.
// An empty TopologySelectorTerm list means there is no topology restriction.
// This field is only honored by servers that enable the VolumeScheduling feature.
// +optional
AllowedTopologies []api.TopologySelectorTerm
}
StorageClass describes a named "class" of storage offered in a cluster. Different classes might map to quality-of-service levels, or to backup policies, or to arbitrary policies determined by the cluster administrators. Kubernetes itself is unopinionated about what classes represent. This concept is sometimes called "profiles" in other storage systems. The name of a StorageClass object is significant, and is how users can request a particular class.
func (*StorageClass) DeepCopy ¶
func (in *StorageClass) DeepCopy() *StorageClass
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageClass.
func (*StorageClass) DeepCopyInto ¶
func (in *StorageClass) DeepCopyInto(out *StorageClass)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StorageClass) DeepCopyObject ¶
func (in *StorageClass) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type StorageClassList ¶
type StorageClassList struct {
metav1.TypeMeta
// Standard list metadata
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
// +optional
metav1.ListMeta
// Items is the list of StorageClasses
Items []StorageClass
}
StorageClassList is a collection of storage classes.
func (*StorageClassList) DeepCopy ¶
func (in *StorageClassList) DeepCopy() *StorageClassList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageClassList.
func (*StorageClassList) DeepCopyInto ¶
func (in *StorageClassList) DeepCopyInto(out *StorageClassList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*StorageClassList) DeepCopyObject ¶
func (in *StorageClassList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type VolumeAttachment ¶
type VolumeAttachment struct {
metav1.TypeMeta
// Standard object metadata.
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
// +optional
metav1.ObjectMeta
// Specification of the desired attach/detach volume behavior.
// Populated by the Kubernetes system.
Spec VolumeAttachmentSpec
// Status of the VolumeAttachment request.
// Populated by the entity completing the attach or detach
// operation, i.e. the external-attacher.
// +optional
Status VolumeAttachmentStatus
}
Captures the intent to attach or detach the specified volume to/from the specified node.
VolumeAttachment objects are non-namespaced.
func (*VolumeAttachment) DeepCopy ¶
func (in *VolumeAttachment) DeepCopy() *VolumeAttachment
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachment.
func (*VolumeAttachment) DeepCopyInto ¶
func (in *VolumeAttachment) DeepCopyInto(out *VolumeAttachment)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*VolumeAttachment) DeepCopyObject ¶
func (in *VolumeAttachment) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type VolumeAttachmentList ¶
type VolumeAttachmentList struct {
metav1.TypeMeta
// Standard list metadata
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
// +optional
metav1.ListMeta
// Items is the list of VolumeAttachments
Items []VolumeAttachment
}
VolumeAttachmentList is a collection of VolumeAttachment objects.
func (*VolumeAttachmentList) DeepCopy ¶
func (in *VolumeAttachmentList) DeepCopy() *VolumeAttachmentList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachmentList.
func (*VolumeAttachmentList) DeepCopyInto ¶
func (in *VolumeAttachmentList) DeepCopyInto(out *VolumeAttachmentList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*VolumeAttachmentList) DeepCopyObject ¶
func (in *VolumeAttachmentList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type VolumeAttachmentSource ¶
type VolumeAttachmentSource struct {
// Name of the persistent volume to attach.
// +optional
PersistentVolumeName *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.
func (*VolumeAttachmentSource) DeepCopy ¶
func (in *VolumeAttachmentSource) DeepCopy() *VolumeAttachmentSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachmentSource.
func (*VolumeAttachmentSource) DeepCopyInto ¶
func (in *VolumeAttachmentSource) DeepCopyInto(out *VolumeAttachmentSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
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
// Source represents the volume that should be attached.
Source VolumeAttachmentSource
// The node that the volume should be attached to.
NodeName string
}
The specification of a VolumeAttachment request.
func (*VolumeAttachmentSpec) DeepCopy ¶
func (in *VolumeAttachmentSpec) DeepCopy() *VolumeAttachmentSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachmentSpec.
func (*VolumeAttachmentSpec) DeepCopyInto ¶
func (in *VolumeAttachmentSpec) DeepCopyInto(out *VolumeAttachmentSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
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
// 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
// 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
// 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
}
The status of a VolumeAttachment request.
func (*VolumeAttachmentStatus) DeepCopy ¶
func (in *VolumeAttachmentStatus) DeepCopy() *VolumeAttachmentStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachmentStatus.
func (*VolumeAttachmentStatus) DeepCopyInto ¶
func (in *VolumeAttachmentStatus) DeepCopyInto(out *VolumeAttachmentStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VolumeBindingMode ¶
type VolumeBindingMode string
VolumeBindingMode indicates how PersistentVolumeClaims should be bound.
const ( // VolumeBindingImmediate indicates that PersistentVolumeClaims should be // immediately provisioned and bound. VolumeBindingImmediate VolumeBindingMode = "Immediate" // VolumeBindingWaitForFirstConsumer indicates that PersistentVolumeClaims // should not be provisioned and bound until the first Pod is created that // references the PeristentVolumeClaim. The volume provisioning and // binding will occur during Pod scheduing. VolumeBindingWaitForFirstConsumer VolumeBindingMode = "WaitForFirstConsumer" )
type VolumeError ¶
type VolumeError struct {
// Time the error was encountered.
// +optional
Time metav1.Time
// String detailing the error encountered during Attach or Detach operation.
// This string maybe logged, so it should not contain sensitive
// information.
// +optional
Message string
}
Captures an error encountered during a volume operation.
func (*VolumeError) DeepCopy ¶
func (in *VolumeError) DeepCopy() *VolumeError
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeError.
func (*VolumeError) DeepCopyInto ¶
func (in *VolumeError) DeepCopyInto(out *VolumeError)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
|
Package install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery. |