Google Git
Sign in
eclipse / gerrit / www.eclipse.org / che / 8041b9ad14c78ef4d7ecc38f386a561ce524896c / . / docs / che-7 / configuring-system-variables / index.html
blob: 95dd0e693830d7d0bd8236cf011282d26344715c [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="">
<meta name="keywords" content=", ">
<title>Configuring system properties for Che | Eclipse Che Documentation</title>
<link rel="stylesheet" href="/che/docs/css/syntax.css">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" crossorigin="anonymous">
<!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
<link rel="stylesheet" href="/che/docs/css/modern-business.css">
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<link rel="stylesheet" href="/che/docs/css/customstyles.css">
<link rel="stylesheet" href="/che/docs/css/boxshadowproperties.css">
<!-- most color styles are extracted out to here -->
<link rel="stylesheet" href="/che/docs/css/theme-che.css">
<link rel="stylesheet" href="/che/docs/css/coderay.css" media="screen" type="text/css">
<link rel="stylesheet" href="/che/docs/css/asciidoc.css" type="text/css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js" crossorigin="anonymous"></script>
<script src="/che/docs/js/jquery.navgoco.min.js"></script>
<!-- Latest compiled and minified JavaScript -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<!-- Anchor.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js" crossorigin="anonymous"></script>
<script src="/che/docs/js/toc.js"></script>
<script src="/che/docs/js/customscripts.js"></script>
<link rel="shortcut icon" href="/che/docs/images/favicon.ico">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="alternate" type="application/rss+xml" title="che" href="/feed.xml">
<script>
$(document).ready(function() {
// Initialize navgoco with default options
$("#mysidebar").navgoco({
caretHtml: '',
accordion: false,
openClass: 'active', // open
save: false, // leave false or nav highlighting doesn't work right
cookie: {
name: 'navgoco',
expires: false,
path: '/'
},
slide: {
duration: 400,
easing: 'swing'
}
});
$("#collapseAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', false);
});
$("#expandAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', true);
});
});
</script>
<script>
$(function () {
$('[data-toggle="tooltip"]').tooltip()
})
</script>
<script>
$(document).ready(function() {
$("#tg-sb-link").click(function() {
$("#tg-sb-sidebar").toggle();
$("#tg-sb-content").toggleClass('col-md-9');
$("#tg-sb-content").toggleClass('col-md-12');
$("#tg-sb-icon").toggleClass('fa-toggle-on');
$("#tg-sb-icon").toggleClass('fa-toggle-off');
});
});
</script>
</head>
<body>
<!-- Navigation -->
<nav class="navbar navbar-inverse navbar-static-top">
<div class="container topnavlinks">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="fa fa-home fa-lg navbar-brand" href="/che/docs/">&nbsp;<span class="projectTitle"> Eclipse Che Documentation</span></a>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right">
<!-- toggle sidebar button -->
<li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i> Nav</a></li>
<!-- entries without drop-downs appear here -->
<li><a href="https://medium.com/eclipse-che-blog/" target="_blank">Blog</a></li>
<li><a href="https://github.com/eclipse/che" target="_blank">Source Code</a></li>
<!-- entries with drop-downs appear here -->
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Support<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="https://github.com/eclipse/che/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Akind%2Fbug" target="_blank">Known Bugs</a></li>
<li><a href="https://github.com/eclipse/che/issues/new" target="_blank">File an Issue</a></li>
<li><a href="https://stackoverflow.com/questions/tagged/eclipse-che" target="_blank">Che on StackOverflow</a></li>
</ul>
</li>
<!--
<li>
<a class="email" title="Submit feedback" href="#" onclick="javascript:window.location='mailto:?subject= feedback&body=I have some feedback about the Configuring system properties for Che page: ' + window.location.href;"><i class="fa fa-envelope-o"></i> Feedback</a>
</li>
-->
<!--comment out this block if you want to hide search-->
<li>
<!--start search-->
<div id="search-demo-container">
<input type="text" id="search-input" placeholder="search...">
<ul id="results-container"></ul>
</div>
<script src="/che/docs/js/jekyll-search.js" type="text/javascript"></script>
<script type="text/javascript">
SimpleJekyllSearch.init({
searchInput: document.getElementById('search-input'),
resultsContainer: document.getElementById('results-container'),
dataSource: "/che/docs/search.json",
searchResultTemplate: '<li><a href="{url}" title="Configuring system properties for Che">{title}</a></li>',
noResultsText: 'No results found.',
limit: 10,
fuzzy: true,
})
</script>
<!--end search-->
</li>
</ul>
</div>
</div>
<!-- /.container -->
</nav>
<!-- Page Content -->
<div class="container">
<div id="main">
<!-- Content Row -->
<div class="row">
<!-- Sidebar Column -->
<div class="col-md-3" id="tg-sb-sidebar">
<ul id="mysidebar" class="nav">
<li class="sidebarTitle"> </li>
<div class="sidebarSubtitle">Overview</div>
<li>
<a href="/che/docs/che-7/introduction-to-eclipse-che">Introduction to Che</a>
<ul>
</ul>
</li>
<li>
<a href="#" class="expandable">Che quick-starts</a>
<ul>
<li><a href="/che/docs/che-7/che-quick-starts">Overview</a></li>
<li><a href="/che/docs/che-7/installing-the-chectl-management-tool">Installing the chectl management tool</a></li>
<li><a href="/che/docs/che-7/running-che-locally">Running Che locally</a></li>
<li><a href="/che/docs/che-7/deploying-che-on-kubernetes-on-aws">Che on Amazon Web Services</a></li>
<li><a href="/che/docs/che-7/installing-che-on-openshift-3-using-the-operator">Che on OpenShift 3</a></li>
<li><a href="/che/docs/che-7/installing-che-on-openshift-4-from-operatorhub">Che on OpenShift 4</a></li>
<li><a href="/che/docs/che-7/installing-che-on-google-cloud-platform">Che on Google Cloud Platform</a></li>
<li><a href="/che/docs/che-7/installing-eclipse-che-on-microsoft-azure">Che on Microsoft Azure</a></li>
<li><a href="/che/docs/che-7/accessing-che-from-openshift-developer-perspective">Accessing Che from OpenShift Developer Perspective</a></li>
</ul>
</li>
<li>
<a href="/che/docs/che-7/hosted-che">Hosted Che</a>
<ul>
</ul>
</li>
<li>
<a href="#" class="expandable">Che architecture</a>
<ul>
<li><a href="/che/docs/che-7/che-architecture">Overview</a></li>
<li><a href="/che/docs/che-7/high-level-che-architecture">High-level Che architecture</a></li>
<li><a href="/che/docs/che-7/che-workspace-controller">Che workspace controller</a></li>
<li><a href="/che/docs/che-7/che-workspaces-architecture">Che workspaces architecture</a></li>
</ul>
</li>
<div class="sidebarSubtitle">End-user Guide</div>
<li>
<a href="/che/docs/che-7/navigating-che-using-the-dashboard">Navigating Che: dashboard</a>
<ul>
</ul>
</li>
<li>
<a href="#" class="expandable">Che-Theia IDE basics</a>
<ul>
<li><a href="/che/docs/che-7/che-theia-ide-basics">Overview</a></li>
<li><a href="/che/docs/che-7/defining-custom-commands-for-che-theia">Defining custom commands for Che-Theia</a></li>
<li><a href="/che/docs/che-7/version-control">Version Control</a></li>
<li><a href="/che/docs/che-7/che-theia-troubleshooting">Che-Theia Troubleshooting</a></li>
</ul>
</li>
<li>
<a href="#" class="expandable">Using developer workspaces</a>
<ul>
<li><a href="/che/docs/che-7/workspaces-overview">Overview</a></li>
<li><a href="/che/docs/che-7/configuring-a-workspace-using-a-devfile">Configuring a workspace using a devfile</a></li>
<li><a href="/che/docs/che-7/making-a-workspace-portable-using-a-devfile">Making a workspace portable using a devfile</a></li>
<li><a href="/che/docs/che-7/converting-a-che-6-workspace-to-a-che-7-devfile">Converting a Che 6 Workspace to a Che 7 devfile</a></li>
<li><a href="/che/docs/che-7/creating-and-configuring-a-new-che-7-workspace">Creating and configuring a new Che 7 workspace</a></li>
<li><a href="/che/docs/che-7/importing-a-kubernetes-application-into-a-che-workspace">Importing a Kubernetes application into a Che workspace</a></li>
<li><a href="/che/docs/che-7/remotely-accessing-che-workspaces">Remotely accessing workspaces</a></li>
<li><a href="/che/docs/che-7/creating-a-workspace-from-code-sample">Creating a workspace from code sample</a></li>
<li><a href="/che/docs/che-7/creating-a-workspace-by-importing-source-code-of-a-project">Creating a workspace by importing source code of a project</a></li>
<li><a href="/che/docs/che-7/configuring-workspace-exposure-strategies">Configuring workspace exposure strategies</a></li>
</ul>
</li>
<li>
<a href="#" class="expandable">Customizing developer environments</a>
<ul>
<li><a href="/che/docs/che-7/customizing-developer-environments">Overview</a></li>
<li><a href="/che/docs/che-7/what-is-a-che-theia-plug-in">What is a Che-Theia plug-in</a></li>
<li><a href="/che/docs/che-7/using-alternative-ides-in-che">Using alternative IDEs in Che</a></li>
<li><a href="/che/docs/che-7/using-a-visual-studio-code-extension-in-che">Using a VS Code extension in Che</a></li>
<li><a href="/che/docs/che-7/adding-tools-to-che-after-creating-a-workspace">Adding tools to Che after creating a workspace</a></li>
</ul>
</li>
<li>
<a href="#" class="expandable">Configuring OAuth authorization</a>
<ul>
<li><a href="/che/docs/che-7/configuring-oauth-authorization">Overview</a></li>
<li><a href="/che/docs/che-7/configuring-github-oauth">Configuring GitHub OAuth</a></li>
<li><a href="/che/docs/che-7/configuring-openshift-oauth">Configuring OpenShift OAuth</a></li>
</ul>
</li>
<li>
<a href="#" class="expandable">Using artifact repositories in a restricted environment</a>
<ul>
<li><a href="/che/docs/che-7/using-artifact-repositories-in-a-restricted-environment">Overview</a></li>
<li><a href="/che/docs/che-7/using-maven-artifact-repositories">Using Maven artifact repositories</a></li>
<li><a href="/che/docs/che-7/using-gradle-artifact-repositories">Using Gradle artifact repositories</a></li>
<li><a href="/che/docs/che-7/using-python-artifact-repositories">Using Python artifact repositories</a></li>
<li><a href="/che/docs/che-7/using-go-artifact-repositories">Using Go artifact repositories</a></li>
<li><a href="/che/docs/che-7/using-nuget-artifact-repositories">Using NuGet artifact repositories</a></li>
<li><a href="/che/docs/che-7/using-npm-artifact-repositories">Using npm artifact repositories</a></li>
</ul>
</li>
<li>
<a href="/che/docs/che-7/troubleshooting-for-che-end-users">Troubleshooting for Che end users</a>
<ul>
</ul>
</li>
<div class="sidebarSubtitle">Installation Guide</div>
<li>
<a href="/che/docs/che-7/installing-che-in-restricted-environment">Installing Che in restricted environment</a>
<ul>
</ul>
</li>
<li>
<a href="/che/docs/che-7/upgrading-che">Upgrading Che</a>
<ul>
</ul>
</li>
<li>
<a href="/che/docs/che-7/advanced-configuration-options">Advanced configuration options</a>
<ul>
</ul>
</li>
<li>
<a href="/che/docs/che-7/uninstalling-che">Uninstalling Che</a>
<ul>
</ul>
</li>
<div class="sidebarSubtitle">Administration Guide</div>
<li>
<a href="#" class="expandable">Customizing devfile and plug-in registries</a>
<ul>
<li><a href="/che/docs/che-7/customizing-the-devfile-and-plug-in-registries">Overview</a></li>
<li><a href="/che/docs/che-7/building-and-running-a-custom-registry-image">Building and running a custom registry image</a></li>
<li><a href="/che/docs/che-7/including-the-plug-in-binaries-in-the-registry-image">Including the plug-in binaries in the registry image</a></li>
<li><a href="/che/docs/che-7/editing-a-devfile-and-plug-in-at-runtime">Editing a devfile and plug-in at runtime</a></li>
</ul>
</li>
<li>
<a href="/che/docs/che-7/configuring-system-variables">Configuring system variables</a>
<ul>
</ul>
</li>
<li>
<a href="#" class="expandable">Retrieving Che logs</a>
<ul>
<li><a href="/che/docs/che-7/retrieving-che-logs">Overview</a></li>
<li><a href="/che/docs/che-7/viewing-kubernetes-events">Accessing Kubernetes events on OpenShift</a></li>
<li><a href="/che/docs/che-7/viewing-che-server-logs">Viewing Che server logs</a></li>
<li><a href="/che/docs/che-7/viewing-external-service-logs">Viewing external service logs</a></li>
<li><a href="/che/docs/che-7/viewing-che-workspaces-logs">Viewing Che workspaces logs</a></li>
<li><a href="/che/docs/che-7/viewing-plug-in-broker-logs">Viewing Plug-in broker logs</a></li>
<li><a href="/che/docs/che-7/collecting-logs-using-chectl">Collecting logs using chectl</a></li>
</ul>
</li>
<li>
<a href="/che/docs/che-7/monitoring-che">Monitoring Che</a>
<ul>
</ul>
</li>
<li>
<a href="/che/docs/che-7/tracing-che">Tracing Che</a>
<ul>
</ul>
</li>
<li>
<a href="#" class="expandable">Managing users</a>
<ul>
<li><a href="/che/docs/che-7/managing-users">Overview</a></li>
<li><a href="/che/docs/che-7/configuring-authorization">Configuring authorization</a></li>
<li><a href="/che/docs/che-7/using-organizations">Using organizations</a></li>
<li><a href="/che/docs/che-7/removing-user-data">Removing user data</a></li>
</ul>
</li>
<li>
<a href="#" class="expandable">Securing Che</a>
<ul>
<li><a href="/che/docs/che-7/securing-che">Overview</a></li>
<li><a href="/che/docs/che-7/authenticating-users">Authenticating users</a></li>
<li><a href="/che/docs/che-7/authorizing-users">Authorizing users</a></li>
</ul>
</li>
<li>
<a href="#" class="expandable">Backup and disaster recovery</a>
<ul>
<li><a href="/che/docs/che-7/backup-and-disaster-recovery">Overview</a></li>
<li><a href="/che/docs/che-7/external-database-setup">External database setup</a></li>
<li><a href="/che/docs/che-7/persistent-volumes-backups">Persistent Volumes backups</a></li>
</ul>
</li>
<li>
<a href="/che/docs/che-7/calculating-che-resource-requirements">Calculating Che resource requirements</a>
<ul>
</ul>
</li>
<li>
<a href="/che/docs/che-7/caching-images-for-faster-workspace-start">Caching images for faster workspace start</a>
<ul>
</ul>
</li>
<div class="sidebarSubtitle">Contributor Guide</div>
<li>
<a href="/che/docs/che-7/installing-che-in-tls-mode-with-self-signed-certificates">Installing Che in TLS mode with self-signed certificates</a>
<ul>
</ul>
</li>
<li>
<a href="/che/docs/che-7/branding-che-theia">Branding Che-Theia</a>
<ul>
</ul>
</li>
<li>
<a href="/che/docs/che-7/developing-che-theia-plug-ins">Developing Che-Theia plug-ins</a>
<ul>
</ul>
</li>
<li>
<a href="/che/docs/che-7/testing-che-theia-plug-ins">Testing Che-Theia plug-ins</a>
<ul>
</ul>
</li>
<li>
<a href="/che/docs/che-7/publishing-che-theia-plug-ins">Publishing Che-Theia plug-ins</a>
<ul>
</ul>
</li>
<li>
<a href="/che/docs/che-7/adding-support-for-a-new-language">Adding support for a new language</a>
<ul>
</ul>
</li>
<li>
<a href="/che/docs/che-7/adding-support-for-a-new-debugger">Adding support for a new debugger</a>
<ul>
</ul>
</li>
<li>
<a href="#" class="expandable">Che extensibility reference</a>
<ul>
<li><a href="/che/docs/che-7/che-extensibility-reference">Overview</a></li>
<li><a href="/che/docs/che-7/che-extension-points">Che extension points</a></li>
<li><a href="/che/docs/che-7/che-theia-plug-in-api">Che-Theia plug-in API</a></li>
<li><a href="/che/docs/che-7/debug-adapter-protocol">Debug Adapter Protocol</a></li>
<li><a href="/che/docs/che-7/language-server-protocol">Language Server Protocol</a></li>
</ul>
</li>
<div class="sidebarSubtitle">Extensions</div>
<li>
<a href="/che/docs/che-7/eclipse-che4z">Eclipse Che4z</a>
<ul>
</ul>
</li>
<li>
<a href="#" class="expandable">OpenShift Connector</a>
<ul>
<li><a href="/che/docs/che-7/openshift-connector-overview">Overview</a></li>
<li><a href="/che/docs/che-7/features-of-openshift-connector">Features of OpenShift Connector</a></li>
<li><a href="/che/docs/che-7/installing-openshift-connector-in-eclipse-che">Installing OpenShift Connector in Eclipse Che</a></li>
<li><a href="/che/docs/che-7/authenticating-with-openshift-connector-from-eclipse-che">Authenticating with OpenShift Connector from Eclipse Che</a></li>
<li><a href="/che/docs/che-7/creating-components-with-openshift-connector-in-eclipse-che">Creating Components with OpenShift Connector in Eclipse Che</a></li>
<li><a href="/che/docs/che-7/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>
<!-- if you aren't using the accordion, uncomment this block: -->
<!-- <p class="external">
<a href="#" id="collapseAll">Collapse all</a> | <a href="#" id="expandAll">Expand all</a>
</p>-->
</ul>
<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
<script>$("li.active").parents('li').toggleClass("active");</script>
</div>
<!-- Content Column -->
<div class="col-md-9" id="tg-sb-content">
<div class="post-header">
<h1 class="post-title-main">Configuring system properties for Che</h1>
</div>
<div class="post-content">
<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
<script>
$( document ).ready(function() {
// Handler for .ready() called.
$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2' });
/* this offset helps account for the space taken up by the floating toolbar. */
$('#toc').on('click', 'a', function() {
var target = $(this.getAttribute('href'))
, scroll_target = target.offset().top
$(window).scrollTop(scroll_target - 10);
return false
})
});
</script>
<div id="toc"></div>
<!--
-->
<div class="paragraph">
<p>The following document describes all possible configuration properties of Che.</p>
</div>
<div class="paragraph">
<p>To override default values on operator-based deployments, update Custom Resource of <code>CheCluster</code>
by adding or editing the <code>customCheProperties</code> field, which expects a map as in the following example:</p>
</div>
<div class="listingblock">
<div class="title">Example of changing the default value of <code>CHE_WORKSPACE_DEFAULT__MEMORY__LIMIT__MB</code> to 2048:</div>
<div class="content">
<pre class="CodeRay highlight"><code data-lang="yaml"><span style="color:#606">apiVersion</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">org.eclipse.che/v1</span></span>
<span style="color:#606">kind</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">CheCluster</span></span>
<span style="color:#606">metadata</span>:
<span style="color:#606">name</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">eclipse-che</span></span>
<span style="color:#606">namespace</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">che</span></span>
<span style="color:#606">spec</span>:
<span style="color:#606">server</span>:
<span style="color:#606">cheImageTag</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">''</span></span>
<span style="color:#606">devfileRegistryImage</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">''</span></span>
<span style="color:#606">pluginRegistryImage</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">''</span></span>
<span style="color:#606">tlsSupport</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">true</span></span>
<span style="color:#606">selfSignedCert</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">false</span></span>
<span style="color:#606">customCheProperties</span>:
<span style="color:#606">CHE_WORKSPACE_DEFAULT__MEMORY__LIMIT__MB</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">2048</span><span style="color:#710">&quot;</span></span>
<span style="color:#606">auth</span>:</code></pre>
</div>
</div>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 1. Che server</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_DATABASE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>${che.home}/storage</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Folder where Che will store internal data objects</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_API</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>http://${CHE_HOST}:${CHE_PORT}/api</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">API service. Browsers initiate REST communications to Che server with this URL</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WEBSOCKET_ENDPOINT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ws://${CHE_HOST}:${CHE_PORT}/api/websocket</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Che websocket major endpoint. Provides basic communication endpointfor major websocket interaction/messaging.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WEBSOCKET_ENDPOINT__MINOR</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ws://${CHE_HOST}:${CHE_PORT}/api/websocket-minor</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Che websocket minor endpoint. Provides basic communication endpointfor minor websocket interaction/messaging.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_STORAGE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>${che.home}/workspaces</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Your projects are synchronized from the Che server into the machine running eachworkspace. This is the directory in the ws runtime where your projects are mounted.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_PROJECTS_STORAGE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/projects</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Your projects are synchronized from the Che server into the machine running eachworkspace. This is the directory in the machine where your projects are placed.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_PROJECTS_STORAGE_DEFAULT_SIZE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1Gi</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Used when devfile k8s/os type components requests project PVC creation(applied in case of unique and perWorkspace PVC strategy. In case of common PVC strategy,it will be rewritten with value of che.infra.kubernetes.pvc.quantity property)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_LOGS_ROOT__DIR</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/workspace_logs</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines the directory inside the machine where all the workspace logs are placed.The value of this folder should be provided into machine e.g. like environment variableso agents developers can use this directory for backup agents logs.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_HTTP__PROXY</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>++</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configures proxies used by runtimes powering workspaces</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_HTTPS__PROXY</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>++</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configures proxies used by runtimes powering workspaces</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_NO__PROXY</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>++</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configures proxies used by runtimes powering workspaces</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_AUTO__START</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">By default, when users access to a workspace with its URL the workspaceautomatically starts if it is stopped. You can set this to false to disable this.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_POOL_TYPE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>fixed</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Workspace threads pool configuration, this pool is used for workspace relatedoperations that require asynchronous execution e.g. starting/stopping.Possible values are 'fixed', 'cached'</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_POOL_EXACT__SIZE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>30</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">This property is ignored when pool type is different from 'fixed'.Configures the exact size of the pool, if it&#8217;s set multiplier property is ignored.If this property is not set(0, &lt; 0, NULL) then pool sized to number of cores,it can be modified within multiplier</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_POOL_CORES__MULTIPLIER</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">This property is ignored when pool type is different from 'fixed' or exact pool size is set.If it&#8217;s set the pool size will be N_CORES * multiplier</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_PROBE__POOL__SIZE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>10</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">This property specifies how much threads to use for workspaces servers liveness probes</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_HTTP__PROXY__JAVA__OPTIONS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Http proxy setting for workspace JVM</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_JAVA__OPTIONS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>-XX:MaxRAM=150m -XX:MaxRAMFraction=2 -XX:+UseParallelGC -XX:MinHeapFreeRatio=10 -XX:MaxHeapFreeRatio=20 -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -Dsun.zip.disableMemoryMapping=true -Xms20m -Djava.security.egd=file:/dev/./urandom</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Java command line options to be added to JVM&#8217;s that running within workspaces.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_MAVEN__OPTIONS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>-XX:MaxRAM=150m -XX:MaxRAMFraction=2 -XX:+UseParallelGC -XX:MinHeapFreeRatio=10 -XX:MaxHeapFreeRatio=20 -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -Dsun.zip.disableMemoryMapping=true -Xms20m -Djava.security.egd=file:/dev/./urandom</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Maven command line options added to JVM&#8217;s that run agents within workspaces.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_MAVEN__SERVER__JAVA__OPTIONS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>-XX:MaxRAM=128m -XX:MaxRAMFraction=1 -XX:+UseParallelGC -XX:MinHeapFreeRatio=10 -XX:MaxHeapFreeRatio=20 -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -Dsun.zip.disableMemoryMapping=true -Xms20m -Djava.security.egd=file:/dev/./urandom</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Default java command line options to be added to JVM that run maven server.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_DEFAULT__MEMORY__LIMIT__MB</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1024</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">RAM limit default for each machine that has no RAM settings in environment.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_DEFAULT__MEMORY__REQUEST__MB</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>200</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">RAM request default for each container that has no explicit RAM settings in environment.this amount will be allocated on workspace container creationthis property might not be supported by all infrastructure implementations:currently it is supported by k8s and openshiftif default memory request is more than the memory limit, request will be ignored,and only limit will be used</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_DEFAULT__CPU__LIMIT__CORES</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>2</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">CPU limit default for each container that has no CPU settings in environment.Can be specified either in floating point cores number, e.g. 0.125 or in K8S format integer millicores e.g. 125m</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_DEFAULT__CPU__REQUEST__CORES</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.125</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">CPU request default for each container that has no CPU settings in environment.if default CPU request is more than the CPU limit, request will be ignored,and only limit will be used</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_SIDECAR_DEFAULT__MEMORY__LIMIT__MB</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>128</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">RAM limit and request default for each sidecar that has no RAM settings in Che plugin configuration.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_SIDECAR_DEFAULT__MEMORY__REQUEST__MB</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>64</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">RAM limit and request default for each sidecar that has no RAM settings in <code>{prod-short}</code> plugin configuration.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_SIDECAR_DEFAULT__CPU__LIMIT__CORES</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">CPU limit and request default for each sidecar that has no CPU settings in Che plugin configuration.Can be specified either in floating point cores number, e.g. 0.125 or in K8S format integer millicores e.g. 125m</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_SIDECAR_DEFAULT__CPU__REQUEST__CORES</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0.115</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">CPU limit and request default for each sidecar that has no CPU settings in <code>{prod-short}</code> plugin configuration.Can be specified either in floating point cores number, e.g. 0.125 or in K8S format integer millicores e.g. 125m</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_SIDECAR_IMAGE__PULL__POLICY</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Always</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Define image pulling strategy for sidecars.Possible values are: Always, Never, IfNotPresent. Any other valuewill be interpreted as unspecified policy (Always if :latest tag is specified,or IfNotPresent otherwise.)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_ACTIVITY__CHECK__SCHEDULER__PERIOD__S</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>60</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Period of inactive workspaces suspend job execution.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_ACTIVITY__CLEANUP__SCHEDULER__PERIOD__S</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3600</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The period of the cleanup of the activity table. The activity table can contain invalid or stale dataif some unforeseen errors happen, like a server crash at a peculiar point in time. The default is torun the cleanup job every hour.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_ACTIVITY__CLEANUP__SCHEDULER__INITIAL__DELAY__S</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>60</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The delay after server startup to start the first activity clean up job.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_ACTIVITY__CHECK__SCHEDULER__DELAY__S</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>180</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Delay before first workspace idleness check job started to avoidmass suspend if ws master was unavailable for period close toinactivity timeout.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_CLEANUP__TEMPORARY__INITIAL__DELAY__MIN</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>5</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Period of stopped temporary workspaces cleanup job execution.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_CLEANUP__TEMPORARY__PERIOD__MIN</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>180</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Period of stopped temporary workspaces cleanup job execution.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_SERVER_PING__SUCCESS__THRESHOLD</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Number of sequential successful pings to server after which it is treated as available.Note: the property is common for all servers e.g. workspace agent, terminal, exec etc.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_SERVER_PING__INTERVAL__MILLISECONDS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3000</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Interval, in milliseconds, between successive pings to workspace server.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_SERVER_LIVENESS__PROBES</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>wsagent/http,exec-agent/http,terminal,theia,jupyter,dirigible,cloud-shell</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">List of servers names which require liveness probes</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_STARTUP__DEBUG__LOG__LIMIT__BYTES</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>10485760</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Limit size of the logs collected from single container that can be observed by che-server whendebugging workspace startup.default 10MB=10485760</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_STOP_ROLE_ENABLED</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, 'stop-workspace' role with the edit privileges will be granted to the 'che' ServiceAccount.This configuration is mainly required for workspace idling when the OpenShift OAuth is enabled.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 2. Templates</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_TEMPLATE_STORAGE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>${che.home}/templates</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Folder that contains JSON files with code templates and samples</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 3. Authentication parameters</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_AUTH_USER__SELF__CREATION</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Che has a single identity implementation, so this does not change the user experience.If true, enables user creation at API level</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_AUTH_ACCESS__DENIED__ERROR__PAGE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/error-oauth</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Authentication error page address</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_AUTH_RESERVED__USER__NAMES</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>++</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Reserved user names</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_OAUTH_GITHUB_CLIENTID</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">You can setup GitHub OAuth to automate authentication to remote repositories.You need to first register this application with GitHub OAuth.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_OAUTH_GITHUB_CLIENTSECRET</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">You can setup GitHub OAuth to automate authentication to remote repositories.You need to first register this application with GitHub OAuth.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_OAUTH_GITHUB_AUTHURI</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>+ <a href="https://github.com/login/oauth/authorize+" class="bare">https://github.com/login/oauth/authorize+</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">You can setup GitHub OAuth to automate authentication to remote repositories.You need to first register this application with GitHub OAuth.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_OAUTH_GITHUB_TOKENURI</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>+ <a href="https://github.com/login/oauth/access_token+" class="bare">https://github.com/login/oauth/access_token+</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">You can setup GitHub OAuth to automate authentication to remote repositories.You need to first register this application with GitHub OAuth.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_OAUTH_GITHUB_REDIRECTURIS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>+ <a href="http://localhost:${CHE_PORT}/api/oauth/callback+" class="bare">http://localhost:${CHE_PORT}/api/oauth/callback+</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">You can setup GitHub OAuth to automate authentication to remote repositories.You need to first register this application with GitHub OAuth.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_OAUTH_OPENSHIFT_CLIENTID</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration of OpenShift OAuth client. Used to obtain OpenShift OAuth token.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_OAUTH_OPENSHIFT_CLIENTSECRET</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration of OpenShift OAuth client. Used to obtain OpenShift OAuth token.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_OAUTH_OPENSHIFT_OAUTH__ENDPOINT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>+ NULL+</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration of OpenShift OAuth client. Used to obtain OpenShift OAuth token.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_OAUTH_OPENSHIFT_VERIFY__TOKEN__URL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>+ NULL+</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration of OpenShift OAuth client. Used to obtain OpenShift OAuth token.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 4. Internal</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>SCHEDULE_CORE__POOL__SIZE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>10</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Che extensions can be scheduled executions on a time basis.This configures the size of the thread pool allocated to extensions that are launched ona recurring schedule.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ORG_EVERREST_ASYNCHRONOUS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Everrest is a Java Web Services toolkit that manages JAX-RS &amp; web socket communicationsUsers should rarely need to configure this.Disable asynchronous mechanism that is embedded in everrest.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ORG_EVERREST_ASYNCHRONOUS_POOL_SIZE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>20</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Quantity of asynchronous requests which may be processed at the same time</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ORG_EVERREST_ASYNCHRONOUS_QUEUE_SIZE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>500</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Size of queue. If asynchronous request can&#8217;t be processed after consuming it will be added in queue.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ORG_EVERREST_ASYNCHRONOUS_JOB_TIMEOUT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>10</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Timeout in minutes for request. If after timeout request is not done or client did not come yet to get result of request it may be discarded.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ORG_EVERREST_ASYNCHRONOUS_CACHE_SIZE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1024</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Size of cache for waiting, running and ended request.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ORG_EVERREST_ASYNCHRONOUS_SERVICE_PATH</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/async/</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Path to asynchronous service</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>DB_SCHEMA_FLYWAY_BASELINE_ENABLED</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">DB initialization and migration configuration</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>DB_SCHEMA_FLYWAY_BASELINE_VERSION</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>5.0.0.8.1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">DB initialization and migration configuration</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>DB_SCHEMA_FLYWAY_SCRIPTS_PREFIX</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>++</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">DB initialization and migration configuration</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>DB_SCHEMA_FLYWAY_SCRIPTS_SUFFIX</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>.sql</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">DB initialization and migration configuration</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>DB_SCHEMA_FLYWAY_SCRIPTS_VERSION__SEPARATOR</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>__</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">DB initialization and migration configuration</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>DB_SCHEMA_FLYWAY_SCRIPTS_LOCATIONS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>classpath:che-schema</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">DB initialization and migration configuration</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 5. Kubernetes Infra parameters</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_MASTER__URL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>++</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration of Kubernetes client that Infra will use</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_TRUST__CERTS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>++</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration of Kubernetes client that Infra will use</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_SERVER__STRATEGY</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>default-host</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines the way how servers are exposed to the world in k8s infra.List of strategies implemented in Che: default-host, multi-host, single-host</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_INGRESS_DOMAIN</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>++</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Used to generate domain for a server in a workspace in case property <code>che.infra.kubernetes.server_strategy</code> is set to <code>multi-host</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_NAMESPACE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>++</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">DEPRECATED - please do not change the value of this property otherwise the existing workspaces will loose data. Do notset it on new installations.Defines Kubernetes namespace in which all workspaces will be created.If not set, every workspace will be created in a new namespace, where namespace = workspace idIt&#8217;s possible to use &lt;username&gt; and &lt;userid&gt; placeholders (e.g.: che-workspace-&lt;username&gt;).In that case, new namespace will be created for each user. Service account with permissionto create new namespace must be used.Ignored for OpenShift infra. Use <code>che.infra.openshift.project</code> insteadIf the namespace pointed to by this property exists, it will be used for all workspaces. If it does not exist,the namespace specified by the che.infra.kubernetes.namespace.default will be created and used.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_NAMESPACE_DEFAULT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>&lt;username&gt;-che</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines Kubernetes default namespace in which user&#8217;s workspaces are createdif user does not override it.It&#8217;s possible to use &lt;username&gt;, &lt;userid&gt; and &lt;workspaceid&gt; placeholders (e.g.: che-workspace-&lt;username&gt;).In that case, new namespace will be created for each user (or workspace).Is used by OpenShift infra as well to specify Project</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_NAMESPACE_ALLOW__USER__DEFINED</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines if a user is able to specify Kubernetes namespace (or OpenShift project) different from the default.It&#8217;s NOT RECOMMENDED to configured true without OAuth configured. This property is also used by the OpenShift infra.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_SERVICE__ACCOUNT__NAME</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines Kubernetes Service Account name which should be specified to be bound to all workspaces pods.Note that Kubernetes Infrastructure won&#8217;t create the service account and it should exist.OpenShift infrastructure will check if project is predefined(if <code>che.infra.openshift.project</code> is not empty): - if it is predefined then service account must exist there - if it is 'NULL' or empty string then infrastructure will create new OpenShift project per workspace and prepare workspace service account with needed roles there</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_CLUSTER__ROLE__NAME</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Specifies an optional, additional cluster role to use with the workspace service account, to allow for additionNote that the cluster role name must already exist, and the Che service account needs to be able to create a Role Bindingto associate this cluster role with the workspace service account.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_WORKSPACE__START__TIMEOUT__MIN</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>8</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines time frame that limits the Kubernetes workspace start time</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_INGRESS__START__TIMEOUT__MIN</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>5</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines the timeout in minutes that limits the period for which Kubernetes Ingress become ready</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_WORKSPACE__UNRECOVERABLE__EVENTS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>FailedMount,FailedScheduling,MountVolume.SetUp failed,Failed to pull image,FailedCreate</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If during workspace startup an unrecoverable event defined in the property occurs,terminate workspace immediately instead of waiting until timeoutNote that this SHOULD NOT include a mere 'Failed' reason, because that might catch events that are not unrecoverable.A failed container startup is handled explicitly by Che server.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_PVC_ENABLED</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines whether use the Persistent Volume Claim for che workspace needse.g backup projects, logs etc or disable it.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_PVC_STRATEGY</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>common</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defined which strategy will be used while choosing PVC for workspaces.Supported strategies:- 'common' All workspaces in the same Kubernetes Namespace will reuse the same PVC. Name of PVC may be configured with 'che.infra.kubernetes.pvc.name'. Existing PVC will be used or new one will be created if it doesn&#8217;t exist.- 'unique' Separate PVC for each workspace&#8217;s volume will be used. Name of PVC is evaluated as '{che.infra.kubernetes.pvc.name} + '-' + `{generated_8_chars}&#8217;. Existing PVC will be used or a new one will be created if it doesn&#8217;t exist.- 'per-workspace' Separate PVC for each workspace will be used. Name of PVC is evaluated as '{che.infra.kubernetes.pvc.name} + '-' + `{WORKSPACE_ID}&#8217;. Existing PVC will be used or a new one will be created if it doesn&#8217;t exist.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_PVC_PRECREATE__SUBPATHS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines whether to run a job that creates workspace&#8217;s subpath directories in persistent volume for the 'common' strategy before launching a workspace.Necessary in some versions of OpenShift/Kubernetes as workspace subpath volume mounts are created with root permissions,and thus cannot be modified by workspaces running as a user (presents an error importing projects into a workspace in Che).The default is 'true', but should be set to false if the version of Openshift/Kubernetes creates subdirectories with user permissions.Relevant issue: <a href="https://github.com/kubernetes/kubernetes/issues/41638Note" class="bare">https://github.com/kubernetes/kubernetes/issues/41638Note</a> that this property has effect only if the 'common' PVC strategy used.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_PVC_NAME</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>claim-che-workspace</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines the settings of PVC name for che workspaces.Each PVC strategy suplies this value differently.See doc for che.infra.kubernetes.pvc.strategy property</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_PVC_STORAGE__CLASS__NAME</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>++</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines the storage class of Persistent Volume Claim for the workspaces.Empty strings means 'use default'.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_PVC_QUANTITY</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>10Gi</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines the size of Persistent Volume Claim of che workspace.Format described here:https://docs.openshift.com/container-platform/latest/dev_guide/compute_resources.htmldev-compute-resources</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_PVC_JOBS_IMAGE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>centos:centos7</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Pod that is launched when performing persistent volume claim maintenance jobs on OpenShift</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_PVC_JOBS_IMAGE_PULL__POLICY</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>IfNotPresent</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Image pull policy of container that used for the maintenance jobs on Kubernetes/OpenShift cluster</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_PVC_JOBS_MEMORYLIMIT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>250Mi</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines pod memory limit for persistent volume claim maintenance jobs</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_PVC_ACCESS__MODE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ReadWriteOnce</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines Persistent Volume Claim access mode.Note that for common PVC strategy changing of access mode affects the number of simultaneously running workspaces.If OpenShift flavor where che running is using PVs with RWX access mode then a limit of running workspaces at the same timebounded only by che limits configuration like(RAM, CPU etc).Detailed information about access mode is described here:https://docs.openshift.com/container-platform/latest/architecture/additional_concepts/storage.htmlpv-access-modes</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_PVC_WAIT__BOUND</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines whether Che Server should wait workspaces PVCs to become bound after creating.It&#8217;s used by all PVC strategies.It should be set to <code>false</code> in case if <code>volumeBindingMode</code> is configured to `WaitForFirstConsumer`otherwise workspace starts will hangs up on phase of waiting PVCs.Default value is true (means that PVCs should be waited to be bound)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_INSTALLER__SERVER__MIN__PORT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>10000</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defined range of ports for installers serversBy default, installer will use own port, but if it conflicts with another installer serversthen OpenShift infrastructure will reconfigure installer to use first available from this range</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_INSTALLER__SERVER__MAX__PORT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>20000</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defined range of ports for installers serversBy default, installer will use own port, but if it conflicts with another installer serversthen OpenShift infrastructure will reconfigure installer to use first available from this range</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_INGRESS_ANNOTATIONS__JSON</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines annotations for ingresses which are used for servers exposing. Value depends on the kind of ingresscontroller.OpenShift infrastructure ignores this property because it uses Routes instead of ingresses.Note that for a single-host deployment strategy to work, a controller supporting URL rewriting has to beused (so that URLs can point to different servers while the servers don&#8217;t need to support changing the app root).The che.infra.kubernetes.ingress.path.rewrite_transform property defines how the path of the ingress should betransformed to support the URL rewriting and this property defines the set of annotations on the ingress itselfthat instruct the chosen ingress controller to actually do the URL rewriting, potentially building on the pathtransformation (if required by the chosen ingress controller).For example for nginx ingress controller 0.22.0 and later the following value is recommended:{'ingress.kubernetes.io/rewrite-target': '/$1','ingress.kubernetes.io/ssl-redirect': 'false',\ 'ingress.kubernetes.io/proxy-connect-timeout': '3600','ingress.kubernetes.io/proxy-read-timeout': '3600'}and the che.infra.kubernetes.ingress.path.rewrite_transform should be set to '%s(.*)'For nginx ingress controller older than 0.22.0, the rewrite-target should be set to merely '/' and the path transformto '%s' (see the the che.infra.kubernetes.ingress.path.rewrite_transform property).Please consult the nginx ingress controller documentation for the explanation of how the ingress controller usesthe regular expression present in the ingress path and how it achieves the URL rewriting.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_INGRESS_PATH__TRANSFORM</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines a 'recipe' on how to declare the path of the ingress that should expose a server.The '%s' represents the base public URL of the server and is guaranteed to end with a forward slash. This propertymust be a valid input to the String.format() method and contain exactly one reference to '%s'.Please see the description of the che.infra.kubernetes.ingress.annotations_json property to see how these twoproperties interplay when specifying the ingress annotations and path.If not defined, this property defaults to '%s' (without the quotes) which means that the path is not transformed inany way for use with the ingress controller.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_POD_SECURITY__CONTEXT_RUN__AS__USER</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines security context for pods that will be created by Kubernetes InfraThis is ignored by OpenShift infra</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_POD_SECURITY__CONTEXT_FS__GROUP</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines security context for pods that will be created by Kubernetes InfraThis is ignored by OpenShift infra</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_POD_TERMINATION__GRACE__PERIOD__SEC</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>0</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines grace termination period for pods that will be created by Kubernetes / OpenShift infrastructuresGrace termination period of Kubernetes / OpenShift workspace&#8217;s pods defaults '0', which allows to terminatepods almost instantly and significantly decrease the time required for stopping a workspace.Note: if <code>terminationGracePeriodSeconds</code> have been explicitly set in Kubernetes / OpenShift recipe it will not be overridden.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_CLIENT_HTTP_ASYNC__REQUESTS_MAX</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1000</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Number of maximum concurrent async web requests(http requests or ongoing web socket calls)supported in the underlying shared http clientof the <code>KubernetesClient</code> instances.Default values are 64, and 5 per-host, whichdoesn&#8217;t seem correct for multi-user scenariosknowing that Che keeps a number of connectionsopened (e.g. for command or ws-agent logs)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_CLIENT_HTTP_ASYNC__REQUESTS_MAX__PER__HOST</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1000</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Number of maximum concurrent async web requests(http requests or ongoing web socket calls)supported in the underlying shared http clientof the <code>KubernetesClient</code> instances.Default values are 64, and 5 per-host, whichdoesn&#8217;t seem correct for multi-user scenariosknowing that <code>{prod-short}</code> keeps a number of connectionsopened (e.g. for command or ws-agent logs)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_CLIENT_HTTP_CONNECTION__POOL_MAX__IDLE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>5</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Max number of idle connections in the connection poolof the Kubernetes-client shared http client</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_CLIENT_HTTP_CONNECTION__POOL_KEEP__ALIVE__MIN</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>5</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Keep-alive timeout of the connection poolof the Kubernetes-client shared http clientin minutes</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_TLS__ENABLED</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Creates Ingresses with Transport Layer Security (TLS) enabledIn OpenShift infrastructure, Routes will be TLS-enabled</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_TLS__SECRET</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>++</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name of a secret that should be used when creating workspace ingresses with TLSIgnored by OpenShift infrastructure</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_TLS__KEY</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data for TLS Secret that should be used for workspaces Ingressescert and key should be encoded with Base64 algorithmThese properties are ignored by OpenShift infrastructure</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_TLS__CERT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data for TLS Secret that should be used for workspaces Ingressescert and key should be encoded with Base64 algorithmThese properties are ignored by OpenShift infrastructure</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_KUBERNETES_RUNTIMES__CONSISTENCY__CHECK__PERIOD__MIN</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>-1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines the period with which runtimes consistency checks will be performed.If runtime has inconsistent state then runtime will be stopped automatically.Value must be more than 0 or <code>-1</code>, where <code>-1</code> means that checks won&#8217;t be performed at all.It is disabled by default because there is possible Che Server configuration when Che Serverdoesn&#8217;t have an ability to interact with Kubernetes API when operation is not invoked by user.It DOES work on the following configurations:- workspaces objects are created in the same namespace where Che Server is located;- cluster-admin service account token is mount to Che Server pod;It DOES NOT work on the following configurations:- Che Server communicates with Kubernetes API using token from OAuth provider;</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 6. OpenShift Infra parameters</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_OPENSHIFT_PROJECT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>++</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">DEPRECATED - please do not change the value of this property otherwise the existing workspaces will loose data. Do notset it on new installations.Defines OpenShift namespace in which all workspaces will be created.If not set, every workspace will be created in a new project, where project name = workspace idIt&#8217;s possible to use &lt;username&gt; and &lt;userid&gt; placeholders (e.g.: che-workspace-&lt;username&gt;).In that case, new project will be created for each user. OpenShift oauth or service account withpermission to create new projects must be used.If the project pointed to by this property exists, it will be used for all workspaces. If it does not exist,the namespace specified by the che.infra.kubernetes.namespace.default will be created and used.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_SINGLEPORT_WILDCARD__DOMAIN_HOST</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Single port mode wildcard domain host &amp; port. nip.io is used by default</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_SINGLEPORT_WILDCARD__DOMAIN_PORT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Single port mode wildcard domain host &amp; port. nip.io is used by default</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_SINGLEPORT_WILDCARD__DOMAIN_IPLESS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enable single port custom DNS without inserting the IP</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 7. Experimental properties</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_PLUGIN__BROKER_METADATA_IMAGE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>quay.io/eclipse/che-plugin-metadata-broker:v3.1.2</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Docker image of Che plugin broker app that resolves workspace tooling configuration and copiesplugins dependencies to a workspace</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_PLUGIN__BROKER_ARTIFACTS_IMAGE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>quay.io/eclipse/che-plugin-artifacts-broker:v3.1.2</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Docker image of <code>{prod-short}</code> plugin broker app that resolves workspace tooling configuration and copiesplugins dependencies to a workspace</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_PLUGIN__BROKER_PULL__POLICY</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Always</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Docker image of Che plugin broker app that resolves workspace tooling configuration and copiesplugins dependencies to a workspace</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_PLUGIN__BROKER_WAIT__TIMEOUT__MIN</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines the timeout in minutes that limits the max period of result waiting for plugin broker.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_PLUGIN__REGISTRY__URL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>https://che-plugin-registry.prod-preview.openshift.io/v3</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Workspace tooling plugins registry endpoint. Should be a valid HTTP URL.Example: <a href="http://che-plugin-registry-eclipse-che.192.168.65.2.nip.ioIn" class="bare">http://che-plugin-registry-eclipse-che.192.168.65.2.nip.ioIn</a> case Che plugins tooling is not needed value 'NULL' should be used</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_DEVFILE__REGISTRY__URL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>https://che-devfile-registry.prod-preview.openshift.io/</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Devfile Registry endpoint. Should be a valid HTTP URL.Example: <a href="http://che-devfile-registry-eclipse-che.192.168.65.2.nip.ioIn" class="bare">http://che-devfile-registry-eclipse-che.192.168.65.2.nip.ioIn</a> case Che plugins tooling is not needed value 'NULL' should be used</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_PERSIST__VOLUMES_DEFAULT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Defines a default value for persist volumes that clients like Dashboardshould propose for users during workspace creation.Possible values: true or falseIn case of true - PersistentVolumeClaims are used by declared volumes by user and plugins. `true`value is supposed not to be set explicitly in Devfile attributes since it&#8217;s default fixed behaviour.In case of false - emptyDir is used instead of PVCs. Note that data will be lost after workspace restart.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_SERVER_SECURE__EXPOSER</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>default</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configures in which way secure servers will be protected with authentication.Suitable values: - 'default': jwtproxy is configured in a pass-through mode. So, servers should authenticate requests themselves. - 'jwtproxy': jwtproxy will authenticate requests. So, servers will receive only authenticated ones.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_SERVER_SECURE__EXPOSER_JWTPROXY_TOKEN_ISSUER</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>wsmaster</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Jwtproxy issuer string, token lifetime and optional auth page path to route unsigned requests to.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_SERVER_SECURE__EXPOSER_JWTPROXY_TOKEN_TTL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>8800h</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Jwtproxy issuer string, token lifetime and optional auth page path to route unsigned requests to.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_SERVER_SECURE__EXPOSER_JWTPROXY_AUTH_LOADER_PATH</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/_app/loader.html</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Jwtproxy issuer string, token lifetime and optional auth page path to route unsigned requests to.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_SERVER_SECURE__EXPOSER_JWTPROXY_IMAGE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>quay.io/eclipse/che-jwtproxy:fd94e60</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Jwtproxy issuer string, token lifetime and optional auth page path to route unsigned requests to.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_SERVER_SECURE__EXPOSER_JWTPROXY_MEMORY__LIMIT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>128mb</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Jwtproxy issuer string, token lifetime and optional auth page path to route unsigned requests to.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 8. Configuration of major "/websocket" endpoint</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_CORE_JSONRPC_PROCESSOR__MAX__POOL__SIZE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>50</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum size of the JSON RPC processing poolin case if pool size would be exceeded message execution will be rejected</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_CORE_JSONRPC_PROCESSOR__CORE__POOL__SIZE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>5</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Initial json processing pool. Minimum number of threads that used to process major JSON RPC messages.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_CORE_JSONRPC_PROCESSOR__QUEUE__CAPACITY</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>100000</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration of queue used to process Json RPC messages.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 9. Configuration of major "/websocket-minor" endpoint</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_CORE_JSONRPC_MINOR__PROCESSOR__MAX__POOL__SIZE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>100</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum size of the JSON RPC processing poolin case if pool size would be exceeded message execution will be rejected</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_CORE_JSONRPC_MINOR__PROCESSOR__CORE__POOL__SIZE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>15</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Initial json processing pool. Minimum number of threads that used to process minor JSON RPC messages.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_CORE_JSONRPC_MINOR__PROCESSOR__QUEUE__CAPACITY</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>10000</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration of queue used to process Json RPC messages.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_METRICS_PORT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>8087</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Port the the http server endpoint that would be exposed with Prometheus metrics</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 10. CORS settings</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_CORS_ALLOWED__ORIGINS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>*</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">CORS filter on WS Master is turned off by default.Use environment variable 'CHE_CORS_ENABLED=true' to turn it on&#8217;cors.allowed.origins' indicates which request origins are allowed</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_CORS_ALLOW__CREDENTIALS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">'cors.support.credentials' indicates if it allows processing of requests with credentials(in cookies, headers, TLS client certificates)</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 11. Factory defaults</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_FACTORY_DEFAULT__EDITOR</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>eclipse/che-theia/next</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Editor and plugin which will be used for factories which are created from remote git repositorywhich doesn&#8217;t contain any Che-specific workspace descriptors (like .devfile of .factory.json)Multiple plugins must be comma-separated, for example:pluginFooPublisher/pluginFooName/pluginFooVersion,pluginBarPublisher/pluginBarName/pluginBarVersion</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_FACTORY_DEFAULT__PLUGINS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>eclipse/che-machine-exec-plugin/nightly</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Editor and plugin which will be used for factories which are created from remote git repositorywhich doesn&#8217;t contain any <code>{prod-short}</code>-specific workspace descriptors (like .devfile of .factory.json)Multiple plugins must be comma-separated, for example:pluginFooPublisher/pluginFooName/pluginFooVersion,pluginBarPublisher/pluginBarName/pluginBarVersion</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 12. Devfile defaults</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_DEVFILE_DEFAULT__EDITOR</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>eclipse/che-theia/next</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Default Editor that should be provisioned into Devfile if there is no specified EditorFormat is <code>editorPublisher/editorName/editorVersion</code> value.<code>NULL</code> or absence of value means that default editor should not be provisioned.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_WORKSPACE_DEVFILE_DEFAULT__EDITOR_PLUGINS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>eclipse/che-machine-exec-plugin/nightly #</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Default Plugins which should be provisioned for Default Editor.All the plugins from this list that are not explicitly mentioned in the user-defined devfilewill be provisioned but only when the default editor is used or if the user-defined editor isthe same as the default one (even if in different version).Format is comma-separated <code>pluginPublisher/pluginName/pluginVersion</code> values, and URLs. For example:eclipse/che-theia-exec-plugin/0.0.1,eclipse/che-theia-terminal-plugin/0.0.1,https://cdn.pluginregistry.com/vi-mode/meta.yamlIf the plugin is a URL, the plugin&#8217;s meta.yaml is retrieved from that URL.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 13. Che system</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_SYSTEM_SUPER__PRIVILEGED__MODE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">System Super Privileged Mode.Grants users with the manageSystem permission additional permissions forgetByKey, getByNameSpace, stopWorkspaces, and getResourcesInformation.These are not given to admins by default and these permissions allowadmins gain visibility to any workspace along with naming themselveswith admin privileges to those workspaces.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_SYSTEM_ADMIN__NAME</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>admin</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Grant system permission for 'che.admin.name' user. If the user already exists it&#8217;ll happen oncomponent startup, if not - during the first login when user is persisted in the database.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 14. Workspace limits</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_LIMITS_WORKSPACE_ENV_RAM</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>16gb</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Workspaces are the fundamental runtime for users when doing development. You can setparameters that limit how workspaces are created and the resources that are consumed.The maximum amount of RAM that a user can allocate to a workspace when theycreate a new workspace. The RAM slider is adjusted to this maximum value.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_LIMITS_WORKSPACE_IDLE_TIMEOUT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1800000</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The length of time that a user is idle with their workspace when the system willsuspend the workspace and then stopping it. Idleness is thelength of time that the user has not interacted with the workspace, meaning thatone of our agents has not received interaction. Leaving a browser window opencounts toward idleness.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 15. Users workspace limits</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_LIMITS_USER_WORKSPACES_RAM</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>-1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The total amount of RAM that a single user is allowed to allocate to runningworkspaces. A user can allocate this RAM to a single workspace or spread itacross multiple workspaces.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_LIMITS_USER_WORKSPACES_COUNT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>-1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of workspaces that a user is allowed to create. The user willbe presented with an error message if they try to create additional workspaces.This applies to the total number of both running and stopped workspaces.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_LIMITS_USER_WORKSPACES_RUN_COUNT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of running workspaces that a single user is allowed to have.If the user has reached this threshold and they try to start an additionalworkspace, they will be prompted with an error message. The user will need tostop a running workspace to activate another.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 16. Organizations workspace limits</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_LIMITS_ORGANIZATION_WORKSPACES_RAM</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>-1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The total amount of RAM that a single organization (team) is allowed to allocateto running workspaces. An organization owner can allocate this RAM however theysee fit across the team&#8217;s workspaces.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_LIMITS_ORGANIZATION_WORKSPACES_COUNT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>-1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of workspaces that a organization is allowed to own. Theorganization will be presented an error message if they try to createadditional workspaces. This applies to the total number of both runningand stopped workspaces.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_LIMITS_ORGANIZATION_WORKSPACES_RUN_COUNT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>-1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of running workspaces that a single organization is allowed.If the organization has reached this threshold and they try to start anadditional workspace, they will be prompted with an error message. Theorganization will need to stop a running workspace to activate another.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_MAIL_FROM__EMAIL__ADDRESS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>che@noreply.com</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Address that will be used as from email for email notifications</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 17. Organizations notifications settings</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_ORGANIZATION_EMAIL_MEMBER__ADDED__SUBJECT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>You've been added to a Che Organization</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Organization notifications sunjects and templates</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_ORGANIZATION_EMAIL_MEMBER__ADDED__TEMPLATE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>st-html-templates/user_added_to_organization</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Organization notifications sunjects and templates</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_ORGANIZATION_EMAIL_MEMBER__REMOVED__SUBJECT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>You've been removed from a Che Organization</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_ORGANIZATION_EMAIL_MEMBER__REMOVED__TEMPLATE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>st-html-templates/user_removed_from_organization</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_ORGANIZATION_EMAIL_ORG__REMOVED__SUBJECT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Che Organization deleted</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_ORGANIZATION_EMAIL_ORG__REMOVED__TEMPLATE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>st-html-templates/organization_deleted</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_ORGANIZATION_EMAIL_ORG__RENAMED__SUBJECT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Che Organization renamed</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_ORGANIZATION_EMAIL_ORG__RENAMED__TEMPLATE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>st-html-templates/organization_renamed</code></p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 18. Multi-user-specific OpenShift infrastructure configuration</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_INFRA_OPENSHIFT_OAUTH__IDENTITY__PROVIDER</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Alias of the Openshift identity provider registered in Keycloak,that should be used to create workspace OpenShift resources inOpenshift namespaces owned by the current Che user.Should be set to NULL if `che.infra.openshift.project`is set to a non-empty value.For more information see the following documentation:https://www.keycloak.org/docs/3.3/server_admin/topics/identity-broker/social/openshift.html</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 19. Keycloak configuration</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_KEYCLOAK_AUTH__SERVER__URL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>http://${CHE_HOST}:5050/auth</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Url to keycloak identity provider serverCan be set to NULL only if `che.keycloak.oidcProvider`is used</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_KEYCLOAK_REALM</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>che</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Keycloak realm is used to authenticate usersCan be set to NULL only if `che.keycloak.oidcProvider`is used</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_KEYCLOAK_CLIENT__ID</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>che-public</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Keycloak client id in che.keycloak.realm that is used by dashboard, ide and cli to authenticate users</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 20. RedHat Che specific configuration</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Environment Variable Name</th>
<th class="tableblock halign-left valign-top">Default value</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_KEYCLOAK_OSO_ENDPOINT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">URL to access OSO oauth tokens</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_KEYCLOAK_GITHUB_ENDPOINT</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">URL to access Github oauth tokens</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_KEYCLOAK_ALLOWED__CLOCK__SKEW__SEC</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>3</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The number of seconds to tolerate for clock skew when verifying exp or nbf claims.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_KEYCLOAK_USE__NONCE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use the OIDC optional <code>nonce</code> feature to increase security.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_KEYCLOAK_JS__ADAPTER__URL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">URL to the Keycloak Javascript adapter we want to use.if set to NULL, then the default used value is`${che.keycloak.auth_server_url}/js/keycloak.js`,or <code>&lt;che-server&gt;/api/keycloak/OIDCKeycloak.js`if an alternate `oidc_provider</code> is used</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_KEYCLOAK_OIDC__PROVIDER</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Base URL of an alternate OIDC provider that providesa discovery endpoint as detailed in the following specificationhttps://openid.net/specs/openid-connect-discovery-1_0.htmlProviderConfig</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_KEYCLOAK_USE__FIXED__REDIRECT__URLS</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set to true when using an alternate OIDC provider thatonly supports fixed redirect UrlsThis property is ignored when <code>che.keycloak.oidc_provider</code> is NULL</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_KEYCLOAK_USERNAME__CLAIM</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NULL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Username claim to be used as user display namewhen parsing JWT tokenif not defined the fallback value is 'preferred_username'</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CHE_OAUTH_SERVICE__MODE</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>delegated</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Configuration of OAuth Authentication Service that can be used in 'embedded' or 'delegated' mode.If set to 'embedded', then the service work as a wrapper to Che&#8217;s OAuthAuthenticator ( as in Single User mode).If set to 'delegated', then the service will use Keycloak IdentityProvider mechanism.Runtime Exception wii be thrown, in case if this property is not set properly.</p></td>
</tr>
</tbody>
</table>
<div class="tags">
<b>Tags: </b>
</div>
<!--
-->
</div>
<hr class="shaded"/>
<footer>
<div class="row">
<div class="col-lg-12 footer">
Eclipse Che - Documentation <br/>
Site last generated: Apr 29, 2020 <br/>
<hr>
<a href="http://www.eclipse.org" target="_blank">Eclipse Foundation</a><br/>
<a href="http://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a><br/>
<a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a><br/>
<a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank">Eclipse Public License</a><br/>
<a href="http://www.eclipse.org/legal" target="_blank">Legal Resources</a><br/>
</div>
</div>
</footer>
<!-- /.row -->
</div>
<!-- /.container -->
</div>
<!-- /#main -->
</div>
</body>
</html>