Skip to content

Commit b17a718

Browse files
authored
Update node-access.md
1 parent c45ac41 commit b17a718

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

articles/aks/node-access.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,9 @@ ms.custom: contperf-fy21q4
1212

1313
# Connect to Azure Kubernetes Service (AKS) cluster nodes for maintenance or troubleshooting
1414

15-
Throughout the lifecycle of your Azure Kubernetes Service (AKS) cluster, you may need to access an AKS node. This access could be for maintenance, log collection, or other troubleshooting operations. You can access AKS nodes using SSH, including Windows Server nodes. You can also [connect to Windows Server nodes using remote desktop protocol (RDP) connections][aks-windows-rdp]. For security purposes, the AKS nodes aren't exposed to the internet. To connect to the AKS nodes, you use `kubectl debug` or the private IP address.
15+
Throughout the lifecycle of your Azure Kubernetes Service (AKS) cluster, you might need to access an AKS node. This access could be for maintenance, log collection, or troubleshooting operations. You can securely authenticate against AKS Linux and Windows nodes using SSH, and you can also [connect to Windows Server nodes using remote desktop protocol (RDP)][aks-windows-rdp]. For security reasons, the AKS nodes aren't exposed to the internet. To connect to the AKS nodes, you use `kubectl debug` or the private IP address.
1616

17-
What's more, AKS now supports [updating SSH key on all existing nodepools][updating SSH key]
18-
19-
This article shows you how to create a connection to an AKS node and update SSH key on existing AKS cluster.
17+
This article shows you how to create a connection to an AKS node and update the SSH key on an existing AKS cluster.
2018

2119
## Before you begin
2220

@@ -165,35 +163,35 @@ When done, `exit` the SSH session, stop any port forwarding, and then `exit` the
165163
kubectl delete pod node-debugger-aks-nodepool1-12345678-vmss000000-bkmmx
166164
```
167165
168-
## Update the SSH key on existing AKS cluster (public preview)
166+
## Update SSH key on an existing AKS cluster (preview)
169167

170168
### Prerequisites
171169
* [Azure CLI][install-azure-cli] and the `aks-preview` 0.5.111 or later CLI extension installed.
172170

173171
### Limitation
174172
* Updating SSH key is supported for VMSS AKS clusters.
175173

176-
Use `az aks update` to update new SSH key on AKS cluster. Note that the SSH key of all nodepools will be updated.
174+
Use the [az aks update][az-aks-update] command to update the SSH key on the cluster. This operation will update the key on all node pools. You can either specify the key or a key file using the `--ssh-key-value` argument.
177175

178176
```azurecli
179-
az aks update --name myAKSCluster --resource-group MyResourceGroup --ssh-key-value <new SSH key value>
177+
az aks update --name myAKSCluster --resource-group MyResourceGroup --ssh-key-value <new SSH key value or SSH key file>
180178
```
181179

182-
Example:
183-
You can attach the new SSH key value directly to `--ssh-key-value`.
180+
Examples:
181+
In the following example, you can specify the new SSH key value for the `--ssh-key-value` argument.
184182

185183
```azurecli
186184
az aks update --name myAKSCluster --resource-group MyResourceGroup --ssh-key-value 'ssh-rsa AAAAB3Nza-xxx'
187185
```
188186

189-
Attaching SSH key file is also supported.
187+
In the following example, you specify a SSH key file.
190188

191189
```azurecli
192190
az aks update --name myAKSCluster --resource-group MyResourceGroup --ssh-key-value .ssh/id_rsa.pub
193191
```
194192

195193
> [!IMPORTANT]
196-
> During this operation, all VMSS instances will be upgraded and re-imaged to fit the new SSH key.
194+
> During this operation, all virtual machine scale set instances are upgraded and re-imaged to use the new SSH key.
197195
198196
## Next steps
199197

@@ -207,5 +205,6 @@ If you need more troubleshooting data, you can [view the kubelet logs][view-kube
207205
[ssh-nix]: ../virtual-machines/linux/mac-create-ssh-keys.md
208206
[ssh-windows]: ../virtual-machines/linux/ssh-from-windows.md
209207
[ssh-linux-kubectl-debug]: #create-an-interactive-shell-connection-to-a-linux-node
210-
[updating SSH key]: #update-the-ssh-key-on-existing-aks-cluster-public-preview
208+
[az-aks-upgrade]: /cli/azure/aks#az-aks-upgrade
209+
211210

0 commit comments

Comments
 (0)