Skip to content

Commit 9bac54b

Browse files
authored
Update howto-configure-cluster.md
1 parent 76d5d49 commit 9bac54b

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

articles/operator-nexus/howto-configure-cluster.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ az networkcloud cluster create --name "<CLUSTER_NAME>" --location "<LOCATION>" \
7575
| LAW_ID | Log Analytics Workspace ID for the Cluster |
7676
| CLUSTER_LOCATION | The local name of the Cluster |
7777
| AGGR_RACK_RESOURCE_ID | RackID for Aggregator Rack |
78-
| AGGR_RACK_SKU | Rack SKU for Aggregator Rack \*See [Operator Nexus Network Cloud SKUs](./reference-operator-nexus-skus.md) |
78+
| AGGR_RACK_SKU | Rack Stock Keeping Unit (SKU) for Aggregator Rack \*See [Operator Nexus Network Cloud SKUs](./reference-operator-nexus-skus.md) |
7979
| AGGR_RACK_SN | Rack Serial Number for Aggregator Rack |
8080
| AGGR_RACK_LOCATION | Rack physical location for Aggregator Rack |
8181
| AGGR_RACK_BMM | Used for single rack deployment only, empty for multi-rack |
@@ -111,7 +111,7 @@ az networkcloud cluster create --name "<CLUSTER_NAME>" --location "<LOCATION>" \
111111

112112
## Cluster Identity
113113

114-
Starting with the 2024-07-01 API version, a customer can assign managed identity to a Cluster. Both System-assigned and User-Assigned managed identities are supported.
114+
After release of the `2024-07-01` API version, a customer can assign managed identity to a Cluster. Both System-assigned and User-Assigned managed identities are supported.
115115

116116
Once added, the Identity can only be removed via the API call at this time.
117117

@@ -171,7 +171,7 @@ Cluster create Logs can be viewed in the following locations:
171171

172172
The threshold for the allowable failures of compute nodes during hardware validation is set using the `compute-deployment-threshold` parameter.
173173

174-
If `compute-deployment-threshold` is not set, the defaults are as follows:
174+
If `compute-deployment-threshold` isn't set, the defaults are as follows:
175175

176176
```
177177
"strategyType": "Rack",
@@ -180,9 +180,9 @@ If `compute-deployment-threshold` is not set, the defaults are as follows:
180180
"waitTimeMinutes": 1
181181
```
182182

183-
If a `compute-deployment-threshold` that it is different from the default of 80% is required, you can run the following `cluster update` command.
183+
If a `compute-deployment-threshold` different from the default of 80% is required, run the following `cluster update` command.
184184

185-
The example below is for a customer requesting type "PercentSuccess" with a success rate of 97%.
185+
For example, a customer requesting type "PercentSuccess" with a success rate of 97%:
186186

187187
```azurecli
188188
az networkcloud cluster update --name "<clusterName>" /
@@ -204,15 +204,15 @@ az networkcloud cluster show --resource-group "<resourceGroup>" --name "<cluster
204204
"value": 97
205205
```
206206

207-
In this example, if less than 97% of the compute nodes being deployed pass hardware validation, the Cluster deployment will fail. **NOTE: All kubernetes control plane (KCP) and nexus management plane (NMP) must pass hardware validation.** If 97% or more of the compute nodes being deployed pass hardware validation, the Cluster deployment will continue to the bootstrap provisioning phase.
207+
In this example, if less than 97% of the compute nodes being deployed pass hardware validation, the Cluster deployment fails. **NOTE: All kubernetes control plane (KCP) and nexus management plane (NMP) must pass hardware validation.** If 97% or more of the compute nodes being deployed pass hardware validation, the Cluster deployment continues to the bootstrap provisioning phase.
208208

209209
> [!NOTE]
210-
> Deployment thresholds cannot be changed after Cluster deployment has started.
210+
> Deployment thresholds can't be changed after Cluster deployment is started.
211211
212212
## Deploy Cluster
213213

214214
> [!IMPORTANT]
215-
> It is recommended to wait for 20 minutes after creating a Cluster before deploying to ensure all associated resources are created.
215+
> As a best pracice, wait 20 minutes after creating a Cluster before deploying to ensure all associated resources are created.
216216
217217
The deploy Cluster action can be triggered after creating the Cluster.
218218
The deploy Cluster action creates the bootstrap image and deploys the Cluster.
@@ -238,7 +238,7 @@ az networkcloud cluster deploy \
238238

