Skip to content

Commit 1bf197c

Browse files
committed
edit pass: azure-operator-service-manager-best-practices
1 parent 9c895c8 commit 1bf197c

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

articles/operator-service-manager/best-practices-onboard-deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Here's the breakdown of resources:
121121
- **NFDV**: As needed based on use cases that trigger NFDV minor or major version updates.
122122
- **NSDG**: Single. Combines the NFs and the Kubernetes cluster definitions.
123123
- **NSDV**: As needed based on the use cases that trigger NSDV minor or major version updates.
124-
- **CGS**: Single. We recommend that the CGS has subsections for each component and infrastructure being deployed for easier management, and that it includes the versions for NFDs.
124+
- **CGS**: Single. For easier management, we recommend that the CGS has subsections for each component and infrastructure that you're deploying. We also recommend that the CGS includes the versions for NFDs.
125125
- **CGV**: Single based on the number of CGSs.
126126
- **SNS**: Single per NSDV.
127127

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Consider the following meta-schema guidelines when you're designing three-CGS ob
110110
A rule of thumb is to expose those parameters by using a direct operation, such as a compute tier or Helm value. Use this approach as opposed to a parameter that another agent acts on, such as `cloudinit` user data.
111111
* Sort the parameters into site-specific, instance-specific, and security-specific sets.
112112
* Define required versus optional parameters. For optional parameters, define a reasonable default value.
113-
* Ensure that paramters don't overlap between CGS objects.
113+
* Ensure that parameters don't overlap between CGS objects.
114114

115115
This example shows a sample CGS payload:
116116

articles/operator-service-manager/helm-requirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Upon execution of a Helm operation, the charts are rendered into Kubernetes mani
1818

1919
Every Helm chart generally requires `registryPath` and `imagePullSecrets` parameters. Most commonly, you expose these parameters in the `values.yaml` file.
2020

21-
At first, Azure Operator Service Manager depended on publishers managing these values in a strict manner (legacy approach), to be substituted for the proper Azure values during deployment. But not all publishers could easily comply with the strict management of these values. Some charts hide `registryPath` and/or `imagePullSecrets` behind conditionals, or other value restrictions, which were not always met. Some charts declare `registryPath` and/or `imagePullSecrets` as an array instead of as the expected named string.
21+
At first, Azure Operator Service Manager depended on publishers managing these values in a strict manner (legacy approach), to be substituted for the proper Azure values during deployment. But not all publishers could easily comply with the strict management of these values. Some charts hide `registryPath` and/or `imagePullSecrets` behind conditionals, or other value restrictions, which weren't always met. Some charts declare `registryPath` and/or `imagePullSecrets` as an array instead of as the expected named string.
2222

2323
To reduce the compliance requirements on publishers, Azure Operator Service Manager introduced two improved methods: `injectArtifactStoreDetail` and cluster registry. These newer methods don't depend on `registryPath` or `imagePullSecrets` appearing in the Helm package. Instead, these methods use a webhook to inject proper Azure values directly into pod operations.
2424

articles/operator-service-manager/publisher-resource-preview-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ To change the state of an artifact manifest resource, use the following Azure CL
6868
--state Uploaded
6969
```
7070

71-
## NFDV and NSDV states
71+
## NFDV and NSDV state machine
7272

7373
- **Preview** is the default state.
7474
- **Deprecated** is a terminal state but can be reversed.

0 commit comments

Comments
 (0)