Skip to content

Commit 4a7f65b

Browse files
author
Eduardo Rivera
committed
remove grace period reference
1 parent 1123be6 commit 4a7f65b

File tree

2 files changed

+32
-19
lines changed

2 files changed

+32
-19
lines changed

articles/operator-nexus/howto-baremetal-bmc-ssh.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ ms.custom: template-how-to, devx-track-azurecli
1414
> [!CAUTION]
1515
> Please note this process is used in emergency situations when all other troubleshooting options via Azure have been exhausted. SSH access to these bare metal machines is restricted to users managed via this method from the specified jump host list.
1616
17-
There are rare situations where a user needs to investigate & resolve issues with a bare metal machine and all other ways using Azure have been exhausted. Operator Nexus provides the `az networkcloud cluster bmckeyset` command so users can manage SSH access to the baseboard management controller (BMC) on these bare metal machines. On keyset creation, users are validated agaisnt Azure Active Directory for proper authorization if a User Principal Name (UPN) is provided. For proper AAD authorization to occur, when creating new keyset a Azure Group ID must also be supplied with `--azure-group-id <Azure AAD Group ID>`.
17+
There are rare situations where a user needs to investigate & resolve issues with a bare metal machine and all other ways using Azure have been exhausted. Operator Nexus provides the `az networkcloud cluster bmckeyset` command so users can manage SSH access to the baseboard management controller (BMC) on these bare metal machines. On keyset creation, users are validated against Microsoft Entra ID for proper authorization by cross referencing the User Principal Name provided for a user against the supplied Azure Group ID `--azure-group-id <Azure AAD Group ID>`.
1818

19-
> [!CAUTION]
20-
> Not supplying a UPN is currently supported during keyset creation and update. After July 1st, 2024, if a UPN is not supplied for a user on keyset creation the user will marked invalid and will be unable to use their keyset. After the grace period date, if a UPN is not supplied for a user during keyset update the user will be marked invalid during reconciliation. In both creation and update scenarios, the keysets and the users are **NOT** deleted, simply invalidated. It is suggested that before July 1st, 2024, the steps are followed to re-create keysets with the UPN for users being provided.
19+
> [!NOTE]
20+
> Not supplying a UPN is currently supported during keyset creation and update. However in a future release enforcement of AAD validation is planned and if a UPN is not supplied for a user on keyset creation/update the user will marked invalid. A user marked invalid does not get deleted but, the user and the matching keyset will no longer be able to be used for SSH access. It is suggested that begin to follow steps to update or re-create keysets supplying UPN for users.
2121
2222
When the command runs, it executes on each bare metal machine in the Cluster with an active Kubernetes node. There's a reconciliation process that runs periodically that retries the command on any bare metal machine that wasn't available at the time of the original command. Also, any bare metal machine that returns to the cluster via an `az networkcloud baremetalmachine actionreimage` or `az networkcloud baremetalmachine actionreplace` command (see [BareMetal functions](./howto-baremetal-functions.md)) sends a signal causing any active keysets to be sent to the machine as soon as it returns to the cluster. Multiple commands execute in the order received.
2323

