Skip to content

Commit 767f1ac

Browse files
bartpintobartpinto
authored
Update howto-cluster-manager.md
Updates based on comments.
1 parent 5684e8d commit 767f1ac

File tree

1 file changed

+51
-45
lines changed

1 file changed

+51
-45
lines changed

‎articles/operator-nexus/howto-cluster-manager.md

Lines changed: 51 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ ms.custom: devx-track-azurecli
1414

1515
The Cluster Manager is deployed in the operator's Azure subscription to manage the lifecycle of Operator Nexus Infrastructure Clusters.
1616

17+
---
18+
1719
## Before you begin
1820

1921
Ensure you have the following information:
@@ -23,9 +25,13 @@ Ensure you have the following information:
2325
- **Azure Region** - The Cluster Manager should be created in the same Azure region as the Network Fabric Controller.
2426
This Azure region should be used in the `Location` field of the Cluster Manager and all associated Operator Nexus instances.
2527

28+
---
29+
2630
## Limitations
2731
- **Naming** - Naming rules can be found [here](../azure-resource-manager/management/resource-name-rules.md#microsoftnetworkcloud).
2832

33+
---
34+
2935
## Cluster Manager properties
3036

3137
| Property Name | Description |
@@ -35,11 +41,12 @@ This Azure region should be used in the `Location` field of the Cluster Manager
3541
| managedResourceGroupConfiguration | The details of Managed Resource Group that is created for the Cluster Manager to host its internally used resources. |
3642
| fabricControllerId | The reference to the Network Fabric Controller that is 1:1 with this Cluster Manager |
3743
| clusterVersions[] | The list of Cluster versions that the Cluster Manager supports. It's used as an input in the Cluster clusterVersion property. |
38-
| userAssignedIdentity | The details of the User Assigned Managed Identity assigned to the Cluster Manager. |
39-
| identity | The details of the type of identity assigned to the Cluster Manager. |
40-
| provisioningState | The provisioning status of the latest operation on the Cluster Manager. One of: Succeeded, Failed, Provisioning, Accepted, Updating |
44+
| userAssignedIdentity | The details of the User Assigned Managed Identity assigned to the Cluster Manager if it is assigned. |
45+
| identity | The details of the type of identity assigned to the Cluster Manager. One of: UserAssigned or SystemAssigned. |
46+
| provisioningState | The provisioning status of the latest operation on the Cluster Manager. One of: Succeeded, Failed, Provisioning, Accepted, Updating. |
4147
| detailedStatus | The detailed statuses that provide additional information about the status of the Cluster Manager. |
4248
| detailedStatusMessage | The descriptive message about the current detailed status. |
49+
---
4350

4451
## Cluster Manager Identity
4552

@@ -58,6 +65,8 @@ The role assignment can be done via the Azure portal:
5865
- Select Member: `AFOI-NC-MGMT-PME-PROD` application
5966
- Review and assign
6067

68+
---
69+
6170
## Create a Cluster Manager
6271

6372
Use the below commands to create a Cluster Manager.
@@ -243,7 +252,38 @@ az networkcloud clustermanager update \
243252
--subscription "<SUB_ID>"
244253
```
245254

246-
Cluster Manager identity can be managed via CLI using `az networkcloud clustermanager identity` sub commands.
255+
### [Azure PowerShell](#tab/azure-powershell)
256+
257+
This command updates the Cluster Manager in the specified Resource group.
258+
259+
```azurepowershell-interactive
260+
$TAGS_HASH = @{
261+
tag1 = "true"
262+
tag2 = "false"
263+
}
264+
265+
Update-AzNetworkCloudClusterManager -Name "<CLUSTER_MANAGER_NAME>" -ResourceGroupName "<CLUSTER_MANAGER_RG>" -SubscriptionId "<SUB_ID>" -Tag $TAGS_HASH
266+
```
267+
268+
This command updates the Cluster Manager for `SystemAssigned` Managed Identity:
269+
```azurepowershell-interactive
270+
Update-AzNetworkCloudClusterManager -Name "<CLUSTER_MANAGER_NAME>" -ResourceGroupName "<CLUSTER_MANAGER_RG>" -SubscriptionId "<SUB_ID>" -IdentityType "SystemAssigned"
271+
```
272+
273+
This command updates the Cluster Manager for `UserAssigned` Managed Identity:
274+
```azurepowershell-interactive
275+
Update-AzNetworkCloudClusterManager -Name "<CLUSTER_MANAGER_NAME>" -ResourceGroupName "<CLUSTER_MANAGER_RG>" -SubscriptionId "<SUB_ID>" -IdentityType "UserAssigned" -IdentityUserAssignedIdentity <UAMI_RESOURCE_ID>
276+
```
277+
278+
### [ARM Template](#tab/template)
279+
280+
The template used for creation can also be used to update the Cluster Manager.
281+
282+
---
283+
284+
## Cluster Manager identity
285+
286+
The Cluster Manager identity can be managed via CLI using `az networkcloud clustermanager identity` sub commands.
247287

248288
This command shows the currently assigned identities.
249289

@@ -274,7 +314,7 @@ az networkcloud clustermanager identity assign \
274314
--mi-system-assigned
275315
```
276316

277-
This command removes a user-assigned identity.
317+
This command removes the user-assigned identity.
278318

279319
```azurecli-interactive
280320
az networkcloud clustermanager identity remove \
@@ -284,7 +324,7 @@ az networkcloud clustermanager identity remove \
284324
--mi-user-assigned "<UAMI_RESOURCE_ID>"
285325
```
286326

287-
This command removes a system-assigned identity.
327+
This command removes the system-assigned identity.
288328

289329
```azurecli-interactive
290330
az networkcloud clustermanager identity remove \
@@ -294,43 +334,6 @@ az networkcloud clustermanager identity remove \
294334
--mi-system-assigned
295335
```
296336

297-
### [Azure PowerShell](#tab/azure-powershell)
298-
299-
This command updates the Cluster Manager in the specified Resource group.
300-
301-
```azurepowershell-interactive
302-
$TAGS_HASH = @{
303-
tag1 = "true"
304-
tag2 = "false"
305-
}
306-
307-
Update-AzNetworkCloudClusterManager -Name "<CLUSTER_MANAGER_NAME>" -ResourceGroupName "<CLUSTER_MANAGER_RG>" -SubscriptionId "<SUB_ID>" -Tag $TAGS_HASH
308-
```
309-
310-
This command updates the Cluster Manager for `SystemAssigned` Managed Identity:
311-
```azurepowershell-interactive
312-
$TAGS_HASH = @{
313-
tag1 = "true"
314-
tag2 = "false"
315-
}
316-
317-
Update-AzNetworkCloudClusterManager -Name "<CLUSTER_MANAGER_NAME>" -ResourceGroupName "<CLUSTER_MANAGER_RG>" -SubscriptionId "<SUB_ID>" -IdentityType "SystemAssigned" -Tag $TAGS_HASH
318-
```
319-
320-
This command updates the Cluster Manager for `UserAssigned` Managed Identity:
321-
```azurepowershell-interactive
322-
$TAGS_HASH = @{
323-
tag1 = "true"
324-
tag2 = "false"
325-
}
326-
327-
Update-AzNetworkCloudClusterManager -Name "<CLUSTER_MANAGER_NAME>" -ResourceGroupName "<CLUSTER_MANAGER_RG>" -SubscriptionId "<SUB_ID>" -IdentityType "UserAssigned" -IdentityUserAssignedIdentity <UAMI_RESOURCE_ID> -Tag $TAGS_HASH
328-
```
329-
330-
### [ARM Template](#tab/template)
331-
332-
The template used for creation can also be used to update the Cluster Manager.
333-
334337
---
335338

336339
## Delete Cluster Manager
@@ -359,17 +362,20 @@ Remove-AzNetworkCloudClusterManager -Name "<CLUSTER_MANAGER_NAME>" -ResourceGrou
359362

360363
To delete the Cluster Manager, use Portal, CLI, or PowerShell.
361364

362-
---
363-
364365
>[!NOTE]
365366
>As best practice, wait 20 minutes after deleting a Cluster Manager before trying to create a new Cluster Manager with the same name.
366367
368+
---
369+
367370
## Next steps
368371

369372
After you successfully created the Network Fabric Controller and the Cluster Manager, the next step is to create a [Network Fabric](./howto-configure-network-fabric.md).
370373

374+
---
375+
371376
## Useful links
372377

373378
- [NetworkCloud REST APIs Reference](/rest/api/networkcloud/)
374379
- [NetworkCloud PowerShell Reference](/powershell/module/az.networkcloud/)
375380

381+
---

0 commit comments

Comments
 (0)