Skip to content

Commit 8286633

Browse files
authored
Update configuration guide by removing CGS with secrets
Removed the section on CGS with secrets and corrected a typo in the CGV with secrets section.
1 parent 1067b80 commit 8286633

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ We now recommend that you use at least three CGS/CGV sets, organizing parameters
4747
* Uses CGS/CGV with secrets.
4848
* Store values in Azure Key Vault to obscure during deployments.
4949

50+
> [!NOTE]
51+
> * Consider restricting access to the role based access control (RBAC) scope `Microsoft.Resources/deployments/exportTemplate/action` to only admin roles.
52+
5053
## CGS without secrets
5154

5255
This example shows a CGS exposing `abc`, `xyz`, and `qwe` parameters. Two of the parameters have default values and one is marked required.
@@ -91,10 +94,8 @@ This example shows the rendered CGV resource created after the CGV deployment co
9194
}
9295
```
9396

94-
## CGS with secrets
95-
Other than separating secrets into a unique CGS, no special requirements exist for CGS secret support.
96-
9797
## CGV with secrets without AKV
98+
9899
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.
99100

100101
* To contain all secrets, define an object parameter with `"type": "secureObject"` .
@@ -129,12 +130,13 @@ This example shows how to pass all secrets in the object `secretCgvContent` to t
129130
```
130131

131132
## CGV with secrets with AKV
133+
132134
Where AKV is being used, consider the following CGV Azure Resource Manager (ARM) template requirements to properly obscure secret values throughout CGV resource lifecycle.
133135

134136
* Define a string `parameter` for each secret and one object `variable` to collect all secret values.
135137
* The object variable contains only a reference to the parameter string and exposes no secrets.
136138

137-
This example shows how to define a paremter `secretPassword` contained within the object variable `secretVal.configurationValue`.
139+
This example shows how to define a parameter `secretPassword` contained within the object variable `secretVal.configurationValue`.
138140

139141
```json
140142
"parameters": {
@@ -185,6 +187,7 @@ This example shows how to pass all secrets in the object `secretVal.configuratio
185187
```
186188

187189
## NF with secrets
190+
188191
Consider the following Azure Resource Manager (ARM) template requirements when creating a network function to properly obscure secret values throughout network function resource lifecycle.
189192

190193
* Use `"type": "secureObject"` in the template for type of the `secretValues` and `config` parameter
@@ -224,9 +227,6 @@ Consider the following Azure Resource Manager (ARM) template requirements when c
224227
]
225228
```
226229

227-
> [!NOTE]
228-
> * Consider restricting access to the role based access control (RBAC) scope `Microsoft.Resources/deployments/exportTemplate/action` to only admin roles.
229-
230230
## Overview of JSON Schema
231231

232232
JSON Schema is an Internet Engineering Task Force (IETF) standard that provides a format for what JSON data is required for an application and how to interact with it. Applying such standards for a JSON document helps you enforce consistency and data validity across JSON data.

0 commit comments

Comments
 (0)