Skip to content

Commit 4d79376

Browse files
authored
Update terminology for Azure Key Vault and CGV
1 parent 8286633 commit 4d79376

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
@@ -45,10 +45,10 @@ We now recommend that you use at least three CGS/CGV sets, organizing parameters
4545
* Security-specific parameters
4646
* Examples include passwords and certificates.
4747
* Uses CGS/CGV with secrets.
48-
* Store values in Azure Key Vault to obscure during deployments.
48+
* Store values in Azure Key Vault (AKV) to obscure during deployments.
4949

5050
> [!NOTE]
51-
> * Consider restricting access to the role based access control (RBAC) scope `Microsoft.Resources/deployments/exportTemplate/action` to only admin roles.
51+
> * When using secrets, consider restricting access to the role based access control (RBAC) scope `Microsoft.Resources/deployments/exportTemplate/action`.
5252
5353
## CGS without secrets
5454

@@ -96,9 +96,9 @@ This example shows the rendered CGV resource created after the CGV deployment co
9696

9797
## CGV with secrets without AKV
9898

99-
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+
Where AKV isn't being used, consider the following Azure Resource Manager (ARM) template requirements to properly obscure secret values throughout CGV resource lifecycle.
100100

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

104104
This example shows how to define an object parameter `secretCgvContent`.
@@ -117,7 +117,7 @@ This example shows how to define an object parameter `secretCgvContent`.
117117
* Under CGV resource properties, use `configurationType: 'Secret'` and `"secretConfigurationValue": "[string(parameters('secretCgvContent'))]"`.
118118
* Once a CGV is deployed, this configuration prevents displaying the secret data via most Azure user interfaces.
119119

120-
This example shows how to pass all secrets in the object `secretCgvContent` to the new CGV.
120+
This example shows how to pass all secrets in the object `secretCgvContent` to the CGV resource.
121121

122122
```json
123123
{
@@ -131,7 +131,7 @@ This example shows how to pass all secrets in the object `secretCgvContent` to t
131131

132132
## CGV with secrets with AKV
133133

134-
Where AKV is being used, consider the following CGV Azure Resource Manager (ARM) template requirements to properly obscure secret values throughout CGV resource lifecycle.
134+
Where AKV is being used, consider the following Azure Resource Manager (ARM) template requirements to properly obscure secret values throughout CGV resource lifecycle.
135135

136136
* Define a string `parameter` for each secret and one object `variable` to collect all secret values.
137137
* The object variable contains only a reference to the parameter string and exposes no secrets.
@@ -146,17 +146,17 @@ This example shows how to define a parameter `secretPassword` contained within t
146146
}
147147
"variables": {
148148
"configurationValue": {
149-
"secretValues": {
149+
"secretVal": {
150150
"elastic_passwd": "secretPassword"
151151
}
152152
}
153153
}
154154
```
155155

156-
* Use a template reference to Azure Key Vault (AKV) in place of the plain-text secret.
156+
* Use a template reference to AKV in place of the plain-text secret.
157157
* Before the CGV is deployed, this configuration obscures the display of the secrets as template variables.
158158

159-
This example shows how to hydrate the secret `secretPassword` using Azure Key Vault secret and key.
159+
This example shows how to hydrate the secret `secretPassword` using AKV secret and key.
160160

161161
```json
162162
"secretPassword": {
@@ -186,11 +186,11 @@ This example shows how to pass all secrets in the object `secretVal.configuratio
186186
]
187187
```
188188

189-
## NF with secrets
189+
## networkFunction with secrets
190190

191-
Consider the following Azure Resource Manager (ARM) template requirements when creating a network function to properly obscure secret values throughout network function resource lifecycle.
191+
Consider the following Azure Resource Manager (ARM) template requirements to properly obscure secret values throughout network function (NF) resource lifecycle.
192192

193-
* Use `"type": "secureObject"` in the template for type of the `secretValues` and `config` parameter
193+
* Use `"type": "secureObject"` in the template for the `secretValues` and `config` parameter
194194
* This configuration obscures the display of the secrets as template parameters.
195195

196196
```json
@@ -215,7 +215,7 @@ Consider the following Azure Resource Manager (ARM) template requirements when c
215215
> * Don't hydrate `secretCgvContent` using the bicep loadJsonContent() function as it forces the use of insecure variables.
216216

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

220220
```json
221221
"resources": [

0 commit comments

Comments
 (0)