[k8s] Remove pv name at startup and replace with "useMountSourceForVo…

…lumeName" (Azure#2620) Set `useMountSourceForVolumeName` as guidance for converting Docker Volume mounts to Persistent Volume Claims. Set to true to tell the runtime to use the Volume mount source (mount.Source) as the Persistent volume name (volumeName) in the PVC. False (default) will not set volume Name.
stkienems · Mar 3, 2020 · 934840b · 934840b
1 parent 6872810
commit 934840b
Show file tree

Hide file tree

Showing 11 changed files with 58 additions and 72 deletions.
diff --git a/edge-agent/src/Microsoft.Azure.Devices.Edge.Agent.Kubernetes/Constants.cs b/edge-agent/src/Microsoft.Azure.Devices.Edge.Agent.Kubernetes/Constants.cs
@@ -67,7 +67,7 @@ public static class EdgeDeployment
 
         public const string ProxyTrustBundleConfigMapEnvKey = "ProxyTrustBundleConfigMapName";
 
-        public const string PersistentVolumeNameKey = "PersistentVolumeName";
+        public const string UseMountSourceForVolumeNameKey = "UseMountSourceForVolumeName";
 
         public const string StorageClassNameKey = "StorageClassName";
 

diff --git a/...ure.Devices.Edge.Agent.Kubernetes/edgedeployment/deployment/KubernetesDeploymentMapper.cs b/...ure.Devices.Edge.Agent.Kubernetes/edgedeployment/deployment/KubernetesDeploymentMapper.cs
@@ -31,7 +31,7 @@ public class KubernetesDeploymentMapper : IKubernetesDeploymentMapper
         readonly string proxyTrustBundleVolumeName;
         readonly string proxyTrustBundleConfigMapName;
         readonly PortMapServiceType defaultServiceType;
-        readonly Option<string> persistentVolumeName;
+        readonly bool useMountSourceForVolumeName;
         readonly Option<string> storageClassName;
         readonly Option<uint> persistentVolumeClaimDefaultSizeMb;
         readonly string workloadApiVersion;
