2.4. プラグインによる OpenShift CLI の拡張

1. oc-foo というファイルを作成します。

   プラグインファイルの名前を付ける際には、以下の点に留意してください。

   • プログインとして認識されるように、ファイルの名前は oc- または kubectl- で開始する必要があります。
   • ファイル名は、プラグインを起動するコマンドを判別するものとなります。たとえば、ファイル名が oc-foo-bar のプラグインは、oc foo bar のコマンドで起動します。また、コマンドにダッシュを含める必要がある場合には、アンダースコアを使用することもできます。たとえば、ファイル名が oc-foo_bar のプラグインは、oc foo-bar のコマンドで起動します。

2. 以下の内容をファイルに追加します。

   #!/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

手順

1. 必要に応じて、プラグインファイルを更新して実行可能にします。

   $ chmod +x <plugin_file>

   Copy to Clipboard Toggle word wrap

2. ファイルを PATH の任意の場所に置きます (例: /usr/local/bin/)。

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

   Copy to Clipboard Toggle word wrap

3. oc plugin list を実行し、プラグインが一覧表示されることを確認します。

   $ oc plugin list

   Copy to Clipboard Toggle word wrap

   出力例

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

   Copy to Clipboard Toggle word wrap

   プラグインがここに一覧表示されていない場合、ファイルが oc- または kubectl- で開始されるものであり、実行可能な状態で PATH 上にあることを確認します。

4. プラグインによって導入される新規コマンドまたはオプションを起動します。

   たとえば、kubectl-ns プラグインを サンプルのプラグインリポジトリー からビルドし、インストールしている場合、以下のコマンドを使用して現在の namespace を表示できます。

   $ oc ns

   Copy to Clipboard Toggle word wrap

   プラグインを呼び出すコマンドは、プラグインのファイル名に依存することに注意してください。たとえば、ファイル名が oc-foo-bar のプラグインは oc foo bar コマンドによって起動します。