第4章 IDE 拡張機能の管理

手順

1. 選択した各拡張機能の発行元と名前を取得します。

   1. Open VSX レジストリー Web サイト で拡張機能を見つけ、拡張機能のリストページの URL をコピーします。

   2. コピーした URL から <publisher> と <extension> の名前を抽出します。

      https://www.open-vsx.org/extension/<publisher>/<extension>

      ヒント

      拡張機能が Microsoft Visual Studio Marketplace からのみ入手可能で、Open VSX からは入手できない場合は、拡張機能の発行者に、これらの 手順 に従って open-vsx.org にも公開するように依頼できます。この GitHub アクション を使用する可能性があります。

      拡張機能の発行者がいない場合や、または拡張機能を open-vsx.org に公開してくれない場合、および拡張機能に相当する Open VSX がない場合は、Open VSX チームに 問題を報告する ことを検討してください。

2. プラグインレジストリーリポジトリー をダウンロードするか、フォークしてクローンします。

3. OpenShift Dev Spaces のバージョンに対応するブランチをチェックアウトします。

   git checkout devspaces-$PRODUCT_VERSION-rhel-8

4. 追加または削除する必要がある拡張機能ごと に、openvsx-sync.json ファイル を編集します。

   • 拡張機能を追加するには、発行元と拡張機能の名前を openvsx-sync.json ファイルに追加します。
   • 拡張機能を削除するには、openvsx-sync.json ファイルから発行元と拡張機能の名前を削除します。

   • 次の JSON 構文を使用します。

         {
             "id": "<publisher>.<extension>"
         }

     ヒント
     • open-vsx.org の最新の拡張バージョンがデフォルトです。または、新しい行に "version": "<extension_version>" を追加して、バージョンを指定することもできます。

     • クローズドソースの拡張機能または社内の内部使用のみを目的として開発された拡張機能がある場合は、カスタムプラグインレジストリーコンテナーにアクセスできる URL を使用して、.vsix ファイルから直接、拡張機能を追加できます。

           {
               "id": "<publisher>.<extension>",
               "download": "<url_to_download_vsix_file>",
               "version": "<extension_version>"
           }

     • リソースを使用する前に、Microsoft Visual Studio Marketplace の 利用規約 をお読みください。

5. プラグインレジストリーコンテナーイメージをビルドし、quay.io などのコンテナーレジストリーに公開します。

   1. $ ./build.sh -o <username> -r quay.io -t custom

   2. $ podman push quay.io/<username/plugin_registry:custom>

6. イメージ (quay.io など) を指すように、社内のクラスター内の CheCluster カスタムリソースを編集し、変更を保存します。

   spec:
     components:
       pluginRegistry:
         deployment:
           containers:
             - image: quay.io/<username/plugin_registry:custom>
         openVSXURL: ''

検証

1. plugin-registry Pod が再始動して実行中であることを確認します。
2. ワークスペースを再起動し、ワークスペース IDE の 拡張機能 ビューで使用可能な拡張機能を確認します。