Documentation ¶
Overview ¶
Package v1alpha1 provides alpha API for CSI API objects. +k8s:deepcopy-gen=package,register +groupName=csi.storage.k8s.io +k8s:openapi-gen=true
Index ¶
Constants ¶
const ( // GroupName is the group name use in this package GroupName string = "csi.storage.k8s.io" // CsiDriverResourcePlural is the plural name of the CSIDriver resource CsiDriverResourcePlural string = "csidrivers" // CsiNodeInfoResourcePlural is the plural name of the CSINode resource CsiNodeInfoResourcePlural string = "csinodeinfos" )
Variables ¶
var ( // SchemeBuilder collects schemas to build. SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) // AddToScheme is used by generated client to add this scheme to the generated client. AddToScheme = SchemeBuilder.AddToScheme )
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 CSIDriver ¶
type CSIDriver struct { metav1.TypeMeta `json:",inline"` // 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. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata,omitempty"` // Specification of the CSI Driver. Spec CSIDriverSpec `json:"spec"` }
CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. CSIDriver objects are non-namespaced.
func (*CSIDriver) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CSIDriver.
func (*CSIDriver) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CSIDriver) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CSIDriverInfo ¶
type CSIDriverInfo struct { // Driver 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. Driver string `json:"driver"` // ID of the node from the driver point of view. NodeID string `json:"nodeID"` // Topology keys reported by the driver on the node. TopologyKeys []string `json:"topologyKeys"` }
CSIDriverInfo contains information about one CSI driver installed on a node.
func (*CSIDriverInfo) DeepCopy ¶
func (in *CSIDriverInfo) DeepCopy() *CSIDriverInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CSIDriverInfo.
func (*CSIDriverInfo) DeepCopyInto ¶
func (in *CSIDriverInfo) DeepCopyInto(out *CSIDriverInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CSIDriverList ¶
type CSIDriverList struct { metav1.TypeMeta `json:",inline"` // Standard list metadata // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata // +optional metav1.ListMeta `json:"metadata,omitempty"` // Items is the list of CSIDriver Items []CSIDriver `json:"items"` }
CSIDriverList is a collection of CSIDriver objects.
func (*CSIDriverList) DeepCopy ¶
func (in *CSIDriverList) DeepCopy() *CSIDriverList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CSIDriverList.
func (*CSIDriverList) DeepCopyInto ¶
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 ¶
func (in *CSIDriverList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CSIDriverSpec ¶
type CSIDriverSpec struct { // Indicates this CSI volume driver requires an attach operation (because it // implements the CSI ControllerPublishVolume() method), and that Kubernetes // should call attach and wait for any attach operation to complete before // proceeding to mounting. // If value is not specified, default is false -- meaning attach will not be // called. // +optional AttachRequired *bool `json:"attachRequired"` // Indicates this CSI volume driver requires additional pod information // (like podName, podUID, etc.) during mount operations. // If this is set to true, Kubelet will pass pod information as // VolumeAttributes in the CSI NodePublishVolume() calls. // If value is not specified, default is false -- meaning pod information // will not be passed on mount. // +optional PodInfoRequiredOnMount *bool `json:"podInfoRequiredOnMount"` }
CSIDriverSpec is the specification of a CSIDriver.
func (*CSIDriverSpec) DeepCopy ¶
func (in *CSIDriverSpec) DeepCopy() *CSIDriverSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CSIDriverSpec.
func (*CSIDriverSpec) DeepCopyInto ¶
func (in *CSIDriverSpec) DeepCopyInto(out *CSIDriverSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CSINodeInfo ¶
type CSINodeInfo struct { metav1.TypeMeta `json:",inline"` // ObjectMeta.Name must be node name. metav1.ObjectMeta `json:"metadata,omitempty"` // List of CSI drivers running on the node and their properties. CSIDrivers []CSIDriverInfo `json:"csiDrivers"` }
CSINodeInfo holds information about all CSI drivers installed on a node.
func (*CSINodeInfo) DeepCopy ¶
func (in *CSINodeInfo) DeepCopy() *CSINodeInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CSINodeInfo.
func (*CSINodeInfo) DeepCopyInto ¶
func (in *CSINodeInfo) DeepCopyInto(out *CSINodeInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CSINodeInfo) DeepCopyObject ¶
func (in *CSINodeInfo) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CSINodeInfoList ¶
type CSINodeInfoList struct { metav1.TypeMeta `json:",inline"` // Standard list metadata // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata // +optional metav1.ListMeta `json:"metadata,omitempty"` // Items is the list of CSINodeInfo Items []CSINodeInfo `json:"items"` }
CSINodeInfoList is a collection of CSINodeInfo objects.
func (*CSINodeInfoList) DeepCopy ¶
func (in *CSINodeInfoList) DeepCopy() *CSINodeInfoList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CSINodeInfoList.
func (*CSINodeInfoList) DeepCopyInto ¶
func (in *CSINodeInfoList) DeepCopyInto(out *CSINodeInfoList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CSINodeInfoList) DeepCopyObject ¶
func (in *CSINodeInfoList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.