Use an alternative extension registry

Use an alternative Open VSX registry instance instead of the managed registry deployed by the Operator. Select the public open-vsx.org registry for internet-connected environments, or a standalone on-premises instance for full control over available extensions.

Disabling the managed registry removes its extension storage and database PVCs. Back up any data you need before disabling the managed registry.

If the managed Open VSX registry 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.

  • The deprecated embedded Open VSX registry instance that runs in the plugin-registry pod.

    The embedded Open VSX registry instance is deprecated and is planned for removal in a future release.

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> is the URL of the public or standalone Open VSX registry instance. For example: https://open-vsx.org. The URL must be accessible from within your organization’s cluster and not blocked by a proxy.

    A non-empty openVSXURL value takes effect on its own. You do not have to disable the managed Open VSX registry to use a public or standalone instance. The managed registry continues to run and consume cluster resources until you disable it. To remove it, see Disable the managed Open VSX registry.

    To select the deprecated embedded Open VSX registry instance, set openVSXURL: '' and disable the Open VSX operand by setting spec.components.openVSXRegistry.enable to false. The embedded registry requires both settings, because Che does not deploy the plugin-registry pod while the managed Open VSX registry is enabled. You can customize the list of included extensions. See How the Open VSX extension registry works.

    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
  • Open a workspace and verify that extensions are available from the selected registry instance in the Extensions view.

  • If you selected the embedded registry, confirm that the plugin-registry pod is running:

    kubectl get pods --namespace eclipse-che -l app.kubernetes.io/component=plugin-registry