Skip to content

Commit 6236ff8

Browse files
authored
Update helm-requirements.md
1 parent 66681ef commit 6236ff8

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ ms.service: azure-operator-service-manager
1212
Helm is a package manager for Kubernetes that helps to simplify application lifecycle management. Helm packages are called charts and consist of YAML configuration and template files. Upon execution of a Helm operation, the charts are rendered into Kubernetes manifest files to trigger the appropriate application lifecycle action. For most efficient integration with Azure Operator Service Manager (AOSM), publisher's should consider certain best-practice considerations when developing Helm charts.
1313

1414
## Considerations for registryUrl and imagePullSecrets
15-
Every Helm chart generally requires a declared registryUrl and imagePullSecrets. Best practice recommends that the publisher define these two parameters consistently as variables in the values.yaml. At first, AOSM depended upon the publisher exposing these values in a strict manner, so they could be ingested and then injected during deployment. This approach is known as the legacy method. Overtime, many complications arose, as not all publishers charts complied with the strict definition of registryUrl and imagePullSecrets required by AOSM.
15+
Every Helm chart generally requires a declared registryUrl and imagePullSecrets. Best practice recommends that the publisher defines these two parameters consistently as variables in the values.yaml. At first, AOSM depended upon the publisher exposing these values in a strict manner, so they could be ingested and then injected during deployment. This approach is known as the legacy method. Overtime, many complications arose, as not all publishers charts complied with the strict definition of registryUrl and imagePullSecrets required by AOSM.
1616
* Some charts hide registryUrl and/or imagePullSecrets behind conditionals, or other values restrictions, which were not always met.
17-
* Some charts didnt declare registryUrl and/or imagePullSecrets as the expected named string, instead as an array.
17+
* Some charts don't declare registryUrl and/or imagePullSecrets as the expected named string, instead as an array.
1818

1919
To reduce the strict compliance requirements on publishers for registryUrl and imagePullSecrets, AOSM later introduced two improved methods of handling these values. First injectArtifactStoreDetail and finally Cluster Registry. These two newer methods do not depend upon the registryUrl or imagePullSecrets appearing in the Helm package, at all. Instead these methods derive and inject these values on behalf of the network function.
2020

@@ -25,7 +25,7 @@ To reduce the strict compliance requirements on publishers for registryUrl and i
2525
* Images hosted in publisher Azure Container Registry (ACR).
2626

2727
**InjectArtifactStoreDetail.**
28-
* Uses a webhook to inject registryUrl & imagePullSecrets directly into pod without any dependancy on helm.
28+
* Uses a webhook to inject registryUrl & imagePullSecrets directly into pod without any dependency on helm.
2929
* Images still hosted in publisher ACR.
3030

3131
**Cluster Registry.**
@@ -154,7 +154,7 @@ image:
154154
```
155155

156156
## injectArtifactStoreDetails requirements for registryUrl and imagePullSecrets
157-
In some cases, third-party helm charts may not be fully compliant with AOSM requirements for registryURL. In this case, the injectArtifactStoreDetails feature can be used to avoid making changes to helm packages. To use injectArtifactStoreDetails, set the installOptions parameter in the NF resource roleOverrides section to true, then, in the helm chart package, use whatever registryURL value is needed to keep the registry URL valid. See following example of injectArtifactStoreDetails parameter enabled.
157+
In some cases, third-party helm charts may not be fully compliant with AOSM requirements for registryURL. In this case, the injectArtifactStoreDetails feature can be used to avoid making changes to helm packages. To use injectArtifactStoreDetails, set the installOptions parameter in the NF resource roleOverrides section to true, then in the helm chart package, use whatever registryURL value is needed to keep the registry URL valid. See following example of injectArtifactStoreDetails parameter enabled.
158158

159159
```bash
160160
resource networkFunction 'Microsoft.HybridNetwork/networkFunctions@2023-09-01' = {
@@ -186,4 +186,4 @@ Immutability restrictions prevent changes to a file or directory. For example, a
186186
```
187187

188188
## Chart CRD declaration and usage split
189-
We recommend splitting the declaration and usage of CRDs into separate helm charts to support updates. For detailed information see: [method-2-separate-charts](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/#method-2-separate-charts)
189+
We recommend splitting the declaration and usage of customer resource definitions (CRD) into separate helm charts to support updates. For detailed information see: [method-2-separate-charts](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/#method-2-separate-charts)

0 commit comments

Comments
 (0)