Configure the Open VSX registry URL

Configure Che to use an alternative Open VSX registry instance instead of the default embedded registry. Switch to the public open-vsx.org registry for internet-connected environments, or to a standalone on-premises instance for full control over available extensions.

The default is the embedded instance of the Open VSX registry.

If the default Open VSX registry instance does not meet your requirements, you can select one of the following instances:

  • The Open VSX registry instance at https://open-vsx.org that requires access to the internet.

  • A standalone Open VSX registry instance that is deployed on a network accessible from Che workspace pods.

Prerequisites

  • You have administrator access to the cluster where Che is deployed.

  • You have an active kubectl session with administrative permissions. See Overview of kubectl.

Procedure

  1. Edit the CheCluster custom resource to update the openVSXURL value:

    spec:
  components:
    pluginRegistry:
      openVSXURL: "<url_of_an_open_vsx_registry_instance>"

    where:

    <url_of_an_open_vsx_registry_instance>

    The URL of the Open VSX registry instance. For example: openVSXURL: "https://open-vsx.org".

    • To select the embedded Open VSX registry instance in the plugin-registry pod, use openVSXURL: ''. You can customize the list of included extensions. See Extensions for Microsoft Visual Studio Code - Open Source.

    • You can also point openVSXURL at the URL of a standalone Open VSX registry instance. The URL must be accessible from within your organization’s cluster and not blocked by a proxy.

    To ensure the stability and performance of the community-supported Open VSX Registry, API usage is organized into defined tiers. The Eclipse Foundation implements these limits to protect infrastructure from high-frequency automated traffic and to provide consistent service quality for all users. For more information, see Rate Limits and Usage Tiers and the open-vsx.org wiki.

    Using https://open-vsx.org is not recommended in an air-gapped environment, isolated from the internet. To reduce the risk of malware infections and unauthorized access to your code, use the embedded or self-hosted Open VSX registry with a curated set of extensions.

    Due to the dedicated Microsoft Terms of Use, Visual Studio Code Marketplace is not supported by Eclipse Che.
Verification

  • Confirm that the plugin-registry pod has restarted and is running.

  • Open a workspace and verify that extensions are available from the selected registry instance in the Extensions view.

Additional resources