Skip to content

Commit 2997834

Browse files
authored
Merge pull request #120288 from deepukraju/patch-1
Update learn document with detailed status message information during Deploy and Upgrade
2 parents 214dddc + 5a7659a commit 2997834

6 files changed

+17
-3
lines changed

articles/operator-nexus/howto-cluster-runtime-upgrade.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,10 @@ To check on the status of the upgrade observe the detailed status of the cluster
7878

7979
To view the upgrade status through the Azure portal, navigate to the targeted cluster resource. In the cluster's *Overview* screen, the detailed status is provided along with a detailed status message.
8080

81+
The Cluster upgrade is in-progress when detailedStatus is set to `Updating` and detailedStatusMessage shows the progress of upgrade. Some examples of upgrade progress shown in detailedStatusMessage are `Waiting for control plane upgrade to complete...`, `Waiting for nodepool "<rack-id>" to finish upgrading...`, etc.
82+
83+
The Cluster upgrade is complete when detailedStatus is set to `Running` and detailedStatusMessage shows message `Cluster is up and running`
84+
8185
:::image type="content" source="./media/runtime-upgrade-cluster-detail-status.png" lightbox="./media/runtime-upgrade-cluster-detail-status.png" alt-text="Screenshot of Azure portal showing in progress cluster upgrade.":::
8286

8387
To view the upgrade status through the Azure CLI, use `az networkcloud cluster show`.
@@ -127,8 +131,7 @@ Upon successful execution of the command, the updateStrategy values specified wi
127131
During a runtime upgrade, it's possible that the upgrade fails to move forward but the detail status reflects that the upgrade is still ongoing. **Because the runtime upgrade can take a very long time to successfully finish, there's no set timeout length currently specified**.
128132
Hence, it's advisable to also check periodically on your cluster's detail status and logs to determine if your upgrade is indefinitely attempting to upgrade.
129133

130-
We can identify when this is the case by looking at the Cluster's logs, detailed message, and detailed status message. If a timeout has occurred, we would observe that the Cluster is continuously reconciling over the same indefinitely and not moving forward. The Cluster's detailed status message would reflect, `"Cluster is in the process of being updated."`.
131-
From here, we recommend checking Cluster logs or configured LAW, to see if there's a failure, or a specific upgrade that is causing the lack of progress.
134+
We can identify when this is the case by looking at the Cluster's logs, detailed message, and detailed status message. If a timeout has occurred, we would observe that the Cluster is continuously reconciling over the same indefinitely and not moving forward. From here, we recommend checking Cluster logs or configured LAW, to see if there's a failure, or a specific upgrade that is causing the lack of progress.
132135

133136
### Hardware Failure doesn't require Upgrade re-execution
134137

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

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,15 +232,24 @@ See the article [Tracking Asynchronous Operations Using Azure CLI](./howto-track
232232

233233
## Cluster deployment validation
234234

235-
View the status of the cluster:
235+
View the status of the cluster on the portal, or via the Azure CLI:
236236

237237
```azurecli
238238
az networkcloud cluster show --resource-group "$CLUSTER_RG" \
239239
--resource-name "$CLUSTER_RESOURCE_NAME"
240240
```
241241

242+
The Cluster deployment is in-progress when detailedStatus is set to `Deploying` and detailedStatusMessage shows the progress of deployment.
243+
Some examples of deployment progress shown in detailedStatusMessage are `Hardware validation is in progress.` (if cluster is deployed with hardware validation) ,`Cluster is bootstrapping.`, `KCP initialization in progress.`, `Management plane deployment in progress.`, `Cluster extension deployment in progress.`, `waiting for "<rack-ids>" to be ready`, etc.
244+
245+
:::image type="content" source="./media/nexus-deploy-kcp-status.png" lightbox="./media/nexus-deploy-kcp-status.png" alt-text="Screenshot of Azure portal showing cluster deploy progress kcp init.":::
246+
247+
:::image type="content" source="./media/nexus-deploy-extention-status.png" lightbox="./media/nexus-deploy-extention-status.png" alt-text="Screenshot of Azure portal showing cluster deploy progress extenstion application.":::
248+
242249
The Cluster deployment is complete when detailedStatus is set to `Running` and detailedStatusMessage shows message `Cluster is up and running`.
243250

251+
:::image type="content" source="./media/nexus-deploy-complete-status.png" lightbox="./media/nexus-deploy-complete-status.png" alt-text="Screenshot of Azure portal showing cluster deploy complete.":::
252+
244253
View the management version of the cluster:
245254

246255
```azurecli
@@ -253,3 +262,5 @@ Cluster create Logs can be viewed in the following locations:
253262

254263
1. Azure portal Resource/ResourceGroup Activity logs.
255264
2. Azure CLI with `--debug` flag passed on command-line.
265+
266+
:::image type="content" source="./media/nexus-deploy-activity-log.png" lightbox="./media/nexus-deploy-activity-log.png" alt-text="Screenshot of Azure portal showing cluster deploy progress activity log.":::
100 KB
Loading
38.9 KB
Loading
31.7 KB
Loading
41 KB
Loading

0 commit comments

Comments
 (0)