Skip to content

Commit 282bbaa

Browse files
authored
Update install-network-function-operator.md
1 parent 63f8abd commit 282bbaa

File tree

1 file changed

+23
-26
lines changed

1 file changed

+23
-26
lines changed

articles/operator-service-manager/install-network-function-operator.md

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ az k8s-extension create --cluster-name
4545
* Name of the Kubernetes cluster.
4646

4747
`--cluster-type -t`
48-
* Specify Arc clusters or AKS managed clusters or Arc appliances or provisionedClusters.
48+
* Specify Arc clusters or Azure kubernetes service (AKS) managed clusters or Arc appliances or provisionedClusters.
4949
* Accepted values: connectedClusters.
5050

5151
`--extension-type`
@@ -56,7 +56,7 @@ az k8s-extension create --cluster-name
5656
* Name of the extension instance.
5757

5858
`--resource-group -g`
59-
* Name of resource group. You can configure the default group using az configure --defaults group=<name>.
59+
* Name of resource group. You can configure the default group using 'az configure --defaults group=<name>'.
6060

6161
`--config Microsoft.CustomLocation.ServiceAccount=azurehybridnetwork-networkfunction-operator`
6262
* This configuration must be provided.
@@ -73,95 +73,92 @@ az k8s-extension create --cluster-name
7373
* Default value: stable.
7474

7575
`--version`
76-
* Specify the version to install for the extension instance if --auto-upgrade-minor-version is not enabled.
76+
* Specify the version to install for the extension instance if '--auto-upgrade-minor-version' isn't enabled.
7777
* Availabe version can be found on [Network Function Extension Release notes]
7878

7979
### Optional feature specific configurations
8080

8181
#### Pod Mutating Webhook
8282

