2.5. Extension de la CLI d'OpenShift avec des plugins

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

   Lorsque vous nommez votre fichier de plugin, gardez à l'esprit les points suivants :

   • 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. Par exemple, un plugin dont le nom de fichier est oc-foo-bar peut être appelé par la commande oc foo bar. Vous pouvez également utiliser des traits de soulignement si vous souhaitez que la commande contienne des tirets. Par exemple, un plugin dont le nom de fichier est oc-foo_bar peut être appelé par la commande 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"

Procédure

1. Si nécessaire, mettez à jour le fichier du plugin pour qu'il soit exécutable.

   chmod x <plugin_file>

2. Placez le fichier n'importe où dans votre PATH, par exemple /usr/local/bin/.

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

3. Exécutez oc plugin list pour vous assurer que le plugin est répertorié.

   $ oc plugin list

   Exemple de sortie

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

   Si votre plugin ne figure pas dans cette liste, vérifiez que le fichier commence par oc- ou kubectl-, qu'il est exécutable et qu'il se trouve sur votre site PATH.

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

   Par exemple, si vous avez créé et installé le plugin kubectl-ns à partir du dépôt de plugins Sample, vous pouvez utiliser la commande suivante pour afficher l'espace de noms actuel.

   $ oc ns

   Notez que la commande permettant d'invoquer le plugin dépend du nom du fichier du plugin. Par exemple, un plugin dont le nom de fichier est oc-foo-bar est appelé par la commande oc foo bar.