Skip to content

Commit 9a7b42e

Browse files
authored
Fix typos and enhance clarity in configuration guide
Corrected typos and improved clarity in the configuration guide.
1 parent 044297c commit 9a7b42e

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

articles/operator-service-manager/configuration-guide.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.service: azure-operator-service-manager
1212

1313
This article provides Azure Operator Service Manager guidelines to optimize the design of configuration group schemas (CGSs) and the operation of configuration group values (CGVs). Network function (NF) vendors, telco operators, and their partners should keep these practices in mind when onboarding and deploying NFs.
1414

15-
## Configurarion group approach
15+
## Configuration group approach
1616

1717
Consider the following meta-schema guidelines when you're designing configuration resources:
1818

@@ -26,7 +26,7 @@ Consider the following meta-schema guidelines when you're designing configuratio
2626

2727
## One-CGS approach
2828

29-
The original recommendation was to use only a single CGS/CGV set for the entire NF. This approach consolidated site-specific, instance-specific, and security-specific parameters together. Only in rare cases, where a service had multiple nfs, were multiple sets used. Many partners successfully onboarded using this approach, and it remains supported. However, this approach doesn't obscure secrets. All configuration values are stored in plain-text and are displayable via most Azure methods.
29+
The original recommendation was to use only a single CGS/CGV set for the entire NF. This approach consolidated site-specific, instance-specific, and security-specific parameters together. Only in rare cases, where a service had multiple NFs, were multiple sets used. Many partners successfully onboarded using this approach, and it remains supported. However, this approach doesn't obscure secrets. All configuration values are stored in plain-text and are displayable via most Azure methods.
3030

3131
## Three-CGS approach
3232

@@ -92,13 +92,13 @@ This example shows the rendered CGV resource created after the CGV deployment co
9292
```
9393

9494
## CGS with secrets
95-
Other then seperating secrets into a unique CGS, no special requirements exist for CGS secret support.
95+
Other than separating secrets into a unique CGS, no special requirements exist for CGS secret support.
9696

9797
## CGV with secrets
98-
Consider the following Azure Resource Manager (ARM) template reqiurements to properly obscure secret values throughout the entire CGV resource lifecycle.
98+
Consider the following Azure Resource Manager (ARM) template requirements to properly obscure secret values throughout the entire CGV resource lifecycle.
9999

100100
* Use `configurationType: 'Secret'` in the template under resource properties.
101-
* Once a CGV is deployed, this prevents displaying the secret data via most Azure methods.
101+
* Once a CGV is deployed, this configuration prevents displaying the secret data via most Azure methods.
102102

103103
```json
104104
"parameters": {
@@ -109,7 +109,7 @@ Consider the following Azure Resource Manager (ARM) template reqiurements to pro
109109
```
110110

111111
* Use `"type": "secureObject"` in the template under parameter type
112-
* This obscures the display of the secrets as template parameters.
112+
* This configuration obscures the display of the secrets as template parameters.
113113

114114
```json
115115
{
@@ -122,10 +122,10 @@ Consider the following Azure Resource Manager (ARM) template reqiurements to pro
122122
```
123123

124124
* Use a template reference to Azure Key Vault (AKV) in place of the plain-text secret.
125-
* This obscures the display of the secrets as template variables.
125+
* This configuration obscures the display of the secrets as template variables.
126126

127127
> [!NOTE]
128-
> * Only Azure Key Vault is supported by ARM for secret reference substition.
128+
> * ARM template only support Azure Key Vault for secret reference substitution.
129129
130130
This example shows how to include an AKV reference to a secret named `secretName` in an ARM template.
131131

@@ -139,7 +139,7 @@ This example shows how to include an AKV reference to a secret named `secretName
139139
}
140140
```
141141

142-
To further secure resources, consinder restricting access to the RBAC scope `Microsoft.Resources/deployments/exportTemplate/action` to only roles which absolutely need to this access.
142+
To further secure resources, consider restricting access to the role based access control (RBAC) scope `Microsoft.Resources/deployments/exportTemplate/action` to only roles that absolutely need to this access.
143143

144144
## Overview of JSON Schema
145145

0 commit comments

Comments
 (0)