2.5. Extension du CLI OpenShift avec des plugins

1. Créez un fichier appelé oc-foo.

   Lorsque vous nommez votre fichier plugin, gardez à l’esprit ce qui suit:

   • Le fichier doit commencer par oc- ou kubectl- pour être reconnu comme un plugin.
   • Le nom du fichier détermine la commande qui invoque le plugin. À titre d’exemple, un plugin avec le nom de fichier oc-foo-bar peut être invoqué par une commande de oc foo bar. Il est également possible d’utiliser des accents si vous souhaitez que la commande contienne des tirets. À titre d’exemple, un plugin avec le nom de fichier oc-foo_bar peut être invoqué par une commande d’oc foo-bar.

2. Ajoutez le contenu suivant au fichier.

   #!/bin/bash
   
   # optional argument handling
   if [[ "$1" == "version" ]]
   then
       echo "1.0.0"
       exit 0
   fi
   
   # optional argument handling
   if [[ "$1" == "config" ]]
   then
       echo $KUBECONFIG
       exit 0
   fi
   
   echo "I am a plugin named kubectl-foo"

   Copy to Clipboard Toggle word wrap

Procédure

1. Au besoin, mettre à jour le fichier plugin pour être exécutable.

   $ chmod +x <plugin_file>

   Copy to Clipboard Toggle word wrap

2. Déposez le fichier n’importe où dans votre PATH, comme /usr/local/bin/.

   $ sudo mv <plugin_file> /usr/local/bin/.

   Copy to Clipboard Toggle word wrap

3. Exécutez la liste des plugins oc pour vous assurer que le plugin est listé.

   $ oc plugin list

   Copy to Clipboard Toggle word wrap

   Exemple de sortie

   The following compatible plugins are available:
   
   /usr/local/bin/<plugin_file>

   Copy to Clipboard Toggle word wrap

   Dans le cas où votre plugin n’est pas listé ici, vérifiez que le fichier commence par oc- ou kubectl-, qu’il est exécutable et qu’il est sur votre PATH.

4. Invoquez la nouvelle commande ou option introduite par le plugin.

   Ainsi, si vous avez construit et installé le plugin kubectl-ns à partir du référentiel du plugin Sample, vous pouvez utiliser la commande suivante pour afficher l’espace de noms actuel.

   $ oc ns

   Copy to Clipboard Toggle word wrap

   A noter que la commande d’invoquer le plugin dépend du nom du fichier du plugin. À titre d’exemple, un plugin avec le nom de fichier d’oc-foo-bar est invoqué par la commande oc foo bar.