kubernetes: k8s.io/kubernetes/pkg/apis/storage Index | Files | Directories

package storage

import "k8s.io/kubernetes/pkg/apis/storage"

Index

Package Files

doc.go register.go types.go zz_generated.deepcopy.go

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

func Kind Uses

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func Resource Uses

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

type CSIDriver Uses

type CSIDriver struct {
    metav1.TypeMeta

    // Standard object metadata.
    // metadata.Name indicates the name of the CSI driver that this object
    // refers to; it MUST be the same name returned by the CSI GetPluginName()
    // call for that driver.
    // The driver name must be 63 characters or less, beginning and ending with
    // an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and
    // alphanumerics between.
    // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
    metav1.ObjectMeta

    // Specification of the CSI Driver.
    Spec CSIDriverSpec
}

CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced.

func (*CSIDriver) DeepCopy Uses

func (in *CSIDriver) DeepCopy() *CSIDriver

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CSIDriver.

func (*CSIDriver) DeepCopyInto Uses

func (in *CSIDriver) DeepCopyInto(out *CSIDriver)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*CSIDriver) DeepCopyObject Uses

func (in *CSIDriver) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type CSIDriverList Uses

type CSIDriverList 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 CSIDriver
    Items []CSIDriver
}

CSIDriverList is a collection of CSIDriver objects.

func (*CSIDriverList) DeepCopy Uses

func (in *CSIDriverList) DeepCopy() *CSIDriverList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CSIDriverList.

func (*CSIDriverList) DeepCopyInto Uses

func (in *CSIDriverList) DeepCopyInto(out *CSIDriverList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*CSIDriverList) DeepCopyObject Uses

func (in *CSIDriverList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type CSIDriverSpec Uses

type CSIDriverSpec struct {
    // attachRequired indicates this CSI volume driver requires an attach
    // operation (because it implements the CSI ControllerPublishVolume()
    // method), and that the Kubernetes attach detach controller should call
    // the attach volume interface which checks the volumeattachment status
    // and waits until the volume is attached before proceeding to mounting.
    // The CSI external-attacher coordinates with CSI volume driver and updates
    // the volumeattachment status when the attach operation is complete.
    // If the CSIDriverRegistry feature gate is enabled and the value is
    // specified to false, the attach operation will be skipped.
    // Otherwise the attach operation will be called.
    // +optional
    AttachRequired *bool

    // If set to true, podInfoOnMount indicates this CSI volume driver
    // requires additional pod information (like podName, podUID, etc.) during
    // mount operations.
    // If set to false, pod information will not be passed on mount.
    // Default is false.
    // The CSI driver specifies podInfoOnMount as part of driver deployment.
    // If true, Kubelet will pass pod information as VolumeContext in the CSI
    // NodePublishVolume() calls.
    // The CSI driver is responsible for parsing and validating the information
    // passed in as VolumeContext.
    // The following VolumeConext will be passed if podInfoOnMount is set to true.
    // This list might grow, but the prefix will be used.
    // "csi.storage.k8s.io/pod.name": pod.Name
    // "csi.storage.k8s.io/pod.namespace": pod.Namespace
    // "csi.storage.k8s.io/pod.uid": string(pod.UID)
    // +optional
    PodInfoOnMount *bool
}

CSIDriverSpec is the specification of a CSIDriver.

func (*CSIDriverSpec) DeepCopy Uses

func (in *CSIDriverSpec) DeepCopy() *CSIDriverSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CSIDriverSpec.

func (*CSIDriverSpec) DeepCopyInto Uses

func (in *CSIDriverSpec) DeepCopyInto(out *CSIDriverSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CSINode Uses

type CSINode struct {
    metav1.TypeMeta

    // metadata.name must be the Kubernetes node name.
    metav1.ObjectMeta

    // spec is the specification of CSINode
    Spec CSINodeSpec
}

CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object.

func (*CSINode) DeepCopy Uses

func (in *CSINode) DeepCopy() *CSINode

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CSINode.

func (*CSINode) DeepCopyInto Uses

func (in *CSINode) DeepCopyInto(out *CSINode)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*CSINode) DeepCopyObject Uses

func (in *CSINode) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type CSINodeDriver Uses

type CSINodeDriver struct {
    // This is the name of the CSI driver that this object refers to.
    // This MUST be the same name returned by the CSI GetPluginName() call for
    // that driver.
    Name string

    // nodeID of the node from the driver point of view.
    // This field enables Kubernetes to communicate with storage systems that do
    // not share the same nomenclature for nodes. For example, Kubernetes may
    // refer to a given node as "node1", but the storage system may refer to
    // the same node as "nodeA". When Kubernetes issues a command to the storage
    // system to attach a volume to a specific node, it can use this field to
    // refer to the node name using the ID that the storage system will
    // understand, e.g. "nodeA" instead of "node1". This field is required.
    NodeID string

    // topologyKeys is the list of keys supported by the driver.
    // When a driver is initialized on a cluster, it provides a set of topology
    // keys that it understands (e.g. "company.com/zone", "company.com/region").
    // When a driver is initialized on a node, it provides the same topology keys
    // along with values. Kubelet will expose these topology keys as labels
    // on its own node object.
    // When Kubernetes does topology aware provisioning, it can use this list to
    // determine which labels it should retrieve from the node object and pass
    // back to the driver.
    // It is possible for different nodes to use different topology keys.
    // This can be empty if driver does not support topology.
    // +optional
    TopologyKeys []string

    // allocatable represents the volume resources of a node that are available for scheduling.
    // +optional
    Allocatable *VolumeNodeResources
}

CSINodeDriver holds information about the specification of one CSI driver installed on a node

func (*CSINodeDriver) DeepCopy Uses

func (in *CSINodeDriver) DeepCopy() *CSINodeDriver

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CSINodeDriver.

func (*CSINodeDriver) DeepCopyInto Uses

func (in *CSINodeDriver) DeepCopyInto(out *CSINodeDriver)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CSINodeList Uses

type CSINodeList 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 CSINode
    Items []CSINode
}

