Skip to content

Commit 41872cb

Browse files
committed
Added TOC and updated the Acrolinx comments
1 parent debc8b6 commit 41872cb

File tree

2 files changed

+20
-18
lines changed

2 files changed

+20
-18
lines changed

articles/operator-nexus/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,8 @@
159159
href: how-to-customize-kubernetes-cluster-dns.md
160160
- name: Customize Worker Nodes
161161
href: howto-kubernetes-cluster-customize-workers.md
162+
- name: Manage SSH keys
163+
href: howto-kubernetes-cluster-manage-ssh-key.md
162164
- name: Nexus Virtual Machine
163165
expanded: false
164166
items:

articles/operator-nexus/howto-kubernetes-cluster-manage-ssh-key.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Manage SSH access on Azure Operator Nexus Kubernetes cluster nodes #Required; page title is displayed in search results. Include the brand.
3-
description: Learn how to configure and manage SSH on Azure Operator Nexus Kubernetes cluster nodes #Required; article description that is displayed in search results.
3+
description: Learn how to configure and manage SSH on Azure Operator Nexus Kubernetes cluster nodes. #Required; article description that is displayed in search results.
44
author: dramasamy #Required; your GitHub user alias, with correct capitalization.
55
ms.author: dramasamy #Required; microsoft alias of author; optional team alias.
66
ms.service: azure-operator-nexus #Required; service per approved list. slug assigned by ACOM.
@@ -36,7 +36,7 @@ There are a few different ways that you can provide SSH keys for your cluster no
3636

