Skip to content

Commit f9a26ed

Browse files
authored
Update howto-nexus-instance-deployment-template.md
1 parent 697cd69 commit f9a26ed

File tree

1 file changed

+23
-32
lines changed

1 file changed

+23
-32
lines changed

articles/operator-nexus/howto-nexus-instance-deployment-template.md

Lines changed: 23 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,27 @@ ms.topic: how-to
99
ms.custom: azure-operator-nexus, template-include
1010
---
1111

12-
# Azure Operator Nexus: Nexus Instance Deployment Template
12+
# Nexus Instance Deployment Template
1313

14-
This how-to guide provides a step-by-step template for deploying a Nexus instance.
14+
This how-to guide provides a step-by-step template for deploying a Nexus Instance.
1515

1616
## Overview
17-
17+
<details>
18+
<summary> Overview of Nexus Instance deployment template </summary>
19+
1820
This template is designed to assist users in managing a reproducible end-to-end deployment through Azure APIs and standard operating procedures.
1921

22+
</details>
23+
2024
## Prerequisites
2125
<details>
22-
<summary> Prerequisites for using this template to deploy a Nexus instance </summary>
26+
<summary> Prerequisites for using this template to deploy a Nexus Instance </summary>
2327

2428
- Latest version of [Azure CLI](https://aka.ms/azcli).
29+
- Latest `managednetworkfabric` [CLI extension](howto-install-cli-extensions.md).
2530
- Latest `networkcloud` [CLI extension](howto-install-cli-extensions.md).
2631
- Subscription access to run the Azure Operator Nexus Network Fabric (NF) and Network Cloud (NC) CLI extension commands.
27-
- Nexus instance data for the [Telco Input Template](concepts-telco-input-template.md).
32+
- Nexus Instance data for the [Telco Input Template](concepts-telco-input-template.md).
2833
- [Platform Prerequisites](howto-platform-prerequisites.md).
2934

3035
</details>
@@ -33,12 +38,11 @@ This template is designed to assist users in managing a reproducible end-to-end
3338
<details>
3439
<summary> Parameters used in this document </summary>
3540

36-
- \<ENVIRONMENT\>: - Instance name
37-
- <AZURE_REGION>: - Azure Region of Instance
41+
- \<ENVIRONMENT\>: Instance name
42+
- <AZURE_REGION>: Azure Region of Instance
3843
- <CUSTOMER_SUB_NAME>: Subscription name
3944
- <CUSTOMER_SUB_ID>: Subscription ID
4045
- <CUSTOMER_SUB_TENANT_ID>: Tenant ID (from `az account show`)
41-
- <DE_ID>: Deployment Engineer performing upgrade
4246
- \<NEXUS_VERSION\>: Nexus release version (for example, 2504.1)
4347
- <NNF_VERSION>: Nexus Network Fabric (NNF) release version (for example, 8.1)
4448
- <NF_VERSION>: Network Fabric (NF) runtime version (for example, 5.0.0)
@@ -58,6 +62,8 @@ This template is designed to assist users in managing a reproducible end-to-end
5862
- <NF_DEVICE_INTERFACE_NAME>: NF Device Interface name
5963
- <NF_DEVICE_HOSTNAME>: NF Device hostname
6064
- <NF_DEVICE_SN>: NF Device serial number
65+
- <CM_NAME>: Associated Cluster Manager (CM)
66+
- <CM_RG>: CM Resource Group
6167
- <CLUSTER_NAME>: Associated Cluster name
6268
- <CLUSTER_RG>: Cluster Resource Group (RG)
6369
- <CLUSTER_RID>: Cluster ARM ID
@@ -66,17 +72,12 @@ This template is designed to assist users in managing a reproducible end-to-end
6672
- <CLUSTER_DEPLOY_GROUPING>: Cluster deployment grouping
6773
- <CLUSTER_DEPLOY_TYPE>: Cluster deployment type
6874
- <CLUSTER_DEPLOY_THRESHOLD>: Cluster deployment threshold
69-
- <NC_VERSION>: Runtime version for upgrade
7075
- <DEPLOYMENT_THRESHOLD>: Compute deployment threshold
7176
- <DEPLOYMENT_PAUSE_MINS>: Time to wait before moving to the next Rack once the current Rack meets the deployment threshold
72-
- <CM_NAME>: Associated Cluster Manager (CM)
73-
- <CM_RG>: CM Resource Group
74-
- <BMM_ISSUE_LIST>: List of BMM with provisioning issues after Cluster upgrade is complete
7577
- <MISE_CID>: Microsoft.Identity.ServiceEssentials (MISE) Correlation ID in debug output for Device updates
7678
- <CORRELATION_ID>: Operation Correlation ID in debug output for Device updates
7779
- <ASYNC_URL>: Asynchronous (ASYNC) URL in debug output for Device updates
78-
- <START_DATE>: Track deployment start date
79-
- <TARGET_DATE>: Track deployment expected end date
80+
- <LINK_TO_TELCO_INPUT>: Link to the Instance Telco Input file
8081

8182
</details>
8283

@@ -85,7 +86,6 @@ This template is designed to assist users in managing a reproducible end-to-end
8586
<summary> Deployment data details </summary>
8687

8788
```
88-
<START_DATE> <ENVIRONMENT> <AZURE_REGION> <DE_ID> <TARGET_DATE>
8989
- Nexus: <NEXUS_VERSION>
9090
- NC: <NC_VERSION>
9191
- NF: <NF_VERSION>
@@ -456,11 +456,11 @@ BMM provisioning is complete when the following conditions are met:
456456
### Review Operator Nexus release notes
457457
Review the Operator Nexus release notes for any version specific actions required post-deployment.
458458

459-
### Validate Nexus instance
459+
### Validate Nexus Instance
460460

461-
Validate the health and status of all the Nexus instance resources created during deployment with the [Nexus Instance Readiness Test (IRT)](howto-run-instance-readiness-testing.md).
461+
Validate the health and status of all the Nexus Instance resources created during deployment with the [Nexus Instance Readiness Test (IRT)](howto-run-instance-readiness-testing.md).
462462

463-
To perform a resource validation of the Nexus instance components post-deployment through Azure CLI:
463+
To perform a resource validation of the Nexus Instance components post-deployment through Azure CLI:
464464
```
465465
# NFC
466466
az networkfabric controller list --subscription <CUSTOMER_SUB_ID> -o table
@@ -483,27 +483,17 @@ az networkcloud cluster list --subscription <CUSTOMER_SUB_ID> -o table
483483
az networkcloud baremetalmachine list -g <CLUSTER_MRG> --subscription <CUSTOMER_SUB_ID> --query "sort_by([]. {name:name,kubernetesNodeName:kubernetesNodeName,location:location,readyState:readyState,provisioningState:provisioningState,detailedStatus:detailedStatus,detailedStatusMessage:detailedStatusMessage,cordonStatus:cordonStatus,powerState:powerState,machineRoles:machineRoles| join(', ', @),createdAt:systemData.createdAt}, &name)" -o table
484484
az networkcloud storageappliance list -g <CLUSTER_MRG> --subscription <CUSTOMER_SUB_ID> -o table
485485
```
486-
> [!Note]
487-
> IRT validation provides a complete functional test of networking and workloads across all components of the Nexus instance. Simple validation does not provide functional tesing.
488-
489-
</details>
490486

491-
## Close out work items
492-
<details>
493-
<summary> Close out any work items in your ticketing system on deployment completion </summary>
494-
495-
- Update task hours for deployment duration.
496-
- Set Nexus deployment work item to `Complete`.
497-
- Add any notes on support tickets and issues encountered during deployment.
498-
- List any BMM that failed to provision.
487+
> [!Note]
488+
> IRT validation provides a complete functional test of networking and workloads across all components of the Nexus Instance. Simple validation does not provide functional tesing.
499489
500490
</details>
501491

502492
## Links
503493
<details>
504-
<summary> Reference Links for Nexus Deployments </summary>
494+
<summary> Reference Links for Nexus Instance deployment </summary>
505495

506-
Reference links for deploying a Nexus instance:
496+
Reference links for deploying a Nexus Instance:
507497
- Access the [Azure portal](https://aka.ms/nexus-portal)
508498
- Access the [Azure portal ARM Template Editor](https://portal.azure.com/#create/Microsoft.Template)
509499
- [Install Azure CLI](https://aka.ms/azcli)
@@ -516,5 +506,6 @@ Reference links for deploying a Nexus instance:
516506
- Reference the [Nexus Telco Input Template](concepts-telco-input-template.md)
517507
- Reference the [Nexus Platform Prerequisites](howto-platform-prerequisites.md)
518508
- Create a [Network Fabric ACL](howto-create-access-control-list-for-network-to-network-interconnects.md)
509+
- Reference the [Nexus Instance Readiness Test (IRT)](howto-run-instance-readiness-testing.md)
519510

520511
</details>

0 commit comments

Comments
 (0)