Skip to content

Commit 0909501

Browse files
committed
Remove references to cluster service principal
Removes reference to cluster service principal in the Nexus public documentation. Adds some missing documentation on bring-your-own resources
1 parent 3feb6f3 commit 0909501

9 files changed

+112
-265
lines changed

articles/operator-nexus/TOC.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -346,12 +346,6 @@
346346
href: howto-configure-acls-for-ssh-management-on-access-vpn.md
347347
- name: Enable/Disable Vulnerability Scanning
348348
href: howto-enable-disable-vulnerability-scanning.md
349-
- name: Service Principal Best Practices
350-
href: howto-service-principal.md
351-
expanded: false
352-
items:
353-
- name: Service Principal Rotation
354-
href: howto-service-principal-rotation.md
355349
- name: Install CLI Extension
356350
href: howto-install-cli-extensions.md
357351
- name: General

articles/operator-nexus/cluster-jsonc-example.md

Lines changed: 63 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ ms.custom: template-how-to, devx-track-arm-template
2020
"environment": {
2121
"type": "string",
2222
"metadata": {
23-
"description": "Name of the Environment"
23+
"description": "Name of the environment"
2424
}
2525
},
2626
"name": {
@@ -48,9 +48,6 @@ ms.custom: template-how-to, devx-track-arm-template
4848
"description": "Specify a Managed Resource Group for the Resource."
4949
}
5050
},
51-
"clusterLawName": {
52-
"type": "string"
53-
},
5451
"networkFabricId": {
5552
"type": "string",
5653
"metadata": {
@@ -60,7 +57,7 @@ ms.custom: template-how-to, devx-track-arm-template
6057
"clusterType": {
6158
"type": "string",
6259
"metadata": {
63-
"description": "The type of the Cluster, single or multi-rack"
60+
"description": "The type of the cluster, whether single or multi-rack"
6461
},
6562
"allowedValues": [
6663
"SingleRack",
@@ -70,7 +67,7 @@ ms.custom: template-how-to, devx-track-arm-template
7067
"clusterVersion": {
7168
"type": "string",
7269
"metadata": {
73-
"description": "The version of the Cluster to install"
70+
"description": "The version of the cluster to install"
7471
}
7572
},
7673
"clusterLocation": {
@@ -82,39 +79,55 @@ ms.custom: template-how-to, devx-track-arm-template
8279
"customLocation": {
8380
"type": "string",
8481
"metadata": {
85-
"description": "The Custom Location of the Cluster Manager"
82+
"description": "The custom location of the cluster manager"
8683
}
8784
},
8885
"aggregatorOrSingleRack": {
8986
"type": "object",
9087
"metadata": {
91-
"description": "Aggregator Rack or single Rack definition"
88+
"description": "Aggregator rack or single rack definition"
9289
}
9390
},
9491
"computeRacks": {
9592
"type": "array",
9693
"metadata": {
9794
"description": "Compute Rack definitions"
9895
}
96+
"secretArchiveSettings": {
97+
"type": "secureobject",
98+
"metadata": {
99+
"description": "SecretArchiveSettings supports the key vault URI along with the managed identity to be used for accessing the key vault"
100+
},
101+
},
102+
"analyticsWorkspaceName": {
103+
"type": "string",
104+
"metadata": {
105+
"description": "The name of the analytics workspace to create for the cluster"
106+
}
107+
},
108+
"analyticsOutputSettings": {
109+
"type": "object",
110+
"metadata": {
111+
"description": "The resource ID of the analytics workspace to create for the cluster"
112+
}
113+
},
114+
"commandOutputSettings": {
115+
"type": "object",
116+
"metadata": {
117+
"description": "commandOutputSettings supports the Storage Account URI along with the managed identity to be used for accessing the Storage Account"
118+
}
99119
},
100120
"clusterServicePrincipal": {
101121
"type": "secureobject",
102122
"metadata": {
103123
"description": "Service principal account details used by the cluster to install the Arc Appliance. This field is needed in the near-term for Arc enrollment."
104124
}
105125
},
106-
"keyVaultId": {
107-
"type": "string",
126+
"assignedIdentities": {
127+
"type": "object",
108128
"metadata": {
109-
"description": "Secret KeyVault for credential rotation"
129+
"description": "The assigned identities for the cluster"
110130
}
111-
},
112-
"useKeyVault":{
113-
"type": "string",
114-
"metadata": {
115-
"description": "The indicator if the specified key vault should be used to archive the secrets of the cluster"
116-
},
117-
"defaultValue": "True"
118131
}
119132
},
120133
"variables": {},
@@ -155,12 +168,6 @@ ms.custom: template-how-to, devx-track-arm-template
155168
"description": "Location of Cluster Resource"
156169
}
157170
},
158-
"analyticsWorkspaceId": {
159-
"type": "string"
160-
},
161-
"clusterLawName": {
162-
"type": "string"
163-
},
164171
"resourceGroupName": {
165172
"type": "string"
166173
},
@@ -173,7 +180,7 @@ ms.custom: template-how-to, devx-track-arm-template
173180
"clusterType": {
174181
"type": "string",
175182
"metadata": {
176-
"description": "The type of the Cluster, single or multi-rack"
183+
"description": "The type of the cluster, whether single or multi-rack"
177184
},
178185
"allowedValues": [
179186
"SingleRack",
@@ -195,50 +202,55 @@ ms.custom: template-how-to, devx-track-arm-template
195202
"customLocation": {
196203
"type": "string",
197204
"metadata": {
198-
"description": "The Custom Location of the Cluster Manager"
205+
"description": "The custom location of the cluster manager"
199206
}
200207
},
201208
"aggregatorOrSingleRack": {
202-
"type": "object",
209+
"type": "secureobject",
203210
"metadata": {
204-
"description": "Aggregator Rack or single Rack definition"
211+
"description": "Aggregator rack or single rack definition"
205212
}
206213
},
207214
"computeRacks": {
208215
"type": "array",
209216
"metadata": {
210-
"description": "Compute Rack definitions"
217+
"description": "Compute rack definitions"
211218
}
212219
},
213-
"clusterServicePrincipal": {
214-
"type": "secureobject",
220+
"managedResourceGroupConfiguration": {
221+
"type": "object"
222+
},
223+
"secretArchiveSettings": {
224+
"type": "object",
215225
"metadata": {
216-
"description": "Service principal account details used by the cluster to install the Arc Appliance. This field is needed in the near-term for Arc enrollment."
226+
"description": "SecretArchiveSettings supports the key vault URI along with the managed identity to be used for accessing the key vault"
217227
}
218228
},
219-
"managedResourceGroupConfiguration": {
220-
"type": "object"
229+
"analyticsOutputSettings": {
230+
"type": "object",
231+
"metadata": {
232+
"description": "The resource ID of the analytics workspace to create for the cluster"
233+
}
221234
},
222-
"keyVaultId": {
223-
"type": "string",
235+
"commandOutputSettings": {
236+
"type": "object",
224237
"metadata": {
225-
"description": "Secret KeyVault for credential rotation"
238+
"description": "commandOutputSettings supports the Storage Account URI along with the managed identity to be used for accessing the Storage Account"
226239
}
227240
},
228-
"useKeyVault": {
229-
"type": "string",
241+
"assignedIdentities": {
242+
"type": "object",
230243
"metadata": {
231-
"description": "The indicator if the specified key vault should be used to archive the secrets of the cluster"
232-
},
233-
"defaultValue": "True"
244+
"description": "The assigned identities for the cluster"
245+
}
234246
}
235247
},
236248
"variables": {},
237249
"resources": [
238250
{
239251
"type": "Microsoft.OperationalInsights/workspaces",
240252
"apiVersion": "2021-12-01-preview",
241-
"name": "[parameters('clusterLawName')]",
253+
"name": "[parameters('analyticsWorkspaceName')]",
242254
"location": "[parameters('location')]",
243255
"properties": {
244256
"sku": {
@@ -252,95 +264,38 @@ ms.custom: template-how-to, devx-track-arm-template
252264
},
253265
{
254266
"dependsOn": [
255-
"[resourceId('Microsoft.OperationalInsights/workspaces/', parameters('clusterLawName'))]"
267+
"[resourceId('Microsoft.OperationalInsights/workspaces/', parameters('analyticsWorkspaceName'))]"
256268
],
257269
"type": "Microsoft.NetworkCloud/clusters",
258-
"apiVersion": "2024-07-01",
270+
"apiVersion": "2025-02-01",
259271
"name": "[parameters('name')]",
260272
"location": "[parameters('location')]",
261273
"tags": {},
262274
"extendedLocation": {
263275
"name": "[parameters('customLocation')]",
264276
"type": "CustomLocation"
265277
},
278+
"identity": "[parameters('assignedIdentities')]",
266279
"properties": {
267-
"analyticsWorkspaceId": "[parameters('analyticsWorkspaceId')]",
268280
"networkFabricId": "[parameters('networkFabricId')]",
269281
"clusterType": "[parameters('clusterType')]",
270282
"clusterVersion": "[parameters('clusterVersion')]",
271283
"clusterLocation": "[parameters('clusterLocation')]",
272284
"aggregatorOrSingleRackDefinition": "[parameters('aggregatorOrSingleRack')]",
273285
"computeRackDefinitions": "[parameters('computeRacks')]",
274-
"clusterServicePrincipal": "[parameters('clusterServicePrincipal')]",
275286
"managedResourceGroupConfiguration": "[parameters('managedResourceGroupConfiguration')]",
276-
"secretArchive": {
277-
"keyVaultId": "[parameters('keyVaultId')]",
278-
"useKeyVault": "[parameters('useKeyVault')]"
279-
}
287+
"analyticsWorkspaceId": "[resourceId('Microsoft.OperationalInsights/workspaces/', parameters('analyticsWorkspaceName'))]",
288+
"analyticsOutputSettings": "[parameters('analyticsOutputSettings')]",
289+
"secretArchiveSettings": "[parameters('secretArchiveSettings')]",
290+
"commandOutputSettings": "[parameters('commandOutputSettings')]"
280291
}
281292
}
282293
],
283294
"outputs": {}
284-
},
285-
"parameters": {
286-
"environment": {
287-
"value": "[parameters('environment')]"
288-
},
289-
"analyticsWorkspaceId": {
290-
"value": "[concat(subscription().id, '/resourceGroups/', parameters('resourceGroupName'), '/providers/Microsoft.OperationalInsights/workspaces/', parameters('clusterLawName'))]"
291-
},
292-
"name": {
293-
"value": "[parameters('name')]"
294-
},
295-
"location": {
296-
"value": "[parameters('location')]"
297-
},
298-
"clusterLawName": {
299-
"value": "[parameters('clusterLawName')]"
300-
},
301-
"resourceGroupName": {
302-
"value": "[parameters('resourceGroupName')]"
303-
},
304-
"managedResourceGroupConfiguration": {
305-
"value": {
306-
"location": "[parameters('location')]",
307-
"name": "[parameters('managedResourceGroupName')]"
308-
}
309-
},
310-
"networkFabricId": {
311-
"value": "[parameters('networkFabricId')]"
312-
},
313-
"clusterType": {
314-
"value": "[parameters('clusterType')]"
315-
},
316-
"clusterVersion": {
317-
"value": "[parameters('clusterVersion')]"
318-
},
319-
"clusterLocation": {
320-
"value": "[parameters('clusterLocation')]"
321-
},
322-
"customLocation": {
323-
"value": "[parameters('customLocation')]"
324-
},
325-
"aggregatorOrSingleRack": {
326-
"value": "[parameters('aggregatorOrSingleRack')]"
327-
},
328-
"computeRacks": {
329-
"value": "[parameters('computeRacks')]"
330-
},
331-
"clusterServicePrincipal": {
332-
"value": "[parameters('clusterServicePrincipal')]"
333-
},
334-
"keyVaultId": {
335-
"value": "[parameters('keyVaultId')]"
336-
},
337-
"useKeyVault": {
338-
"value": "[parameters('useKeyVault')]"
339-
}
340295
}
341296
}
342297
}
343-
],
298+
},
344299
"outputs": {}
345300
}
346301
```

articles/operator-nexus/cluster-parameters-jsonc-example.md

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ ms.custom: template-how-to, devx-track-arm-template
2525
"managedResourceGroupName": {
2626
"value": "<MRG_NAME>"
2727
},
28-
"clusterLawName": {
28+
"analyticsWorkspaceName": {
2929
"value": "<LAW_NAME>"
3030
},
3131
"networkFabricId": {
@@ -34,6 +34,23 @@ ms.custom: template-how-to, devx-track-arm-template
3434
"clusterType": {
3535
"value": "<CLUSTER_TYPE>"
3636
},
37+
"assignedIdentities": {
38+
"value": {
39+
"type": "UserAssigned",
40+
"userAssignedIdentities": {
41+
"<CLUSTER_UAMI>": {}
42+
}
43+
}
44+
},
45+
"analyticsOutputSettings": {
46+
"value": {
47+
"analyticsWorkspaceId": "<LAW_ID>",
48+
"associatedIdentity": {
49+
"identityType": "UserAssignedIdentity",
50+
"userAssignedIdentityResourceId": "<CLUSTER_UAMI>"
51+
}
52+
}
53+
},
3754
"skipHardwareValidation": {
3855
"value": "false>"
3956
},
@@ -46,8 +63,23 @@ ms.custom: template-how-to, devx-track-arm-template
4663
"customLocation": {
4764
"value": "<CL_NAME>"
4865
},
49-
"secretArchive": {
50-
"value": "<KV_RESOURCE_ID>"
66+
"commandOutputSettings": {
67+
"value": {
68+
"containerUrl": "<CONTAINER_URI>",
69+
"associatedIdentity": {
70+
"identityType": "UserAssignedIdentity",
71+
"userAssignedIdentityResourceId": "<CLUSTER_UAMI>"
72+
}
73+
}
74+
},
75+
"secretArchiveSettings": {
76+
"value": {
77+
"vaultUri": "<VAULT_URI>",
78+
"associatedIdentity": {
79+
"identityType": "UserAssignedIdentity",
80+
"userAssignedIdentityResourceId": "<CLUSTER_UAMI>"
81+
}
82+
}
5183
},
5284
"aggregatorOrSingleRack": {
5385
"value": {
@@ -1872,14 +1904,6 @@ ms.custom: template-how-to, devx-track-arm-template
18721904
}
18731905
]
18741906
},
1875-
"clusterServicePrincipal": {
1876-
"value": {
1877-
"tenantId": "<TENANT_ID>",
1878-
"applicationId": "<SP_APP_ID>",
1879-
"principalId": "<SP_ID>",
1880-
"password": "<SP_PASS>"
1881-
}
1882-
},
18831907
"environment": {
18841908
"value": "<CLUSTER_NAME>"
18851909
},

0 commit comments

Comments
 (0)