Section courante

A propos

Section administrative du site

kubectl annotate

Annotations
Kubernetes

Syntaxe

kubectl annotate (-f FILENAME | TYPE NAME | TYPE/NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags]

Paramètres

Nom Description
all Ce paramètre permet de sélectionner toutes les ressources, y compris celles non initialisées, dans l'espace de noms des types de ressources spécifiés.
allow-missing-template-keys Ce paramètre permet d'indiquer si true, qu'il faut ignorer les erreurs dans les gabarits lorsqu'un champ ou une clef de cartographie est manquant dans le gabarit. S'applique uniquement aux formats de sortie golang et jsonpath.
dry-run Ce paramètre permet d'indiquer le mode d'exécution «none», «server» ou «client». En cas de stratégie client, n'affiche que l'objet étant envoyé, sans l'envoyer. En cas de stratégie serveur, soumettre la demande côté serveur sans conserver la ressource.
field-manager Ce paramètre permet d'indiquer le nom du responsable utilisé pour suivre la propriété du champ.
field-selector Ce paramètre permet d'indiquer le sélecteur (requête de champ) sur lequel filtrer, prend en charge '=', '==' et '!='. (Par exemple --field-selector key1=value1,key2=value2). Le serveur ne prend en charge qu'un nombre limité de requêtes de champ par type.
filename Ce paramètre permet d'indiquer le nom de fichier, répertoire ou URL des fichiers identifiant la ressource pour mettre à jour l'annotation.
kustomize Ce paramètre permet de traiter le répertoire kustomization. Ce drapeau ne peut pas être utilisé avec -f ou -R.
list Ce paramètre permet d'indiquer, si true, d'afficher les annotations pour une ressource donnée.
local Ce paramètre permet d'indiquer, si true, l'annotation ne contactera pas l'api-server mais s'exécutera localement.
output Ce paramètre permet d'indiquer que le format de sortie. Un des : json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-as-json|jsonpath-file.
overwrite Ce paramètre permet d'indiquer, si la valeur est true, d'autoriser le remplacement des annotations, sinon de rejeter les mises à jour d'annotations écrasant les annotations existantes.
record Ce paramètre permet d'enregistrer la commande kubectl actuelle dans l'annotation de la ressource. S'il est défini sur false, n'enregistrez pas la commande. Si la valeur est true, alors enregistre la commande. S'il n'est pas défini, la valeur par défaut de l'annotation est mise à jour uniquement s'il en existe déjà une.
recursive Ce paramètre permet de traiter récursivement le répertoire utilisé dans -f, --filename. Utile lorsque vous souhaitez gérer des manifestes associés organisés dans le même répertoire.
resource-version Ce paramètre permet d'indiquer, si non-empty, la mise à jour de l'annotation ne réussira que s'il s'agit de la version de ressource actuelle de l'objet. Uniquement valable lors de la spécification d'une seule ressource.
selector Ce paramètre permet d'indiquer un sélecteur (requête d'étiquette) sur lequel filtrer, sans inclure les non initialisés, prend en charge '=', '==' et '!='. (Par exemple -l key1=value1,key2=value2).
template Ce paramètre permet d'indiquer une chaîne de gabarit ou un chemin d'accès au fichier de gabarit à utiliser lorsque -o=go-template, -o=go-template-file. Le format du gabarit est les gabarit golang.

Description

Cette commande permet d'ajouter ou de mettre à jour les annotations d'une ou plusieurs ressources.

Remarques

Exemples

L'exemple suivant permet de mettre à jour le pod 'gladir' avec l'annotation 'description' et la valeur 'mon frontale'. Si la même annotation est définie plusieurs fois, seule la dernière valeur sera appliquée :

kubectl annotate pods gladir description='mon frontale'

L'exemple suivant permet de mettre à jour un pod identifié par son type et son nom dans "pod.json" :

kubectl annotate -f pod.json description='mon frontale'

L'exemple suivant permet de mettre à jour le pod 'gladir' avec l'annotation 'description' et la valeur 'my frontend running nginx', en écrasant toute valeur existante :

kubectl annotate --overwrite pods gladir description='my frontend running nginx'

L'exemple suivant permet de mettre à jour tous les pods dans l'espace de noms :

kubectl annotate pods --all description='my frontend running nginx'

L'exemple suivant permet de mettre à jour le pod 'gladir' uniquement si la ressource est inchangée depuis la version 1 :

kubectl annotate pods gladir description='my frontend running nginx' --resource-version=1

L'exemple suivant permet de mettre à jour le pod 'gladir' en supprimant une annotation nommée 'description' si elle existe. Ne nécessite pas l'indicateur --overwrite :

kubectl annotate pods gladir description-


Dernière mise à jour : Lundi, le 1 Février 2021