Skip to content

Commit c5d93e2

Browse files
v-dirichardsv-dirichards
authored
Merge pull request #229311 from pgoyal01/release-preview-operator-nexus
Address active voice issues
2 parents 7b3b180 + e8ad4e7 commit c5d93e2

File tree

1 file changed

+50
-42
lines changed

1 file changed

+50
-42
lines changed

‎articles/operator-nexus/howto-configure-network-fabric-controller.md

Lines changed: 50 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
---
2-
title: "Azure Operator Nexus : How to configure Network Fabric Controller"
3-
description: How to configure Network Fabric Controller
2+
title: "Azure Operator Nexus: How to configure Network fabric Controller"
3+
description: How to configure Network fabric Controller
44
author: surajmb #Required
55
ms.author: surmb #Required
66
ms.service: azure #Required
77
ms.topic: how-to #Required; leave this attribute/value as-is.
88
ms.date: 02/06/2023 #Required; mm/dd/yyyy format.
99
ms.custom: template-how-to #Required; leave this attribute/value as-is.
1010
---
11-
# Create and modify a Network Fabric Controller using Azure CLI
11+
# Create and modify a network fabric controller using Azure CLI
1212

13-
This article describes how to create a Network Fabric Controller by using the Azure Command Line Interface (AzureCLI).
14-
This document also shows you how to check the status, or delete a Network Fabric Controller.
13+
This article describes how to create a Network fabric controller (NFC) by using the Azure Command Line Interface (AzureCLI).
14+
This document also shows you how to check the status, or delete a Network fabric controller.
1515

1616
## Prerequisites
1717

18-
- The User must make sure all the Pre-Requisites are met prior moving on to the next steps
19-
- Before the User starts with NFC deployment, the ExpressRoute circuit has to be validated with the right connectivity (CircuitID)(AuthID), otherwise the NFC provisioning would fail.
18+
You must implement all the Pre-requisites prior to creating a network fabric controller (NFC).
19+
20+
Names, such as for resources, shouldn't contain the underscore (\_) character.
21+
22+
### Validate ExpressRoute circuit
23+
24+
Validate the ExpressRoute circuit(s) for correct connectivity (CircuitID)(AuthID); NFC provisioning would fail if connectivity is incorrect.
2025

2126
### Install CLI extensions
2227

@@ -37,15 +42,15 @@ Check the subscriptions for the account.
3742
az account list
3843
```
3944

40-
Select the subscription for which you want to create a Network Fabric Controller. This subscription will be used across all Operator Nexus resources.
45+
Select the subscription for which you want to create a Network fabric Controller. All Operator Nexus resources, associated with this NFC, will use this subscription.
4146

4247
```azurecli
4348
az account set --subscription "<subscription ID>"
4449
```
4550

46-
## Register providers for Managed Network Fabric
51+
## Register providers for managed network fabric
4752

48-
You can skip this step if your subscription is already registered with the Microsoft.ManagedNetworkFabric Resource Provider. Otherwise, proceed with the following steps:
53+
You must register your subscription with the `Microsoft.ManagedNetworkFabric` Resource Provider, if not previously registered.
4954

5055
In Azure CLI, enter the following commands:
5156

@@ -59,49 +64,53 @@ Monitor the registration process. Registration may take up to 10 minutes.
5964
az provider show -n Microsoft.ManagedNetworkFabric -o table
6065
```
6166

62-
Once registered, you should see the RegistrationState state for the namespace change to Registered.
67+
Once registered, you should see the `RegistrationState` state for the namespace change to `Registered`.
6368

6469
If you've already registered, you can verify using the `show` command.
6570

66-
## Create a Network Fabric Controller
71+
## Create a network fabric controller
6772

68-
If you don't have a resource group created already, you must create a resource group before you create your Network Fabric Controller.
73+
You must create a resource group before you create your NFC.
6974

