blob: 40f679beac635f32b5502b25d7694de1837e85b0 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-112407000-2"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() {
dataLayer.push(arguments);
}
gtag('js', new Date());
gtag('config', 'UA-112407000-2');
</script>
<!-- Google Tag Manager -->
<script>
(function (w, d, s, l, i) {
w[l] = w[l] || [];
w[l].push({
'gtm.start': new Date().getTime(),
event: 'gtm.js'
});
var f = d.getElementsByTagName(s)[0],
j = d.createElement(s),
dl = l != 'dataLayer' ? '&l=' + l : '';
j.async = true;
j.src =
'https://www.googletagmanager.com/gtm.js?id=' + i + dl;
f.parentNode.insertBefore(j, f);
})(window, document, 'script', 'dataLayer', 'GTM-KS8HHSF');
</script>
<!-- End Google Tag Manager -->
<head>
<base href="/codewind/" />
<title>Codewind technical preview install instruction | Codewind</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Codewind technical preview">
<meta name="keywords" content="Codewind technical preview, Codewind, introduction, about, getting started, install, setup, use, uninstall"/>
<link rel="icon" type="image/png" sizes="16x16" href="images/favicon-16x16.png">
<link rel="icon" type="image/png" sizes="32x32" href="images/favicon-32x32.png">
<link href="https://fonts.googleapis.com/css?family=IBM+Plex+Sans:300,400,600&display=swap" rel="stylesheet">
<!-- Bootstrap CSS CDN -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css"
integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" />
<link rel="stylesheet" href="css/styles.css">
<link rel="stylesheet" href="css/docs.css">
</head>
<body data-spy="scroll" data-target="#toc">
<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KS8HHSF"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->
<div class="main">
<!-- Bootstrap NavBar -->
<nav class="navbar navbar-expand-lg navbar-light cw-banner fixed-top">
<button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse"
data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false"
aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<a class="navbar-brand" href="">
<img src="images/header-logo.svg" class="cw-header-logo" alt="">
</a>
<div class="collapse navbar-collapse justify-content-end cw-navbar-padding" id="navbarNavDropdown">
<ul class="navbar-nav cw-navbar-nav">
<li class="nav-item cw-navbar-item cw-header-link">
<a class="nav-link cw-nav-link" href="docindex.html">Docs</a>
</li>
<!-- li class="nav-item cw-navbar-item" id="download-li">
<button onClick="window.location.href='https://microclimate.dev/download/codewind';" type="button" class="btn cw-download-button">Download</button>
<a href="https://microclimate.dev/download/codewind" class="nav-link cw-nav-link cw-download-link" href="#">Download</a>
</li> -->
<li class="nav-item cw-navbar-item" id="github-stars-button">
<!-- Place this tag where you want the button to render. -->
<a class="github-button" href="https://github.com/eclipse/codewind" data-size="large"
data-show-count="true" aria-label="Star eclipse/codewind on GitHub">Star</a>
</li>
<!-- Smaller devices menu END -->
</ul>
</div>
</nav>
<!-- NavBar END -->
<!-- Bootstrap row -->
<div class="row" id="body-row">
<!-- Sidebar -->
<div id="sidebar-container" class="bg-light">
<!-- Bootstrap List Group -->
<ul class="list-group sticky-top bg-light cw-sticky-offset">
<!-- Separator with title -->
<li class="list-group-item cw-sidebar-separator-title cw-text-gray d-flex bg-light align-items-center menu-collapsed">
<small class="badge badge-success cw-margin-auto">DOCUMENTS</small>
</li>
<!-- /END Separator -->
<!-- Hard coded TOC -->
<a href="#install_on_cloud" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Installing and Using Codewind on Cloud</span>
<span class="submenu-icon ml-auto"></span>
</div>
</a>
<div id="install_on_cloud" class="cw-sidebar-div cw-sidebar-submenu collapse" style="">
<a href="installoncloud.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Installing and Using Codewind on Kubernetes</span>
</div>
</a>
<a href="supportingmultipleusers.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Support for multiple users</span>
</div>
</a>
<a href="viewkibanalogs.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Viewing logs using Kibana in IBM Cloud Private</span>
</div>
</a>
</div>
<a href="installlocally.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Installing Codewind locally</span>
</div>
</a>
<a href="#codewind_for_eclipse" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Codewind for Eclipse</span>
<span class="submenu-icon ml-auto"></span>
</div>
</a>
<div id="codewind_for_eclipse" class="cw-sidebar-div cw-sidebar-submenu collapse" style="">
<a href="mdteclipseoverview.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Overview</span>
</div>
</a>
<a href="mdteclipsegettingstarted.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Installation and Getting Started</span>
</div>
</a>
<a href="mdteclipsemanagingprojects.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Managing Codewind projects</span>
</div>
</a>
<a href="mdteclipsebuildproject.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Building Codewind projects</span>
</div>
</a>
<a href="mdteclipsedebugproject.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Debugging Codewind projects</span>
</div>
</a>
<a href="mdteclipsetroubleshooting.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Troubleshooting</span>
</div>
</a>
<a href="mdteclipseuninstall.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Uninstalling</span>
</div>
</a>
</div>
<a href="#codewind_for_vscode" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Codewind for VS Code</span>
<span class="submenu-icon ml-auto"></span>
</div>
</a>
<div id="codewind_for_vscode" class="cw-sidebar-div cw-sidebar-submenu collapse" style="">
<a href="mdt-vsc-overview.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Overview</span>
</div>
</a>
<a href="mdt-vsc-getting-started.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Getting started</span>
</div>
</a>
<a href="mdt-vsc-tutorial.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Tutorial</span>
</div>
</a>
<a href="mdt-vsc-commands-overview.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Commands overview</span>
</div>
</a>
<a href="mdt-vsc-commands-project.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Project commands</span>
</div>
</a>
<a href="mdt-vsc-commands-restart-and-debug.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Restart and debug commands</span>
</div>
</a>
<a href="mdt-vsc-troubleshooting.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Troubleshooting</span>
</div>
</a>
<a href="mdt-vsc-uninstall.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Uninstalling</span>
</div>
</a>
</div>
<a href="#configuring_codewind" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Configuring Codewind</span>
<span class="submenu-icon ml-auto"></span>
</div>
</a>
<div id="configuring_codewind" class="cw-sidebar-div cw-sidebar-submenu collapse" style="">
<a href="usingadifferenttemplate"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Using a template repository of your own</span>
</div>
</a>
</div>
<a href="guide_performance.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Guide: Monitoring applications with the performance dashboard</span>
</div>
</a>
<a href="uninstall.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Uninstalling Codewind</span>
</div>
</a>
<a href="troubleshooting.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Troubleshooting</span>
</div>
</a>
<a href="limitations.html"
class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Limitations</span>
</div>
</a>
<!-- END hard coded TOC -->
<!-- Separator without title -->
<li class="list-group-item cw-sidebar-separator-title bg-light cw-text-gray d-flex align-items-center menu-collapsed">
<small class="badge badge-success cw-margin-auto">HELPFUL
LINKS</small>
</li>
<!-- /END Separator -->
<a href="https://projects.eclipse.org/proposals/eclipse-codewind" class="bg-light list-group-item list-group-item-action">
<div class="d-flex w-100 justify-content-start align-items-center">
<span class="menu-collapsed">Eclipse Codewind project page</span>
</div>
</a>
<!-- Logo -->
<li class="list-group-item cw-logo-separator bg-light d-flex justify-content-center">
<img src="images/header-logo.svg">
</li>
</ul>
<!-- List Group END-->
</div>
<!-- sidebar-container END -->
<!-- MAIN -->
<div id="content-container" class="py-5 px-5">
<div role="main"><!-- Eclipse Codewind proposal https://projects.eclipse.org/proposals/eclipse-codewind -->
<h1 id="introducing-eclipse-codewind">Introducing Eclipse Codewind</h1>
<p>Welcome to a technical preview of Eclipse Codewind, an evolution of Microclimate!</p>
<p>Our first Microclimate release was over a year ago now, and we’ve talked to customers about what’s important to them and learned how to build tools for cloud native applications. As a result of this experience we’ve taken stock and decided to go in a new direction.</p>
<p>Two of the major decisions we’ve made are to switch to the powerful <a href="https://www.eclipse.org/che/">Eclipse Che</a> for our cloud-hosted IDE and evolve our CI/CD pipeline to be based on <a href="https://tekton.dev">Tekton Pipelines</a>. However, today is special for another reason - an initial preview of how we expect our support for local IDEs to evolve.</p>
<p><img src="images/evolution.png" alt="Microclimate evolution" title="Microclimate evolution" width="100%" /></p>
<p>Developers expect high-quality open source tools to be available in their IDE of choice. To deliver on this, we’ve started putting the local Microclimate installation on a diet and contributed it to a new Eclipse project that we’ve helped to form: Eclipse Codewind. Today we’re happy to announce a first glimpse of what Codewind will look like. This preview shows the state of the codebase as it begins the move to Eclipse.</p>
<p>Why Eclipse? That’s easy - it’s because the Eclipse Foundation has a strong history and community around building vendor-agnostic developer tools. Eclipse also hosts two of the main IDEs that we plan to extend, making it a natural fit for Codewind.</p>
<p>The initial contribution for Codewind is coming from Microclimate. The Eclipse plug-in and Visual Studio Code extension are already open source and licensed under EPL 2. The common library that these depend on (a Docker container for now) has been relicensed under EPL 2 and is in the process of being legally cleared to release at Eclipse. All future releases of Codewind will come from the Eclipse codebase - we hope to see you there soon!</p>
<h2 id="limitations">Limitations</h2>
<p>This preview is only available to use on Apple Mac (macOS).</p>
<p>You must run a local installer (which installs almost 1 Gb of Docker containers - we’re working on it!) in addition to the IDE plug-in/extension.</p>
<p>Projects must be located in <code class="highlighter-rouge">&lt;user&gt;/microclimate-workspace</code>.</p>
<h2 id="prerequisites">Prerequisites</h2>
<ul>
<li>Docker</li>
<li>Git</li>
<li>VS Code or Eclipse</li>
<li>Either uninstall Microclimate or prevent the Microclimate images from running. For more information about uninstalling Microclimate, see <a href="https://microclimate.dev/uninstalllinuxmac">Uninstalling Microclimate on Linux or Mac/OS</a>.</li>
</ul>
<h2 id="installing-codewind">Installing Codewind</h2>
<h4 id="downloading-the-release-binary-on-macos">Downloading the release binary on MacOS</h4>
<ol>
<li>Download <a href="download/codewind" class="download-link trackdownload">codewind</a> to a folder on your system.</li>
<li>Make the <code class="highlighter-rouge">codewind</code> file usable with the <code class="highlighter-rouge">chmod +x codewind</code> command.</li>
<li>Enter the <code class="highlighter-rouge">./codewind install</code> command in the Terminal.</li>
<li>Run the <code class="highlighter-rouge">./codewind</code> command to see the available commands.</li>
</ol>
<h4 id="installing-the-vs-code-extension">Installing the VS Code extension</h4>
<ol>
<li>Install VS Code Version 1.27 or later.</li>
<li>Install the <a href="https://marketplace.visualstudio.com/items?itemName=IBM.codewind">Codewind VS Code extension</a> from the VS Code Marketplace or by searching for <code class="highlighter-rouge">Codewind</code> in the VS Code Extensions view.</li>
<li><strong>Optional:</strong> If you plan to work on Java projects, also install the Java Extension Pack.</li>
<li>After installing the extension, the Codewind view is available in the Explorer view and the Command Palette. In the VS Code Explorer view group, open the Codewind view, or enter <code class="highlighter-rouge">Focus on Codewind</code> into the Command Palette.</li>
</ol>
<h4 id="installing-the-eclipse-plug-in">Installing the Eclipse plug-in</h4>
<ol>
<li>Download and install the <a href="https://www.eclipse.org/downloads/packages/release/">latest Eclipse IDE for Java EE Developers</a> or use an existing installation. The earliest supported version of the Eclipse IDE is Version 2019-03 (4.11).</li>
<li>Obtain the plug-in in one of the following ways:
<ul>
<li><a href="http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=4638524" title="Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client"><img src="https://marketplace.eclipse.org/sites/all/themes/solstice/public/images/marketplace/btn-install.png" alt="Drag this install button to your running Eclipse workspace. Note: You need to have the Eclipse Marketplace Client." /></a> Drag this install button to your running Eclipse workspace. Note: You need to have the Eclipse Marketplace Client.</li>
<li>Open the <a href="https://marketplace.eclipse.org/content/codewind">Eclipse IDE</a> and go to <strong>Help</strong>&gt;<strong>Eclipse Marketplace</strong>. Then, search for <code class="highlighter-rouge">Codewind</code>. Click <strong>Install</strong> and finish the wizard and accept licenses as prompted.</li>
</ul>
</li>
<li>When the installation is complete, restart Eclipse.</li>
<li>Open the Codewind Explorer view. Go to <strong>Window</strong>&gt;<strong>Show View</strong>&gt;<strong>Other</strong> and type <code class="highlighter-rouge">Codewind</code> in the filter field.</li>
<li>Then, select <strong>Codewind Explorer</strong> and click <strong>Open</strong>.</li>
</ol>
<h2 id="getting-started">Getting started</h2>
<p>You can use Codewind to develop Node.js, Spring, and Liberty projects.</p>
<h4 id="getting-started-with-codewind-in-eclipse">Getting started with Codewind in Eclipse</h4>
<p><strong>Creating a project in Codewind</strong></p>
<ol>
<li>To create a project, right-click the <strong>Project Explorer</strong> view. When the menu appears, click <strong>New</strong>&gt;<strong>Project</strong>.</li>
<li>In the <strong>New Project</strong> window, click the <code class="highlighter-rouge">Codewind</code> folder and <strong>New Codewind Project</strong>.</li>
<li>Name your project, select a template, and click <strong>Finish</strong>.</li>
</ol>
<p><strong>Binding a project in Codewind</strong></p>
<ol>
<li>From the <strong>Project Explorer</strong> view, select a node. When the menu appears, click <strong>Codewind</strong>&gt;<strong>Add Project</strong>.</li>
<li>In the <strong>Add Project to Codewind</strong> window, select a langauge and, if applicable, a project type.</li>
<li>Click <strong>Finish</strong>. The project builds.</li>
</ol>
<h4 id="getting-started-with-codewind-in-vs-code">Getting started with Codewind in VS Code</h4>
<p>In the <code class="highlighter-rouge">README</code> file on the <code class="highlighter-rouge">codewind-vscode</code> repository, see the <a href="https://github.com/microclimate-dev2ops/codewind-vscode#how-to-use"><strong>How to use</strong></a> section to begin working with Codewind in VS Code.</p>
<h2 id="deactivating-codewind">Deactivating Codewind</h2>
<p>With Codewind, you have a single connection that is either active or inactive. To deactivate Codewind, click the <strong>Codewind (Local)</strong> menu and click <strong>Deactivate Connection</strong>.</p>
<h2 id="discovering-more">Discovering more</h2>
<p>For more information, see the <a href="http://codewind.dev">Eclipse Codewind site</a>. If you can’t find what you need, contact us in our <code class="highlighter-rouge">ibm-cloud-tech</code> <a href="https://ibm-cloud-tech.slack.com/messages/microclimate">Slack channel</a>! If you are new to Slack, you can <a href="https://slack-invite-ibm-cloud-tech.mybluemix.net/">create a user ID here</a>!</p>
</div>
</div>
</div>
<!-- Main Col END -->
<!-- footer row -->
<footer>
<div class="row" id="footer-div">
<div class="col-lg-3 col-md-3 footer-col text-center">
<div>
<div>
<a href="https://twitter.com/EclipseCodewind"><img src="images/twitter-logo.svg" class="cw-logo" /></a>
</div>
<div>@EclipseCodewind</div>
</div>
</div>
<div class="col-lg-3 col-md-3 footer-col text-center">
<div>
<div>
<a href="https://github.com/eclipse/codewind"><img src="images/github-logo.svg"
class="cw-logo" /></a>
</div>
<div>@Codewind</div>
</div>
</div>
<div class="col-lg-3 col-md-3 footer-col text-center">
<div>
<div>
<a href="mailto:codewind-dev@eclipse.org"><img src="images/email-icon.svg" class="cw-logo" /></a>
</div>
<div>@Codewind</div>
</div>
</div>
<div class="col-lg-3 col-md-3 footer-col text-center">
<div class="cw-logo-mm" >
<div class="cw-logo-mm" >
<a href="mailto:codewind-dev@eclipse.org"><img src="images/mattermost-logo.png" class="cw-logo-mm" /></a>
</div>
</div>
</div>
</div>
</footer>
<!-- footer row END --> <!-- Jquery -->
<script
src="https://code.jquery.com/jquery-3.4.1.min.js"
integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo="
crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js"
integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous">
</script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js"
integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous">
</script>
<!-- Font Awesome JS -->
<script defer src="https://use.fontawesome.com/releases/v5.0.13/js/solid.js"
integrity="sha384-tzzSw1/Vo+0N5UhStP3bvwWPq+uvzCMfrN1fEFe+xBmv1C/AtVX5K0uZtmcHitFZ" crossorigin="anonymous">
</script>
<script defer src="https://use.fontawesome.com/releases/v5.0.13/js/fontawesome.js"
integrity="sha384-6OIrr52G08NpOFSZdxxz1xdNSndlD4vdcf/q2myIUVO0VsqaGHJsB0RaBE01VTOY" crossorigin="anonymous">
</script>
<!-- Place this tag in your head or just before your close body tag. -->
<script async defer src="https://buttons.github.io/buttons.js"></script>
<script src="js/jquery.matchHeight-min.js"></script>
<script src="js/index.js"></script>
<script src="js/docs.js"></script>
</div>
</body>
</html>