Skip to content

Commit 1067b80

Browse files
authored
Update configuration-guide.md
1 parent 29e0694 commit 1067b80

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -95,12 +95,12 @@ This example shows the rendered CGV resource created after the CGV deployment co
9595
Other than separating secrets into a unique CGS, no special requirements exist for CGS secret support.
9696

9797
## CGV with secrets without AKV
98-
Where AKV is not being useed, consider the following CGV Azure Resource Manager (ARM) template requirements to properly obscure secret values throughout CGV resource lifecycle.
98+
Where AKV isn't being used, consider the following CGV Azure Resource Manager (ARM) template requirements to properly obscure secret values throughout CGV resource lifecycle.
9999

100-
* Define a object paramerter `secretCgvContent` with `"type": "secureObject"` to contain all secrets.
100+
* To contain all secrets, define an object parameter with `"type": "secureObject"` .
101101
* Before a CGV is deployed, this configuration obscures the display of secrets as template parameters.
102102

103-
This example shows how to define a object paremter `secretCgvContent` to contain all secrets.
103+
This example shows how to define an object parameter `secretCgvContent`.
104104

105105
```json
106106
"parameters": {
@@ -111,9 +111,9 @@ This example shows how to define a object paremter `secretCgvContent` to contain
111111
```
112112

113113
> [!NOTE]
114-
> * Do not hydrate `secretCgvContent` using the bicep loadJsonContent() function as it forces the use of insecure variables.
114+
> * Don't hydrate `secretCgvContent` using the bicep loadJsonContent() function as it forces the use of insecure variables.
115115
116-
* Under CGV resource properties use `configurationType: 'Secret'` and `"secretConfigurationValue": "[string(parameters('secretCgvContent'))]"`.
116+
* Under CGV resource properties, use `configurationType: 'Secret'` and `"secretConfigurationValue": "[string(parameters('secretCgvContent'))]"`.
117117
* Once a CGV is deployed, this configuration prevents displaying the secret data via most Azure user interfaces.
118118

119119
This example shows how to pass all secrets in the object `secretCgvContent` to the new CGV.
@@ -129,7 +129,7 @@ This example shows how to pass all secrets in the object `secretCgvContent` to t
129129
```
130130

131131
## CGV with secrets with AKV
132-
Where AKV is being useed, consider the following CGV Azure Resource Manager (ARM) template requirements to properly obscure secret values throughout CGV resource lifecycle.
132+
Where AKV is being used, consider the following CGV Azure Resource Manager (ARM) template requirements to properly obscure secret values throughout CGV resource lifecycle.
133133

134134
* Define a string `parameter` for each secret and one object `variable` to collect all secret values.
135135
* The object variable contains only a reference to the parameter string and exposes no secrets.
@@ -167,7 +167,7 @@ This example shows how to hydrate the secret `secretPassword` using Azure Key Va
167167
}
168168
```
169169

170-
* Under CGV resource properties use `configurationType: 'Secret'` and `"secretConfigurationValue": "string(secretVal.configurationValue)"`.
170+
* Under CGV resource properties, use `configurationType: 'Secret'` and `"secretConfigurationValue": "string(secretVal.configurationValue)"`.
171171
* Once a CGV is deployed, this configuration prevents displaying the secret data via most Azure user interfaces.
172172

173173
This example shows how to pass all secrets in the object `secretVal.configurationValue` to the new CGV.
@@ -209,9 +209,9 @@ Consider the following Azure Resource Manager (ARM) template requirements when c
209209
```
210210

211211
> [!NOTE]
212-
> * Do not hydrate `secretCgvContent` using the bicep loadJsonContent() function as it forces the use of insecure variables.
212+
> * Don't hydrate `secretCgvContent` using the bicep loadJsonContent() function as it forces the use of insecure variables.
213213

214-
* Under networkFunctions resource properties use `configurationType: 'Secret'` and `"secretDeploymentValues": "[string(parameters('config'))]"`.
214+
* Under networkFunctions resource properties, use `configurationType: 'Secret'` and `"secretDeploymentValues": "[string(parameters('config'))]"`.
215215
* Once a network function is deployed, this configuration prevents displayed the secret data via most Azure user interfaces.
216216

217217
```json
@@ -245,7 +245,7 @@ For the CGS meta-schema, Azure Operator Service Manager implements support for J
245245
* For string types, keyword support isn't limited or filtered. See [string](https://json-schema.org/understanding-json-schema/reference/string) in the JSON Schema reference.
246246
* For numeric types, keyword support isn't limited or filtered. See [Numeric types](https://json-schema.org/understanding-json-schema/reference/numeric) in the JSON Schema reference.
247247

248-
## Optional and required fields
248+
### Optional and required fields
249249

250250
You declare a property as optional by including a `required` keyword, which omits the optional property. If you don't specify the `required` keyword, all properties are considered required. You need at least one required property type to support an optional property type.
251251

@@ -266,11 +266,11 @@ You declare a property as optional by including a `required` keyword, which omit
266266
}
267267
```
268268

269-
## Default values in JSON Schema
269+
### Default values in JSON Schema
270270

271271
For optional properties, Azure Operator Service Manager implements a custom method of handling default values. When a default value is defined in CGS meta-schema, Azure Operator Service Manager uses that value where the property is missing or undefined in the input CGV data. Azure Operator Service Manager validator logic essentially hydrates the CGV value with the default value when the operator doesn't provide a value.
272272

273-
### How to define defaults
273+
#### How to define defaults
274274

275275
Defaults must be specified either inside properties or inside items of an array. The following example demonstrates defaults with integer and string property types:
276276

@@ -290,7 +290,7 @@ Defaults must be specified either inside properties or inside items of an array.
290290
}
291291
```
292292

293-
### Rules for defining defaults
293+
#### Rules for defining defaults
294294

295295
The following rules are applied when you're validating a default value. Consider these rules when you're using default values to ensure expected outcomes.
296296

0 commit comments

Comments
 (0)