70-
> [!NOTE]
71-
> You should create a separate Resource Group for Network Fabric Controller (NFC) and a separate one for Network fabric (NF). The value (\_) underscore is not supported for any of the naming conventions, for example (Resource Name or Resource Group.
75+
**Note**: You should create a separate Resource Group for NFC and a separate one for the on-premises Network fabric (NF).
7276

73-
You can create a resource group by running the following command:
77+
You create resource groups by running the following commands:
7478

7579
```azurecli
7680
az group create -n NFCResourceGroupName -l "East US"
7781
```
7882

83+
```azurecli
84+
az group create -n NFResourceGroupName -l "East US"
85+
```
86+
7987
## Attributes for NFC creation
8088

81-
| Parameter | Description | values | Example | Required | Type |
82-
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------ |
83-
| Resource-Group | A resource group is a container that holds related resources for an Azure solution. | NFCResourceGroupName | ATTNFCResourceGroupName | True | String |
84-
| Location | The Azure Region is mandatory to provision your deployment. | eastus, westus3 | eastus | True | String |
85-
| Resource-Name | The Resource-name will be the name of the Fabric | nfcname | ATTnfcname | True | String |
86-
| NFC IP Block | This Block is the NFC IP subnet, the default subnet block is 10.0.0.0/19, and it also shouldn't overlap with any of the Express Route Circuits. | 10.0.0.0/19 | 10.0.0.0/19 | Not Required | String |
89+
| Parameter | Description | values | Example | Required | Type |
90+
|---------|------------------------------|----------------------------|----------------------------|------------|------|
91+
| Resource-Group | A resource group is a container that holds related resources for an Azure solution. | NFCResourceGroupName | XYZNFCResourceGroupName | True | String |
92+
| Location | The Azure Region is mandatory to provision your deployment. | eastus, westus3 | eastus | True | String |
93+
| Resource-Name | The Resource-name will be the name of the Fabric | nfcname | XYZnfcname | True | String |
94+
| NFC IP Block | This Block is the NFC IP subnet, the default subnet block is 10.0.0.0/19, and it also shouldn't overlap with any of the ExpressRoute IPs | 10.0.0.0/19 | 10.0.0.0/19 | Not Required | String |
8795
| Express Route Circuits | The ExpressRoute circuit is a dedicated 10G link that connects Azure and on-premises. You need to know the ExpressRoute Circuit ID and Auth key for an NFC to successfully provision. There are two Express Route Circuits, one for the Infrastructure services and other one for Workload (Tenant) services | --workload-er-connections '[{"expressRouteCircuitId": "xxxxxx-xxxxxx-xxxx-xxxx-xxxxxx", "expressRouteAuthorizationKey": "xxxxxx-xxxxxx-xxxx-xxxx-xxxxxx"}]' <br /><br /> --infra-er-connections '[{"expressRouteCircuitId": "xxxxxx-xxxxxx-xxxx-xxxx-xxxxxx", "expressRouteAuthorizationKey": "xxxxxx-xxxxxx-xxxx-xxxx-xxxxxx"}]' | subscriptions/xxxxxx-xxxxxx-xxxx-xxxx-xxxxxx/resourceGroups/ER-Dedicated-WUS2-AFO-Circuits/providers/Microsoft.Network/expressRouteCircuits/MSFT-ER-Dedicated-PvtPeering-WestUS2-AFO-Ckt-01", "expressRouteAuthorizationKey": "xxxxxx-xxxxxx-xxxx-xxxx-xxxxxx"}] | True | string |
8896

89-
Here is an example of how you can create a Network Fabric Controller using the Azure CLI.
97+
Here's an example of how you can create an NFC using the Azure CLI.
9098
For more information, see [attributes section](#attributes-for-nfc-creation).
9199

92100
```azurecli
93-
94101
az nf controller create \
95-
--resource-group "NFCResourceGroupName" \
96-
--location "eastus" \
97-
--resource-name "nfcname" \
98-
--ipv4-address-space "10.0.0.0/19" \
99-
--infra-er-connections '[{"expressRouteCircuitId": "/subscriptions/xxxxxx-xxxxxx-xxxx-xxxx-xxxxxx/resourceGroups/ER-Dedicated-WUS2-AFO-Circuits/providers/Microsoft.Network/expressRouteCircuits/MSFT-ER-Dedicated-PvtPeering-WestUS2-AFO-Ckt-01", "expressRouteAuthorizationKey": "<auth-key>"}]'
100-
--workload-er-connections '[{"expressRouteCircuitId": "/subscriptions/xxxxxx-xxxxxx-xxxx-xxxx-xxxxxx/resourceGroups/ER-Dedicated-WUS2-AFO-Circuits/providers/Microsoft.Network/expressRouteCircuits/MSFT-ER-Dedicated-PvtPeering-WestUS2-AFO-Ckt-01"", "expressRouteAuthorizationKey": "<auth-key>"}]'
102+
--resource-group "NFCResourceGroupName" \
103+
--location "eastus" \
104+
--resource-name "nfcname" \
105+
--ipv4-address-space "10.0.0.0/19" \
106+
--infra-er-connections '[{"expressRouteCircuitId": "/subscriptions/xxxxxx-xxxxxx-xxxx-xxxx-xxxxxx/resourceGroups/ER-Dedicated-WUS2-AFO-Circuits/providers/Microsoft.Network/expressRouteCircuits/MSFT-ER-Dedicated-PvtPeering-WestUS2-AFO-Ckt-01", "expressRouteAuthorizationKey": "<auth-key>"}]'
107+
--workload-er-connections '[{"expressRouteCircuitId": "/subscriptions/xxxxxx-xxxxxx-xxxx-xxxx-xxxxxx/resourceGroups/ER-Dedicated-WUS2-AFO-Circuits/providers/Microsoft.Network/expressRouteCircuits/MSFT-ER-Dedicated-PvtPeering-WestUS2-AFO-Ckt-01"", "expressRouteAuthorizationKey": "<auth-key>"}]'
101108
```
102109

103-
> [!NOTE]
104-
> The NFC creation takes between 30-45 mins. Start using the show commands to monitor the progress of the NFC creation. You'll start to see different provisioning states while monitoring the progress of NFC creation such as, Accepted, updating and Succeeded/Failed.
110+
**Note:** The NFC creation takes between 30-45 mins.
111+
Use the `show` command to monitor NFC creation progress.
112+
You'll see different provisioning states such as, Accepted, updating and Succeeded/Failed.
113+
Delete and recreate the NFC if the creation fails (`Failed`).
105114

106115
Expected output:
107116

@@ -135,10 +144,10 @@ Expected output:
135144
"lastModifiedBy": "[email protected]",
136145
```
137146

138-
## Get Network Fabric Controller
147+
## Get network fabric controller
139148

140149
```azurecli
141-
az nf controller show --resource-group "NFCResourceGroupName" --resource-name "nfcname"
150+
az nf controller show --resource-group "NFCResourceGroupName" --resource-name "nfcname"
142151
```
143152

144153
Expected output:
@@ -193,15 +202,14 @@ Expected output:
193202
}
194203
```
195204

196-
## Delete Network Fabric Controller
205+
## Delete network fabric controller
206+
207+
You should delete an NFC only after deleting all associated network fabrics.
197208

198209
```azurecli
199-
az nf controller delete --resource-group "NFCResourceGroupName" --resource-name "nfcname"
210+
az nf controller delete --resource-group "NFCResourceGroupName" --resource-name "nfcname"
200211
```
201212

202-
> [!NOTE]
203-
> If NF is created, then make sure the NF is deleted first before you delete the NFC.
204-
205213
Expected output:
206214

207215
```json
@@ -215,8 +223,8 @@ Expected output:
215223
```
216224

217225
> [!NOTE]
218-
> It will take 30 mins to delete the NFC. Verify the hosted resources in Azure portal whether or not it's deleted. Delete and recreate NFC if you run into NFC provisioning issue (Failed).
226+
> It takes 30 mins to delete the NFC. In the Azure portal, verify that the hosted resources have been deleted.
219227

220-
### Next steps
228+
## Next steps
221229

222-
Once you've successfully created a Network Fabric Controller, the next step is to create a [Cluster Manager](./howto-cluster-manager.md).
230+
Once you've successfully created an NFC, the next step is to create a [Cluster Manager](./howto-cluster-manager.md).

0 commit comments

Comments
 (0)