Chapter 4. Managing IDE extensions

Procedure

1. Download or fork and clone the plugin registry repository.

2. For each extension that you need to add or remove, edit the openvsx-sync.json file:

   • If the extension is published on open-vsx.org, you can add its extension id in the format <published_by>.<unique_identifier>. You can find the id details on the extension’s listing page on open-vsx.org.

         {
             "id": "<published_by>.<unique_identifier>"
         }

     Copy to Clipboard Toggle word wrap
     Tip

     The latest extension version on open-vsx.org is the default. Alternatively, you can add "version": "<extension_version>" on a new line to specify a version.

   • If the extension is only available from Microsoft Visual Studio Marketplace, but not Open VSX, you can ask the extension publisher to also publish it on open-vsx.org according to these instructions, potentially using this GitHub action.

     Tip
     • If the extension publisher is unavailable or unwilling to publish the extension to open-vsx.org, and if there is no Open VSX equivalent of the extension, consider reporting an issue to the Open VSX team.

     • If you have a closed-source extension or an extension developed only for internal use in your company, you can add the extension directly from a .vsix file by using a URL accessible to your custom plugin registry container:

           {
               "id": "<published_by>.<unique_identifier>",
               "download": "<url_to_download_vsix_file>",
               "version": "<extension_version>"
           }

       Copy to Clipboard Toggle word wrap
     Warning

     Please read the Terms of Use for the Microsoft Visual Studio Marketplace before using its resources.

   • You can remove the extension by deleting it from the openvsx-sync.json file.

3. Build the plugin registry container image and publish it to a container registry like quay.io:

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

      Copy to Clipboard Toggle word wrap

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

      Copy to Clipboard Toggle word wrap

4. Edit the CheCluster custom resource in your organization’s cluster to point to the image (for example, on quay.io) and then save the changes:

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

   Copy to Clipboard Toggle word wrap
5. Check that the plugin-registry pod has restarted and is running.
6. Restart the workspace and check the available extensions in the Extensions view of the workspace IDE.