8383
`--config global.networkfunctionextension.webhook.pod.mutation.matchConditionExpression=`
84-
* This configuration is an optional parameter. It comes into play when CNF is getting installed and as a part of its installation corresponding pods are spin up in the CNF's release namespace.
84+
* This configuration is an optional parameter. It comes into play when container network function (CNF) is getting installed and as a part of its installation corresponding pods are spin up in the CNF's release namespace.
8585
* This configuration configures more granular control on top of rules and namespaceSelectors defined in [Pod Mutating Webhook Configuration](https://dev.azure.com/msazuredev/AzureForOperatorsIndustry/_git/aosm-networkfunctionextension?version=GBmain&path=/src/NetworkFunctionExtension/config/default/networkfunction-operator/templates/webhook_pod/webhook_mutating_config.yaml).
8686
* Default value:
8787
```bash
8888
"((object.metadata.namespace != \"kube-system\") || (object.metadata.namespace == \"kube-system\" && has(object.metadata.labels) && (has(object.metadata.labels.app) && (object.metadata.labels.app == \"commissioning\") || (has(object.metadata.labels.name) && object.metadata.labels.name == \"cert-exporter\") || (has(object.metadata.labels.app) && object.metadata.labels.app == \"descheduler\"))))"
8989
```
90-
The above matchCondition implies that the pods getting admitted in kube-system namespace will be mutated only if they have atleast one of the following labels:
90+
The referenced matchCondition implies that the pods getting accepted in kube-system namespace are mutated only if they have at least one of the following labels:
9191
- app == "commissioning"
9292
- name == "cert-exporter"
9393
- app == "descheduler"
9494

95-
else they will not be mutated and continue to be pulled from the original source as per the helm chart of CNF/Component/Application.
95+
else they are not mutated and continue to be pulled from the original source as per the helm chart of CNF/Component/Application.
9696
* Accepted value:
97-
Any valid [CEL expressions](https://kubernetes.io/docs/reference/using-api/cel/)
98-
* To learn more about matchConditions [reference Kubernetes doc link](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#matching-requests-matchconditions).
99-
* This is configurable parameter that can be set or updated during NF Extension's installation or update.
100-
* Also, this condition comes into play only when the CNF/Component/Application is getting installed into the namespace as per the rules and namespaceSelectors defined in [Pod Mutating Webhook Configuration](https://dev.azure.com/msazuredev/AzureForOperatorsIndustry/_git/aosm-networkfunctionextension?version=GBmain&path=/src/NetworkFunctionExtension/config/default/networkfunction-operator/templates/webhook_pod/webhook_mutating_config.yaml). If there are more pods getting spin up in that namespace, this condition will still be applied to them.
97+
Any valid [CEL expressions](https://kubernetes.io/docs/reference/using-api/cel/)
98+
* This parameter can be set or updated during either network function (NF) extension installation or update.
99+
* This condition comes into play only when the CNF/Component/Application is getting installed into the namespace as per the rules and namespaceSelectors defined in [Pod Mutating Webhook Configuration](https://dev.azure.com/msazuredev/AzureForOperatorsIndustry/_git/aosm-networkfunctionextension?version=GBmain&path=/src/NetworkFunctionExtension/config/default/networkfunction-operator/templates/webhook_pod/webhook_mutating_config.yaml). If there are more pods getting spin up in that namespace, this condition is applied.
101100

102101
#### Cluster registry
103102

104103
`--config global.networkfunctionextension.enableClusterRegistry=`
105-
* This configuration will provision a regsitry in the cluster to locally cache artifacts.
106-
* By default this will enable lazy loading mode unless global.networkfunctionextension.enableEarlyLoading=true.
104+
* This configuration provisions a registry in the cluster to locally cache artifacts.
105+
* Default values enable lazy loading mode unless global.networkfunctionextension.enableEarlyLoading=true.
107106
* Accepted values: false, true.
108107
* Default value: false.
109108

110109
`--config global.networkfunctionextension.clusterRegistry.highAvailability.enabled=`
111-
* This configuration will provision the cluster regsitry in high availability mode if cluster registry is enabled.
112-
* By default is true and uses NAKS nexus-shared volume on AKS recommendation is to set this as false.
110+
* This configuration provisions the cluster registry in high availability mode if cluster registry is enabled.
111+
* Default value is true and uses Nexus Azure kubernetes service (NAKS) nexus-shared volume on AKS recommendation is set false.
113112
* Accepted values: true, false.
114113
* Default value: true.
115114

116115
`--config global.networkfunctionextension.clusterRegistry.autoScaling.enabled=`
117-
* This configuration will provision the cluster registry pods with horizontal auto scaling.
116+
* This configuration provisions the cluster registry pods with horizontal auto scaling.
118117
* Accepted values: true, false.
119118
* Default value: true.
120119

121120
`--config global.networkfunctionextension.webhook.highAvailability.enabled=`
122-
* This configuration will provision multiple replicas of webhook for high availability.
121+
* This configuration provisions multiple replicas of webhook for high availability.
123122
* Accepted values: true, false.
124123
* Default value: true.
125124

126125
`--config global.networkfunctionextension.webhook.autoScaling.enabled=`
127-
* This configuration will provision the webhook pods with horizontal auto scaling.
126+
* This configuration provisions the webhook pods with horizontal auto scaling.
128127
* Accepted values: true, false.
129128
* Default value: true.
130129

131130
`--config global.networkfunctionextension.enableEarlyLoading=`
132-
* This configuration will enable artifacts early loading into cluster regsitry before helm installation or upgrade.
131+
* This configuration enables artifacts early loading into cluster registry before helm installation or upgrade.
133132
* This configuration can only be enabled when global.networkfunctionextension.enableClusterRegistry=true.
134-
* Accetped values: false, true.
133+
* Accepted values: false, true.
135134
* Default value: false.
136135

137136
`--config global.networkfunctionextension.clusterRegistry.storageClassName=`
138137
* This configuration must be provided when global.networkfunctionextension.enableClusterRegistry=true.
139-
* NetworkFunctionExtension will provision a PVC to local cache artifacts from this storage class.
138+
* NetworkFunctionExtension provisions a PVC to local cache artifacts from this storage class.
140139
* Platform specific values
141140
* AKS: managed-csi
142141
* NAKS(Default): nexus-shared
143142
* NAKS(Non-HA): nexus-volume
144-
* ASE: managed-premium
143+
* Azure stack edge (ASE): managed-premium
145144
* Default value: nexus-shared.
146145

147146
`--config global.networkfunctionextension.clusterRegistry.storageSize=`
148147
* This configuration must be provided when global.networkfunctionextension.enableClusterRegistry=true.
149148
* This configuration configures the size we reserve for cluster registry.
150-
* Recommend carefully choose a value that needed to cache artifacts.
151-
* Please notes to use unit as Gi and Ti for sizing. International system of unites: https://physics.nist.gov/cuu/Units/binary.html
149+
* This configuration uses unit as Gi and Ti for sizing.
152150
* Default value: 100Gi
153151

154152
#### Side loading
155153

156154
`--config global.networkfunctionextension.enableLocalRegistry=`
157-
* This configuration will allow artifacts to be delivered to edge via hardware drive.
158-
* It is only used for Tempnet with AP5GC.
155+
* This configuration allows artifacts to be delivered to edge via hardware drive.
159156
* Accepted values: false, true.
160157
* Default value: false.
161158

162159
### Recommended NFO config for AKS
163160

164-
The default NFO config is configured for HA on NAKS as none of the csi disk drives on AKS support ReadWriteX access mode, HA needs to be disabled on AKS.Use the following config options on AKS
161+
The default NFO config configures HA on NAKS but none of the disk drives on AKS support ReadWriteX access mode. In this case, whhere HA needs to be disabled, use the following config options;
165162

166163
` --config global.networkfunctionextension.clusterRegistry.highAvailability.enabled=false`
167164
` --config global.networkfunctionextension.webhook.highAvailability.enabled=false` (optional)

0 commit comments

Comments
 (0)