docs/che-7/contributor-guide/publishing-che-theia-plug-ins/index.html - gerrit/www.eclipse.org/che - Git at Google

 <!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <title>Publishing Che-Theia plug-ins :: Eclipse Che Documentation</title>
     <link rel="canonical" href="https://www.eclipse.org/che/docs/che-7/contributor-guide/publishing-che-theia-plug-ins/">
     <meta name="keywords" content="contributor-guide, publishing-che-theia-plug-ins">
     <meta name="generator" content="Antora 2.3.4">
     <link rel="stylesheet" href="../../../_/css/site.css">
 <link rel="stylesheet" href="../../../_/css/extra.css">
 <link rel="stylesheet" href="../../../_/font-awesome-4.7.0/css/font-awesome.min.css">
 <link rel="icon" href="../../../favicon.ico" type="image/x-icon">
     <script async src="https://www.googletagmanager.com/gtag/js?id=UA-37306001-2"></script>
     <script>function gtag(){dataLayer.push(arguments)};window.dataLayer=window.dataLayer||[];gtag('js',new Date());gtag('config','UA-37306001-2')</script>
     <script>var uiRootPath = '../../../_'</script>
   </head>
   <body class="article">
 <header class="header" role="banner">
   <nav class="navbar">
     <div class="navbar-brand">
       <div class="navbar-item">
         <button class="navbar-burger" data-target="topbar-nav">
           <span></span>
           <span></span>
           <span></span>
         </button>
         <img src="../../../_/img/icon-eclipse-che.svg" class="navbar-logo" alt="Eclipse Che logo">
         <a href="https://www.eclipse.org/che/docs">Eclipse Che Documentation</a>
       </div>
     </div>
     <div id="topbar-nav" class="navbar-menu">
       <div class="navbar-end">
         <div class="navbar-item hide-for-print">
           <script async src="https://cse.google.com/cse.js?cx=002898025167115630151:gnr5edrg2eo"></script>
           <div class="gcse-searchbox" enableAutoComplete="true"></div>
         </div>
         <a class="navbar-item" href="https://www.eclipse.org/che/docs">Home</a>
         <a class="navbar-item" href="https://che.eclipse.org/">Blog</a>
         <a class="navbar-item" href="https://github.com/eclipse/che">Source Code</a>
       </div>
     </div>
   </nav>
   <div class="gcse-searchresults"></div>
 </header><div class="body">
 <div class="nav-container" data-component="che-7" data-version="master">
   <aside class="nav">
     <div class="panels">
 <div class="nav-panel-menu is-active" data-panel="menu">
   <nav class="nav-menu">
     <h3 class="title"><a href="../../overview/introduction-to-eclipse-che/">Documentation</a></h3>
 <ul class="nav-list">
   <li class="nav-item" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../overview/introduction-to-eclipse-che/">Introduction to Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../overview/che-architecture/">Che architecture</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../hosted-che/hosted-che/">Eclipse Che hosted by Red Hat</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="0">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">End-user Guide</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../end-user-guide/navigating-che/">Navigating Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/navigating-che-using-the-dashboard/">Navigating Che: dashboard</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/importing-certificates-to-browsers/">Importing certificates to browsers</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/accessing-che-from-openshift-developer-perspective/">Navigating Che from OpenShift Developer Perspective</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../end-user-guide/che-theia-ide-basics/">Che-Theia IDE basics</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/defining-custom-commands-for-che-theia/">Defining custom commands for Che-Theia</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/version-control/">Version Control</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/che-theia-troubleshooting/">Che-Theia Troubleshooting</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/differences-in-how-che-theia-webview-works-on-a-single-host-mode-comparing-to-a-multi-host-mode/">Differences in how Che-Theia Webview works on a single-host mode comparing to a multi-host mode</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../end-user-guide/workspaces-overview/">Using developer workspaces</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/creating-a-workspace-from-code-sample/">Creating a workspace from code sample</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/creating-a-workspace-from-remote-devfile/">Creating a workspace from a remote devfile using the dashboard</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/creating-a-workspace-from-local-devfile-using-chectl/">Creating a workspace from local devfile using chectl</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/creating-a-workspace-by-importing-the-source-code-of-a-project/">Creating a workspace by importing the source code of a project</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/configuring-a-workspace-with-dashboard/">Configuring a workspace</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/running-a-workspace-with-dashboard/">Running a workspace</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/importing-kubernetes-applications-into-a-workspace/">Importing Kubernetes applications into a workspace</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/remotely-accessing-workspaces/">Remotely accessing workspaces</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/mounting-a-secret-as-a-file-or-an-environment-variable-into-a-workspace-container/">Mounting a secret as a file or an environment variable into a workspace container</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/authenticating-on-scm-server-with-a-personal-access-token/">Authenticating on SCM Server with a personal access token</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../end-user-guide/authoring-devfiles/">Authoring devfiles</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/authoring-devfiles-version-1/">Authoring devfiles version 1</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/authoring-devfiles-version-2/">Authoring devfiles version 2</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../end-user-guide/customizing-developer-environments/">Customizing developer environments</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/what-is-a-che-theia-plug-in/">What is a Che-Theia plug-in</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/adding-a-vs-code-extension-to-a-workspace/">Adding a VS Code extension to a workspace</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/adding-a-vs-code-extension-to-the-che-plugin-registry/">Adding a VS Code extension to the Che plug-ins registry</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/publishing-metadata-for-a-vs-code-extension/">Publishing a VS Code extension</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/testing-a-visual-studio-code-extension-in-che/">Testing a VS Code extension in Che</a>
   </li>
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../end-user-guide/using-alternative-ides-in-che/">Using alternative IDEs in Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../end-user-guide/support-for-jetbrains-ides/">JetBrains IDEs</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../../end-user-guide/using-jetbrains-intellij-idea-community-edition/">Using IntelliJ Idea Community Edition</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../../end-user-guide/using-jetbrains-intellij-idea-ultimate-edition/">Using IntelliJ Idea Ultimate Edition</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../../end-user-guide/configuring-an-existing-workspace-to-use-intellij-idea/">Configuring an existing workspace to use IntelliJ IDEA</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../../end-user-guide/using-jetbrains-webstorm/">Using WebStorm</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="../../end-user-guide/provisioning-jetbrains-activation-code-for-offline-use/">Provisioning activation code for offline use</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../end-user-guide/support-for-theia-based-ides/">Theia-based IDEs</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/adding-tools-to-che-after-creating-a-workspace/">Adding tools to Che after creating a workspace</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/using-private-container-registries/">Using private container registries</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../end-user-guide/using-artifact-repositories-in-a-restricted-environment/">Using artifact repositories in a restricted environment</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/using-maven-artifact-repositories/">Using Maven artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/using-gradle-artifact-repositories/">Using Gradle artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/using-python-artifact-repositories/">Using Python artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/using-go-artifact-repositories/">Using Go artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/using-nuget-artifact-repositories/">Using NuGet artifact repositories</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/using-npm-artifact-repositories/">Using npm artifact repositories</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../end-user-guide/troubleshooting-che/">Troubleshooting Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/viewing-che-workspaces-logs/">Viewing Che workspaces logs</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/investigating-failures-at-a-workspace-start-using-the-verbose-mode/">Troubleshooting workspace start failures</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/troubleshooting-slow-workspaces/">Troubleshooting slow workspaces</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../end-user-guide/troubleshooting-network-problems/">Troubleshooting network problems</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="0">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Installation Guide</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../installation-guide/supported-platforms/">Supported platforms</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../installation-guide/configuring-the-che-installation/">Configuring the Che installation</a>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../installation-guide/installing-che/">Installing Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../installation-guide/installing-che-in-cloud/">Installing Che in cloud</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-openshift-4-using-operatorhub/">Installing Che on OpenShift 4 using OperatorHub</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-openshift-4-using-cli/">Installing Che on OpenShift 4 using CLI</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-openshift-3-using-the-operator/">Installing Che on OpenShift 3</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-kubespray/">Installing Che on Kubespray</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-aws/">Installing Che on AWS</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-google-cloud-platform/">Installing Che on Google Cloud</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-microsoft-azure/">Installing Che on Microsoft Azure</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../installation-guide/installing-che-locally/">Installing Che locally</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-codeready-containers/">Installing Che on CodeReady Containers</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-docker-desktop/">Installing Che on Docker Desktop</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-minikube/">Installing Che on Minikube</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-minishift/">Installing Che on Minishift</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../../installation-guide/installing-che-on-kind/">Installing Che on Kind</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/using-the-chectl-management-tool/">Using the chectl management tool</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/installing-che-in-a-restricted-environment/">Installing Che in restricted environment</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../installation-guide/advanced-configuration/">Advanced configuration</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/advanced-configuration-options-for-the-che-server-component/">Advanced configuration options for Che server</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-namespace-strategies/">Configuring workspace target namespace</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-storage-strategies/">Configuring storage strategies</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-storage-types/">Configuring storage types</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-the-number-of-workspaces-that-a-user-can-run/">Configuring the number of workspaces that a user can run</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-the-number-of-workspaces-that-a-user-can-create/">Configuring the number of workspaces that a user can create</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-workspace-exposure-strategies/">Configuring workspace exposure strategies</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-workspaces-nodeselector/">Configuring workspaces nodeSelector</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-che-hostname/">Configuring Che hostname</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-ingresses/">Configuring Kubernetes Ingress</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/configuring-routes/">Configuring OpenShift Route</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/">Deploying Che with support for Git repositories with self-signed certificates</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/installing-che-using-storage-classes/">Installing Che using storage classes</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/importing-untrusted-tls-certificates/">Importing untrusted TLS certificates to Che</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/switching-between-external-and-internal-communication/">Switching between external and internal ways in inter-component communication</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/setting-up-the-keycloak-che-username-readonly-theme-for-the-eclipse-che-login-page/">Setting up the Keycloak che-username-readonly theme for the Eclipse Che login page</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/mounting-a-secret-as-a-file-or-an-environment-variable-into-a-container/">Mounting a Secret or a ConfigMap as a file or an environment variable into a Eclipse&#160;Che container</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/enabling-dev-workspace-engine/">Enabling Dev Workspace engine</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../installation-guide/upgrading-che/">Upgrading Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/upgrading-che-using-operatorhub/">Upgrading Che using OperatorHub</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/upgrading-che-using-the-cli-management-tool/">Upgrading Che using the CLI management tool</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/upgrading-che-using-the-cli-management-tool-in-restricted-environment/">Upgrading Che in restricted environment</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/upgrading-che-namespace-strategies-other-than-per-user/">Updating Che namespace strategies other than 'per user'</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../installation-guide/uninstalling-che/">Uninstalling Che</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/uninstalling-che-after-operatorhub-installation-using-openshift-web-console/">Using the OpenShift web console</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/uninstalling-che-after-operatorhub-installation-using-openshift-cli/">Using OpenShift CLI</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../installation-guide/uninstalling-che-after-chectl-installation/">Using chectl</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="0">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Administration Guide</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../administration-guide/che-architecture-overview/">Che architecture</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/che-workspace-controller/">Che workspace controller</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/che-workspaces-architecture/">Che workspaces architecture</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../administration-guide/calculating-che-resource-requirements/">Calculating Che resource requirements</a>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../administration-guide/customizing-the-registries/">Customizing the registries</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/building-custom-registry-images/">Building custom registry images</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/running-custom-registries/">Running custom registries</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../administration-guide/retrieving-che-logs/">Retrieving Che logs</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/configuring-server-logging/">Configuring server logging</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/viewing-kubernetes-events/">Accessing Kubernetes events on OpenShift</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/viewing-operator-events/">Viewing the Operator events on OpenShift</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/viewing-che-server-logs/">Viewing Che server logs</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/viewing-external-service-logs/">Viewing external service logs</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/viewing-plug-in-broker-logs/">Viewing Plug-in broker logs</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/collecting-logs-using-chectl/">Collecting logs using chectl</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../administration-guide/monitoring-che/">Monitoring Che</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../administration-guide/tracing-che/">Tracing Che</a>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../administration-guide/backup-and-disaster-recovery/">Backup and disaster recovery</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/external-database-setup/">External database setup</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/persistent-volumes-backups/">Persistent Volumes backups</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../administration-guide/caching-images-for-faster-workspace-start/">Caching images for faster workspace start</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/defining-the-list-of-images-to-pull/">Defining the list of images</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/defining-the-memory-parameters-for-the-image-puller/">Defining the memory settings</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/installing-image-puller-using-che-operator/">Installing using the Che Operator</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/installing-image-puller-on-kubernetes-using-the-image-puller-operator/">Installing using the Kubernetes Image Puller Operator</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/installing-image-puller-on-openshift-using-operatorhub/">Installing on OpenShift 4</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/installing-image-puller-on-openshift-using-openshift-templates/">Installing on OpenShift 3</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/installing-image-puller-on-kubernetes-using-helm/">Installing using Helm</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../administration-guide/managing-identities-and-authorizations/">Managing identities and authorizations</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/authenticating-users/">Authenticating users</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/authorizing-users/">Authorizing users</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/configuring-authorization/">Configuring authorization</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/configuring-openshift-oauth/">Configuring OpenShift OAuth</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../administration-guide/removing-user-data/">Removing user data</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="0">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Contributor Guide</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../branding-che-theia/">Branding Che-Theia</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../developing-che-theia-plug-ins/">Developing Che-Theia plug-ins</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../testing-che-theia-plug-ins/">Testing Che-Theia plug-ins</a>
   </li>
   <li class="nav-item is-current-page" data-depth="1">
     <a class="nav-link" href="./">Publishing Che-Theia plug-ins</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../adding-support-for-a-new-language/">Adding support for a new language</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../adding-support-for-a-new-debugger/">Adding support for a new debugger</a>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../che-extensibility-reference/">Che extensibility reference</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../che-extension-points/">Che extension points</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../che-theia-plug-in-api/">Che-Theia plug-in API</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../debug-adapter-protocol/">Debug Adapter Protocol</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../language-server-protocol/">Language Server Protocol</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="0">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Extensions</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../extensions/eclipse-che4z/">Eclipse Che4z</a>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../extensions/openshift-connector-overview/">OpenShift Connector</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../extensions/features-of-openshift-connector/">Features of OpenShift Connector</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../extensions/installing-openshift-connector-in-che/">Installing OpenShift Connector in Eclipse Che</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../extensions/authenticating-with-openshift-connector-from-che/">Authenticating with OpenShift Connector from Eclipse Che</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../extensions/creating-components-with-openshift-connector-in-che/">Creating Components with OpenShift Connector in Eclipse Che</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../extensions/connecting-source-code-from-github-to-a-openshift-component-using-openshift-connector/">Connecting source code from GitHub to a OpenShift Component</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../../extensions/telemetry/">Telemetry</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../extensions/creating-a-telemetry-plugin/">Creating A Telemetry Plugin</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../../extensions/the-woopra-telemetry-plugin/">The Woopra Telemetry Plugin</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../extensions/java-lombok/">Java Lombok</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../../glossary/che-glossary/">Che glossary</a>
   </li>
 </ul>
   </li>
 </ul>
   </nav>
 </div>
 <div class="nav-panel-explore" data-panel="explore">
   <div class="context">
     <span class="title">Documentation</span>
     <span class="version">master</span>
   </div>
   <ul class="components">
     <li class="component is-current">
       <a class="title" href="../../overview/introduction-to-eclipse-che/">Documentation</a>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../../overview/introduction-to-eclipse-che/">master</a>
         </li>
       </ul>
     </li>
   </ul>
 </div>
     </div>
   </aside>
 </div>
 <main class="article">
 <div class="toolbar" role="navigation">
 <button class="nav-toggle"></button>
   <a href="../../overview/introduction-to-eclipse-che/" class="home-link"></a>
 <nav class="breadcrumbs" aria-label="breadcrumbs">
   <ul>
     <li><a href="../../overview/introduction-to-eclipse-che/">Documentation</a></li>
     <li>Contributor Guide</li>
     <li><a href="./">Publishing Che-Theia plug-ins</a></li>
   </ul>
 </nav>
   <div class="edit-this-page"><a href="https://github.com/eclipse/che-docs/edit/master/modules/contributor-guide/pages/publishing-che-theia-plug-ins.adoc">Edit this Page</a></div>
   </div>
   <div class="content">
 <aside class="toc sidebar" data-title="Contents" data-levels="2">
   <div class="toc-menu"></div>
 </aside>
 <article class="doc">
 <h1 class="page">Publishing Che-Theia plug-ins</h1>
 <div class="sect1">
 <h2 id="che-theia-plug-in-registries_che"><a class="anchor" href="#che-theia-plug-in-registries_che"></a>Che-Theia plug-in registries</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>A plug-in registry is a simple service that hosts metadata about the enabled plug-ins.</p>
 </div>
 <div class="paragraph">
 <p>To retrieve a full list of plug-ins hosted in a registry, navigate to the <code>&lt;registry-base-uri&gt;/v3/plugins/index.json</code> file.</p>
 </div>
 <div class="paragraph">
 <p>Each plug-in item in the list is represented by a JSON definition.</p>
 </div>
 <div class="listingblock">
 <div class="title">Sample plug-in definition</div>
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-json hljs" data-lang="json">  {
     "description": "This extension provides a live preview, syntax highlighting and snippets for the AsciiDoc format using Asciidoctor flavor.",
     "displayName": "AsciiDoc support",
     "id": "joaompinto/vscode-asciidoctor/latest",
     "links": {
       "self": "/v3/plugins/joaompinto/vscode-asciidoctor/latest/"
     },
     "name": "vscode-asciidoctor",
     "publisher": "joaompinto",
     "type": "VS Code extension",
     "version": "latest"
   }</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>This definition contains a <code>links</code> section that points to the complete plug-in description (<code>meta.yaml</code>).</p>
 </div>
 <div class="listingblock">
 <div class="title">Sample plug-in <code>meta.yaml</code> file</div>
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">publisher: joaompinto
 apiVersion: v2
 version: latest
 type: VS Code extension
 name: vscode-asciidoctor
 displayName: AsciiDoc support
 title: AsciiDoctor Plugin.
 description: This extension provides a live preview, syntax highlighting, and snippets
   for the AsciiDoc format using Asciidoctor flavor.
 icon: https://www.eclipse.org/che/images/logo-eclipseche.svg
 category: Language
 repository: https://github.com/asciidoctor/asciidoctor-vscode
 firstPublicationDate: '2019-09-09'
 spec:
   extensions:
     - https://marketplace.visualstudio.com/_apis/public/gallery/publishers/joaompinto/vsextensions/asciidoctor-vscode/2.7.6/vspackage
 latestUpdateDate: "2019-12-09"</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>For more details about the <code>meta.yaml</code> structure, see <a href="../../end-user-guide/what-is-a-che-theia-plug-in/#che-theia-plug-in-metadata_che" class="page">Che-Theia plug-in metadata</a>.</p>
 </div>
 <div class="sect2">
 <h3 id="custom-plug-in-registries_che"><a class="anchor" href="#custom-plug-in-registries_che"></a>Custom plug-in registries</h3>
 <div class="paragraph">
 <p>For more information about setting up a custom registry, see the description of the <a href="https://github.com/eclipse-che/che-plugin-registry">official registry repository</a>.</p>
 </div>
 <div class="paragraph">
 <p>To use plug-ins from a custom registry, follow one of the following methods:</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
 <p>Specify a link to the plug-in in the configuration of a workspace. See <a href="#adding-a-plug-in-by-configuring-a-workspace_che">Adding a plug-in into a workspace using the workspace configuration</a>.</p>
 </li>
 <li>
 <p>Replace the default official registry with a custom one in your Che instance. To do so, set the <code>PLUGIN_REGISTRY_IMAGE</code> environment variable in your Che configuration. Note that plug-ins from the official registry are not available from the dashboard interface. To include them, add references to your registry from the official registry.</p>
 </li>
 </ul>
 </div>
 <div class="ulist">
 <div class="title">Additional resources</div>
 <ul>
 <li>
 <p><a href="../../end-user-guide/what-is-a-che-theia-plug-in/#che-theia-plug-in-metadata_che" class="page">Che-Theia plug-in metadata</a></p>
 </li>
 </ul>
 </div>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="adding-a-che-theia-plug-in-to-the-che-plug-in-registry_che"><a class="anchor" href="#adding-a-che-theia-plug-in-to-the-che-plug-in-registry_che"></a>Adding a Che-Theia plug-in to the Che plug-in registry</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>To have a Che-Theia plug-in available in the default Che plug-in registry, submit a pull request to the registry GitHub repository.</p>
 </div>
 <div class="ulist">
 <div class="title">Prerequisites</div>
 <ul>
 <li>
 <p>Che-Theia plug-in definition file: <code>meta.yaml</code></p>
 </li>
 </ul>
 </div>
 <div class="ulist">
 <div class="title">Procedure</div>
 <ul>
 <li>
 <p>Submit a pull request to <a href="https://github.com/eclipse/che-plugin-registry">the plug-in registry repository</a> containing the <code>meta.yaml</code> file of the plug-in in the <code>v3/plugins/<em>&lt;plugin-publisher&gt;</em>/<em>&lt;plugin-name&gt;</em>/<em>&lt;plugin-version&gt;</em>/</code> directory.</p>
 <div class="exampleblock">
 <div class="title">Example 1. Location of <code>meta.yaml</code> file for the SonarLint Che-Theia plug-in</div>
 <div class="content">
 <div class="listingblock">
 <div class="content">
 <pre>v3/plugins/sonarsource/sonarlint-vscode/0.0.1/meta.yaml</pre>
 </div>
 </div>
 </div>
 </div>
 </li>
 </ul>
 </div>
 <div class="paragraph">
 <p>After the new Che-Theia plug-ins are added and merged into the repository, the list of available plug-ins in the registry is updated.</p>
 </div>
 <div class="ulist">
 <div class="title">Additional resources</div>
 <ul>
 <li>
 <p><a href="https://github.com/eclipse-che/che-plugin-registry/">che-plugin-registry repository</a></p>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="adding-a-che-theia-plug-in-into-a-workspace_che"><a class="anchor" href="#adding-a-che-theia-plug-in-into-a-workspace_che"></a>Adding a Che-Theia plug-in into a workspace</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>You can add Che-Theia plug-in into the Che-Theia IDE in three ways:</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
 <p>At Theia runtime</p>
 </li>
 <li>
 <p>By configuring a workspace devfile</p>
 </li>
 <li>
 <p>By preparing shareable devfile</p>
 </li>
 </ul>
 </div>
 <div class="sect2">
 <h3 id="adding-a-plug-in-at-runtime_che"><a class="anchor" href="#adding-a-plug-in-at-runtime_che"></a>Adding a plug-in at Theia runtime</h3>
 <div class="paragraph">
 <p>This method adds a plug-in to an already running workspace. The plug-in is not added permanently; it is removed when the workspace stops. This is a good method to test a plug-in without affecting the permanent workspace configuration.</p>
 </div>
 <div class="ulist">
 <div class="title">Procedure</div>
 <ul>
 <li>
 <p>Run the <code>Deploy Plugin by Id</code> command, and specify the ID of the plug-in to add to the workspace. A plug-in ID can be:</p>
 <div class="dlist">
 <dl>
 <dt class="hdlist1">A local directory with plug-ins</dt>
 <dd>
 <p>Che loads all the plug-in binaries (<code>.theia</code> files) in the specified directory.</p>
 <div class="exampleblock">
 <div class="title">Example 2. Adding the local directory <code>/home/theia/plugins/</code></div>
 <div class="content">
 <div class="listingblock">
 <div class="content">
 <pre>local-dir:///home/theia/plugins/</pre>
 </div>
 </div>
 </div>
 </div>
 </dd>
 <dt class="hdlist1">VS Code extension link</dt>
 <dd>
 <p>To obtain the link, go to the VS Code marketplace, find the needed extension, copy its ID, and append the ID to the <code>vscode:extension/</code> prefix.</p>
 <div class="exampleblock">
 <div class="title">Example 3. VS Code extension link for the <a href="https://marketplace.visualstudio.com/items?itemName=redhat.vscode-xml">XML language server</a> plug-in</div>
 <div class="content">
 <div class="listingblock">
 <div class="content">
 <pre>vscode:extension/redhat.vscode-xml</pre>
 </div>
 </div>
 </div>
 </div>
 </dd>
 <dt class="hdlist1">Link to plug-in binaries (<code>.theia</code> files)</dt>
 <dd>
 <p>Can be both HTTP and HTTPS.</p>
 <div class="exampleblock">
 <div class="title">Example 4. Link to plug-in binaries</div>
 <div class="content">
 <div class="listingblock">
 <div class="content">
 <pre>https://domain.net/path/plugin.theia</pre>
 </div>
 </div>
 </div>
 </div>
 </dd>
 </dl>
 </div>
 </li>
 </ul>
 </div>
 <div class="ulist">
 <div class="title">Verification steps</div>
 <ul>
 <li>
 <p>Open the <strong>Plugins panel</strong> (<strong>View</strong> &gt; <strong>Plugins</strong> in the main menu) and search for the plug-in in the list.</p>
 </li>
 </ul>
 </div>
 </div>
 <div class="sect2">
 <h3 id="adding-a-plug-in-by-configuring-a-workspace_che"><a class="anchor" href="#adding-a-plug-in-by-configuring-a-workspace_che"></a>Adding a plug-in by configuring a workspace devfile</h3>
 <div class="paragraph">
 <p>This method is useful when you need to add plug-ins from a non-default registry.</p>
 </div>
 <div class="olist arabic">
 <div class="title">Procedure</div>
 <ol class="arabic">
 <li>
 <p>Navigate to the <strong>Workspaces</strong> tab in the dashboard.</p>
 </li>
 <li>
 <p>Select the plug-in destination workspace.</p>
 </li>
 <li>
 <p>Switch to the <strong>Devfile</strong> tab, and find the <code>components</code> section.</p>
 </li>
 <li>
 <p>To add plug-ins, append your plugin component to the <code>components</code> section. A record has the following format:</p>
 <div class="listingblock">
 <div class="content">
 <pre>components:
   - type: chePlugin
     reference: &gt;-
       <em>&lt;registry-base-uri&gt;</em>/v3/plugins/<em>&lt;plugin-publisher&gt;</em>/<em>&lt;plugin-name&gt;</em>/<em>&lt;plugin-version&gt;</em></pre>
 </div>
 </div>
 <div class="exampleblock">
 <div class="title">Example 5. <code>chePlugin</code> reference URLs pointing to a plug-in <code>meta.yaml</code></div>
 <div class="content">
 <div class="listingblock">
 <div class="content">
 <pre>https://custom-registry/v3/plugins/custom-plugin-name/0.0.1/
 https://raw.githubusercontent.com/username/che-custom-plugins/master/v3/plugins/custom-plugin-name/0.0.1/meta.yaml</pre>
 </div>
 </div>
 </div>
 </div>
 </li>
 </ol>
 </div>
 </div>
 <div class="sect2">
 <h3 id="adding-a-plug-in-by-shareable-devfile_che"><a class="anchor" href="#adding-a-plug-in-by-shareable-devfile_che"></a>Adding a plug-in by preparing shareable devfile</h3>
 <div class="paragraph">
 <p>This approach brings an advantage of other users being able to contribute to the development, provided they have write access to the repository with the plug-in.</p>
 </div>
 <div class="olist arabic">
 <div class="title">Procedure</div>
 <ol class="arabic">
 <li>
 <p>Create a devfile with the plug-in development environment and share it with reviewers to provide them with the same environment. Reviewers then must build and run the plug-in to test it, using a script or a set of instructions on how to include the build in the plug-in repository.</p>
 </li>
 <li>
 <p>Share with reviewers factory link with a URL to a repository with devfile or a direct URL to content of the devfile.</p>
 <div class="exampleblock">
 <div class="title">Example 6. Factory URL pointing to a repository containing a devfile</div>
 <div class="content">
 <div class="paragraph">
 <p><code>https://che-host:che-port/#https://github.com/eclipse-che/che-server</code></p>
 </div>
 </div>
 </div>
 <div class="exampleblock">
 <div class="title">Example 7. Factory URL pointing to a devfile</div>
 <div class="content">
 <div class="paragraph">
 <p><code>https://che-host:che-port/#https://raw.githubusercontent.com/eclipse/che/master/devfile.yaml</code></p>
 </div>
 </div>
 </div>
 </li>
 <li>
 <p>The reviewer starts a workspace by opening a link where they are able to starts a hosted plug-in instance and specify the path to the plug-in project inside the workspace. For instructions on how to start a hosted instance of Che-Theia for plug-in testing, see <a href="../testing-che-theia-plug-ins/" class="page">Testing Che-Theia plug-ins</a>.</p>
 </li>
 </ol>
 </div>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="overriding-ram-of-a-che-theia-plug-in_che"><a class="anchor" href="#overriding-ram-of-a-che-theia-plug-in_che"></a>Overriding RAM of a Che-Theia plug-in</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>Sometimes, a plug-in consumes more memory than what has been allocated to it by the plug-in author or Che defaults. An example of such a case is the use of a language server with a project that has many source files (&amp;8gt; 10 000). RAM consumption in such circumstances needs to be tuned, otherwise the machine that runs the Che workspaces kills the process with an out-of-memory error (OOM) error.</p>
 </div>
 <div class="paragraph">
 <div class="title">Procedure</div>
 <p>Users can override the RAM limit and request for a particular plug-in in their workspace configuration.</p>
 </div>
 <div class="ulist">
 <ul>
 <li>
 <p>Set the <code>memoryLimit</code> and/or <code>memoryRequest</code> for devfile component  to <code>1000M</code> or <code>10Gi</code>, or any other value formatted as a number and a unit (<code>b, k, ki, m, mi, g, gi</code>). When no unit is specified, the number is in bytes.</p>
 </li>
 </ul>
 </div>
 <div class="admonitionblock note">
 <table>
 <tr>
 <td class="icon">
 <i class="fa icon-note" title="Note"></i>
 </td>
 <td class="content">
 Using this notation, units that contain the character <code>i</code>, denote a number that is of the power 2, such as 1024 (as opposed to numbers that use a power of 10, such as 1000).
 </td>
 </tr>
 </table>
 </div>
 <div class="exampleblock">
 <div class="title">Example 8. Limiting RAM use for a plug-in</div>
 <div class="content">
 <div class="paragraph">
 <p>For the YAML language server plug-in, sets the RAM limit to 768 mebibytes (1073741824 bytes) and RAM request to 500 megabytes:</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">components:
   - id: redhat/vscode-yaml/latest
     type: chePlugin
     memoryLimit: 768mi
     memoryRequest: 500M</code></pre>
 </div>
 </div>
 </div>
 </div>
 <div class="exampleblock">
 <div class="title">Example 9. Limiting CPU use for a plug-in</div>
 <div class="content">
 <div class="paragraph">
 <p>For the YAML language server plug-in, sets the CPU limit to 1.5 cores and CPU request to 500 millicores:</p>
 </div>
 <div class="listingblock">
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml">components:
   - id: redhat/vscode-yaml/latest
     type: chePlugin
     cpuLimit: 1.5
     cpuRequest: 500m</code></pre>
 </div>
 </div>
 </div>
 </div>
 </div>
 </div>
 </article>
   </div>
 </main>
 </div>
 <footer class="footer">
     <div><a href="https://www.eclipse.org" target="_blank">Eclipse Foundation</a> |
        <a href="https://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a> |
        <a href="https://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a> |
        <a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank">Eclipse Public License</a> |
        <a href="https://www.eclipse.org/legal" target="_blank">Legal Resources</a></div>
 </footer>

 <script src="../../../_/js/site.js"></script>
 <script async src="../../../_/js/vendor/highlight.js"></script>
   </body>
 </html>