Merge pull request #3241 from helio/ssh-public-key-windows

mark sshPublicKey as optional, docs windows ssh

Author: k8s-ci-robot

api/v1beta1/azuremachine_types.go

@@ -81,6 +81,9 @@ type AzureMachineSpec struct {
 	// +optional
 	DataDisks []DataDisk `json:"dataDisks,omitempty"`
 
+	// SSHPublicKey is the SSH public key string, base64-encoded to add to a Virtual Machine. Linux only.
+	// Refer to documentation on how to set up SSH access on Windows instances.
+	// +optional
 	SSHPublicKey string `json:"sshPublicKey"`
 
 	// AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the

config/crd/bases/infrastructure.cluster.x-k8s.io_azuremachinepools.yaml

@@ -1888,8 +1888,9 @@ spec:
                         x-kubernetes-int-or-string: true
                     type: object
                   sshPublicKey:
-                    description: SSHPublicKey is the SSH public key string base64
-                      encoded to add to a Virtual Machine
+                    description: SSHPublicKey is the SSH public key string, base64-encoded
+                      to add to a Virtual Machine. Linux only. Refer to documentation
+                      on how to set up SSH access on Windows instances.
                     type: string
                   subnetName:
                     description: 'Deprecated: SubnetName should be set in the networkInterfaces
@@ -1942,7 +1943,6 @@ spec:
                     type: string
                 required:
                 - osDisk
-                - sshPublicKey
                 - vmSize
                 type: object
               userAssignedIdentities:

config/crd/bases/infrastructure.cluster.x-k8s.io_azuremachines.yaml

@@ -1492,6 +1492,9 @@ spec:
                     x-kubernetes-int-or-string: true
                 type: object
               sshPublicKey:
+                description: SSHPublicKey is the SSH public key string, base64-encoded
+                  to add to a Virtual Machine. Linux only. Refer to documentation
+                  on how to set up SSH access on Windows instances.
                 type: string
               subnetName:
                 description: 'Deprecated: SubnetName should be set in the networkInterfaces
@@ -1573,7 +1576,6 @@ spec:
                 type: string
             required:
             - osDisk
-            - sshPublicKey
             - vmSize
             type: object
           status:

config/crd/bases/infrastructure.cluster.x-k8s.io_azuremachinetemplates.yaml

@@ -1276,6 +1276,9 @@ spec:
                             x-kubernetes-int-or-string: true
                         type: object
                       sshPublicKey:
+                        description: SSHPublicKey is the SSH public key string, base64-encoded
+                          to add to a Virtual Machine. Linux only. Refer to documentation
+                          on how to set up SSH access on Windows instances.
                         type: string
                       subnetName:
                         description: 'Deprecated: SubnetName should be set in the
@@ -1363,7 +1366,6 @@ spec:
                         type: string
                     required:
                     - osDisk
-                    - sshPublicKey
                     - vmSize
                     type: object
                 required:

docs/book/src/topics/windows.md

@@ -101,15 +101,36 @@ When creating a cluster with `Machinepool` if the Machine Pool name is longer th
 
 ### VM password and access
 The VM password is [random generated](https://cloudbase-init.readthedocs.io/en/latest/plugins.html#setting-password-main)
-by Cloudbase-init during provisioning of the VM. For Access to the VM you can use ssh which will be configured with SSH
-public key you provided during deployment.
+by Cloudbase-init during provisioning of the VM. For Access to the VM you can use ssh, which can be configured with a
+public key you provide during deployment.
+It's required to specify the SSH key using the `users` property in the Kubeadm config template. Specifying the `sshPublicKey` on `AzureMachine` / `AzureMachinePool` resources only works with Linux instances.
+
+For example like this:
+```yaml
+apiVersion: bootstrap.cluster.x-k8s.io/v1alpha3
+kind: KubeadmConfigTemplate
+metadata:
+  name: test1-md-0
+  namespace: default
+spec:
+  template:
+    spec:
+      ...
+      users:
+      - name: username
+        groups: Administrators
+        sshAuthorizedKeys:
+        - "ssh-rsa AAAA..."
+```
 
 To SSH:
 
 ```
 ssh -t -i .sshkey -o 'ProxyCommand ssh -i .sshkey -W %h:%p capi@<api-server-ip>' capi@<windows-ip>
 ```
 
+Refer to [SSH Access for nodes](ssh-access.md) for more instructions on how to connect using SSH.
+
 > There is also a [CAPZ kubectl plugin](https://github.com/kubernetes-sigs/cluster-api-provider-azure/blob/main/hack/debugging/Readme.md) that automates the ssh connection using the Management cluster
 
 To RDP you can proxy through the api server:

exp/api/v1beta1/azuremachinepool_types.go

@@ -62,7 +62,9 @@ type (
 		// +optional
 		DataDisks []infrav1.DataDisk `json:"dataDisks,omitempty"`
 
-		// SSHPublicKey is the SSH public key string base64 encoded to add to a Virtual Machine
+		// SSHPublicKey is the SSH public key string, base64-encoded to add to a Virtual Machine. Linux only.
+		// Refer to documentation on how to set up SSH access on Windows instances.
+		// +optional
 		SSHPublicKey string `json:"sshPublicKey"`
 
 		// Deprecated: AcceleratedNetworking should be set in the networkInterfaces field.