Logiciel - Helm - Référence des commandes

helm install	Installation
Helm

Syntaxe

helm install [NAME] [CHART] [flags]

Paramètres

Nom	Description
--atomic	Ce paramètre permet d'indiquer s'il est défini, que le processus d'installation supprime l'installation en cas d'échec. Le drapeau --wait sera défini automatiquement si --atomic est utilisé.
--ca-file string	Ce paramètre permet de vérifier les certificats des serveurs compatibles HTTPS à l'aide de ce bundle CA.
--cert-file string	Ce paramètre permet d'identifier le client HTTPS à l'aide de ce fichier de certificat SSL.
--create-namespace	Ce paramètre permet de créer l'espace de noms de version s'il n'est pas présent.
--dependency-update	Ce paramètre permet d'exécuter la mise à jour des dépendances de helm avant d'installer le chart.
--description string	Ce paramètre permet d'ajouter une description personnalisée.
--devel	Ce paramètre permet d'utiliser également des versions de développement. Équivalent à la version '> 0.0.0-0'. Si --version est défini, alors il est ignoré.
--disable-openapi-validation	Ce paramètre permet d'indiquer s'il est défini, que le processus d'installation ne validera pas les modèles rendus par rapport au schéma OpenAPI de Kubernetes.
--dry-run	Ce paramètre permet de simuler une installation.
-g	Ce paramètre permet de générer le nom (et omettre le paramètre NAME).
--generate-name	Ce paramètre permet de générer le nom (et omettre le paramètre NAME).
-h	Ce paramètre permet d'aider à l'installation.
--help	Ce paramètre permet d'aider à l'installation.
--insecure-skip-tls-verify	Ce paramètre permet d'ignorer les vérifications de certificat TLS pour le téléchargement du chart.
--key-file string	Ce paramètre permet d'identifier le client HTTPS à l'aide de ce fichier de clef SSL.
--keyring string	Ce paramètre permet d'indiquer l'emplacement des clefs publiques utilisées pour la vérification (par défaut "~/.gnupg/pubring.gpg").
--name-template string	Ce paramètre permet d'indiquer le modèle utilisé pour nommer la version.
--no-hooks	Ce paramètre permet d'empêcher les crochets de fonctionner pendant l'installation.
-o format	Ce paramètre permet d'afficher la sortie au format spécifié. Valeurs autorisées : table, JSON, yaml (table par défaut).
--output format	Ce paramètre permet d'afficher la sortie au format spécifié. Valeurs autorisées : table, JSON, yaml (table par défaut).
--password string	Ce paramètre permet d'indiquer le mot de passe du dépôt de chart où trouver le chart demandé.
--post-renderer postrenderer	Ce paramètre permet d'indiquer le chemin vers un exécutable à utiliser pour le post-rendu. S'il existe dans $PATH, le binaire sera utilisé, sinon il essaiera de chercher l'exécutable au chemin donné (exécution par défaut).
--render-subchart-notes	Ce paramètre permet d'indiquer, s'il est défini, de rendre les notes du subchart avec le parent.
--replace	Ce paramètre permet de réutiliser le nom donné, uniquement si ce nom est une version supprimée restant dans l'historique. Ce paramètre est dangereux en production.
--repo string	Ce paramètre permet d'indiquer l'URL du dépôt de chart où trouver le chart demandé.
--set stringArray	Ce paramètre permet de définir des valeurs sur la ligne de commande (peut spécifier plusieurs valeurs ou des valeurs séparées par des virgules : key1=val1,key2=val2).
--set-file stringArray	Ce paramètre permet de définir les valeurs des fichiers respectifs spécifiés via la ligne de commande (peut spécifier plusieurs valeurs ou des valeurs séparées par des virgules : key1=path1,key2=path2).
--set-string stringArray	Ce paramètre permet de définir les valeurs STRING sur la ligne de commande (peut spécifier plusieurs valeurs ou des valeurs séparées par des virgules : key1=val1,key2=val2).
--skip-crds	Ce paramètre permet d'indiquer, s'il est défini, aucun CRD ne sera installé. Par défaut, les CRD sont installés s'ils ne sont pas déjà présents.
--timeout duration	Ce paramètre permet d'indiquer le temps d'attente pour toute opération Kubernetes individuelle (comme les Jobs pour les crochets) (par défaut 5m0s).
--username string	Ce paramètre permet d'indiquer le nom d'utilisateur du dépôt de chart où trouver le chart demandé.
-f strings	Ce paramètre permet d'indiquer des valeurs dans un fichier YAML ou une URL (peut en spécifier plusieurs).
--values strings	Ce paramètre permet d'indiquer des valeurs dans un fichier YAML ou une URL (peut en spécifier plusieurs).
--verify	Ce paramètre permet de vérifier l'emballage avant de l'utiliser.
--version string	Ce paramètre permet d'indiquer la version exacte du chart à utiliser. Si ce n'est pas spécifié, la dernière version est utilisée.
--wait	Ce paramètre permet d'indiquer s'il est défini, d'attendre que tous les pods, PVC, services et le nombre minimum de pods d'un déploiement, d'un StatefulSet ou d'un ReplicaSet soient dans un état prêt avant de marquer la publication comme réussie. Il attendra aussi longtemps que --timeout.
--debug	Ce paramètre permet d'activer la sortie détaillée.
--kube-apiserver string	Ce paramètre permet d'indiquer l'adresse et le port du serveur d'API de Kubernetes.
--kube-as-group stringArray	Ce paramètre permet d'indiquer le groupe à emprunter l'identité de l'opération, ce drapeau peut être répété pour spécifier plusieurs groupes.
--kube-as-user string	Ce paramètre permet d'indiquer le nom d'utilisateur à emprunter pour l'opération.
--kube-context string	Ce paramètre permet d'indiquer le nom du contexte kubeconfig à utiliser.
--kube-token string	Ce paramètre permet d'indiquer un jeton de support utilisé pour l'authentification.
--kubeconfig string	Ce paramètre permet d'indiquer un chemin vers le fichier kubeconfig.
-n string	Ce paramètre permet d'indiquer l'étendue de l'espace de noms pour cette demande.
--namespace string	Ce paramètre permet d'indiquer l'étendue de l'espace de noms pour cette demande.
--registry-config string	Ce paramètre permet d'indiquer le chemin vers le fichier de configuration du registre (par défaut "~/.config/helm/registry.json").
--repository-cache string	Ce paramètre permet d'indiquer le chemin vers le fichier contenant les index de dépôt mis en cache (par défaut "~/.cache/helm/repository").
--repository-config string	Ce paramètre permet d'indiquer le chemin vers le fichier contenant les noms de dépôt et les URL (par défaut "~/.config/helm/repositories.yaml").

