Add new switch GenerateSshKey to generate SSH keys if necessary.

wyunchi-ms · wyunchi-ms · commit 6550366d27f7 · 2020-08-12T17:15:51.000+08:00
diff --git a/src/Aks/Aks/Commands/CreateOrUpdateKubeBase.cs b/src/Aks/Aks/Commands/CreateOrUpdateKubeBase.cs
@@ -16,6 +16,7 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.IO;
 using System.Linq;
 using System.Management.Automation;
@@ -116,6 +117,11 @@ public abstract class CreateOrUpdateKubeBase : KubeCmdletBase
         [Alias("SshKeyPath")]
         public string SshKeyValue { get; set; }
 
+        [Parameter(
+            Mandatory = false,
+            HelpMessage = "Generate ssh key file to {HOME}/.ssh/id_rsa.")]
+        public SwitchParameter GenerateSshKey { get; set; }
+
         [Parameter(Mandatory = false, HelpMessage = "Run cmdlet in the background")]
         public SwitchParameter AsJob { get; set; }
 
@@ -451,5 +457,47 @@ protected string DefaultDnsPrefix()
             var subPart = string.Join("", DefaultContext.Subscription.Id.Take(4));
             return $"{namePart}{subPart}";
         }
+
+        protected string GenerateSshKeyValue()
+        {
+            String generateSshKeyPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), ".ssh", "id_rsa"); ;
+            if (File.Exists(generateSshKeyPath))
+            {
+                throw new ArgumentException(string.Format(Resources.DefaultSshKeyAlreadyExist));
+            }
+            using (Process process = new Process())
+            {
+                process.StartInfo.FileName = "ssh-keygen.exe";
+                process.StartInfo.Arguments = "-f " + generateSshKeyPath;
+                process.StartInfo.UseShellExecute = false;
+                process.StartInfo.RedirectStandardInput = true;
+                process.StartInfo.RedirectStandardOutput = true;
+                process.Start();
+
+                Console.WriteLine(process.StandardOutput.ReadToEnd());
+
+                process.WaitForExit();
+            }
+            return GetSshKey(generateSshKeyPath);
+        }
+
+        protected virtual void PreValidate()
+        {
+            if (this.IsParameterBound(c => c.GenerateSshKey))
+            {
+                if (this.IsParameterBound(c => c.SshKeyValue))
+                {
+                    throw new ArgumentException(string.Format(Resources.DonotUseGenerateSshKeyWithSshKeyValue));
+                }
+            }
+        }
+
+        protected void PrepareParameter()
+        {
+            if (this.IsParameterBound(c => c.GenerateSshKey))
+            {
+                SshKeyValue = GenerateSshKeyValue();
+            }
+        }
     }
 }
diff --git a/src/Aks/Aks/Commands/NewAzureRmAks.cs b/src/Aks/Aks/Commands/NewAzureRmAks.cs
@@ -35,6 +35,7 @@ public override void ExecuteCmdlet()
         {
             base.ExecuteCmdlet();
             PreValidate();
+            PrepareParameter();
 
             Action action = () =>
             {
@@ -67,11 +68,12 @@ public override void ExecuteCmdlet()
             }
         }
 
-        private void PreValidate()
+        protected override void PreValidate()
         {
             if ((this.IsParameterBound(c => c.NodeMinCount) || this.IsParameterBound(c => c.NodeMaxCount) || this.EnableNodeAutoScaling.IsPresent) &&
                 !(this.IsParameterBound(c => c.NodeMinCount) && this.IsParameterBound(c => c.NodeMaxCount) && this.EnableNodeAutoScaling.IsPresent))
                 throw new PSInvalidCastException(Resources.AksNodePoolAutoScalingParametersMustAppearTogether);
+            base.PreValidate();
         }
     }
 }
diff --git a/src/Aks/Aks/Commands/SetAzureRmAks.cs b/src/Aks/Aks/Commands/SetAzureRmAks.cs
@@ -57,6 +57,8 @@ public class SetAzureRmAks : CreateOrUpdateKubeBase
         public override void ExecuteCmdlet()
         {
             base.ExecuteCmdlet();
+            PreValidate();
+            PrepareParameter();
 
             ManagedCluster cluster = null;
             switch (ParameterSetName)
@@ -103,7 +105,11 @@ public override void ExecuteCmdlet()
                             cluster.DnsPrefix = DnsNamePrefix;
                         }
 
