Skip to content

Commit 8e8a7a4

Browse files
authored
Fix typos and enhance clarity in configuration guide
Corrected typos and improved clarity in the configuration guide.
1 parent da5e12a commit 8e8a7a4

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ Consider the following meta-schema guidelines when you're designing configuratio
1818

1919
* First, choose which parameters to expose to the operator.
2020
* 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.
2323
* Ensure that parameters don't overlap between CGS resources.
2424
* Define required versus optional parameters.
2525
* For optional parameters, define a reasonable default value.
2626

2727
## One-CGS approach
2828

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.
3030

3131
## Three-CGS approach
3232

@@ -65,7 +65,7 @@ This example shows a sample CGS payload defining `abc`, `xyz`, and `qwe` as expo
6565

6666
## CGV without secrets
6767

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:
6969

7070
```json
7171
{
@@ -153,6 +153,6 @@ The following rules are applied when you're validating a default value. Consider
153153
* A default value shouldn't be applied to a required property.
154154
* A default value is evaluated in top-down order from where the keyword first appears.
155155
* 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.
158158

0 commit comments

Comments
 (0)