Configuring editors download URLs

This procedure describes how to configure download URLs for editors. This feature is valuable in air-gapped environments where editors cannot be retrieved from the public internet. Currently, this option is intended only for JetBrains editors and should not be used for other editor types.

Prerequisites

  • You have an active orch-cli session with administrative permissions to the Kubernetes cluster. For more information, see Overview of kubectl.

  • jq. See Downloading jq.

Procedure

  1. An editor ID has the following format: publisher/name/version. Find out the IDs of the available editors:

    kubectl exec deploy/che-dashboard -n eclipse-che  \
    -- curl -s http://localhost:8080/dashboard/api/editors | jq -r '[.[] | "\(.metadata.attributes.publisher)/\(.metadata.name)/\(.metadata.attributes.version)"]'

  2. Configure the download URLs for editors:

    kubectl patch checluster/eclipse-che \
  --namespace eclipse-che \
  --type='merge' \
  -p '{
    "spec": {
      "devEnvironments": {
        "editorsDownloadUrls": [
          { "editor": "publisher1/editor-name1/version1", "url": "https://example.com/editor1.tar.gz" },
          { "editor": "publisher2/editor-name2/version2", "url": "https://example.com/editor2.tar.gz" }
        ]
      }
    }
  }'