@@ -53,7 +53,7 @@ public KubernetesDeploymentMapper(
             string proxyTrustBundleVolumeName,
             string proxyTrustBundleConfigMapName,
             PortMapServiceType defaultServiceType,
-            string persistentVolumeName,
+            bool useMountSourceForVolumeName,
             string storageClassName,
             Option<uint> persistentVolumeClaimDefaultSizeMb,
             string workloadApiVersion,
@@ -74,8 +74,7 @@ public KubernetesDeploymentMapper(
             this.proxyTrustBundleVolumeName = proxyTrustBundleVolumeName;
             this.proxyTrustBundleConfigMapName = proxyTrustBundleConfigMapName;
             this.defaultServiceType = defaultServiceType;
-            this.persistentVolumeName = Option.Maybe(persistentVolumeName)
-                .Filter(p => !string.IsNullOrWhiteSpace(p));
+            this.useMountSourceForVolumeName = useMountSourceForVolumeName;
             this.storageClassName = Option.Maybe(storageClassName);
             this.persistentVolumeClaimDefaultSizeMb = persistentVolumeClaimDefaultSizeMb;
             this.workloadApiVersion = workloadApiVersion;
@@ -228,7 +227,7 @@ List<V1EnvVar> CollectModuleEnv(KubernetesModule module, IModuleIdentity identit
                 envList.Add(new V1EnvVar(KubernetesConstants.EdgeK8sObjectOwnerUidKey, module.Owner.Uid));
                 envList.Add(new V1EnvVar(KubernetesConstants.PortMappingServiceType, this.defaultServiceType.ToString()));
                 envList.Add(new V1EnvVar(KubernetesConstants.EnableK8sServiceCallTracingName, this.enableServiceCallTracing.ToString()));
-                this.persistentVolumeName.ForEach(pvName => envList.Add(new V1EnvVar(KubernetesConstants.PersistentVolumeNameKey, pvName)));
+                envList.Add(new V1EnvVar(KubernetesConstants.UseMountSourceForVolumeNameKey, this.useMountSourceForVolumeName.ToString()));
                 this.storageClassName.ForEach(scName => envList.Add(new V1EnvVar(KubernetesConstants.StorageClassNameKey, scName)));
                 this.persistentVolumeClaimDefaultSizeMb.ForEach(size => envList.Add(new V1EnvVar(KubernetesConstants.PersistentVolumeClaimDefaultSizeInMbKey, size.ToString())));
                 envList.AddRange(this.experimentalFeatures.Select(env => new V1EnvVar(env.Key, env.Value.ToString())));
@@ -361,10 +360,8 @@ static string ToProxyLogLevel(LogEventLevel level)
 
         V1Volume GetVolume(KubernetesModule module, Mount mount)
         {
-            // Volume name will be pvName if persistent volume is set, else will be volumeName
-            string volumeName = this.persistentVolumeName
-                .Map(KubeUtils.SanitizeK8sValue)
-                .GetOrElse(() => KubeUtils.SanitizeDNSValue(mount.Source));
+            // Volume name will be mount.Source
+            string volumeName = KubeUtils.SanitizeDNSValue(mount.Source);
             // PVC name will be volume name
             string pvcName = volumeName;
 
@@ -377,10 +374,8 @@ V1Volume GetVolume(KubernetesModule module, Mount mount)
 
         V1VolumeMount GetVolumeMount(Mount mount)
         {
-            // Volume name will be pvName if persistent volume is set, else will be volumeName
-            string volumeName = this.persistentVolumeName
-                .Map(KubeUtils.SanitizeK8sValue)
-                .GetOrElse(() => KubeUtils.SanitizeDNSValue(mount.Source));
+            // Volume name will be mount.Source
+            string volumeName = KubeUtils.SanitizeDNSValue(mount.Source);
 
             return new V1VolumeMount(mount.Target, volumeName, readOnlyProperty: mount.ReadOnly);
         }

diff --git a/...c/Microsoft.Azure.Devices.Edge.Agent.Kubernetes/edgedeployment/pvc/KubernetesPvcMapper.cs b/...c/Microsoft.Azure.Devices.Edge.Agent.Kubernetes/edgedeployment/pvc/KubernetesPvcMapper.cs
@@ -10,17 +10,16 @@ namespace Microsoft.Azure.Devices.Edge.Agent.Kubernetes.EdgeDeployment.Pvc
 
     public class KubernetesPvcMapper : IKubernetesPvcMapper
     {
-        readonly Option<string> persistentVolumeName;
+        readonly bool useMountSourceForVolumeName;
         readonly Option<string> storageClassName;
         readonly uint persistentVolumeClaimSizeMb;
 
         public KubernetesPvcMapper(
-            string persistentVolumeName,
+            bool useMountSourceForVolumeName,
             string storageClassName,
             uint persistentVolumeClaimSizeMb)
         {
-            this.persistentVolumeName = Option.Maybe(persistentVolumeName)
-                .Filter(p => !string.IsNullOrWhiteSpace(p));
+            this.useMountSourceForVolumeName = useMountSourceForVolumeName;
             this.storageClassName = Option.Maybe(storageClassName);
             this.persistentVolumeClaimSizeMb = persistentVolumeClaimSizeMb;
         }
@@ -38,7 +37,7 @@ bool ShouldCreatePvc(Mount mount)
                 return false;
             }
 
-            return this.storageClassName.HasValue || this.persistentVolumeName.HasValue;
+            return this.storageClassName.HasValue;
         }
 
         V1PersistentVolumeClaim ExtractPvc(KubernetesModule module, Mount mount, IDictionary<string, string> labels)
@@ -58,11 +57,9 @@ V1PersistentVolumeClaim ExtractPvc(KubernetesModule module, Mount mount, IDictio
                     Requests = new Dictionary<string, ResourceQuantity>() { { "storage", new ResourceQuantity($"{this.persistentVolumeClaimSizeMb}Mi") } }
                 },
             };
-            if (this.persistentVolumeName.HasValue)
+            if (this.useMountSourceForVolumeName)
             {
-                string pvName = this.persistentVolumeName.OrDefault();
-                pvcName = KubeUtils.SanitizeK8sValue(pvName);
-                persistentVolumeClaimSpec.VolumeName = pvcName;
+                persistentVolumeClaimSpec.VolumeName = volumeName;
             }
 
             if (this.storageClassName.HasValue)

diff --git a/edge-agent/src/Microsoft.Azure.Devices.Edge.Agent.Service/Program.cs b/edge-agent/src/Microsoft.Azure.Devices.Edge.Agent.Service/Program.cs
@@ -191,7 +191,7 @@ public static async Task<int> MainAsync(IConfiguration configuration)
                         string proxyTrustBundleConfigMapName = configuration.GetValue<string>(K8sConstants.ProxyTrustBundleConfigMapEnvKey);
                         PortMapServiceType mappedServiceDefault = GetDefaultServiceType(configuration);
                         bool enableServiceCallTracing = configuration.GetValue<bool>(K8sConstants.EnableK8sServiceCallTracingName);
-                        string persistentVolumeName = configuration.GetValue<string>(K8sConstants.PersistentVolumeNameKey);
+                        bool useMountSourceForVolumeName = configuration.GetValue<bool>(K8sConstants.UseMountSourceForVolumeNameKey, false);
                         string storageClassName = configuration.GetValue<string>(K8sConstants.StorageClassNameKey);
                         Option<uint> persistentVolumeClaimDefaultSizeMb = Option.Maybe(configuration.GetValue<uint?>(K8sConstants.PersistentVolumeClaimDefaultSizeInMbKey));
                         string deviceNamespace = configuration.GetValue<string>(K8sConstants.K8sNamespaceKey);
@@ -226,7 +226,7 @@ public static async Task<int> MainAsync(IConfiguration configuration)
                                 Option.Some(productInfo),
                                 mappedServiceDefault,
                                 enableServiceCallTracing,
-                                persistentVolumeName,
+                                useMountSourceForVolumeName,
                                 storageClassName,
                                 persistentVolumeClaimDefaultSizeMb,
                                 proxy,

diff --git a/edge-agent/src/Microsoft.Azure.Devices.Edge.Agent.Service/modules/KubernetesModule.cs b/edge-agent/src/Microsoft.Azure.Devices.Edge.Agent.Service/modules/KubernetesModule.cs
@@ -54,7 +54,7 @@ public class KubernetesModule : Module
         readonly Option<string> productInfo;
         readonly PortMapServiceType defaultMapServiceType;
         readonly bool enableServiceCallTracing;
-        readonly string persistentVolumeName;
+        readonly bool useMountSourceForVolumeName;
         readonly string storageClassName;
         readonly Option<uint> persistentVolumeClaimSizeMb;
         readonly Option<IWebProxy> proxy;
@@ -86,7 +86,7 @@ public KubernetesModule(
             Option<string> productInfo,
             PortMapServiceType defaultMapServiceType,
             bool enableServiceCallTracing,
-            string persistentVolumeName,
+            bool useMountSourceForVolumeName,
             string storageClassName,
             Option<uint> persistentVolumeClaimSizeMb,
             Option<IWebProxy> proxy,
@@ -117,7 +117,7 @@ public KubernetesModule(
             this.productInfo = productInfo;
             this.defaultMapServiceType = defaultMapServiceType;
             this.enableServiceCallTracing = enableServiceCallTracing;
-            this.persistentVolumeName = persistentVolumeName;
+            this.useMountSourceForVolumeName = useMountSourceForVolumeName;
             this.storageClassName = storageClassName;
             this.persistentVolumeClaimSizeMb = persistentVolumeClaimSizeMb;
             this.proxy = proxy;
@@ -256,7 +256,7 @@ protected override void Load(ContainerBuilder builder)
                             this.proxyTrustBundleVolumeName,
                             this.proxyTrustBundleConfigMapName,
                             this.defaultMapServiceType,
-                            this.persistentVolumeName,
+                            this.useMountSourceForVolumeName,
                             this.storageClassName,
                             this.persistentVolumeClaimSizeMb,
                             this.apiVersion,
@@ -272,7 +272,7 @@ protected override void Load(ContainerBuilder builder)
                 .As<IKubernetesServiceMapper>();
 
             // KubernetesPvcMapper
-            builder.Register(c => new KubernetesPvcMapper(this.persistentVolumeName, this.storageClassName, this.persistentVolumeClaimSizeMb.OrDefault()))
+            builder.Register(c => new KubernetesPvcMapper(this.useMountSourceForVolumeName, this.storageClassName, this.persistentVolumeClaimSizeMb.OrDefault()))
                 .As<IKubernetesPvcMapper>();
 
             // KubernetesServiceAccountProvider

diff --git a/...test/Microsoft.Azure.Devices.Edge.Agent.Kubernetes.Test/KubernetesDeploymentMapperTest.cs b/...test/Microsoft.Azure.Devices.Edge.Agent.Kubernetes.Test/KubernetesDeploymentMapperTest.cs
@@ -193,7 +193,7 @@ public void PvcMappingForVolumeNameVolume()
             var config = new KubernetesConfig("image", CreatePodParameters.Create(labels: labels, hostConfig: hostConfig), Option.None<AuthConfig>());
             var docker = new DockerModule("module1", "v1", ModuleStatus.Running, RestartPolicy.Always, Config1, ImagePullPolicy.OnCreate, Constants.DefaultPriority, DefaultConfigurationInfo, EnvVarsDict);
             var module = new KubernetesModule(docker, config, EdgeletModuleOwner);
-            var mapper = CreateMapper("a-volume", null);
+            var mapper = CreateMapper(true, null);
 
             var deployment = mapper.CreateDeployment(identity, module, labels);
 
@@ -573,7 +573,7 @@ public void EdgeAgentEnvSettingsHaveLotsOfStuff()
                 ["feature1"] = true,
                 ["feature2"] = false
             };
-            var mapper = CreateMapper(runAsNonRoot: true, persistentVolumeName: "pvname", storageClassName: "scname", proxyImagePullSecretName: "secret name", experimentalFeatures: features);
+            var mapper = CreateMapper(runAsNonRoot: true, useMountSourceForVolumeName: true, storageClassName: "scname", proxyImagePullSecretName: "secret name", experimentalFeatures: features);
 
             var deployment = mapper.CreateDeployment(identity, module, labels);
 
@@ -598,15 +598,15 @@ public void EdgeAgentEnvSettingsHaveLotsOfStuff()
             Assert.Equal("123", container.Env.Single(e => e.Name == KubernetesConstants.EdgeK8sObjectOwnerUidKey).Value);
             Assert.Equal("ClusterIP", container.Env.Single(e => e.Name == KubernetesConstants.PortMappingServiceType).Value);
             Assert.Equal("False", container.Env.Single(e => e.Name == KubernetesConstants.EnableK8sServiceCallTracingName).Value);
-            Assert.Equal("pvname", container.Env.Single(e => e.Name == KubernetesConstants.PersistentVolumeNameKey).Value);
+            Assert.Equal("True", container.Env.Single(e => e.Name == KubernetesConstants.UseMountSourceForVolumeNameKey).Value);
             Assert.Equal("scname", container.Env.Single(e => e.Name == KubernetesConstants.StorageClassNameKey).Value);
             Assert.Equal("100", container.Env.Single(e => e.Name == KubernetesConstants.PersistentVolumeClaimDefaultSizeInMbKey).Value);
             Assert.Equal("True", container.Env.Single(e => e.Name == "feature1").Value);
             Assert.Equal("False", container.Env.Single(e => e.Name == "feature2").Value);
         }
 
         static KubernetesDeploymentMapper CreateMapper(
-          string persistentVolumeName = "",
+          bool useMountSourceForVolumeName = false,
           string storageClassName = "",
           string proxyImagePullSecretName = null,
           bool runAsNonRoot = false,
@@ -623,7 +623,7 @@ static KubernetesDeploymentMapper CreateMapper(
                 "trustBundleVolumeName",
                 "trustBundleConfigMapName",
                 PortMapServiceType.ClusterIP,
-                persistentVolumeName,
+                useMountSourceForVolumeName,
                 storageClassName,
                 Option.Some<uint>(100),
                 "apiVersion",