You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/operator-service-manager/configuration-guide.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,12 +95,12 @@ This example shows the rendered CGV resource created after the CGV deployment co
95
95
Other than separating secrets into a unique CGS, no special requirements exist for CGS secret support.
96
96
97
97
## 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.
99
99
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"` .
101
101
* Before a CGV is deployed, this configuration obscures the display of secrets as template parameters.
102
102
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`.
104
104
105
105
```json
106
106
"parameters": {
@@ -111,9 +111,9 @@ This example shows how to define a object paremter `secretCgvContent` to contain
111
111
```
112
112
113
113
> [!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.
115
115
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'))]"`.
117
117
* Once a CGV is deployed, this configuration prevents displaying the secret data via most Azure user interfaces.
118
118
119
119
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
129
129
```
130
130
131
131
## 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.
133
133
134
134
* Define a string `parameter` for each secret and one object `variable` to collect all secret values.
135
135
* 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
167
167
}
168
168
```
169
169
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)"`.
171
171
* Once a CGV is deployed, this configuration prevents displaying the secret data via most Azure user interfaces.
172
172
173
173
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
209
209
```
210
210
211
211
> [!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.
213
213
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'))]"`.
215
215
* Once a network function is deployed, this configuration prevents displayed the secret data via most Azure user interfaces.
216
216
217
217
```json
@@ -245,7 +245,7 @@ For the CGS meta-schema, Azure Operator Service Manager implements support for J
245
245
* 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.
246
246
* 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.
247
247
248
-
## Optional and required fields
248
+
### Optional and required fields
249
249
250
250
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.
251
251
@@ -266,11 +266,11 @@ You declare a property as optional by including a `required` keyword, which omit
266
266
}
267
267
```
268
268
269
-
## Default values in JSON Schema
269
+
### Default values in JSON Schema
270
270
271
271
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.
272
272
273
-
### How to define defaults
273
+
#### How to define defaults
274
274
275
275
Defaults must be specified either inside properties or inside items of an array. The following example demonstrates defaults with integer and string property types:
276
276
@@ -290,7 +290,7 @@ Defaults must be specified either inside properties or inside items of an array.
290
290
}
291
291
```
292
292
293
-
### Rules for defining defaults
293
+
#### Rules for defining defaults
294
294
295
295
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.
0 commit comments