Description

Cette commande permet d'installer une archive chart.

Remarques

Le paramètre d'installation doit être une référence chart, un chemin vers un graphique empaqueté, un chemin vers un répertoire de graphique décompressé ou une URL.
Pour remplacer les valeurs dans un chart, utilisez soit le paramètre --values et transmettez un fichier ou utilisez le paramètre --set et passez la configuration à partir de la ligne de commande, pour forcer une valeur de chaîne de caractères, utilisez --set-string. Si une valeur est grande et que vous ne voulez donc pas utiliser ni --values ni --set, utilisez --set-file pour lire la seule grande valeur du fichier :

helm install -f mesvaleurs.yaml monredis ./redis

helm install --set name=prod monredis ./redis

helm install --set-string long_int=1234567890 monredis ./redis

helm install --set-file my_script=dothings.sh monredis ./redis

Vous pouvez spécifier les paramètres --values/-f plusieurs fois. La priorité sera donnée au dernier fichier (le plus à droite) spécifié. Par exemple, si mesvaleurs.yaml et override.yaml contenaient une clef appelée «Test», la valeur définie dans override.yaml prévaudrait :

helm install -f mesvaleurs.yaml -f override.yaml monredis ./redis

Vous pouvez spécifier le paramètre --set plusieurs fois. La priorité sera donnée au dernier ensemble (le plus à droite) spécifié. Par exemple, si les valeurs 'bar' et 'newbar' sont définies pour une clef appelée 'gladir', la valeur 'newbar' prévaudra :

helm install --set gladir=bar --set gladir=newbar myredis ./redis

Pour vérifier les manifestes générés d'une version sans installer le chart, les paramètres --debug et --dry-run peuvent être combinés.
Si --verify est défini, le chart doit avoir un fichier de provenance, et le fichier de provenance doit passer toutes les étapes de vérification.
Il existe cinq façons différentes d'exprimer le chart que vous souhaitez installer : par référence au chart, comme par exemple :

helm install mymaria example/mariadb

par chemin vers un chart de paquet :

helm install mynginx ./nginx-1.2.3.tgz

par chemin vers un répertoire de graphiques décompressé :

helm install mynginx ./nginx

par URL absolue :

helm install mynginx https://example.com/charts/nginx-1.2.3.tgz

Par référence de graphique et URL de dépôt :

helm install --repo https://example.com/charts/ mynginx nginx

Une référence chart est un moyen pratique de référencer un chart dans un dépôt de chart.
Lorsque vous utilisez une référence de chart avec un préfixe de référentiel ('example/mariadb'), le Helm recherchera dans la configuration locale un dépôt de graphiques nommé 'example', puis recherchera un graphique dans ce référentiel dont le nom est 'mariadb'. Il installera la dernière version stable de chart jusqu'à ce que vous spécifiez le paramètre --devel pour inclure également la version de développement (versions alpha, bêta et candidate), ou fournissez un numéro de version avec le paramètre --version.
Pour voir la liste des dépôts de chart, utilisez la commande «helm repo list». Pour rechercher des graphiques dans un dépôt, utilisez la commande «helm search».

Dernière mise à jour : Mardi, le 5 Janvier 2021

Section courante

A propos

Section administrative du site

helm install

Syntaxe

Paramètres

Description

Remarques