@@ -54,8 +54,9 @@ az networkcloud cluster bmckeyset create \
5454
--expiration <Expiration Timestamp> \
5555
--jump-hosts-allowed <List of jump server IP addresses> \
5656
--privilege-level <"Administrator" or "ReadOnly"> \
57-
--user-list '[{"description":"<User description>","azureUserName":"<User Name>", \
58-
"sshPublicKey":{"keyData":"<SSH Public Key>"}}]' \
57+
--user-list '[{"description":"<User List Description>","azureUserName":"<User Name>",\
58+
"sshPublicKey":{"keyData":"<SSH Public Key>"}, \
59+
"userPrincipalName":""}]', \
5960
--tags key1=<Key Value> key2=<Key Value> \
6061
--cluster-name <Cluster Name> \
6162
--resource-group <Resource Group Name>
@@ -91,6 +92,7 @@ az networkcloud cluster bmckeyset create \
9192
azure-user-name: Required. User name used to login to the server.
9293
description: The free-form description for this user.
9394
key-data: Required. The public ssh key of the user.
95+
userPrincipalName: Optional. The User Principal Name of the User.
9496
9597
Multiple users can be specified by using more than one --user-list argument.
9698
--tags : Space-separated tags: key[=value]
@@ -191,9 +193,9 @@ az networkcloud cluster bmckeyset update \
191193
--name <BMC Keyset Name> \
192194
--jump-hosts-allowed <List of jump server IP addresses> \
193195
--privilege-level <"Standard" or "Superuser"> \
194-
--user-list '[{"description":"<User description>",\
195-
"azureUserName":"<UserName>", \
196-
"sshPublicKey":{"keyData":"<SSH Public Key>"}}]' \
196+
--user-list '[{"description":"<User List Description>","azureUserName":"<User Name>",\
197+
"sshPublicKey":{"keyData":"<SSH Public Key>"}, \
198+
"userPrincipalName":""}]', \
197199
--tags key1=<Key Value> key2=<Key Value> \
198200
--cluster-name <Cluster Name> \
199201
--resource-group <Resource Group Name>
@@ -220,6 +222,7 @@ az networkcloud cluster bmckeyset update \
220222
azure-user-name: Required. User name used to login to the server.
221223
description: The free-form description for this user.
222224
key-data: Required. The public SSH key of the user.
225+
userPrincipalName: Optional. The User Principal Name of the User.
223226
224227
Multiple users can be specified by using more than one --user-list argument.
225228
--resource-group -g [Required] : Name of resource group. Optional if
@@ -239,7 +242,9 @@ az networkcloud cluster bmckeyset update \
239242
--name "bmcKeySetName" \
240243
--expiration "2023-12-31T23:59:59.008Z" \
241244
--user-list '[{"description":"Needs access for troubleshooting as a part of the support team",\
242-
"azureUserName":"userDEF","sshPublicKey":{"keyData":"ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1XoyYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"}}]\
245+
"azureUserName":"userDEF", \
246+
"sshPublicKey":{"keyData":"ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1XoyYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"}, \
247+
"userPrincipalName":"[email protected]"}] \
243248
--cluster-name "clusterName" \
244249
--resource-group "resourceGroupName"
245250
```

articles/operator-nexus/howto-baremetal-bmm-ssh.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ ms.custom: template-how-to, devx-track-azurecli
1414
> [!CAUTION]
1515
> Please note this process is used in emergency situations when all other troubleshooting options using Azure have been exhausted. SSH access to these bare metal machines is restricted to users managed via this method from the specified jump host list.
1616
17-
There are rare situations where a user needs to investigate & resolve issues with a bare metal machine and all other ways have been exhausted via Azure. Azure Operator Nexus provides the `az networkcloud cluster baremetalmachinekeyset` command so users can manage SSH access to these bare metal machines. On keyset creation, users are validated agaisnt Azure Active Directory for proper authorization if a User Principal Name (UPN) is provided. For proper AAD authorization to occur, when creating new keyset a Azure Group ID must also be supplied with `--azure-group-id <Azure AAD Group ID>`.
17+
There are rare situations where a user needs to investigate & resolve issues with a bare metal machine and all other ways have been exhausted via Azure. Azure Operator Nexus provides the `az networkcloud cluster baremetalmachinekeyset` command so users can manage SSH access to these bare metal machines. On keyset creation, users are validated against Microsoft Entra ID for proper authorization by cross referencing the User Principal Name provided for a user against the supplied Azure Group ID `--azure-group-id <Azure AAD Group ID>`.
1818

19-
> [!CAUTION]
20-
> Not supplying a UPN is currently supported during keyset creation and update. After July 1st, 2024, if a UPN is not supplied for a user on keyset creation the user will marked invalid and will be unable to use their keyset. After the grace period date, if a UPN is not supplied for a user during keyset update the user will be marked invalid during reconciliation. In both creation and update scenarios, the keysets and the users are **NOT** deleted, simply invalidated. It is suggested that before July 1st, 2024, the steps are followed to re-create keysets with the UPN for users being provided.
19+
> [!NOTE]
20+
> Not supplying a UPN is currently supported during keyset creation and update. However in a future release enforcement of AAD validation is planned and if a UPN is not supplied for a user on keyset creation/update the user will marked invalid. A user marked invalid does not get deleted but, the user and the matching keyset will no longer be able to be used for SSH access. It is suggested that begin to follow steps to update or re-create keysets supplying UPN for users.
2121
2222
When the command runs, it executes on each bare metal machine in the Cluster with an active Kubernetes node. There's a reconciliation process that runs periodically that retries the command on any bare metal machine that wasn't available at the time of the original command. Also, any bare metal machine that returns to the cluster via an `az networkcloud baremetalmachine actionreimage` or `az networkcloud baremetalmachine actionreplace` command (see [BareMetal functions](./howto-baremetal-functions.md)) sends a signal causing any active keysets to be sent to the machine as soon as it returns to the cluster. Multiple commands execute in the order received.
2323

@@ -27,7 +27,7 @@ There's no limit to the number of users in a group.
2727
> Notes for jump host IP addresses
2828
2929
- The keyset create/update process adds the jump host IP addresses to the IP tables for each machine in the Cluster. This restricts SSH access to be allowed only from those jump hosts.
30-
- It's important to specify the Cluster facing IP addresses for the jump hosts. These IP addresses may be different than the public facing IP address used to access the jump host.
30+
- It's important to specify the Cluster facing IP addresses for the jump hosts. These IP addresses might be different than the public facing IP address used to access the jump host.
3131
- Once added, users are able to access bare metal machines from any specified jump host IP including a jump host IP defined in another bare metal machine keyset group.
3232
- Existing SSH access remains when adding the first bare metal machine keyset. However, the keyset command limits an existing user's SSH access to the specified jump host IPs in the keyset commands.
3333

@@ -64,7 +64,8 @@ az networkcloud cluster baremetalmachinekeyset create \
6464
--os-group-name <Name of the Operating System Group> \
6565
--privilege-level <"Standard" or "Superuser"> \
6666
--user-list '[{"description":"<User List Description>","azureUserName":"<User Name>",\
67-
"sshPublicKey":{"keyData":"<SSH Public Key>"}}]' \
67+
"sshPublicKey":{"keyData":"<SSH Public Key>"}, \
68+
"userPrincipalName":""}]', \
6869
--tags key1=<Key Value> key2=<Key Value> \
6970
--cluster-name <Cluster Name> \
7071
--resource-group <Resource Group>
@@ -105,6 +106,7 @@ az networkcloud cluster baremetalmachinekeyset create \
105106
azure-user-name: Required. User name used to login to the server.
106107
description: The free-form description for this user.
107108
key-data: Required. The public ssh key of the user.
109+
userPrincipalName: Optional. The User Principal Name of the User.
108110
109111
Multiple users can be specified by using more than one --user-list argument.
110112
--os-group-name : The name of the group that users are assigned
@@ -153,8 +155,8 @@ az networkcloud cluster baremetalmachinekeyset create \
153155
--jump-hosts-allowed "192.0.2.1" "192.0.2.5" \
154156
--os-group-name "standardAccessGroup" \
155157
--privilege-level "Standard" \
156-
--user-list '[{"description":"Needs access for troubleshooting as a part of the support team","azureUserName":"userABC", "sshPublicKey":{"keyData":"ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1XoyYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"}},\
157-
{"description":"Needs access for troubleshooting as a part of the support team","azureUserName":"userXYZ","sshPublicKey":{"keyData":"ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXTSTRnIDpcf5qytjs1XoyYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"}}]' \
158+
--user-list '[{"description":"Needs access for troubleshooting as a part of the support team","azureUserName":"userABC", "sshPublicKey":{"keyData":"ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1XoyYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"},"userPrincipalName":"[email protected]"},\
159+
{"description":"Needs access for troubleshooting as a part of the support team","azureUserName":"userXYZ","sshPublicKey":{"keyData":"ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXTSTRnIDpcf5qytjs1XoyYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"}, "userPrincipalName":"[email protected]"}]' \
158160
--tags key1="myvalue1" key2="myvalue2" \
159161
--cluster-name "clusterName"
160162
--resource-group "resourceGroupName"
@@ -210,7 +212,8 @@ az networkcloud cluster baremetalmachinekeyset update \
210212
--jump-hosts-allowed <List of jump server IP addresses> \
211213
--privilege-level <"Standard" or "Superuser"> \
212214
--user-list '[{"description":"<User List Description>","azureUserName":"<User Name>",\
213-
"sshPublicKey":{"keyData":"<SSH Public Key>"}}]' \
215+
"sshPublicKey":{"keyData":"<SSH Public Key>"}, \
216+
"userPrincipalName":""}]', \
214217
--tags key1=<Key Value> key2=<Key Value> \
215218
--cluster-name <Cluster Name> \
216219
--resource-group <Resource Group>
@@ -237,6 +240,7 @@ az networkcloud cluster baremetalmachinekeyset update \
237240
azure-user-name: Required. User name used to login to the server.
238241
description: The free-form description for this user.
239242
key-data: Required. The public SSH key of the user.
243+
userPrincipalName: Optional. The User Principal Name of the User.
240244
241245
Multiple users can be specified by using more than one --user-list argument.
242246
--resource-group -g [Required] : Name of resource group. Optional if
@@ -256,9 +260,13 @@ az networkcloud cluster baremetalmachinekeyset update \
256260
--name "bareMetalMachineKeySetName" \
257261
--expiration "2023-12-31T23:59:59.008Z" \
258262
--user-list '[{"description":"Needs access for troubleshooting as a part of the support team",\
259-
"azureUserName":"userABC","sshPublicKey":{"keyData":"ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1XoyYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"}},\
263+
"azureUserName":"userABC", \
264+
"sshPublicKey":{"keyData":"ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1XoyYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"}, \
265+
"userPrincipalName":"[email protected]"},\
260266
{"description":"Needs access for troubleshooting as a part of the support team",\
261-
"azureUserName":"userXYZ","sshPublicKey":{"keyData":"ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXTSTRnIDpcf5qytjs1XoyYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"}}]' \
267+
"azureUserName":"userXYZ", \
268+
"sshPublicKey":{"keyData":"ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXTSTRnIDpcf5qytjs1XoyYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"}, \
269+
"userPrincipalName":"[email protected]"}]' \
262270
--cluster-name "clusterName" \
263271
--resource-group "resourceGroupName"
264272
```

0 commit comments

Comments
 (0)