-                        if (this.IsParameterBound(c => c.SshKeyValue))
+                        if (this.IsParameterBound(c => c.GenerateSshKey))
+                        {
+                            SshKeyValue = GenerateSshKeyValue();
+                        }
+                        if (string.IsNullOrEmpty(SshKeyValue))
                         {
                             WriteVerbose(Resources.UpdatingSshKeyValue);
                             cluster.LinuxProfile.Ssh.PublicKeys = new List<ContainerServiceSshPublicKey>
diff --git a/src/Aks/Aks/Properties/Resources.Designer.cs b/src/Aks/Aks/Properties/Resources.Designer.cs
diff --git a/src/Aks/Aks/Properties/Resources.resx b/src/Aks/Aks/Properties/Resources.resx
@@ -369,4 +369,10 @@
   <data name="WindowsNodePoolNameLengthLimitation" xml:space="preserve">
     <value>Windows agent pool name can not be longer than 6 characters.</value>
   </data>
+  <data name="DonotUseGenerateSshKeyWithSshKeyValue" xml:space="preserve">
+    <value>Don't use -GenerateSshKey and -SshKeyVaule that the same time.</value>
+  </data>
+  <data name="DefaultSshKeyAlreadyExist" xml:space="preserve">
+    <value>Default ssh key is already exist. Please use -SshKeyVaule.</value>
+  </data>
 </root>
diff --git a/src/Aks/Aks/help/Az.Aks.md b/src/Aks/Aks/help/Az.Aks.md
@@ -49,3 +49,4 @@ Stop the Kubectl SSH tunnel created in Start-AzKubernetesDashboard.
 
 ### [Update-AzAksNodePool](Update-AzAksNodePool.md)
 Update node pool in a managed cluster.
+
diff --git a/src/Aks/Aks/help/New-AzAksCluster.md b/src/Aks/Aks/help/New-AzAksCluster.md
@@ -21,8 +21,8 @@ New-AzAksCluster [-Force] [-NodeVmSetType <String>] [-NodeVnetSubnetID <String>]
  [-Location <String>] [-LinuxProfileAdminUserName <String>] [-DnsNamePrefix <String>]
  [-KubernetesVersion <String>] [-NodeName <String>] [-NodeMinCount <Int32>] [-NodeMaxCount <Int32>]
  [-EnableNodeAutoScaling] [-NodeCount <Int32>] [-NodeOsDiskSize <Int32>] [-NodeVmSize <String>]
- [-SshKeyValue <String>] [-AsJob] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
- [-Confirm] [<CommonParameters>]
+ [-SshKeyValue <String>] [-GenerateSshKey] [-AsJob] [-Tag <Hashtable>]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -154,6 +154,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -GenerateSshKey
+Generate ssh key file to {HOME}/.ssh/id_rsa.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -KubernetesVersion
 The version of Kubernetes to use for creating the cluster.
 
diff --git a/src/Aks/Aks/help/Set-AzAksCluster.md b/src/Aks/Aks/help/Set-AzAksCluster.md
@@ -18,16 +18,16 @@ Set-AzAksCluster [-ResourceGroupName] <String> [-Name] <String> [[-ServicePrinci
  [-Location <String>] [-LinuxProfileAdminUserName <String>] [-DnsNamePrefix <String>]
  [-KubernetesVersion <String>] [-NodeName <String>] [-NodeMinCount <Int32>] [-NodeMaxCount <Int32>]
  [-EnableNodeAutoScaling] [-NodeCount <Int32>] [-NodeOsDiskSize <Int32>] [-NodeVmSize <String>]
- [-SshKeyValue <String>] [-AsJob] [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
- [-Confirm] [<CommonParameters>]
+ [-SshKeyValue <String>] [-GenerateSshKey] [-AsJob] [-Tag <Hashtable>]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### InputObjectParameterSet
 ```powershell
 Set-AzAksCluster -InputObject <PSKubernetesCluster> [-Location <String>] [-LinuxProfileAdminUserName <String>]
  [-DnsNamePrefix <String>] [-KubernetesVersion <String>] [-NodeName <String>] [-NodeMinCount <Int32>]
  [-NodeMaxCount <Int32>] [-EnableNodeAutoScaling] [-NodeCount <Int32>] [-NodeOsDiskSize <Int32>]
- [-NodeVmSize <String>] [-SshKeyValue <String>] [-AsJob] [-Tag <Hashtable>]
+ [-NodeVmSize <String>] [-SshKeyValue <String>] [-GenerateSshKey] [-AsJob] [-Tag <Hashtable>]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -36,7 +36,7 @@ Set-AzAksCluster -InputObject <PSKubernetesCluster> [-Location <String>] [-Linux
 Set-AzAksCluster [-Id] <String> [-Location <String>] [-LinuxProfileAdminUserName <String>]
  [-DnsNamePrefix <String>] [-KubernetesVersion <String>] [-NodeName <String>] [-NodeMinCount <Int32>]
  [-NodeMaxCount <Int32>] [-EnableNodeAutoScaling] [-NodeCount <Int32>] [-NodeOsDiskSize <Int32>]
- [-NodeVmSize <String>] [-SshKeyValue <String>] [-AsJob] [-Tag <Hashtable>]
+ [-NodeVmSize <String>] [-SshKeyValue <String>] [-GenerateSshKey] [-AsJob] [-Tag <Hashtable>]
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -114,6 +114,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -GenerateSshKey
+Generate ssh key file. Defaults to {HOME}/.ssh/.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Id
 Id of a managed Kubernetes cluster
 

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ public override void ExecuteCmdlet()`
`35`	`35`	`{`
`36`	`36`	`base.ExecuteCmdlet();`
`37`	`37`	`PreValidate();`
	`38`	`+ PrepareParameter();`
`38`	`39`
`39`	`40`	`Action action = () =>`
`40`	`41`	`{`
`@@ -67,11 +68,12 @@ public override void ExecuteCmdlet()`
`67`	`68`	`}`
`68`	`69`	`}`
`69`	`70`
`70`		`- private void PreValidate()`
	`71`	`+ protected override void PreValidate()`
`71`	`72`	`{`
`72`	`73`	`if ((this.IsParameterBound(c => c.NodeMinCount) \|\| this.IsParameterBound(c => c.NodeMaxCount) \|\| this.EnableNodeAutoScaling.IsPresent) &&`
`73`	`74`	`!(this.IsParameterBound(c => c.NodeMinCount) && this.IsParameterBound(c => c.NodeMaxCount) && this.EnableNodeAutoScaling.IsPresent))`
`74`	`75`	`throw new PSInvalidCastException(Resources.AksNodePoolAutoScalingParametersMustAppearTogether);`
	`76`	`+ base.PreValidate();`
`75`	`77`	`}`
`76`	`78`	`}`
`77`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,8 @@ public class SetAzureRmAks : CreateOrUpdateKubeBase`
`57`	`57`	`public override void ExecuteCmdlet()`
`58`	`58`	`{`
`59`	`59`	`base.ExecuteCmdlet();`
	`60`	`+ PreValidate();`
	`61`	`+ PrepareParameter();`
`60`	`62`
`61`	`63`	`ManagedCluster cluster = null;`
`62`	`64`	`switch (ParameterSetName)`
`@@ -103,7 +105,11 @@ public override void ExecuteCmdlet()`
`103`	`105`	`cluster.DnsPrefix = DnsNamePrefix;`
`104`	`106`	`}`
`105`	`107`
`106`		`- if (this.IsParameterBound(c => c.SshKeyValue))`
	`108`	`+ if (this.IsParameterBound(c => c.GenerateSshKey))`
	`109`	`+ {`
	`110`	`+ SshKeyValue = GenerateSshKeyValue();`
	`111`	`+ }`
	`112`	`+ if (string.IsNullOrEmpty(SshKeyValue))`
`107`	`113`	`{`
`108`	`114`	`WriteVerbose(Resources.UpdatingSshKeyValue);`
`109`	`115`	`cluster.LinuxProfile.Ssh.PublicKeys = new List<ContainerServiceSshPublicKey>`
Original file line number	Diff line number	Diff line change
`@@ -49,3 +49,4 @@ Stop the Kubectl SSH tunnel created in Start-AzKubernetesDashboard.`
`49`	`49`
`50`	`50`	`### [Update-AzAksNodePool](Update-AzAksNodePool.md)`
`51`	`51`	`Update node pool in a managed cluster.`
	`52`	`+`