Skip to content

Commit 89fe2d8

Browse files
authored
Update howto-cluster-runtime-upgrade-template.md
Filling in parameters and pre-checks.
1 parent 8ac96bb commit 89fe2d8

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

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

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,69 @@ Runtime changes are categorized as follows:
2828
2. The latest `networkcloud` CLI extension is required. It can be installed following the steps listed in [Install CLI Extension](howto-install-cli-extensions.md).
2929
3. Subscription access to run the Azure Operator Nexus Network Fabric (NF) and Network Cloud (NC) CLI extension commands.
3030
4. Target Cluster must be healthy in a running state.
31+
32+
## Required Parameters:
33+
- <ENVIRONMENT> - Instance Name
34+
- <AZURE_REGION> - Azure Region of Instance
35+
- <CUSTOMER_SUB_NAME>: Subscription Name
36+
- <CUSTOMER_SUB_TENANT_ID> // From 'az account show'
37+
- <CUSTOMER_SUB_ID>: Subscription ID
38+
- <CLUSTER_NAME>: Cluster Name
39+
- <CLUSTER_RG>: Cluster Resource Group
40+
- <CLUSTER_RID>: Cluster ARM ID
41+
- <CLUSTER_KEYVAULT_ID>: Cluster Keyvault ARM ID
42+
- <CLUSTER_MRG>: Cluster Managed Resource Group
43+
- <CLUSTER_CONTROL_BMM>: Cluster Control plane baremetalmachine
44+
- <CLUSTER_RUNTIME_VERSION>: Runtime version for upgrade
45+
- <START_TIME>: Planned start time of upgrade
46+
- <DURATION>: Estimated Duration of upgrade
47+
- <NFC_NAME>: Associated NFC
48+
- <CM_NAME>: Associated CM
49+
- <ETCD_LAST_ROTATION_DATE>: Control plane etcd credential last rotation date
50+
- <ETCD_ROTATION_DAYS>: Control plane etcd credential next rotation period
51+
- <FABRIC_NAME>: Associated Fabric
52+
- <NEXUS_VERSION>: Target upgrade version
53+
54+
## Pre-Checks
55+
56+
1. Very last/next rotation date on etcd credential will not occur during upgrade on each control plane Bare Metal Machine (BMM):
57+
- Check in Azure portal from the following path: `Clusters` -> <CLUSTER_NAME> -> `Resources` -> `Bare Metal Machines`
58+
- Select each BMM with `control-plane` under the `Role`: <CLUSTER_CONTROL_BMM> -> `JSON View`
59+
- Validate the `lastRotationTime` and `rotationPeriodDays` under the `etcd credential` section:
60+
```
61+
{
62+
"lastRotationTime": "<ETCD_LAST_ROTATION_DATE>",
63+
"rotationPeriodDays": <ETCD_ROTATION_DAYS>,
64+
"secretType": "etcd credential"
65+
}
66+
```
67+
68+
>[!Important]
69+
> If the upgrade will occur within three days of the next `etcd credential` rotation (<ETCD_LAST_ROTATION_DATE> + <ETCD_ROTATION_DAYS>), contact Miscrosoft Support to complete a manual rotation before starting the upgrade.
70+
71+
2. Validate the provisioning and detailed status for the Cluster Manager (CM) and Cluster.
72+
73+
Set up the subscription, CM, and Cluster parameters:
74+
```
75+
export SUBSCRIPTION_ID=<CUSTOMER_SUB_ID>
76+
export CM_RG=<CM_RG>
77+
export CM_NAME=<CM_NAME>
78+
export CLUSTER_RG=<CLUSTER_RG>
79+
export CLUSTER_NAME=<CLUSTER_NAME>
80+
```
81+
82+
Check that the CM is in `Succeeded` for `Provisioning state`:
83+
```
84+
az networkcloud clustermanager show -g $CM_RG --resource-name $CM_NAME --subscription $SUBSCRIPTION_ID -o table
85+
```
86+
87+
Check the Cluster status `Detailed status` is `Running`:
88+
```
89+
az networkcloud cluster show -g $CLUSTER_RG --resource-name $CLUSTER_NAME --subscription $SUBSCRIPTION_ID -o table
90+
```
91+
92+
>[!Note]
93+
> If CM `Provisioning state` is not `Succeeded` and Cluster `Detailed status` is not `Running` stop the upgrade until issues are resolved.
94+
95+
3. Review Operator Nexus Release notes for required checks and configuration updates not included in this document.
96+

0 commit comments

Comments
 (0)