Skip to content

Commit 5dfcc33

Browse files
authored
Update configuration-guide.md
1 parent 828c3c0 commit 5dfcc33

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.service: azure-operator-service-manager
99
---
1010

1111
# Workload configuration management
12-
This article provides guidelines that NF vendors, telco operators, and their partners can follow to optimize the design of configuration group schemas (CGS) and the operation of configuration group values (CGV) when using Azure Operator Service Manager (AOSM). Keep these practices in mind when you onboard and deploy your NFs.
12+
This article provides Azure Operator Service Manager (AOSM) guidelines to optimize the design of configuration group schemas (CGS) and the operation of configuration group values (CGV). NF vendors, telco operators, and their partners should keep these practices in mind when onboarding and deploying NFs.
1313

1414
## What is JSON schema
1515
JSON Schema is an Internet Engineering Task Force (IETF) standard providing a format for what JSON data is required for a given application and how to interact with it. Applying such standards for a JSON document lets you enforce consistency and data validity across JSON data
@@ -20,14 +20,14 @@ JSON Schema is an Internet Engineering Task Force (IETF) standard providing a
2020
* AOSM service allows the meta-schema properties be optional or required. Where a property is marked required, it must be specified in the values Json.
2121

2222
### What JSON keywords are supported
23-
For the CG meta-schema, AOSM implements supports for JSON standard keywords on a type by type basis.
23+
For the CGS meta-schema, AOSM implements supports for JSON standard keywords on a type by type basis.
2424

2525
* For object types, keyword supported is limited by filter policy. See JSON Schema - [object](https://json-schema.org/understanding-json-schema/reference/object)
2626
* For string types, keyword support isn't limited or filtered. See JSON Schema - [string](https://json-schema.org/understanding-json-schema/reference/string)
2727
* For numeric types, keyword support isn't limited or filtered. See JSON Schema - [numeric](https://json-schema.org/understanding-json-schema/reference/numeric)
2828

2929
## Optional and Required fields
30-
An optional property is declared by including a required keywork which doesn't contain the optional property. An optional property can also have defaults to it. A property is required if the designer/publisher hasn't specified the required section and the property doesn't have defaults.
30+
A property is declared optional by including a `required` keyword which omitts the optional property. If the `required` keyword is not specified, then all properties are considered required. At leaat one required property type is needed to support an optional property type.
3131

3232
```json
3333
{
@@ -48,7 +48,7 @@ An optional property is declared by including a required keywork which doesn't c
4848

4949

5050
## Defaults Values in JSON Schema
51-
For optional properties, AOSM implements a custom method of default value handling. When a default value is defined in CGS meta-schema, AOSM uses that value where the property is missing or undefined in the input CGV data. AOSM validator logic essentially hydrates the CGV value with the default value when no value has been provided by operator.
51+
For optional properties, AOSM implements a custom method of default value handling. When a default value is defined in CGS meta-schema, AOSM uses that value where the property is missing or undefined in the input CGV data. AOSM validator logic essentially hydrates the CGV value with the default value when no value is provided by operator.
5252

5353
### How to define defaults
5454
Defaults must be specified either inside properties or inside items of array. The following example demonstrates defaults with integer and trying property types.
@@ -74,16 +74,16 @@ The following rules are applied when validating a default value. Consider these
7474

7575
* A default value shouldn't be applied to a required property.
7676
* A default value is evaluated in top-down order, from where the keyword is first seen.
77-
* Where a property value exist in the input CGV, only children of those properties are evaluated for defaults.
78-
* Where a property value doesn't exist in the input CGV, it is evaluated for a default, along with any children.
79-
* Where a proerty value is type object, and neither it nor it's key exist in the input CGV, then no defaults for the object are evaluated.
77+
* Where a property value exists in the input CGV, only children of those properties are evaluated for defaults.
78+
* Where a property value doesn't exist in the input CGV, it's evaluated for a default, along with any children.
79+
* Where a property value is type object, and neither it or it's key exist in the input CGV, then no defaults for the object are evaluated.
8080

8181
## Configuration Group Schema considerations
8282
We recommend that you always start with a single CGS for the entire NF. If there are site-specific or instance-specific parameters, we still recommend that you keep them in a single CGS. We recommend splitting into multiple CGSs when there are multiple components (rarely NFs, more commonly, infrastructure) or configurations that are shared across multiple NFs. The number of CGSs defines the number of CGVs.
8383

8484
### Scenario
8585

86-
- FluentD, Kibana, and Splunk (common third-party components) are always deployed for all NFs within an network service design (NSD). We recommend grouping these components into a single network function design group (NFDG).
86+
- FluentD, Kibana, and Splunk (common third-party components) are always deployed for all NFs within a network service design (NSD). We recommend grouping these components into a single network function design group (NFDG).
8787
- NSD has multiple NFs that all share a few configurations (deployment location, publisher name, and a few chart configurations).
8888

8989
In this scenario, we recommend that you use a single global CGS to expose the common NF and third-party component configurations. You can define NF-specific CGS as needed.

0 commit comments

Comments
 (0)