| <!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>Eclipse Che4z | 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/"> <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 Eclipse Che4z 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="Eclipse Che4z">{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">Eclipse Che4z</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 id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Eclipse Che4z is an all-in-one mainframe extension stack for Eclipse Che, which provides a modern experience for mainframe software developers working with z/OS applications.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Powered by the open-source projects <a href="https://www.zowe.org/">Zowe</a> and <a href="/che/docs/che-7">Eclipse Che</a>, Che4z offers an easy and streamlined on-boarding process to get new developers using the tools they need. Using container technology and stacks, Eclipse Che brings the necessary technology to the task at hand.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Developers can now find the code they need to work on in Explorer for Endevor, Git and Zowe Explorer, edit code assisted by COBOL or HLASM Language Support, and test the resulting code with the Debugger, all in one Mainframe development package.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Eclipse Che4z is an open source project. Many of the components of the Che4z stack are also available on the VS Code marketplace as part of the <a href="https://marketplace.visualstudio.com/items?itemName=broadcomMFD.code4z-extension-pack">Code4z</a> package.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="use-cases">Use cases</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The Eclipse Che4z extension allows:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Viewing and editing CA Endevor SCM data in the Eclipse Che environment.</p> |
| </li> |
| <li> |
| <p>Editing COBOL and High Level Assembler language files with syntax awareness and autocomplete features.</p> |
| </li> |
| <li> |
| <p>Browsing mainframe data sets in the Eclipse Che environment.</p> |
| </li> |
| <li> |
| <p>Debugging COBOL programs running on a CICS region.</p> |
| </li> |
| <li> |
| <p>Performing tasks on mainframe applications using a command-line interface.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="getting-started">Getting Started</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>For instructions on how to install the Eclipse Che4z stack, see the <a href="https://github.com/eclipse/che-che4z">Che4z Git repository</a></p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="components">Components</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The Eclipse Che4z extension includes the following components:</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="cobol-language-support">COBOL Language Support</h3> |
| <div class="paragraph"> |
| <p>COBOL Language Support standardizes the communication between language tools and the code editor using the Language Server Protocol (LSP).</p> |
| </div> |
| <div class="paragraph"> |
| <p>The Che4z package includes a bitlang <a href="https://marketplace.visualstudio.com/items?itemName=bitlang.cobol">COBOL |
| extension</a> which provides an enhanced experience while working with a COBOL Language Support, giving the ability to leverage syntax highlighting.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="features">Features:</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Edit COBOL code with assistance including:</p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Syntax highlighting</p> |
| </li> |
| <li> |
| <p>Real time syntax validation</p> |
| </li> |
| <li> |
| <p>Content assist</p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p><a href="https://github.com/eclipse/che-che4z-lsp-for-cobol/issues"><span class="image"><img src="https://img.shields.io/github/issues-raw/eclipse/che-che4z-lsp-for-cobol?style=flat-square" alt="GitHub issues"></span></a> |
| <a href="https://join.slack.com/t/che4z/shared_invite/enQtNzk0MzA4NDMzOTIwLWIzMjEwMjJlOGMxNmMyNzQ1NWZlMzkxNmQ3M2VkYWNjMmE0MGQ0MjIyZmY3MTdhZThkZDg3NGNhY2FmZTEwNzQ"><span class="image"><img src="https://img.shields.io/badge/chat-on%20Slack-blue?style=flat-square" alt="slack"></span></a></p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>For documentation and release information, see the <a href="https://github.com/eclipse/che-che4z-lsp-for-cobol">COBOL Language Support Git repository</a></p> |
| </li> |
| <li> |
| <p>How can we improve COBOL Language Support? <a href="https://github.com/eclipse/che-che4z-lsp-for-cobol/issues">Let us know</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="blogs">Blogs:</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="https://medium.com/modern-mainframe/beginners-guide-cobol-made-easy-introduction-ecf2f611ac76">Beginner’s Guide: COBOL Made Easy</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="zowe-explorer">Zowe Explorer</h3> |
| <div class="paragraph"> |
| <p>Zowe Explorer is a VS Code extension powered by Zowe CLI that streamlines interaction with mainframe data sets, USS files, and jobs</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="features-2">Features:</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Access z/OS Datasets, z/OS Unix file system and submit JCL</p> |
| </li> |
| <li> |
| <p>View and download job output</p> |
| </li> |
| <li> |
| <p>Issue TSO commands</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p><a href="https://github.com/zowe/vscode-extension-for-zowe/issues"><span class="image"><img src="https://img.shields.io/github/issues-raw/zowe/vscode-extension-for-zowe?style=flat-square" alt="GitHub issues"></span></a> |
| <a href="https://openmainframeproject.slack.com/"><span class="image"><img src="https://img.shields.io/badge/chat-on%20Slack-blue?style=flat-square" alt="slack"></span></a></p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>For documentation, see <a href="https://docs.zowe.org/stable/user-guide/cli-vscodeplugin.html#zowe-explorer-extension-for-vscode">Zowe Docs</a></p> |
| </li> |
| <li> |
| <p>How can we improve Zowe Explorer? <a href="https://github.com/zowe/vscode-extension-for-zowe/issues">Let us know on our Git repository</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="blogs-2">Blogs:</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="https://marketplace.visualstudio.com/items?itemName=Zowe.vscode-extension-for-zowe">Beginner’s Guide: How to access mainframe via Zowe in 10 easy steps</a> *</p> |
| </li> |
| <li> |
| <p><a href="https://marketplace.visualstudio.com/items?itemName=Zowe.vscode-extension-for-zowe">Zowe blog</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="hlasm-language-support">HLASM Language Support</h3> |
| <div class="paragraph"> |
| <p>HLASM Language Support is an extension that supports the High Level Assembler language. It provides code completion, highlighting and navigation features, shows mistakes in the source, and lets you trace how the conditional assembly is evaluated with a modern debugging experience.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="features-3">Features:</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Highlights statements with different colors for labels, instructions, operands, remarks and variables.</p> |
| </li> |
| <li> |
| <p>Autocomplete is enabled for the instruction field. While typing, a list of instructions starting with the typed characters displays.</p> |
| </li> |
| <li> |
| <p>The extension adds the 'go to definition' and 'find all references' functionalities.</p> |
| </li> |
| <li> |
| <p>The macro tracer functionality allows you to track the process of assembling HLASM code.</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p><a href="https://github.com/eclipse/che-che4z-lsp-for-hlasm/issues"><span class="image"><img src="https://img.shields.io/github/issues-raw/zowe/vscode-extension-for-zowe?style=flat-square" alt="GitHub issues"></span></a> |
| <a href="https://openmainframeproject.slack.com/"><span class="image"><img src="https://img.shields.io/badge/chat-on%20Slack-blue?style=flat-square" alt="slack"></span></a></p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>For documentation and release information, see the <a href="https://github.com/eclipse/che-che4z-lsp-for-hlasm">HLASM Language Support Git repository</a></p> |
| </li> |
| <li> |
| <p>How can we improve HLASM Language Support? <a href="https://github.com/eclipse/che-che4z-lsp-for-hlasm/issues">Let us know</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="explorer-for-endevor">Explorer for Endevor</h3> |
| <div class="paragraph"> |
| <p>Explorer for Endevor gives you the ability to Browse and Retrieve <a href="https://www.broadcom.com/products/mainframe/devops-app-development/app/endevor-software-change-manager">CA Endevor® SCM</a> elements using a user-friendly, intuitive interface.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This extension offers best developer experience in synergy with <a href="https://youtu.be/sjnZuQpUVM4">Bridge for Git</a>, a solution which enables you to concurrently work in Git and mainframe.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="features-4">Features</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Retrieve, browse and search CA Endevor® elements.</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p><a href="https://github.com/eclipse/che-che4z-explorer-for-endevor/issues"><span class="image"><img src="https://img.shields.io/github/issues-raw/eclipse/che-che4z-explorer-for-endevor?style=flat-square" alt="GitHub issues"></span></a> |
| <a href="https://join.slack.com/t/che4z/shared_invite/enQtNzk0MzA4NDMzOTIwLWIzMjEwMjJlOGMxNmMyNzQ1NWZlMzkxNmQ3M2VkYWNjMmE0MGQ0MjIyZmY3MTdhZThkZDg3NGNhY2FmZTEwNzQ"><span class="image"><img src="https://img.shields.io/badge/chat-on%20Slack-blue?style=flat-square" alt="slack"></span></a></p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>For documentation and release information, see the <a href="https://github.com/eclipse/che-che4z-explorer-for-endevor/">Explorer for Endevor Git repository</a></p> |
| </li> |
| <li> |
| <p>How can we improve Explorer for Endevor? <a href="https://github.com/eclipse/che-che4z-explorer-for-endevor/issues">Let us know</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="debugger-for-mainframe">Debugger for Mainframe</h3> |
| <div class="paragraph"> |
| <p>Debugger for Mainframe provides the debugging interface to <a href="https://www.broadcom.com/products/mainframe/devops-app-development/testing-quality/intertest-cics">CA InterTest™ for CICS</a>. This extension provides a modern debug experience for COBOL applications running in a CICS region.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="features-5">Features:</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Debug COBOL code for applications running in a CICS region.</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p><a href="https://github.com/BroadcomMFD/debugger-for-mainframe/issues"><span class="image"><img src="https://img.shields.io/github/issues-raw/broadcomMFD/debugger-for-mainframe?style=flat-square" alt="GitHub issues"></span></a> |
| <a href="https://join.slack.com/t/che4z/shared_invite/enQtNzk0MzA4NDMzOTIwLWIzMjEwMjJlOGMxNmMyNzQ1NWZlMzkxNmQ3M2VkYWNjMmE0MGQ0MjIyZmY3MTdhZThkZDg3NGNhY2FmZTEwNzQ"><span class="image"><img src="https://img.shields.io/badge/chat-on%20Slack-blue?style=flat-square" alt="slack"></span></a></p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>For documentation and release information, see the <a href="https://github.com/BroadcomMFD/debugger-for-mainframe">Debugger for Mainframe Git repository</a></p> |
| </li> |
| <li> |
| <p>How can we improve Debugger for Mainframe? <a href="https://github.com/BroadcomMFD/debugger-for-mainframe/issues">Let us know</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="zowe-cli-plug-ins">Zowe CLI plug-ins</h3> |
| <div class="paragraph"> |
| <p>Zowe Command Line-Interface (Zowe CLI) is a command-line interface that lets application developers interact with the mainframe in a familiar format. The following Zowe CLI plug-ins are included in the Che4z basic stack:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/devops/ca-brightside/3-0/ca-brightside-command-line-interface-cli/available-cli-plug-ins/ca-brightside-plug-in-for-ca-endevor-scm.html">CA Endevor SCM plug-in for Zowe CLI</a></p> |
| </li> |
| <li> |
| <p><a href="https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/devops/ca-brightside/3-0/ca-brightside-command-line-interface-cli/available-cli-plug-ins/ca-brightside-plug-in-for-ca-file-master-plus.html">CA File Master Plus plug-in for Zowe CLI</a></p> |
| </li> |
| <li> |
| <p><a href="https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/devops/ca-brightside/3-0/ca-brightside-command-line-interface-cli/available-cli-plug-ins/ca-brightside-plug-in-for-ibm-db2-database.html">IBM Db2 plug-in for Zowe CLI</a></p> |
| </li> |
| <li> |
| <p><a href="https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-mainframe-software/devops/ca-brightside/3-0/ca-brightside-command-line-interface-cli/available-cli-plug-ins/ca-brightside-plug-in-for-ibm-cics.html">IBM CICS plug-in for Zowe CLI</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="sample-workflows">Sample Workflows</h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="cobol-language-support-using-ca-endevor-bridge-for-git-and-explorer-for-endevor">COBOL Language Support using CA Endevor Bridge for Git and Explorer for Endevor</h3> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Use VS Code’s built-in Git interface to clone source code from CA Endevor using Endevor’s Bridge for Git.</p> |
| </li> |
| <li> |
| <p>Edit COBOL code using COBOL Language Support, taking advantage of all the coding assistance provided by the extension.</p> |
| </li> |
| <li> |
| <p>Use VS Code’s built-in Git interface to push, pull and merge changes.</p> |
| </li> |
| <li> |
| <p>Search and browse additional code elements in the entire map of Endevor using the Explorer for Endevor extension. The COBOL Language Support extension provides syntax awareness for COBOL elements.</p> |
| </li> |
| <li> |
| <p>Download code elements, including their dependencies, into the current workspace using the Explorer for Endevor extension, and synchronize them with the Git project if code modifications are needed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="debugger-for-mainframe-2">Debugger for Mainframe</h3> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Provide InterTest server location, CICS region, credentials and program/transaction name (either by file or input form).</p> |
| </li> |
| <li> |
| <p>Obtain the listing and set breakpoints.</p> |
| </li> |
| <li> |
| <p>Trigger the CICS transaction and start a debug session.</p> |
| </li> |
| <li> |
| <p>Display and change variable values.</p> |
| </li> |
| <li> |
| <p>Stop at designated breakpoints, continue from a designated breakpoint and step through the listing.</p> |
| </li> |
| <li> |
| <p>Close the debug session.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="zowe-explorer-and-zowe-cli">Zowe Explorer and Zowe CLI</h3> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Access mainframe files and execute jobs, either from an interactive graphical interface or in the terminal with CLI. Whether you want to view a PDS, allocate a dataset, change a JCL, submit a mainframe compile, or download and upload files, Zowe Explorer and Zowe CLI interfaces provide these capabilities.</p> |
| </li> |
| </ul> |
| </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> |
