Skip to content

Commit bae1d50

Browse files
bartpintobartpinto
authored
Update cluster-jsonc-example.md
update cluster template for keyvault.
1 parent dc5ef21 commit bae1d50

File tree

1 file changed

+42
-35
lines changed

1 file changed

+42
-35
lines changed

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

Lines changed: 42 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: "Azure Operator Nexus - Example of cluster.jsonc template file"
33
description: Example of cluster.jsonc template file to use with ARM template in creating a cluster.
4-
author: jeffreymason
5-
ms.author: jeffreymason
4+
author: bartpinto
5+
ms.author: bpinto
66
ms.service: azure-operator-nexus
77
ms.topic: how-to
8-
ms.date: 05/08/2024
8+
ms.date: 03/31/2025
99
ms.custom: template-how-to, devx-track-arm-template
1010
---
1111

@@ -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": {
@@ -45,7 +45,7 @@ ms.custom: template-how-to, devx-track-arm-template
4545
"managedResourceGroupName": {
4646
"type": "string",
4747
"metadata": {
48-
"description": "Specify a managed resource group for the resource."
48+
"description": "Specify a Managed Resource Group for the Resource."
4949
}
5050
},
5151
"clusterLawName": {
@@ -60,7 +60,7 @@ ms.custom: template-how-to, devx-track-arm-template
6060
"clusterType": {
6161
"type": "string",
6262
"metadata": {
63-
"description": "The type of the cluster, whether single or multi-rack"
63+
"description": "The type of the Cluster, single or multi-rack"
6464
},
6565
"allowedValues": [
6666
"SingleRack",
@@ -70,7 +70,7 @@ ms.custom: template-how-to, devx-track-arm-template
7070
"clusterVersion": {
7171
"type": "string",
7272
"metadata": {
73-
"description": "The version of the cluster to install"
73+
"description": "The version of the Cluster to install"
7474
}
7575
},
7676
"clusterLocation": {
@@ -82,32 +82,39 @@ ms.custom: template-how-to, devx-track-arm-template
8282
"customLocation": {
8383
"type": "string",
8484
"metadata": {
85-
"description": "The custom location of the cluster manager"
85+
"description": "The Custom Location of the Cluster Manager"
8686
}
8787
},
8888
"aggregatorOrSingleRack": {
8989
"type": "object",
9090
"metadata": {
91-
"description": "Aggregator rack or single rack definition"
91+
"description": "Aggregator Rack or single Rack definition"
9292
}
9393
},
9494
"computeRacks": {
9595
"type": "array",
9696
"metadata": {
97-
"description": "Compute rack definitions"
97+
"description": "Compute Rack definitions"
9898
}
9999
},
100100
"clusterServicePrincipal": {
101101
"type": "secureobject",
102102
"metadata": {
103-
"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"
103+
"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."
104104
}
105105
},
106-
"secretArchive": {
106+
"keyVaultId": {
107107
"type": "string",
108108
"metadata": {
109109
"description": "Secret KeyVault for credential rotation"
110110
}
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"
111118
}
112119
},
113120
"variables": {},
@@ -166,7 +173,7 @@ ms.custom: template-how-to, devx-track-arm-template
166173
"clusterType": {
167174
"type": "string",
168175
"metadata": {
169-
"description": "The type of the cluster, whether single or multi-rack"
176+
"description": "The type of the Cluster, single or multi-rack"
170177
},
171178
"allowedValues": [
172179
"SingleRack",
@@ -176,7 +183,7 @@ ms.custom: template-how-to, devx-track-arm-template
176183
"clusterVersion": {
177184
"type": "string",
178185
"metadata": {
179-
"description": "The version of the cluster to install"
186+
"description": "The version of the Cluster to install"
180187
}
181188
},
182189
"clusterLocation": {
@@ -188,41 +195,42 @@ ms.custom: template-how-to, devx-track-arm-template
188195
"customLocation": {
189196
"type": "string",
190197
"metadata": {
191-
"description": "The custom location of the cluster manager"
198+
"description": "The Custom Location of the Cluster Manager"
192199
}
193200
},
194201
"aggregatorOrSingleRack": {
195202
"type": "object",
196203
"metadata": {
197-
"description": "Aggregator rack or single rack definition"
204+
"description": "Aggregator Rack or single Rack definition"
198205
}
199206
},
200207
"computeRacks": {
201208
"type": "array",
202209
"metadata": {
203-
"description": "Compute rack definitions"
210+
"description": "Compute Rack definitions"
204211
}
205212
},
206213
"clusterServicePrincipal": {
207214
"type": "secureobject",
208215
"metadata": {
209-
"description": "Service principal account details used by the cluster to install the Arc Appliance. This field is needed for Arc enrollment."
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."
210217
}
211218
},
212219
"managedResourceGroupConfiguration": {
213220
"type": "object"
214221
},
215-
"secretArchive": {
222+
"keyVaultId": {
216223
"type": "string",
217224
"metadata": {
218225
"description": "Secret KeyVault for credential rotation"
219226
}
220227
},
221-
"sshKeyUrl": {
228+
"useKeyVault": {
222229
"type": "string",
223230
"metadata": {
224-
"description": "SSH Key URL that is used for to gather list of Public Keys"
225-
}
231+
"description": "The indicator if the specified key vault should be used to archive the secrets of the cluster"
232+
},
233+
"defaultValue": "True"
226234
}
227235
},
228236
"variables": {},
@@ -247,13 +255,12 @@ ms.custom: template-how-to, devx-track-arm-template
247255
"[resourceId('Microsoft.OperationalInsights/workspaces/', parameters('clusterLawName'))]"
248256
],
249257
"type": "Microsoft.NetworkCloud/clusters",
250-
"apiVersion": "2023-07-01",
258+
"apiVersion": "2024-07-01",
251259
"name": "[parameters('name')]",
252260
"location": "[parameters('location')]",
253261
"tags": {
254262
"LabEnvironment": "[parameters('environment')]",
255-
"ResourceType": "cluster",
256-
"sshKeyUrl": "[parameters('sshKeyUrl')]"
263+
"ResourceType": "cluster"
257264
},
258265
"extendedLocation": {
259266
"name": "[parameters('customLocation')]",
@@ -268,7 +275,11 @@ ms.custom: template-how-to, devx-track-arm-template
268275
"aggregatorOrSingleRackDefinition": "[parameters('aggregatorOrSingleRack')]",
269276
"computeRackDefinitions": "[parameters('computeRacks')]",
270277
"clusterServicePrincipal": "[parameters('clusterServicePrincipal')]",
271-
"managedResourceGroupConfiguration": "[parameters('managedResourceGroupConfiguration')]"
278+
"managedResourceGroupConfiguration": "[parameters('managedResourceGroupConfiguration')]",
279+
"secretArchive": {
280+
"keyVaultId": "[parameters('keyVaultId')]",
281+
"useKeyVault": "[parameters('useKeyVault')]"
282+
}
272283
}
273284
}
274285
],
@@ -323,20 +334,16 @@ ms.custom: template-how-to, devx-track-arm-template
323334
"clusterServicePrincipal": {
324335
"value": "[parameters('clusterServicePrincipal')]"
325336
},
326-
"secretArchive": {
327-
"value": {
328-
"keyVaultId": "[parameters('secretArchive')]",
329-
"useKeyVault": "True"
330-
337+
"keyVaultId": {
338+
"value": "[parameters('keyVaultId')]"
331339
},
332-
"sshKeyUrl": {
333-
"value": "[parameters('sshKeyUrl')]"
340+
"useKeyVault": {
341+
"value": "[parameters('useKeyVault')]"
334342
}
335343
}
336344
}
337345
}
338-
}
339-
],
346+
],
340347
"outputs": {}
341348
}
342349
```

0 commit comments

Comments
 (0)