Generated code for local persistent volumes

Kubernetes-commit: 936269a2eb60be837685a632b78a11941cb9d434

pkg/api/helper/helpers.go

@@ -594,3 +594,29 @@ func PersistentVolumeClaimHasClass(claim *api.PersistentVolumeClaim) bool {
 
 	return false
 }
+
+// GetStorageNodeAffinityFromAnnotation gets the json serialized data from PersistentVolume.Annotations
+// and converts it to the NodeAffinity type in api.
+// TODO: update when storage node affinity graduates to beta
+func GetStorageNodeAffinityFromAnnotation(annotations map[string]string) (*api.NodeAffinity, error) {
+	if len(annotations) > 0 && annotations[api.AlphaStorageNodeAffinityAnnotation] != "" {
+		var affinity api.NodeAffinity
+		err := json.Unmarshal([]byte(annotations[api.AlphaStorageNodeAffinityAnnotation]), &affinity)
+		if err != nil {
+			return nil, err
+		}
+		return &affinity, nil
+	}
+	return nil, nil
+}
+
+// Converts NodeAffinity type to Alpha annotation for use in PersistentVolumes
+// TODO: update when storage node affinity graduates to beta
+func StorageNodeAffinityToAlphaAnnotation(annotations map[string]string, affinity *api.NodeAffinity) error {
+	json, err := json.Marshal(*affinity)
+	if err != nil {
+		return err
+	}
+	annotations[api.AlphaStorageNodeAffinityAnnotation] = string(json)
+	return nil
+}

pkg/api/helper/helpers_test.go

@@ -266,3 +266,90 @@ func TestSysctlsFromPodAnnotation(t *testing.T) {
 		}
 	}
 }
+
+// TODO: remove when alpha support for topology constraints is removed
+func TestGetNodeAffinityFromAnnotations(t *testing.T) {
+	testCases := []struct {
+		annotations map[string]string
+		expectErr   bool
+	}{
+		{
+			annotations: nil,
+			expectErr:   false,
+		},
+		{
+			annotations: map[string]string{},
+			expectErr:   false,
+		},
+		{
+			annotations: map[string]string{
+				api.AlphaStorageNodeAffinityAnnotation: `{ 
+					"requiredDuringSchedulingIgnoredDuringExecution": { 
+						"nodeSelectorTerms": [ 
+							{ "matchExpressions": [
+								{ "key": "test-key1",
+								  "operator": "In",
+								  "values": ["test-value1", "test-value2"]
+								},
+								{ "key": "test-key2",
+								  "operator": "In",
+								  "values": ["test-value1", "test-value2"]
+								}
+							]}
+						]}
+					}`,
+			},
+			expectErr: false,
+		},
+		{
+			annotations: map[string]string{
+				api.AlphaStorageNodeAffinityAnnotation: `[{ 
+					"requiredDuringSchedulingIgnoredDuringExecution": { 
+						"nodeSelectorTerms": [ 
+							{ "matchExpressions": [
+								{ "key": "test-key1",
+								  "operator": "In",
+								  "values": ["test-value1", "test-value2"]
+								},
+								{ "key": "test-key2",
+								  "operator": "In",
+								  "values": ["test-value1", "test-value2"]
+								}
+							]}
+						]}
+					}]`,
+			},
+			expectErr: true,
+		},
+		{
+			annotations: map[string]string{
+				api.AlphaStorageNodeAffinityAnnotation: `{ 
+					"requiredDuringSchedulingIgnoredDuringExecution": { 
+						"nodeSelectorTerms":  
+							 "matchExpressions": [
+								{ "key": "test-key1",
+								  "operator": "In",
+								  "values": ["test-value1", "test-value2"]
+								},
+								{ "key": "test-key2",
+								  "operator": "In",
+								  "values": ["test-value1", "test-value2"]
+								}
+							]}
+						}
+					}`,
+			},
+			expectErr: true,
+		},
+	}
+
+	for i, tc := range testCases {
+		_, err := GetStorageNodeAffinityFromAnnotation(tc.annotations)
+		if err == nil && tc.expectErr {
+			t.Errorf("[%v]expected error but got none.", i)
+		}
+		if err != nil && !tc.expectErr {
+			t.Errorf("[%v]did not expect error but got: %v", i, err)
+		}
+	}
+}

pkg/api/types.go

