blob: 3a3858d5546e64c53879934d0d00cf0206503912 [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>Creating and configuring a new Che 7 workspace | 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 Creating and configuring a new Che 7 workspace 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="Creating and configuring a new Che 7 workspace">{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">Creating and configuring a new Che 7 workspace</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="sect1">
<h2 id="creating-a-new-workspace-from-the-dashboard_creating-and-configuring-a-new-che-7.9-workspace">Creating a new workspace from the dashboard</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This procedure describes how to create and edit a new Che 7.9 devfile using the <strong>Dashboard</strong>.</p>
</div>
<div class="ulist">
<div class="title">Prerequisites</div>
<ul>
<li>
<p>A running instance of Eclipse Che. To install an instance of Eclipse Che, see <a href="/che/docs/che-7/che-quick-starts/">Che 'quick-starts'</a>.</p>
</li>
</ul>
</div>
<div class="paragraph">
<div class="title">Procedure</div>
<p>To edit the devfile:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>In the <strong>Workspaces</strong> window, click the <b class="button">Add Workspace</b> button.</p>
</li>
<li>
<p>In the <strong>SELECT STACK</strong> list, select one of the default stacks.</p>
<div class="imageblock">
<div class="content">
<a class="image" href="/che/docs/images/workspaces/che-stack-list.png"><img src="/che/docs/images/workspaces/che-stack-list.png" alt="che stack list"></a>
</div>
</div>
</li>
<li>
<p>Click the <b class="button">Create &amp; Proceed Editing</b> button. The <strong>Workspaces &#8594; Configs</strong> page is shown.</p>
<div class="imageblock">
<div class="content">
<a class="image" href="/che/docs/images/workspaces/workspaces-config-page.png"><img src="/che/docs/images/workspaces/workspaces-config-page.png" alt="workspaces config page"></a>
</div>
</div>
</li>
<li>
<p>Change the workspace name and click the <strong>Devfile</strong> tab.</p>
<div class="imageblock">
<div class="content">
<a class="image" href="/che/docs/images/workspaces/workspace-devfile-tab.png"><img src="/che/docs/images/workspaces/workspace-devfile-tab.png" alt="workspace devfile tab"></a>
</div>
</div>
</li>
<li>
<p>Delete all the <strong>components</strong> and <strong>commands</strong> in the devfile to get an empty devfile.</p>
<div class="imageblock">
<div class="content">
<img src="/che/docs/images/workspaces/workspace-empty-devfile.png" alt="workspace empty devfile">
</div>
</div>
</li>
</ol>
</div>
</div>
</div>
<div class="sect1">
<h2 id="adding-projects-to-your-workspace_creating-and-configuring-a-new-che-7.9-workspace">Adding projects to your workspace</h2>
<div class="sectionbody">
<div class="ulist">
<div class="title">Prerequisites</div>
<ul>
<li>
<p>A running instance of Eclipse Che. To install an instance of Eclipse Che, see <a href="/che/docs/che-7/che-quick-starts/">Che 'quick-starts'</a>.</p>
</li>
<li>
<p>An existing workspace defined on this instance of Eclipse Che <a href="/che/docs/che-7/creating-and-configuring-a-new-che-7-workspace/">Creating a workspace from user dashboard</a>.</p>
</li>
</ul>
</div>
<div class="paragraph">
<div class="title">Procedure</div>
<p>To add a project to your workspace:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Click the <strong>Projects</strong> tab, and then click the <b class="button">Add Project</b> button.</p>
</li>
<li>
<p>Select the type of the project. Choose from: <strong>Samples</strong>, <strong>Blank</strong>, <strong>Git</strong>, <strong>GitHub</strong>, or <strong>Zip</strong>.</p>
</li>
<li>
<p>Fill in the required details for the project type that you selected, and click the <b class="button">Add</b> button.</p>
<div class="imageblock">
<div class="content">
<a class="image" href="/che/docs/images/workspaces/projects-add-project.png"><img src="/che/docs/images/workspaces/projects-add-project.png" alt="projects add project"></a>
</div>
</div>
</li>
<li>
<p>To add another project to the workspace, click the <b class="button">Add Project</b> button.</p>
</li>
<li>
<p>After configuring the project for the workspace, check the change in the devfile, which is the configuration file of the workspace, by opening the <strong>Devfile</strong> tab.</p>
<div class="imageblock">
<div class="content">
<a class="image" href="/che/docs/images/workspaces/devfile-tab-to-view.png"><img src="/che/docs/images/workspaces/devfile-tab-to-view.png" alt="devfile tab to view"></a>
</div>
</div>
</li>
</ol>
</div>
</div>
</div>
<div class="sect1">
<h2 id="configuring-the-workspace-and-adding-tooling_creating-and-configuring-a-new-che-7.9-workspace">Configuring the workspace and adding tools</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="adding-plug-ins">Adding plug-ins</h3>
<div class="paragraph">
<p>Che 7.9 plug-ins replace Che 6.x installers. The following table lists the Che 7.9 plug-ins that have replaced Che 6.x installers.</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 1. Che 7.9 plug-ins that have replaced Che 6.x installers</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Che 6.x installer</th>
<th class="tableblock halign-left valign-top">Che 7.9 plug-in</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">org.eclipse.che.ws-agent</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Deprecated and not necessary</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">org.eclipse.che.terminal</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Deprecated and not necessary anymore-</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">org.eclipse.che.exec</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Che machine-exec Service</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">org.eclipse.che.ls.java</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Language Support for Java</p></td>
</tr>
</tbody>
</table>
<div class="ulist">
<div class="title">Prerequisites</div>
<ul>
<li>
<p>A running instance of Eclipse Che. To install an instance of Eclipse Che, see <a href="/che/docs/che-7/che-quick-starts/">Che 'quick-starts'</a>.</p>
</li>
<li>
<p>An existing workspace defined on this instance of Eclipse Che <a href="/che/docs/che-7/creating-and-configuring-a-new-che-7-workspace/">Creating a workspace from user dashboard</a>.</p>
</li>
</ul>
</div>
<div class="paragraph">
<div class="title">Procedure</div>
<p>To add plug-ins to your workspace:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Click the <strong>Plugins</strong> tab.</p>
</li>
<li>
<p>Enable the plug-in that you want to add and click the <b class="button">Save</b> button.</p>
</li>
</ol>
</div>
</div>
<div class="sect2">
<h3 id="defining-the-workspace-editor">Defining the workspace editor</h3>
<div class="ulist">
<div class="title">Prerequisites</div>
<ul>
<li>
<p>A running instance of Eclipse Che. To install an instance of Eclipse Che, see <a href="/che/docs/che-7/che-quick-starts/">Che 'quick-starts'</a>.</p>
</li>
<li>
<p>An existing workspace defined on this instance of Eclipse Che <a href="/che/docs/che-7/creating-and-configuring-a-new-che-7-workspace/">Creating a workspace from user dashboard</a>.</p>
</li>
</ul>
</div>
<div class="paragraph">
<div class="title">Procedure</div>
<p>To define the editor to use with the workspace:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Click the <strong>Editors</strong> tab.</p>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
The recommended editor for Che 7.9 is Che-Theia.
</td>
</tr>
</table>
</div>
</li>
<li>
<p>Enable the editor to add and click the <b class="button">Save</b> button.</p>
</li>
<li>
<p>Click the <strong>Devfile</strong> tab to view the changes.</p>
<div class="imageblock">
<div class="content">
<img src="/che/docs/images/workspaces/workspace-devfile.png" alt="workspace devfile">
</div>
</div>
</li>
</ol>
</div>
</div>
<div class="sect2">
<h3 id="defining-specific-container-images">Defining specific container images</h3>
<div class="paragraph">
<div class="title">Procedure</div>
<p>To add a new container image:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Copy the following section from the <strong>devfile</strong> into <strong>components</strong>:</p>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="yaml">- <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">mountSources: true</span><span style="color:#D20">
command:
- sleep
args:
- infinity
memoryLimit: 1Gi
alias: maven3-jdk11
type: dockerimage
endpoints:
- name: 8080/tcp
port: 8080
volumes:
- name: projects
containerPath: /projects
image: 'maven:3.6.0-jdk-11'</span></span></code></pre>
</div>
</div>
</li>
<li>
<p>When using <code>type: kubernetes</code> or <code>type: openshift</code>, you must:</p>
<div class="ulist">
<ul>
<li>
<p>Use separate recipe files.</p>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
<div class="paragraph">
<p>To use separate recipe files, the paths can be relative or absolute. For example:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="yaml"><span style="color:#f8f;background:#505"><span style="color:#f4f">...</span></span>
<span style="color:#606">type</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">kubernetes</span></span>
<span style="color:#606">reference</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">deploy_k8s.yaml</span></span>
<span style="color:#f8f;background:#505"><span style="color:#f4f">...</span></span></code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="yaml"><span style="color:#f8f;background:#505"><span style="color:#f4f">...</span></span>
<span style="color:#606">type</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">openshift</span></span>
<span style="color:#606">reference</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">deploy_openshift.yaml</span></span>
<span style="color:#f8f;background:#505"><span style="color:#f4f">...</span></span></code></pre>
</div>
</div>
</td>
</tr>
</table>
</div>
</li>
<li>
<p>Alternatively, add the content as <code>referenceContent</code> (the <code>referenceContent</code> field replaces the Che 6.x recipe content).</p>
<div class="imageblock">
<div class="content">
<img src="/che/docs/images/workspaces/che-6-workspace-configuration.png" alt="che 6 workspace configuration">
</div>
</div>
</li>
</ul>
</div>
</li>
<li>
<p>Add a Che 6.x recipe content to the Che 7.9 devfile as <code>referenceContent</code>:</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>Click the <strong>Containers</strong> tab (<strong>Workspace</strong> &#8594; <strong>Details</strong> &#8594; <strong>Containers</strong>).</p>
<div class="imageblock">
<div class="content">
<a class="image" href="/che/docs/images/workspaces/edit-the-container.png"><img src="/che/docs/images/workspaces/edit-the-container.png" alt="edit the container"></a>
</div>
</div>
</li>
<li>
<p>Copy the Che 6.x recipe, and paste it into the separate Che 7.9 component as a <strong>referenceContent</strong>.</p>
<div class="imageblock">
<div class="content">
<a class="image" href="/che/docs/images/workspaces/component_as_a_referenceContent.png"><img src="/che/docs/images/workspaces/component_as_a_referenceContent.png" alt="component as a referenceContent"></a>
</div>
</div>
</li>
<li>
<p>Set the type from the original Che 6.x configuration. The following is an example of the resulting file:</p>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="yaml"> <span style="color:#606">type</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">kubernetes</span></span>
<span style="color:#606">referenceContent</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">|</span><span style="color:#D20">
apiVersion: v1
kind: Pod
metadata:
name: ws
spec:
containers:
-
image: 'rhche/centos_jdk8:latest'
name: dev
resources:
limits:
memory: 512Mi</span></span></code></pre>
</div>
</div>
</li>
</ol>
</div>
</li>
<li>
<p>Copy the required fields from the old workspace (<code>image</code>, <code>volumes</code>, <code>endpoints</code>). For example:</p>
<div class="imageblock">
<div class="content">
<img src="/che/docs/images/workspaces/workspace_configuration_che_6.png" alt="workspace configuration che 6">
</div>
</div>
<div class="imageblock">
<div class="content">
<img src="/che/docs/images/workspaces/workspace_devfile_che_7_.png" alt="workspace devfile che 7 ">
</div>
</div>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 2. Сhe 6 and Сhe 7 equivalence table</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Che 6.x workspace configuration</th>
<th class="tableblock halign-left valign-top">Che 7.9 workspace devfile</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>environments['defaultEnv'].machines['target'].servers</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>components[n].endpoints</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>environments['defaultEnv'].machines['machineName'].volumes</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>components[n].volumes</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>environments['defaultEnv'].recipe.type</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>components[n].type</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>environments['defaultEnv'].recipe.content</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>components[n].image</code></p></td>
</tr>
</tbody>
</table>
</li>
<li>
<p>Change the <code>memoryLimit</code> and <code>alias</code> variables, if needed. Here, the field <code>alias</code> is used to set a name for the component. It is generated automatically from the <code>image</code> field, if not set.</p>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="yaml"> <span style="color:#606">image</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">'maven:3.6.0-jdk-11'</span></span>
<span style="color:#606">alias</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">maven3-jdk11</span></span></code></pre>
</div>
</div>
</li>
<li>
<p>Change the <code>memoryLimit</code> and/or <code>memoryRequest</code> field to specify the <code>RAM</code> required for the component.</p>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="yaml"> <span style="color:#606">alias</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">maven3-jdk11</span></span>
<span style="color:#606">memoryLimit</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">256M</span></span>
<span style="color:#606">memoryRequest</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">128M</span></span></code></pre>
</div>
</div>
</li>
<li>
<p>Open the <strong>Devfile</strong> tab to see the changes.</p>
<div class="imageblock">
<div class="content">
<img src="/che/docs/images/workspaces/devfile-tab.png" alt="devfile tab">
</div>
</div>
</li>
<li>
<p>Repeat the steps to add additional container images.</p>
</li>
</ol>
</div>
</div>
<div class="sect2">
<h3 id="adding-commands-to-your-workspace">Adding commands to your workspace</h3>
<div class="paragraph">
<p>The following is a comparison between workspace configuration commands in Che 6.x (Figure 1) and Che 7.9 (Figure 2):</p>
</div>
<div class="imageblock">
<div class="content">
<img src="/che/docs/images/workspaces/che-6-workspace-configuration.png" alt="che 6 workspace configuration">
</div>
<div class="title">Figure 1. An example of the Workspace configuration commands in Che 6.x</div>
</div>
<div class="imageblock">
<div class="content">
<img src="/che/docs/images/workspaces/workspace-devfile.png" alt="workspace devfile">
</div>
<div class="title">Figure 2. An example of the Workspace configuration commands in Che 7.9</div>
</div>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 3. Сhe 6 and Сhe 7 equivalence table</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Che 6.x workspace configuration</th>
<th class="tableblock halign-left valign-top">Che 7.9 workspace devfile</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>environments['defaultEnv'].commands[n].name</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>commands[n].name</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>environments['defaultEnv'].commands[n].actions.command</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>components[n].commandLine</code></p></td>
</tr>
</tbody>
</table>
<div class="paragraph">
<div class="title">Procedure</div>
<p>To define commands to your workspace, edit the workspace devfile:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Add (or replace) the <code>commands</code> section with the first command. Change the <code>name</code> and the <code>command</code> fields from the original workspace configuration (see the preceding equivalence table).</p>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="yaml"><span style="color:#606">commands</span>:
- <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">name: build</span></span>
<span style="color:#606">actions</span>:
- <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">type: exec</span></span>
<span style="color:#606">command</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">mvn clean install</span></span></code></pre>
</div>
</div>
</li>
<li>
<p>Copy the following YAML code into the <code>commands</code> section to add a new command. Change the <code>name</code> and the <code>command</code> fields from the original workspace configuration (see the preceding equivalence table).</p>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="yaml"> - <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">name: build and run</span></span>
<span style="color:#606">actions</span>:
- <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">type: exec</span></span>
<span style="color:#606">command</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#D20">mvn clean install &amp;&amp; java -jar</span></span></code></pre>
</div>
</div>
</li>
<li>
<p>Optionally, add the <code>component</code> field into <code>actions</code>. This indicates the component alias where the command will be performed.</p>
</li>
<li>
<p>Repeat step 2 to add more commands to the devfile.</p>
</li>
<li>
<p>Click the <strong>Devfile</strong> tab to view the changes.</p>
<div class="imageblock">
<div class="content">
<img src="/che/docs/images/workspaces/workspace-devfile-changes.png" alt="workspace devfile changes">
</div>
</div>
</li>
<li>
<p>Save changes and start the new Che 7.9 workspace.</p>
<div class="imageblock">
<div class="content">
<a class="image" href="/che/docs/images/workspaces/save-and-start-the-new-che-workspace.png"><img src="/che/docs/images/workspaces/save-and-start-the-new-che-workspace.png" alt="save and start the new che workspace"></a>
</div>
</div>
</li>
</ol>
</div>
</div>
</div>
</div>
<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>