Skip to content

Commit c3d4cb4

Browse files
Merge pull request #296556 from matternst7258/matternst7258/keyset-limits
[operator-nexus] Adds language for keysets to not leverage groups with greater than 5k…
2 parents f70c8a2 + 2ae40ec commit c3d4cb4

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

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

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,25 @@ author: DanCrank
55
ms.author: danielcrank
66
ms.service: azure-operator-nexus
77
ms.topic: how-to
8-
ms.date: 06/12/2024
8+
ms.date: 03/18/2025
99
ms.custom: template-how-to, devx-track-azurecli
1010
---
1111

1212
# Manage emergency access to a bare metal machine using the `az networkcloud cluster bmckeyset`
1313

1414
> [!CAUTION]
15-
> Please note this process is used in emergency situations when all other troubleshooting options via Azure are exhausted. SSH access to these bare metal machines is restricted to users managed via this method from the specified jump host list.
15+
> This process is used in emergency situations when all other troubleshooting options via Azure are exhausted. SSH access to these bare metal machines is restricted to users managed via this method from the specified jump host list.
1616
1717
There are rare situations where a user needs to investigate & resolve issues with a bare metal machine and all other ways using Azure are 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 <Entra Group ID>`.
1818

1919
Users in a keyset are validated every four hours, and also when any changes are made to any keyset. Each user's status is then set to "Active" or "Invalid." Invalid users remain in the keyset but their keys are removed from all hosts and they aren't allowed access. Reasons for a user being invalid are:
20-
- The user's User Principal Name hasn't been specified
20+
- The user's User Principal Name isn't specified
2121
- The user's User Principal Name isn't a member of the given Entra group
2222
- The given Entra group doesn't exist (in which case all users in the keyset are invalid)
2323
- The keyset is expired (in which case all users in the keyset are invalid)
2424

2525
> [!NOTE]
26-
> The User Principal Name is now required for keysets as Microsoft Entra ID validation is enforced for all users. Current keysets that do not specify User Principal Names for all users will continue to work until the expiration date. If a keyset without User Principal Names expires, the keyset will need to be updated with User Principal Names, for all users, in order to become valid again. Keysets that have not been updated with the User Principal Names for all users prior to December 2024 are at-risk of being `Invalid`. Note that if any user fails to specify a User Principal Name this results in the entire keyset being invalidated.
26+
> The User Principal Name is now required for keysets as Microsoft Entra ID validation is enforced for all users. Current keysets that don't specify User Principal Names for all users will continue to work until the expiration date. If a keyset without User Principal Names expires, the keyset will need to be updated with User Principal Names, for all users, in order to become valid again. Keysets that haven't been updated with the User Principal Names for all users before December 2024 are at-risk of being `Invalid`. Note that if any user fails to specify a User Principal Name this results in the entire keyset being invalidated.
2727
2828
The keyset and each individual user also have detailed status messages communicating other information:
2929
- The keyset's detailedStatusMessage tells you whether the keyset is expired, and other information about problems encountered while updating the keyset across the cluster.
@@ -33,6 +33,9 @@ When the command runs, it executes on each bare metal machine in the Cluster wit
3333

3434
The BMCs support a maximum number of 12 users. Users are defined on a per Cluster basis and applied to each bare metal machine. Attempts to add more than 12 users results in an error. Delete a user before adding another one when 12 already exists.
3535

36+
> [!WARNING]
37+
> Using an Entra Group ID with greater than 5,000 users isn't recommended. Reconciling a large number of users can result in timeouts, blocking access and causing login issues.
38+
3639
## Prerequisites
3740

3841
- Install the latest version of the [appropriate CLI extensions](./howto-install-cli-extensions.md).

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ The keyset and each individual user also have detailed status messages communica
3232

3333
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 reimage` or `az networkcloud baremetalmachine replace` 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.
3434

35-
There's no limit to the number of users in a group.
35+
> [!WARNING]
36+
> Using an Entra Group ID with greater than 5,000 users isn't recommended. Reconciling a large number of users can result in timeouts, blocking access and causing login issues.
3637
3738
> [!CAUTION]
3839
> Notes for jump host IP addresses

0 commit comments

Comments
 (0)