@@ -381,6 +381,9 @@ type PersistentVolumeSource struct {
 	// ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
 	// +optional
 	ScaleIO *ScaleIOVolumeSource
+	// Local represents directly-attached storage with node affinity
+	// +optional
+	Local *LocalVolumeSource
 }
 
 type PersistentVolumeClaimVolumeSource struct {
@@ -399,6 +402,10 @@ const (
 
 	// MountOptionAnnotation defines mount option annotation used in PVs
 	MountOptionAnnotation = "volume.beta.kubernetes.io/mount-options"
+
+	// AlphaStorageNodeAffinityAnnotation defines node affinity policies for a PersistentVolume.
+	// Value is a string of the json representation of type NodeAffinity
+	AlphaStorageNodeAffinityAnnotation = "volume.alpha.kubernetes.io/node-affinity"
 )
 
 // +genclient=true
@@ -1223,6 +1230,14 @@ type KeyToPath struct {
 	Mode *int32
 }
 
+// Local represents directly-attached storage with node affinity
+type LocalVolumeSource struct {
+	// The full path to the volume on the node
+	// For alpha, this path must be a directory
+	// Once block as a source is supported, then this path can point to a block device
+	Path string
+}
+
 // ContainerPort represents a network port in a single container
 type ContainerPort struct {
 	// Optional: If specified, this must be an IANA_SVC_NAME  Each named port

pkg/api/v1/generated.proto

@@ -1440,6 +1440,14 @@ message LocalObjectReference {
   optional string name = 1;
 }
 
+// Local represents directly-attached storage with node affinity
+message LocalVolumeSource {
+  // The full path to the volume on the node
+  // For alpha, this path must be a directory
+  // Once block as a source is supported, then this path can point to a block device
+  optional string path = 1;
+}
+
 // Represents an NFS mount that lasts the lifetime of a pod.
 // NFS volumes do not support ownership management or SELinux relabeling.
 message NFSVolumeSource {
@@ -2202,6 +2210,10 @@ message PersistentVolumeSource {
   // ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
   // +optional
   optional ScaleIOVolumeSource scaleIO = 19;
+
+  // Local represents directly-attached storage with node affinity
+  // +optional
+  optional LocalVolumeSource local = 20;
 }
 
 // PersistentVolumeSpec is the specification of a persistent volume.

pkg/api/v1/types.go

@@ -439,6 +439,9 @@ type PersistentVolumeSource struct {
 	// ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
 	// +optional
 	ScaleIO *ScaleIOVolumeSource `json:"scaleIO,omitempty" protobuf:"bytes,19,opt,name=scaleIO"`
+	// Local represents directly-attached storage with node affinity
+	// +optional
+	Local *LocalVolumeSource `json:"local,omitempty" protobuf:"bytes,20,opt,name=local"`
 }
 
 const (
@@ -448,6 +451,10 @@ const (
 
 	// MountOptionAnnotation defines mount option annotation used in PVs
 	MountOptionAnnotation = "volume.beta.kubernetes.io/mount-options"
+
+	// AlphaStorageNodeAffinityAnnotation defines node affinity policies for a PersistentVolume.
+	// Value is a string of the json representation of type NodeAffinity
+	AlphaStorageNodeAffinityAnnotation = "volume.alpha.kubernetes.io/node-affinity"
 )
 
 // +genclient=true
@@ -1310,6 +1317,14 @@ type KeyToPath struct {
 	Mode *int32 `json:"mode,omitempty" protobuf:"varint,3,opt,name=mode"`
 }
 
+// Local represents directly-attached storage with node affinity
+type LocalVolumeSource struct {
+	// The full path to the volume on the node
+	// For alpha, this path must be a directory
+	// Once block as a source is supported, then this path can point to a block device
+	Path string `json:"path" protobuf:"bytes,1,opt,name=path"`
+}
+
 // ContainerPort represents a network port in a single container.
 type ContainerPort struct {
 	// If specified, this must be an IANA_SVC_NAME and unique within the pod. Each

pkg/api/v1/types_swagger_doc_generated.go

@@ -794,6 +794,15 @@ func (LocalObjectReference) SwaggerDoc() map[string]string {
 	return map_LocalObjectReference
 }
 
+var map_LocalVolumeSource = map[string]string{
+	"":     "Local represents directly-attached storage with node affinity",
+	"path": "The full path to the volume on the node For alpha, this path must be a directory Once block as a source is supported, then this path can point to a block device",
+}
+
+func (LocalVolumeSource) SwaggerDoc() map[string]string {
+	return map_LocalVolumeSource
+}
+
 var map_NFSVolumeSource = map[string]string{
 	"":         "Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.",
 	"server":   "Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
@@ -1150,6 +1159,7 @@ var map_PersistentVolumeSource = map[string]string{
 	"photonPersistentDisk": "PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine",
 	"portworxVolume":       "PortworxVolume represents a portworx volume attached and mounted on kubelets host machine",
 	"scaleIO":              "ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.",
+	"local":                "Local represents directly-attached storage with node affinity",
 }
 
 func (PersistentVolumeSource) SwaggerDoc() map[string]string {

pkg/api/v1/zz_generated.conversion.go

@@ -173,6 +173,8 @@ func RegisterConversions(scheme *runtime.Scheme) error {
 		Convert_api_LoadBalancerStatus_To_v1_LoadBalancerStatus,
 		Convert_v1_LocalObjectReference_To_api_LocalObjectReference,
 		Convert_api_LocalObjectReference_To_v1_LocalObjectReference,
+		Convert_v1_LocalVolumeSource_To_api_LocalVolumeSource,
+		Convert_api_LocalVolumeSource_To_v1_LocalVolumeSource,
 		Convert_v1_NFSVolumeSource_To_api_NFSVolumeSource,
 		Convert_api_NFSVolumeSource_To_v1_NFSVolumeSource,
 		Convert_v1_Namespace_To_api_Namespace,
@@ -2166,6 +2168,26 @@ func Convert_api_LocalObjectReference_To_v1_LocalObjectReference(in *api.LocalOb
 	return autoConvert_api_LocalObjectReference_To_v1_LocalObjectReference(in, out, s)
 }
 
+func autoConvert_v1_LocalVolumeSource_To_api_LocalVolumeSource(in *LocalVolumeSource, out *api.LocalVolumeSource, s conversion.Scope) error {
+	out.Path = in.Path
+	return nil
+}
+
+// Convert_v1_LocalVolumeSource_To_api_LocalVolumeSource is an autogenerated conversion function.
+func Convert_v1_LocalVolumeSource_To_api_LocalVolumeSource(in *LocalVolumeSource, out *api.LocalVolumeSource, s conversion.Scope) error {
+	return autoConvert_v1_LocalVolumeSource_To_api_LocalVolumeSource(in, out, s)
+}
+
+func autoConvert_api_LocalVolumeSource_To_v1_LocalVolumeSource(in *api.LocalVolumeSource, out *LocalVolumeSource, s conversion.Scope) error {
+	out.Path = in.Path
+	return nil
+}
+
+// Convert_api_LocalVolumeSource_To_v1_LocalVolumeSource is an autogenerated conversion function.
+func Convert_api_LocalVolumeSource_To_v1_LocalVolumeSource(in *api.LocalVolumeSource, out *LocalVolumeSource, s conversion.Scope) error {
+	return autoConvert_api_LocalVolumeSource_To_v1_LocalVolumeSource(in, out, s)
+}
+
 func autoConvert_v1_NFSVolumeSource_To_api_NFSVolumeSource(in *NFSVolumeSource, out *api.NFSVolumeSource, s conversion.Scope) error {
 	out.Server = in.Server
 	out.Path = in.Path
@@ -3002,6 +3024,7 @@ func autoConvert_v1_PersistentVolumeSource_To_api_PersistentVolumeSource(in *Per
 	out.PhotonPersistentDisk = (*api.PhotonPersistentDiskVolumeSource)(unsafe.Pointer(in.PhotonPersistentDisk))
 	out.PortworxVolume = (*api.PortworxVolumeSource)(unsafe.Pointer(in.PortworxVolume))
 	out.ScaleIO = (*api.ScaleIOVolumeSource)(unsafe.Pointer(in.ScaleIO))
+	out.Local = (*api.LocalVolumeSource)(unsafe.Pointer(in.Local))
 	return nil
 }
 
@@ -3030,6 +3053,7 @@ func autoConvert_api_PersistentVolumeSource_To_v1_PersistentVolumeSource(in *api
 	out.PhotonPersistentDisk = (*PhotonPersistentDiskVolumeSource)(unsafe.Pointer(in.PhotonPersistentDisk))
 	out.PortworxVolume = (*PortworxVolumeSource)(unsafe.Pointer(in.PortworxVolume))
 	out.ScaleIO = (*ScaleIOVolumeSource)(unsafe.Pointer(in.ScaleIO))
+	out.Local = (*LocalVolumeSource)(unsafe.Pointer(in.Local))
 	return nil
 }
 

pkg/api/v1/zz_generated.deepcopy.go

@@ -104,6 +104,7 @@ func RegisterDeepCopies(scheme *runtime.Scheme) error {
 		conversion.GeneratedDeepCopyFunc{Fn: DeepCopy_v1_LoadBalancerIngress, InType: reflect.TypeOf(&LoadBalancerIngress{})},
 		conversion.GeneratedDeepCopyFunc{Fn: DeepCopy_v1_LoadBalancerStatus, InType: reflect.TypeOf(&LoadBalancerStatus{})},
 		conversion.GeneratedDeepCopyFunc{Fn: DeepCopy_v1_LocalObjectReference, InType: reflect.TypeOf(&LocalObjectReference{})},
+		conversion.GeneratedDeepCopyFunc{Fn: DeepCopy_v1_LocalVolumeSource, InType: reflect.TypeOf(&LocalVolumeSource{})},
 		conversion.GeneratedDeepCopyFunc{Fn: DeepCopy_v1_NFSVolumeSource, InType: reflect.TypeOf(&NFSVolumeSource{})},
 		conversion.GeneratedDeepCopyFunc{Fn: DeepCopy_v1_Namespace, InType: reflect.TypeOf(&Namespace{})},
 		conversion.GeneratedDeepCopyFunc{Fn: DeepCopy_v1_NamespaceList, InType: reflect.TypeOf(&NamespaceList{})},
@@ -1495,6 +1496,16 @@ func DeepCopy_v1_LocalObjectReference(in interface{}, out interface{}, c *conver
 	}
 }
 
+// DeepCopy_v1_LocalVolumeSource is an autogenerated deepcopy function.
+func DeepCopy_v1_LocalVolumeSource(in interface{}, out interface{}, c *conversion.Cloner) error {
+	{
+		in := in.(*LocalVolumeSource)
+		out := out.(*LocalVolumeSource)
+		*out = *in
+		return nil
+	}
+}
+
 // DeepCopy_v1_NFSVolumeSource is an autogenerated deepcopy function.
 func DeepCopy_v1_NFSVolumeSource(in interface{}, out interface{}, c *conversion.Cloner) error {
 	{
@@ -2165,6 +2176,11 @@ func DeepCopy_v1_PersistentVolumeSource(in interface{}, out interface{}, c *conv
 				return err
 			}
 		}
+		if in.Local != nil {
+			in, out := &in.Local, &out.Local
+			*out = new(LocalVolumeSource)
+			**out = **in
+		}
 		return nil
 	}
 }

pkg/api/zz_generated.deepcopy.go

@@ -106,6 +106,7 @@ func RegisterDeepCopies(scheme *runtime.Scheme) error {
 		conversion.GeneratedDeepCopyFunc{Fn: DeepCopy_api_LoadBalancerIngress, InType: reflect.TypeOf(&LoadBalancerIngress{})},
 		conversion.GeneratedDeepCopyFunc{Fn: DeepCopy_api_LoadBalancerStatus, InType: reflect.TypeOf(&LoadBalancerStatus{})},
 		conversion.GeneratedDeepCopyFunc{Fn: DeepCopy_api_LocalObjectReference, InType: reflect.TypeOf(&LocalObjectReference{})},
+		conversion.GeneratedDeepCopyFunc{Fn: DeepCopy_api_LocalVolumeSource, InType: reflect.TypeOf(&LocalVolumeSource{})},
 		conversion.GeneratedDeepCopyFunc{Fn: DeepCopy_api_NFSVolumeSource, InType: reflect.TypeOf(&NFSVolumeSource{})},
 		conversion.GeneratedDeepCopyFunc{Fn: DeepCopy_api_Namespace, InType: reflect.TypeOf(&Namespace{})},
 		conversion.GeneratedDeepCopyFunc{Fn: DeepCopy_api_NamespaceList, InType: reflect.TypeOf(&NamespaceList{})},
@@ -1513,6 +1514,16 @@ func DeepCopy_api_LocalObjectReference(in interface{}, out interface{}, c *conve
 	}
 }
 
+// DeepCopy_api_LocalVolumeSource is an autogenerated deepcopy function.
+func DeepCopy_api_LocalVolumeSource(in interface{}, out interface{}, c *conversion.Cloner) error {
+	{
+		in := in.(*LocalVolumeSource)
+		out := out.(*LocalVolumeSource)
+		*out = *in
+		return nil
+	}
+}
+
 // DeepCopy_api_NFSVolumeSource is an autogenerated deepcopy function.
 func DeepCopy_api_NFSVolumeSource(in interface{}, out interface{}, c *conversion.Cloner) error {
 	{
@@ -2183,6 +2194,11 @@ func DeepCopy_api_PersistentVolumeSource(in interface{}, out interface{}, c *con
 				return err
 			}
 		}
+		if in.Local != nil {
+			in, out := &in.Local, &out.Local
+			*out = new(LocalVolumeSource)
+			**out = **in
+		}
 		return nil
 	}
 }