Skip to content

Commit c8930b7

Browse files
authored
Update how-to-credential-manager-key-vault.md
1 parent 228ccd0 commit c8930b7

File tree

1 file changed

+61
-20
lines changed

1 file changed

+61
-20
lines changed

articles/operator-nexus/how-to-credential-manager-key-vault.md

Lines changed: 61 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,36 +22,43 @@ Azure Operator Nexus utilizes secrets and certificates to manage component secur
2222
> [!NOTE]
2323
> A single Key Vault can be used for any number of clusters.
2424
25-
## Writing Credential Updates to a Customer Key Vault on Nexus Cluster
25+
## Configure Managed Identity for Cluster Manager
2626

27-
- Ensure that the *Microsoft.NetworkCloud* resource provider is registered with the customer subscription.
27+
Beginning with the 2024-06-01 public preview API, managed identities are used in the Cluster Manager for write access to rotated credentials to a key vault. The Cluster Manager identity can be system-assigned or [user-assigned](/entra/identity/managed-identities-azure-resources/how-manage-user-assigned-managed-identities), and can be managed directly via APIs or via CLI.
2828

29-
```console
30-
az provider register --namespace 'Microsoft.NetworkCloud' --subscription <Subscription ID>
31-
```
32-
33-
- Assign the *Operator Nexus Key Vault Writer Service Role*. Ensure that *Azure role-based access control* is selected as the permission model for the key vault on the *Access configuration* view. Then from the *Access control (IAM)* view, select to add a role assignment.
29+
The examples below describe how to configure a managed identity for a Cluster Manager if one is not already configured.
3430

35-
| Role Name | Role Definition ID |
36-
|:-------------------------------------------------------|:-------------------------------------|
37-
| Operator Nexus Key Vault Writer Service Role (Preview) | 44f0a1a8-6fea-4b35-980a-8ff50c487c97 |
38-
39-
| Environment | App Name | App ID |
40-
|:------------|:----------------------|:-------------------------------------|
41-
| Production | AFOI-NC-RP-PME-PROD | 05cf5e27-931d-47ad-826d-cb9028d8bd7a |
42-
| Production | AFOI-NC-MGMT-PME-PROD | 3365d4ea-bb16-4bc9-86dd-f2c8cf6f1f56 |
31+
- Create or update Cluster Manager with system-assigned identity
32+
```
33+
az networkcloud clustermanager create --name "clusterManagerName" --location "location" \
34+
--analytics-workspace-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" \
35+
--fabric-controller-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName" \
36+
--managed-resource-group-configuration name="my-managed-rg" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --mi-system-assigned
37+
```
4338

44-
Example:
39+
- Create or update Cluster Manager with user-assigned identity
40+
```
41+
az networkcloud clustermanager create --name <Cluster Manager Name> --location <Location> \
42+
--analytics-workspace-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName" \
43+
--fabric-controller-id "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName" \
44+
--managed-resource-group-configuration name="my-managed-rg" --tags key1="myvalue1" key2="myvalue2" \
45+
--resource-group <Resource Group Name> --mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI
46+
```
4547

46-
```console
47-
az role assignment create --assignee 05cf5e27-931d-47ad-826d-cb9028d8bd7a --role 44f0a1a8-6fea-4b35-980a-8ff50c487c97 --scope /subscriptions/<Subscription ID>/resourceGroups/<Resource Group Name>/providers/Microsoft.KeyVault/vaults/<Key Vault Name>
48+
- Add system assigned identity to Cluster Manager
49+
```
50+
az networkcloud clustermanager update --name <Cluster Manager Name> --resource-group <Resource Group Name> --mi-system-assigned
51+
```
4852

49-
az role assignment create --assignee 3365d4ea-bb16-4bc9-86dd-f2c8cf6f1f56 --role 44f0a1a8-6fea-4b35-980a-8ff50c487c97 --scope /subscriptions/<Subscription ID>/resourceGroups/<Resource Group Name>/providers/Microsoft.KeyVault/vaults/<Key Vault Name>
53+
- Add user assigned identity to Cluster Manager
54+
```
55+
az networkcloud clustermanager update --name <Cluster Manager Name> --resource-group <Resource Group Name> \
56+
--mi-user-assigned "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myUAI"
5057
```
5158

5259
## Get the Principal ID for the Managed Identity
5360

54-
Once a managed identity is configured, use the 2024-05-01-preview API to view the Identity data within the cluster manager.
61+
Once a managed identity is configured, use the CLI to view the identity and the associated principal ID data within the cluster manager.
5562

5663
Example:
5764

@@ -81,6 +88,40 @@ User-assigned identity example:
8188
},
8289
```
8390

91+
## Using App IDs for Key Vault Access
92+
93+
> [!IMPORTANT]
94+
> Use of App IDs for Customer Key Vault access is deprecated and support will be removed in a future version. It is recommended to use managed identity principals.
95+
96+
Instead of managed identities, the following application IDs may be granted access to the Key Vault.
97+
98+
- Ensure that the *Microsoft.NetworkCloud* resource provider is registered with the customer subscription.
99+
100+
```console
101+
az provider register --namespace 'Microsoft.NetworkCloud' --subscription <Subscription ID>
102+
```
103+
104+
- When assigned role access to the key vault, use the following App IDs as principal IDs.
105+
106+
| Environment | App Name | App ID |
107+
|:------------|:----------------------|:-------------------------------------|
108+
| Production | AFOI-NC-RP-PME-PROD | 05cf5e27-931d-47ad-826d-cb9028d8bd7a |
109+
| Production | AFOI-NC-MGMT-PME-PROD | 3365d4ea-bb16-4bc9-86dd-f2c8cf6f1f56 |
110+
111+
## Writing Credential Updates to a Customer Key Vault on Nexus Cluster
112+
113+
- Assign the *Operator Nexus Key Vault Writer Service Role*. Ensure that *Azure role-based access control* is selected as the permission model for the key vault on the *Access configuration* view. Then from the *Access control (IAM)* view, select to add a role assignment.
114+
115+
| Role Name | Role Definition ID |
116+
|:-------------------------------------------------------|:-------------------------------------|
117+
| Operator Nexus Key Vault Writer Service Role (Preview) | 44f0a1a8-6fea-4b35-980a-8ff50c487c97 |
118+
119+
Example:
120+
121+
```console
122+
az role assignment create --assignee <Managed Identity Principal Id> --role 44f0a1a8-6fea-4b35-980a-8ff50c487c97 --scope /subscriptions/<Subscription ID>/resourceGroups/<Resource Group Name>/providers/Microsoft.KeyVault/vaults/<Key Vault Name>
123+
```
124+
84125
- User associates the Customer Key Vault with the Operator Nexus cluster. The key vault resource ID must be configured in the cluster and enabled to store the secrets of the cluster.
85126

86127
Example:

0 commit comments

Comments
 (0)