Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Helm est un gestionnaire de package pour Kubernetes qui simplifie la gestion du cycle de vie des applications. Les packages Helm sont appelés graphiques et se composent de fichiers de configuration et de modèle YAML. Lors de l’exécution d’une opération Helm, les graphiques sont rendus dans des fichiers manifeste Kubernetes pour déclencher les actions de cycle de vie des applications appropriées. Pour une intégration la plus efficace avec Azure Operator Service Manager, suivez ces bonnes pratiques recommandées lors du développement de graphiques Helm.
Considérations relatives à RegistryPath et imagePullSecrets
Chaque graphique Helm nécessite généralement des paramètres et registryPath des imagePullSecrets paramètres. Le plus souvent, vous exposez ces paramètres dans le values.yaml fichier. Au début, Azure Operator Service Manager dépendait des éditeurs gérant ces valeurs de manière stricte (approche héritée), à remplacer par les valeurs Azure appropriées pendant le déploiement. Mais tous les éditeurs ne peuvent pas se conformer facilement à la gestion stricte de ces valeurs. Certains graphiques masquent registryPath et / ou imagePullSecrets derrière des conditions, ou d’autres restrictions de valeur, qui n’ont pas toujours été remplies. Certains graphiques déclarent registryPath et / ou imagePullSecrets en tant que tableau au lieu de la chaîne nommée attendue.
Pour réduire les exigences de conformité sur les éditeurs, Azure Operator Service Manager a introduit deux méthodes améliorées : injectArtifactStoreDetail et le registre de cluster. Ces méthodes plus récentes ne dépendent registryPath pas ou imagePullSecrets n’apparaissent pas dans le package Helm. Au lieu de cela, ces méthodes utilisent un webhook pour injecter des valeurs Azure appropriées directement dans les opérations de pod.
Résumé de la méthode pour registryPath et imagePullSecrets
Les trois méthodes sont actuellement prises en charge, comme décrit dans cet article. Choisissez la meilleure offre pour votre fonction réseau (NF) et le cas d’usage.
Héritage :
- Vous devez paramétrer
registryPathetimagePullSecretsdans les valeurs Helm et les modèles de déploiement pour la substitution. - Héberge les images dans Azure Container Registry.
InjectArtifactStoreDetail :
- Utilise un webhook pour injecter
registryPathetimagePullSecretsdirectement dans les opérations du pod, avec un minimum de dépendances vis-à-vis de Helm. - Héberge les images dans Azure Container Registry.
Registre de cluster :
- Utilise un webhook pour injecter
registryPathetimagePullSecretsdirectement dans des opérations de pod, sans dépendance sur Helm. - Héberge des images dans l’extension NFO (Local Network Function Operator).
Dans les trois cas, Azure Operator Service Manager remplace les valeurs Azure pour les valeurs que vous exposez dans les modèles. La seule différence est la méthode de substitution.
Exigences héritées pour registryPath et imagePullSecrets
Azure Operator Service Manager utilise le service Azure Network Function Manager pour déployer des fonctions réseau conteneurisées (CNF). Avec la méthode héritée, Azure Network Function Manager remplace les valeurs et registryPath les valeurs du imagePullSecrets conteneur Azure Operator Service Manager dans l’opération Helm pendant le déploiement de fonctions réseau.
Exemple de méthode héritée
Le modèle de déploiement Helm suivant montre un exemple de la façon dont vous devez exposer registryPath et imagePullSecrets :
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-deployment
labels:
app: nginx
spec:
replicas: 3
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
{{- if .Values.global.imagePullSecrets }}
imagePullSecrets: {{ toYaml .Values.global.imagePullSecrets | nindent 8 }}
{{- end }}
containers:
- name: contosoapp
image:{{ .Values.global.registryPath }}/contosoapp:1.14.2
ports:
- containerPort: 80
Le modèle suivant values.yaml montre un exemple de la façon dont vous pouvez fournir les valeurs et registryPath les imagePullSecrets valeurs :
global:
imagePullSecrets: []
registryPath: ""
Le fichier suivant values.schema.json montre un exemple de la façon dont vous pouvez définir les valeurs et registryPath les imagePullSecrets valeurs :
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "StarterSchema",
"type": "object",
"required": ["global"],
"properties": {
"global" : {
"type": "object",
"properties": {
"registryPath": {"type": "string"},
"imagePullSecrets": {"type": "string"},
}
"required": [ "registryPath", "imagePullSecrets" ],
}
}
}
La charge utile de la demande de définition de fonction réseau (NFDV) suivante montre un exemple de la façon dont vous pouvez fournir les valeurs et registryPath les imagePullSecrets valeurs au moment du déploiement :
"registryValuesPaths": [ "global.registryPath" ],
"imagePullSecretsValuesPaths": [ "global.imagePullSecrets" ],
Dans les exemples précédents :
- La
registryPathvaleur est définie sans préfixe tel quehttps://ouoci://. Si nécessaire, définissez un préfixe dans le package Helm. -
imagePullSecretsetregistryPathdoit être fourni pendant l’intégration de NFDV.
Autres considérations
Tenez compte des recommandations suivantes lorsque vous utilisez la méthode héritée.
Éviter les références à un registre externe
Les références à un registre externe peuvent entraîner des problèmes de validation. Par exemple, si deployment.yaml vous utilisez un chemin d’accès de Registre codé en dur ou des références de Registre externe, la validation échoue.
Effectuer des validations manuelles
Passez en revue les images et les spécifications de conteneur pour vous assurer que les images ont un préfixe registryPath et qu’elles imagePullSecrets sont remplies avec secretName :
helm template --set "global.imagePullSecrets[0].name=<secretName>" --set "global.registry.url=<registryPath>" <release-name> <chart-name> --dry-run
Voici un autre exemple :
helm install --set "global.imagePullSecrets[0].name=<secretName>" --set "global.registry.url=<registryPath>" <release-name> <chart-name> --dry-run
kubectl create secret <secretName> regcred --docker-server=<registryPath> --dockerusername=<regusername> --docker-password=<regpassword>
Utiliser un référentiel d’images statiques et des balises
Chaque graphique Helm doit contenir un référentiel d’images statiques et des balises. Vous définissez les valeurs statiques via l’une des méthodes suivantes :
- Dans la
imageligne - In
values.yaml, sans exposer ces valeurs dans le NFDV
Un NFDV doit être mappé à un ensemble statique de graphiques et d’images Helm. Vous mettez à jour les graphiques et les images uniquement en publiant un nouveau NFDV, comme indiqué dans les exemples suivants :
image: "{{ .Values.global.registryPath }}/contosoapp:1.14.2"
image: "{{ .Values.global.registryPath }}/{{ .Values.image.repository }}:{{ .Values.image.tag}}"
YAML values.yaml
image:
repository: contosoapp
tag: 1.14.2
image: http://myUrl/{{ .Values.image.repository }}:{{ .Values.image.tag}}
configuration requise pour injectArtifactStoreDetails pour registryPath et imagePullSecrets
Dans certains cas, les graphiques Helm tiers peuvent ne pas être entièrement conformes aux exigences d’Azure Operator Service Manager pour registryPath. Dans ces cas, vous pouvez utiliser injectArtifactStoreDetails pour éviter d’apporter des modifications de conformité aux packages Helm.
Avec injectArtifactStoreDetails activé, vous utilisez une méthode de webhook pour injecter les données appropriées registryPath et imagePullSecrets dynamiques pendant les opérations de pod. Cette méthode remplace les valeurs configurées dans le package Helm. Vous devez toujours utiliser des valeurs factices légales où registryPath et imagePullSecrets sont référencées, généralement dans la global section de values.yaml.
L’exemple suivant values.yaml montre comment fournir les valeurs et registryPath les imagePullSecrets valeurs de compatibilité avec l’approche injectArtifactStoreDetails :
global:
registryPath: "azure.io"
imagePullSecrets: ["abc123"]
Remarque
S’il registryPath est laissé vide dans le package Helm sous-jacent, le déploiement du service de réseau de site (SNS) échoue lors du téléchargement de l’image.
Utilisation de la méthode injectArtifactStoreDetails
Pour activer injectArtifactStoreDetails, définissez le installOptions paramètre dans la section roleOverrides de true la ressource NF sur , comme illustré dans l’exemple suivant :
resource networkFunction 'Microsoft.HybridNetwork/networkFunctions@2023-09-01' = {
name: nfName
location: location
properties: {
nfviType: 'AzureArcKubernetes'
networkFunctionDefinitionVersionResourceReference: {
id: nfdvId
idType: 'Open'
}
allowSoftwareUpdate: true
nfviId: nfviId
deploymentValues: deploymentValues
configurationType: 'Open'
roleOverrideValues: [
// Use inject artifact store details feature on test app 1
'{"name":"testapp1", "deployParametersMappingRuleProfile":{"helmMappingRuleProfile":{"options":{"installOptions":{"atomic":"false","wait":"false","timeout":"60","injectArtifactStoreDetails":"true"},"upgradeOptions": {"atomic": "false", "wait": "true", "timeout": "100", "injectArtifactStoreDetails": "true"}}}}}'
]
}
}
Remarque
Le package de graphique Helm doit toujours exposer correctement mis en forme registryPath et imagePullSecrets les valeurs.
Configuration requise pour registryPath et imagePullSecrets
Avec un registre de clusters, les images sont copiées à partir d’Azure Container Registry vers un référentiel Docker local sur le cluster Nexus Kubernetes. Vous utilisez une méthode webhook pour injecter dynamiquement les valeurs appropriées registryPath et imagePullSecrets pendant les opérations de pod. Cette méthode remplace les valeurs configurées dans le package Helm. Vous devez toujours utiliser des valeurs factices légales où registryPath et imagePullSecrets sont référencées, généralement dans la global section de values.yaml.
L’exemple suivant values.yaml montre comment fournir les valeurs et registryPath les imagePullSecrets valeurs de compatibilité avec l’approche de Registre de cluster :
global:
registryPath: "azure.io"
imagePullSecrets: ["abc123"]
Remarque
S’il registryPath est laissé vide dans le package Helm sous-jacent, le déploiement SNS échoue lors du téléchargement de l’image.
Pour plus d’informations sur l’utilisation d’un registre de clusters, consultez la documentation sur le concept.
Recommandations pour les restrictions d’immuabilité
Les restrictions d’immuabilité empêchent les modifications d’un fichier ou d’un répertoire. Par exemple, un fichier immuable ne peut pas être modifié ni renommé. Vous devez éviter d’utiliser des balises mutables telles que latest, devou stable. Par exemple, si deployment.yaml l’utilisation est utilisée latest pour .Values.image.tag, le déploiement échoue.
image: "{{ .Values.global.registryPath }}/{{ .Values.image.repository }}:{{ .Values.image.tag}}"
Recommandations pour la déclaration CRD et le fractionnement de l’utilisation
Nous vous recommandons de fractionner la déclaration et l’utilisation des définitions de ressources client (CRD) en graphiques Helm distincts pour prendre en charge les mises à jour. Pour plus d’informations, consultez la documentation Helm sur la séparation des graphiques.
Recommandations pour l’étiquetage des versions d’image
Pour garantir des déploiements cohérents et prévisibles, nous vous recommandons les éléments suivants pour toutes les images conteneur :
- Évitez d’utiliser
:latestdans les environnements de production.- L’utilisation de la dernière version peut entraîner un comportement inattendu, car l’image réelle derrière la dernière peut changer sans préavis.
- Dans une configuration du registre de cluster, si la valeur de la balise change, mais que le nom de la balise reste le même, le registre de cluster ne télécharge pas à nouveau l’image mise à jour.
- Cela peut entraîner l’exécution d’images obsolètes ou incohérentes.
- À la place, utilisez toujours des balises immuables comme
:1.4.2 - Vérifiez que chaque build produit une balise unique, ne remplacez pas les balises existantes.
Ces pratiques permettent d’éviter les problèmes de déploiement et d’améliorer la traçabilité, la sécurité de restauration et la conformité de la sécurité.
Recommandations pour l'ordre séquentiel de l'application nfApplication
Par défaut, les applications CNF sont installées ou mises à jour en fonction de l’ordre dans lequel elles apparaissent dans le NFDV. Pour l’opération de suppression, les applications CNF sont supprimées dans l’ordre inverse spécifié. Si vous devez définir un ordre spécifique d’applications CNF qui diffèrent de la valeur par défaut, utilisez dependsOnProfile pour définir une séquence unique pour les opérations d’installation, de mise à jour et de suppression.
Utilisation de dependsOnProfile
Vous pouvez utiliser dependsOnProfile dans le NFDV pour contrôler la séquence d’exécutions Helm pour les applications CNF. Dans l’exemple suivant :
- Pendant une opération d’installation, les applications CNF sont déployées dans l’ordre suivant :
dummyApplication1,dummyApplication2,dummyApplication. - Pendant une opération de mise à jour, les applications CNF sont mises à jour dans l’ordre suivant :
dummyApplication2,dummyApplication1,dummyApplication. - Pendant une opération de suppression, les applications CNF sont supprimées dans l’ordre suivant :
dummyApplication2,dummyApplication1,dummyApplication.
{
"location": "eastus",
"properties": {
"networkFunctionTemplate": {
"networkFunctionApplications": [
{
"dependsOnProfile": {
"installDependsOn": [
"dummyApplication1",
"dummyApplication2"
],
"uninstallDependsOn": [
"dummyApplication1"
],
"updateDependsOn": [
"dummyApplication1"
]
},
"name": "dummyApplication"
},
{
"dependsOnProfile": {
"installDependsOn": [
],
"uninstallDependsOn": [
"dummyApplication2"
],
"updateDependsOn": [
"dummyApplication2"
]
},
"name": "dummyApplication1"
},
{
"dependsOnProfile": null,
"name": "dummyApplication2"
}
],
"nfviType": "AzureArcKubernetes"
},
"networkFunctionType": "ContainerizedNetworkFunction"
}
}
Erreurs courantes avec dependsOnProfile
Actuellement, si le dependsOnProfile code fourni dans le NFDV n’est pas valide, l’opération NF échoue avec une erreur de validation. Le message de l’erreur de validation s’affiche dans la ressource d’état de l’opération et ressemble à l’exemple suivant :
{
"id": "/providers/Microsoft.HybridNetwork/locations/EASTUS2EUAP/operationStatuses/ca051ddf-c8bc-4cb2-945c-a292bf7b654b*C9B39996CFCD97AB3A121AE136ED47F67BB13946C573EF90628C47628BC5EF5F",
"name": "ca051ddf-c8bc-4cb2-945c-a292bf7b654b*C9B39996CFCD97AB3A121AE136ED47F67BB13946C573EF90628C47628BC5EF5F",
"resourceId": "/subscriptions/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/resourceGroups/xinrui-publisher/providers/Microsoft.HybridNetwork/networkfunctions/testnfDependsOn02",
"status": "Failed",
"startTime": "2023-07-17T20:48:01.4792943Z",
"endTime": "2023-07-17T20:48:10.0191285Z",
"error": {
"code": "DependenciesValidationFailed",
"message": "CyclicDependencies: Circular dependencies detected at hellotest."
}
}
Meilleures pratiques pour l’adoption de Helm 4
Helm est le gestionnaire de package standard pour Kubernetes depuis sa version initiale en 2016. Son évolution a étroitement suivi Kubernetes lui-même :
- Helm v2 (2016–2019) : a introduit le packaging d’applications basés sur des charts, mais reposait sur un composant côté serveur (Tiller), ce qui a soulevé des préoccupations en matière de sécurité et de multi-location.
- Helm v3 (2019-2025) : Suppression de Tiller, passage à un modèle client uniquement avec une sécurité et une facilité d’utilisation améliorées. Cette version est devenue la norme du secteur et a accumulé des améliorations incrémentielles tout en conservant la compatibilité descendante.
Après près de six ans de Helm v3, le projet a accumulé une dette technique, des limitations architecturales et des défis de sécurité qu’il n’a pas pu résoudre sans introduire de changements cassants. Cette situation a entraîné la publication de Helm v4 à la fin de 2025.
Ce que Helm 4 représente
Helm 4 est une évolution architecturale significative plutôt qu’une mise à niveau incrémentielle. Ses principaux objectifs sont les suivants :
- Aligner avec les modèles de déploiement Kubernetes modernes
- Supprimer les comportements Helm v3 hérités
- Améliorer l’extensibilité, la maintenance et la sécurité
Les principales modifications introduites avec Helm 4 sont les suivantes :
- Server-Side Apply (SSA) : remplace l’approche héritée de fusion à trois voies et aligne les déploiements sur la sémantique de réconciliation propre à Kubernetes.
- Système de plug-in repensé : introduit une architecture plus extensible, notamment des plug-ins WebAssembly facultatifs pour améliorer l’isolation et la flexibilité.
- Amélioration du suivi des ressources : tire parti des mécanismes d’état Kubernetes plus récents, tels que kstatus, pour fournir des rapports d’état de déploiement plus précis.
- Modernisation interne : Supprime la dette technique et constitue la base des améliorations futures de l’innovation et des performances.
Important encore, Helm 4 maintient la compatibilité avec les graphiques Helm v3 existants, ce qui permet aux organisations d’adopter Helm 4 progressivement sans nécessiter de modifications immédiates des graphiques ou des artefacts de déploiement.
Pertinence pour les éditeurs AOSM
L’équipe AOSM prévoit de prendre en charge Helm 4 à deux étapes clés :
- Tout d’abord, l’équipe AOSM publie une version NFO qui inclut Helm 4.1.4 fonctionnant en mode de compatibilité. Ce mode conserve le comportement helm 3.18, afin que les éditeurs puissent adopter Helm 4 sans modifier les graphiques ou artefacts existants.
- Vous pouvez tester cette version NFO aujourd’hui dans le laboratoire UKSouth.
- Deuxièmement, l’équipe AOSM publie une version NFO qui supprime les personnalisations de compatibilité et active un comportement Helm 4 complet. Les éditeurs peuvent adopter cette version quand ils sont prêts, en comprenant que les modifications de graphique et d’artefact peuvent être requises.
- L’équipe AOSM prévoit cette version NFO pour les tests des éditeurs au 4e trimestre de l’année civile 2026.
Les éditeurs continuent d’avoir une flexibilité lors de la sélection du comportement Helm lors de l’installation du NFO. Par défaut, NFO est « mode de compatibilité », tout en fournissant une option d’installation pour activer le comportement Helm 4 complet. Cette fonctionnalité est étendue au cluster, ce qui signifie que tous les déploiements au sein d’un cluster doivent utiliser le même mode d’exploitation Helm.
Détails du mode de compatibilité
Les paramètres suivants conservent le comportement Helm 3 lors de l’exécution de Helm 4 en « mode de compatibilité » :
- Validation de schéma plus stricte
- Helm 4 introduit une validation plus stricte qui rejette les tranches typées go, telles que []map[string]interface{}, lors de la validation des tableaux JSON. Ce comportement peut entraîner des défaillances lorsque NFO injecte des valeurs imagePullSecrets.
- NFO met à jour la logique d’injection de valeurs pour utiliser []interface{} à la place et audite des chemins de code similaires pour garantir la compatibilité.
- Server-Side Apply (SSA) activé par défaut
- Helm 4 valide les manifestes rendus par rapport au schéma OpenAPI du cluster avant d’appliquer des ressources. Les charts contenant des définitions de champ non valides que Helm 3 tolérait auparavant pourraient ne pas passer la validation.
- Le mode de compatibilité désactive SSA pendant les opérations d’installation et de mise à niveau pour préserver le comportement Helm 3.
- Nouveau modèle d’attente
- Helm 4 utilise par défaut un modèle d’attente axé sur les événements qui nécessite des autorisations d’observation dans Kubernetes. Ce comportement peut échouer sur les clusters Nexus lorsque les autorisations RBAC nécessaires ne sont pas disponibles.
- Le mode de compatibilité fixe le comportement d'attente sur LegacyStrategy, préservant ainsi le comportement d'interrogation de Helm 3.
- Recréer l’élément supprimé
- Helm 4 ne prend plus en charge Upgrade.Recreate. Bien que l’impact du runtime soit faible, les valeurs configurées par le client dans le CRD n’auraient plus d’effet.
- Le mode de compatibilité conserve le champ CRD pour la compatibilité descendante, mais l’ignore lors de l’exécution des opérations Helm 4.
- Validation du métaschéma du schéma
- Helm 4 valide values.schema.json par rapport au métaschema de schéma JSON. Les graphiques contenant des définitions de schéma non conformes sont rejetés avant la validation des valeurs. Ce comportement est connu pour avoir un impact sur certains graphiques d’éditeur.
- Le mode de compatibilité définit SkipSchemaValidation=true pendant les opérations d’installation et de mise à niveau.