CSINodeList is a collection of CSINode objects.

func (*CSINodeList) DeepCopy Uses

func (in *CSINodeList) DeepCopy() *CSINodeList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CSINodeList.

func (*CSINodeList) DeepCopyInto Uses

func (in *CSINodeList) DeepCopyInto(out *CSINodeList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*CSINodeList) DeepCopyObject Uses

func (in *CSINodeList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type CSINodeSpec Uses

type CSINodeSpec struct {
    // drivers is a list of information of all CSI Drivers existing on a node.
    // If all drivers in the list are uninstalled, this can become empty.
    // +patchMergeKey=name
    // +patchStrategy=merge
    Drivers []CSINodeDriver
}

CSINodeSpec holds information about the specification of all CSI drivers installed on a node

func (*CSINodeSpec) DeepCopy Uses

func (in *CSINodeSpec) DeepCopy() *CSINodeSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CSINodeSpec.

func (*CSINodeSpec) DeepCopyInto Uses

func (in *CSINodeSpec) DeepCopyInto(out *CSINodeSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StorageClass Uses

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 Uses

func (in *StorageClass) DeepCopy() *StorageClass

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageClass.

func (*StorageClass) DeepCopyInto Uses

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 Uses

func (in *StorageClass) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StorageClassList Uses

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 Uses

func (in *StorageClassList) DeepCopy() *StorageClassList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageClassList.

func (*StorageClassList) DeepCopyInto Uses

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 Uses

func (in *StorageClassList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VolumeAttachment Uses

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 Uses

func (in *VolumeAttachment) DeepCopy() *VolumeAttachment

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachment.

func (*VolumeAttachment) DeepCopyInto Uses

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 Uses

func (in *VolumeAttachment) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VolumeAttachmentList Uses

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 Uses

func (in *VolumeAttachmentList) DeepCopy() *VolumeAttachmentList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachmentList.

func (*VolumeAttachmentList) DeepCopyInto Uses

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 Uses

func (in *VolumeAttachmentList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VolumeAttachmentSource Uses

type VolumeAttachmentSource struct {
    // Name of the persistent volume to attach.
    // +optional
    PersistentVolumeName *string

    // 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 *api.PersistentVolumeSpec
}

VolumeAttachmentSource represents a volume that should be attached. Right now persistent volumes as well as inline volumes (only in CSI Migration scenarios) can be attached via external attacher. Exactly one member can be set.

func (*VolumeAttachmentSource) DeepCopy Uses

func (in *VolumeAttachmentSource) DeepCopy() *VolumeAttachmentSource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachmentSource.

func (*VolumeAttachmentSource) DeepCopyInto Uses

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 Uses

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 Uses

func (in *VolumeAttachmentSpec) DeepCopy() *VolumeAttachmentSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachmentSpec.

func (*VolumeAttachmentSpec) DeepCopyInto Uses

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 Uses

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 Uses

func (in *VolumeAttachmentStatus) DeepCopy() *VolumeAttachmentStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeAttachmentStatus.

func (*VolumeAttachmentStatus) DeepCopyInto Uses

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 Uses

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 Uses

type VolumeError struct {
    // Time the error was encountered.
    // +optional
    Time metav1.Time

    // String detailing the error encountered during Attach or Detach operation.
    // This string may be logged, so it should not contain sensitive
    // information.
    // +optional
    Message string
}

Captures an error encountered during a volume operation.

func (*VolumeError) DeepCopy Uses

func (in *VolumeError) DeepCopy() *VolumeError

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeError.

func (*VolumeError) DeepCopyInto Uses

func (in *VolumeError) DeepCopyInto(out *VolumeError)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VolumeNodeResources Uses

type VolumeNodeResources struct {
    // Maximum number of unique volumes managed by the CSI driver that can be used on a node.
    // A volume that is both attached and mounted on a node is considered to be used once, not twice.
    // The same rule applies for a unique volume that is shared among multiple pods on the same node.
    // If this field is nil, then the supported number of volumes on this node is unbounded.
    // +optional
    Count *int32
}

VolumeNodeResources is a set of resource limits for scheduling of volumes.

func (*VolumeNodeResources) DeepCopy Uses

func (in *VolumeNodeResources) DeepCopy() *VolumeNodeResources

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeNodeResources.

func (*VolumeNodeResources) DeepCopyInto Uses

func (in *VolumeNodeResources) DeepCopyInto(out *VolumeNodeResources)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Directories

PathSynopsis
fuzzer
installPackage install installs the experimental API group, making it available as an option to all of the API encoding/decoding machinery.
util
v1
v1alpha1
v1beta1
v1beta1/util
v1/util
validation

Package storage imports 4 packages (graph) and is imported by 221 packages. Updated 2019-06-30. Refresh now. Tools for package owners.