3737
Following are the variables you need to set, along with the [QuickStart guide](./quickstarts-kubernetes-cluster-deployment-cli.md#create-an-azure-nexus-kubernetes-cluster) default values you can use for certain variables.
3838

39-
* `SSH_PUBLIC_KEY` - For the cluster wide keys. Note that using cluster wide key with agent pool and control plane keys doesn't have any effect as the control plane and agent pool keys are used instead of the cluster wide keys.
39+
* `SSH_PUBLIC_KEY` - For the cluster wide keys. Using cluster wide key with agent pool and control plane keys doesn't have any effect as the control plane and agent pool keys are used instead of the cluster wide keys.
4040
* `CONTROL_PLANE_SSH_PUBLIC_KEY` - For the control plane, you can provide public keys that are inserted into the control plane nodes.
4141
* `INITIAL_AGENT_POOL_SSH_PUBLIC_KEY` - For each agent pool, you can provide public keys that are inserted into the nodes in that pool.
4242

@@ -64,7 +64,7 @@ Following are the variables you need to set, along with the [QuickStart guide](.
6464
dns-service-ip="${DNS_SERVICE_IP}"
6565
```
6666

67-
### [Azure ARM](#tab/other)
67+
### [Azure Resource Manager](#tab/other)
6868

6969
The `administratorConfiguration` can be inserted into the `properties` object for the cluster wide keys, and into the `initialAgentPoolConfigurations[].administratorConfiguration` object for each agent pool. The `controlPlaneNodeConfiguration.administratorConfiguration` object is used for the control plane.
7070

@@ -158,7 +158,7 @@ NEW_CLUSTER_WIDE_KEY="ssh-rsa CCCCC...."
158158
az networkcloud kubernetescluster update --name "$CLUSTER_NAME" --resource-group "$RESOURCE_GROUP" --subscription "$SUBSCRIPTION_ID" --ssh-key-values "$CLUSER_WIDE_KEY"
159159
```
160160

161-
#### Azure ARM and Bicep to update cluster wide SSH keys
161+
#### Azure Resource Manager (ARM) and Bicep to update cluster wide SSH keys
162162

163163
1. Update the `sshPublicKeys` parameter in `kubernetes-deploy-parameters.json` with the new SSH key.
164164

@@ -174,13 +174,13 @@ az networkcloud kubernetescluster update --name "$CLUSTER_NAME" --resource-group
174174

175175
2. Redeploy the template.
176176

177-
for ARM:
177+
For ARM template:
178178

179179
```azurecli
180180
az deployment group create --resource-group myResourceGroup --template-file kubernetes-deploy.json --parameters @kubernetes-deploy-parameters.json
181181
```
182182

183-
for Bicep:
183+
For Bicep:
184184

185185
```azurecli
186186
az deployment group create --resource-group myResourceGroup --template-file kubernetes-deploy.bicep --parameters @kubernetes-deploy-parameters.json
@@ -191,9 +191,9 @@ for Bicep:
191191
Use the following command to update the SSH keys for a specific agent pool.
192192

193193
* All the nodes in the agent pool will be updated with the new keys.
194-
* If the agent pool was created with keys, the new keys will replace the existing keys.
195-
* If the agent pool was created without keys, the new keys will be added.
196-
* If the agent pool was created with cluster wide keys, the new keys will replace the existing keys.
194+
* If the agent pool was created with keys, the new keys replace the existing keys.
195+
* If the agent pool was created without keys, the new keys are added.
196+
* If the agent pool was created with cluster wide keys, the new keys replace the existing keys.
197197
* If you try to update the keys for a cluster that was created without any keys, the new key is added, but you can't remove it.
198198
* If you try to update the agent pool keys with an empty array, the operation succeeds, and the cluster wide keys are used instead.
199199

@@ -211,7 +211,7 @@ AGENT_POOL_KEY="ssh-rsa DDDDD...."
211211
az networkcloud kubernetescluster agentpool update --agent-pool-name "${CLUSTER_NAME}-nodepool-2" --kubernetes-cluster-name "$CLUSTER_NAME" --resource-group "$RESOURCE_GROUP" --subscription "$SUBSCRIPTION_ID" --ssh-key-values "$AGENT_POOL_KEY"
212212
```
213213

214-
#### Azure ARM and Bicep to update agent pool SSH keys
214+
#### Azure ARM template and Bicep to update agent pool SSH keys
215215

216216
> [!NOTE]
217217
> Updating node pools created through initial agent pool configuration is not possible with this method, as there is no separate agent pool template and parameter file. Only the agent pool keys for pools created after cluster creation can be updated using this method. To update the keys for the initial agent pool, refer to the CLI command provided in the previous section. If the initial agent pool was created with cluster wide keys, and if you want to update the keys for the initial agent pool, you can update the cluster wide keys.
@@ -230,13 +230,13 @@ az networkcloud kubernetescluster agentpool update --agent-pool-name "${CLUSTER_
230230

231231
2. Redeploy the template.
232232

233-
for ARM:
233+
For ARM template:
234234

235235
```azurecli
236236
az deployment group create --resource-group myResourceGroup --template-file kubernetes-add-agentpool.json --parameters @kubernetes-nodepool-parameters.json
237237
```
238238

239-
for Bicep:
239+
For Bicep:
240240

241241
```azurecli
242242
az deployment group create --resource-group myResourceGroup --template-file kubernetes-add-agentpool.bicep --parameters @kubernetes-nodepool-parameters.json
@@ -247,9 +247,9 @@ for Bicep:
247247
Use the following command to update the SSH keys for the control plane.
248248

249249
* All the nodes in the control plane will be updated with the new keys.
250-
* If the control plane was created with keys, the new keys will replace the existing keys.
251-
* If the control plane was created without keys, the new keys will be added.
252-
* If the control plane was created with cluster wide keys, the new keys will replace the existing keys.
250+
* If the control plane was created with keys, the new keys replace the existing keys.
251+
* If the control plane was created without keys, the new keys are added.
252+
* If the control plane was created with cluster wide keys, the new keys replace the existing keys.
253253
* If you try to update the keys for a cluster that was created without any keys, the new key is added, but you can't remove it.
254254
* If you try to update the control plane keys with an empty array, the operation succeeds, and the cluster wide keys are used instead.
255255

@@ -270,7 +270,7 @@ CONTROL_PLANE_KEY="ssh-rsa EEEEE...."
270270
az networkcloud kubernetescluster update --name "$CLUSTER_NAME" --resource-group "$RESOURCE_GROUP" --subscription "$SUBSCRIPTION_ID" --control-plane-node-configuration ssh-key-values="['$CONTROL_PLANE_KEY']"
271271
```
272272

273-
#### Azure ARM and Bicep to update control plane SSH keys
273+
#### Azure ARM template and Bicep to update control plane SSH keys
274274

275275
1. Update the `controlPlaneSshKeys` parameter in `kubernetes-deploy-parameters.json` with the new SSH key.
276276

@@ -286,13 +286,13 @@ az networkcloud kubernetescluster update --name "$CLUSTER_NAME" --resource-group
286286

287287
2. Redeploy the template.
288288

289-
for ARM:
289+
For ARM template:
290290

291291
```azurecli
292292
az deployment group create --resource-group myResourceGroup --template-file kubernetes-deploy.json --parameters @kubernetes-deploy-parameters.json
293293
```
294294

295-
for Bicep:
295+
For Bicep:
296296

297297
```azurecli
298298
az deployment group create --resource-group myResourceGroup --template-file kubernetes-deploy.bicep --parameters @kubernetes-deploy-parameters.json

0 commit comments

Comments
 (0)