239239
> [!TIP]
240240
> To check the status of the `az networkcloud cluster deploy` command, it can be executed using the `--debug` flag.
241-
> This will allow you to obtain the `Azure-AsyncOperation` or `Location` header used to query the `operationStatuses` resource.
241+
> Obtain the `Azure-AsyncOperation` or `Location` header used to query the `operationStatuses` resource from the debug output.
242242
> See the section [Cluster Deploy Failed](#cluster-deploy-failed) for more detailed steps.
243243
> Optionally, the command can run asynchronously using the `--no-wait` flag.
244244
@@ -251,12 +251,12 @@ and any user skipped machines, a determination is done on whether sufficient nod
251251
passed and/or are available to meet the thresholds necessary for deployment to continue.
252252

253253
> [!IMPORTANT]
254-
> The hardware validation process will write the results to the specified `analyticsWorkspaceId` at Cluster Creation.
254+
> The hardware validation process writes the results to the specified `analyticsWorkspaceId` at Cluster Creation.
255255
> Additionally, the provided Service Principal in the Cluster object is used for authentication against the Log Analytics Workspace Data Collection API.
256-
> This capability is only visible during a new deployment (Green Field); existing Cluster will not have the logs available retroactively.
256+
> This capability is only visible during a new deployment (Green Field); existing Clusters won't have the logs available retroactively.
257257
258258
> [!NOTE]
259-
> The RAID controller is reset during Cluster deployment wiping all data from the server's virtual disks. Any Baseboard Management Controller (BMC) virtual disk alerts can typically be ignored unless there are additional physical disk and/or RAID controllers alerts.
259+
> The RAID controller is reset during Cluster deployment wiping all data from the server's virtual disks. Any Baseboard Management Controller (BMC) virtual disk alerts can be ignored unless there are other physical disk and/or RAID controllers alerts.
260260
261261
By default, the hardware validation process writes the results to the configured Cluster `analyticsWorkspaceId`.
262262
However, due to the nature of Log Analytics Workspace data collection and schema evaluation, there can be ingestion delay that can take several minutes or more.
@@ -284,7 +284,7 @@ az networkcloud cluster deploy \
284284
#### Cluster Deploy failed
285285

286286
> [!IMPORTANT]
287-
> If a Cluster is in `Failed` state, it must be deleted and recreated before it can be deployed again. Cluster failures can occur when the hardware validation threshold is not met, or any phase of the deployment can't complete up until the Cluster is in `Running` state.
287+
> If a Cluster is in `Failed` state, it must be deleted and recreated before it can be deployed again. Cluster failures can occur when the hardware validation threshold isn't met, or any phase of the deployment can't complete up until the Cluster is in `Running` state.
288288
289289
To track the status of an asynchronous operation, run with a `--debug` flag enabled.
290290
When `--debug` is specified, the progress of the request can be monitored.
@@ -318,7 +318,7 @@ metal machines that failed the hardware validation (for example, `COMP0_SVR0_SER
318318
```
319319

320320
See the article [Tracking Asynchronous Operations Using Azure CLI](./howto-track-async-operations-cli.md) for another example.
321-
See the article [Troubleshoot BMM provisioning](./troubleshoot-bare-metal-machine-provisioning.md) for more information that may be helpful when specific machines fail validation or deployment.
321+
See the article [Troubleshoot Bare Metal Machine (BMM) provisioning](./troubleshoot-bare-metal-machine-provisioning.md) for more information that may be helpful when specific machines fail validation or deployment.
322322

323323
## Cluster deployment validation
324324

@@ -360,8 +360,8 @@ Cluster create Logs can be viewed in the following locations:
360360

361361
Deleting a Cluster deletes the resources in Azure and the Cluster that resides in the on-premises environment.
362362

363-
> [!NOTE]
364-
> If there are any tenant resources that exist in the cluster, it will not be deleted until those resources are deleted.
363+
> [!IMPORTANT]
364+
> If there are any tenant resources that exist in the Cluster, the delete will fail until those resources are deleted.
365365
366366
:::image type="content" source="./media/nexus-delete-failure.png" lightbox="./media/nexus-delete-failure.png" alt-text="Screenshot of the portal showing the failure to delete because of tenant resources.":::
367367

@@ -370,4 +370,4 @@ az networkcloud cluster delete --name "$CLUSTER_NAME" --resource-group "$CLUSTER
370370
```
371371

372372
> [!NOTE]
373-
> It is recommended to wait for 20 minutes after deleting a Cluster before trying to create a new Cluster with the same name to ensure all associated resources are deleted.
373+
> As a best practice, wait 20 minutes after deleting a Cluster before trying to create a new Cluster with the same name to ensure all associated resources are deleted.

0 commit comments

Comments
 (0)