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
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,15 +18,15 @@ Consider the following meta-schema guidelines when you're designing configuratio
18
18
19
19
* First, choose which parameters to expose to the operator.
20
20
* A rule of thumb is to expose parameters backed by direct operation, such as a helm value.
21
-
*Surpress parameters backed by another agent, such as `cloudinit``userdata`.
22
-
* Sort the parameters into site-specific, instance-specific and decurity-specific sets.
21
+
*Suppress parameters backed by another agent, such as `cloudinit``userdata`.
22
+
* Sort the parameters into site-specific, instance-specific, and security-specific sets.
23
23
* Ensure that parameters don't overlap between CGS resources.
24
24
* Define required versus optional parameters.
25
25
* For optional parameters, define a reasonable default value.
26
26
27
27
## One-CGS approach
28
28
29
-
The original recommendation was to use only a single CGS for the entire NF. This approach consolidated site-specific, instance-specific, and security-specific parameters into a single set of configuration group resources. This approach avoided multiple resource sets, except for rare cases where a service had multiple components. Many partners successfully onboarded services using this approach, and it remains supported. However, this approach does not obscure secrets. All configuration values will be stored in resources as plain-text.
29
+
The original recommendation was to use only a single CGS for the entire NF. This approach consolidated site-specific, instance-specific, and security-specific parameters into a single set of configuration group resources. This approach avoided multiple resource sets, except for rare cases where a service had multiple components. Many partners successfully onboarded services using this approach, and it remains supported. However, this approach doesn't obscure secrets. All configuration values are stored in resources as plain-text.
30
30
31
31
## Three-CGS approach
32
32
@@ -65,7 +65,7 @@ This example shows a sample CGS payload defining `abc`, `xyz`, and `qwe` as expo
65
65
66
66
## CGV without secrets
67
67
68
-
This example shows a corresponding CGV input which an operator uses with the prior CGS:
68
+
This example shows a corresponding CGV input that an operator uses with the prior CGS:
69
69
70
70
```json
71
71
{
@@ -153,6 +153,6 @@ The following rules are applied when you're validating a default value. Consider
153
153
* A default value shouldn't be applied to a required property.
154
154
* A default value is evaluated in top-down order from where the keyword first appears.
155
155
* Where a property value exists in the input CGV, only children of those properties are evaluated for defaults.
156
-
* Where a property value doesn't exist in the input CGV, it's evaluated for a default, along with any children.
157
-
* Where a property value is the `object` type, and neither it nor its key exists in the input CGV, no defaults for the object are evaluated.
156
+
* Where a property value doesn't exist in the input CGV, a default is evaluated, along with any children.
157
+
* Where a property value is the `object` type, and it's key doesn't exist in the input CGV, no defaults for the object are evaluated.
0 commit comments