2019-01-18 01:50:10 +00:00
|
|
|
/*
|
|
|
|
Copyright 2017 The Kubernetes Authors.
|
|
|
|
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
you may not use this file except in compliance with the License.
|
|
|
|
You may obtain a copy of the License at
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
limitations under the License.
|
|
|
|
*/
|
|
|
|
|
|
|
|
package v1alpha1
|
|
|
|
|
2021-05-15 10:08:31 +00:00
|
|
|
import (
|
|
|
|
"k8s.io/api/core/v1"
|
|
|
|
"k8s.io/apimachinery/pkg/api/resource"
|
|
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
|
|
)
|
2019-01-18 01:50:10 +00:00
|
|
|
|
|
|
|
// +genclient
|
|
|
|
// +genclient:nonNamespaced
|
|
|
|
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
|
2021-05-15 10:08:31 +00:00
|
|
|
// +k8s:prerelease-lifecycle-gen:introduced=1.9
|
|
|
|
// +k8s:prerelease-lifecycle-gen:deprecated=1.21
|
|
|
|
// +k8s:prerelease-lifecycle-gen:replacement=storage.k8s.io,v1,VolumeAttachment
|
2019-01-18 01:50:10 +00:00
|
|
|
|
|
|
|
// VolumeAttachment captures the intent to attach or detach the specified volume
|
|
|
|
// to/from the specified node.
|
|
|
|
//
|
|
|
|
// VolumeAttachment objects are non-namespaced.
|
|
|
|
type VolumeAttachment struct {
|
|
|
|
metav1.TypeMeta `json:",inline"`
|
|
|
|
|
|
|
|
// Standard object metadata.
|
2021-05-15 10:08:31 +00:00
|
|
|
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
2019-01-18 01:50:10 +00:00
|
|
|
// +optional
|
|
|
|
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
|
|
|
|
|
|
|
|
// Specification of the desired attach/detach volume behavior.
|
|
|
|
// Populated by the Kubernetes system.
|
|
|
|
Spec VolumeAttachmentSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`
|
|
|
|
|
|
|
|
// Status of the VolumeAttachment request.
|
|
|
|
// Populated by the entity completing the attach or detach
|
|
|
|
// operation, i.e. the external-attacher.
|
|
|
|
// +optional
|
|
|
|
Status VolumeAttachmentStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
|
2021-05-15 10:08:31 +00:00
|
|
|
// +k8s:prerelease-lifecycle-gen:introduced=1.9
|
|
|
|
// +k8s:prerelease-lifecycle-gen:deprecated=1.21
|
|
|
|
// +k8s:prerelease-lifecycle-gen:replacement=storage.k8s.io,v1,VolumeAttachmentList
|
2019-01-18 01:50:10 +00:00
|
|
|
|
|
|
|
// VolumeAttachmentList is a collection of VolumeAttachment objects.
|
|
|
|
type VolumeAttachmentList struct {
|
|
|
|
metav1.TypeMeta `json:",inline"`
|
|
|
|
// Standard list metadata
|
2021-05-15 10:08:31 +00:00
|
|
|
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
2019-01-18 01:50:10 +00:00
|
|
|
// +optional
|
|
|
|
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
|
|
|
|
|
|
|
|
// Items is the list of VolumeAttachments
|
|
|
|
Items []VolumeAttachment `json:"items" protobuf:"bytes,2,rep,name=items"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// VolumeAttachmentSpec is the specification of a VolumeAttachment request.
|
|
|
|
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 `json:"attacher" protobuf:"bytes,1,opt,name=attacher"`
|
|
|
|
|
|
|
|
// Source represents the volume that should be attached.
|
|
|
|
Source VolumeAttachmentSource `json:"source" protobuf:"bytes,2,opt,name=source"`
|
|
|
|
|
|
|
|
// The node that the volume should be attached to.
|
|
|
|
NodeName string `json:"nodeName" protobuf:"bytes,3,opt,name=nodeName"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// 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.
|
|
|
|
type VolumeAttachmentSource struct {
|
|
|
|
// Name of the persistent volume to attach.
|
|
|
|
// +optional
|
|
|
|
PersistentVolumeName *string `json:"persistentVolumeName,omitempty" protobuf:"bytes,1,opt,name=persistentVolumeName"`
|
|
|
|
|
2021-05-15 10:08:31 +00:00
|
|
|
// 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 *v1.PersistentVolumeSpec `json:"inlineVolumeSpec,omitempty" protobuf:"bytes,2,opt,name=inlineVolumeSpec"`
|
2019-01-18 01:50:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// VolumeAttachmentStatus is the status of a VolumeAttachment request.
|
|
|
|
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 `json:"attached" protobuf:"varint,1,opt,name=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.
|
|
|
|
// +optional
|
|
|
|
AttachmentMetadata map[string]string `json:"attachmentMetadata,omitempty" protobuf:"bytes,2,rep,name=attachmentMetadata"`
|
|
|
|
|
|
|
|
// 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 `json:"attachError,omitempty" protobuf:"bytes,3,opt,name=attachError,casttype=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 `json:"detachError,omitempty" protobuf:"bytes,4,opt,name=detachError,casttype=VolumeError"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// VolumeError captures an error encountered during a volume operation.
|
|
|
|
type VolumeError struct {
|
|
|
|
// Time the error was encountered.
|
|
|
|
// +optional
|
|
|
|
Time metav1.Time `json:"time,omitempty" protobuf:"bytes,1,opt,name=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 `json:"message,omitempty" protobuf:"bytes,2,opt,name=message"`
|
|
|
|
}
|
2021-05-15 10:08:31 +00:00
|
|
|
|
|
|
|
// +genclient
|
|
|
|
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
|
|
|
|
// +k8s:prerelease-lifecycle-gen:introduced=1.19
|
|
|
|
// +k8s:prerelease-lifecycle-gen:deprecated=1.21
|
|
|
|
// +k8s:prerelease-lifecycle-gen:replacement=storage.k8s.io,v1beta1,CSIStorageCapacity
|
|
|
|
|
|
|
|
// 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.
|
|
|
|
//
|
|
|
|
// They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate
|
|
|
|
// is enabled there and a CSI driver opts into capacity-aware scheduling with
|
|
|
|
// CSIDriver.StorageCapacity.
|
|
|
|
type CSIStorageCapacity struct {
|
|
|
|
metav1.TypeMeta `json:",inline"`
|
|
|
|
// 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
|
|
|
|
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
|
|
|
|
|
|
|
|
// 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 *metav1.LabelSelector `json:"nodeTopology,omitempty" protobuf:"bytes,2,opt,name=nodeTopology"`
|
|
|
|
|
|
|
|
// 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 `json:"storageClassName" protobuf:"bytes,3,name=storageClassName"`
|
|
|
|
|
|
|
|
// 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 `json:"capacity,omitempty" protobuf:"bytes,4,opt,name=capacity"`
|
|
|
|
|
|
|
|
// MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse
|
|
|
|
// for a GetCapacityRequest with topology and parameters that match the
|
|
|
|
// previous fields.
|
|
|
|
//
|
|
|
|
// This is defined since CSI spec 1.4.0 as the largest size
|
|
|
|
// that may be used in a
|
|
|
|
// CreateVolumeRequest.capacity_range.required_bytes field to
|
|
|
|
// create a volume with the same parameters as those in
|
|
|
|
// GetCapacityRequest. The corresponding value in the Kubernetes
|
|
|
|
// API is ResourceRequirements.Requests in a volume claim.
|
|
|
|
//
|
|
|
|
// +optional
|
|
|
|
MaximumVolumeSize *resource.Quantity `json:"maximumVolumeSize,omitempty" protobuf:"bytes,5,opt,name=maximumVolumeSize"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
|
|
|
|
// +k8s:prerelease-lifecycle-gen:introduced=1.19
|
|
|
|
// +k8s:prerelease-lifecycle-gen:deprecated=1.21
|
|
|
|
// +k8s:prerelease-lifecycle-gen:replacement=storage.k8s.io,v1beta1,CSIStorageCapacityList
|
|
|
|
|
|
|
|
// CSIStorageCapacityList is a collection of CSIStorageCapacity objects.
|
|
|
|
type CSIStorageCapacityList struct {
|
|
|
|
metav1.TypeMeta `json:",inline"`
|
|
|
|
// Standard list metadata
|
|
|
|
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
|
|
|
// +optional
|
|
|
|
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
|
|
|
|
|
|
|
|
// Items is the list of CSIStorageCapacity objects.
|
|
|
|
// +listType=map
|
|
|
|
// +listMapKey=name
|
|
|
|
Items []CSIStorageCapacity `json:"items" protobuf:"bytes,2,rep,name=items"`
|
|
|
|
}
|