| <!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>Getting Started: Tools for Eclipse | 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="Getting Started: Tools for Eclipse"> | |
| <meta name="keywords" content="introducing, introduction, overview, what is, tools, eclipse, getting started, Codewind for Eclipse, work within Eclipse"/> | |
| <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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| class="cw-current-page 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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" | |
| 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"><h1 id="getting-started-codewind-for-eclipse">Getting started: Codewind for Eclipse</h1> | |
| <p>Codewind for Eclipse enables you to develop and debug your containerized projects from within Eclipse (debug is only supported for Microprofile/Java EE, Spring, and Node.js projects).</p> | |
| <p>Complete the following steps to install Codewind for Eclipse:</p> | |
| <ol> | |
| <li>Download and install the latest <a href="https://www.eclipse.org/downloads/packages/release/">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>Install <a href="https://marketplace.eclipse.org/content/codewind">Codewind from Eclipse Marketplace</a>. | |
| <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 to your running Eclipse workspace. " /></a> Drag this install button to your running Eclipse workspace. Note: You need to have the Eclipse Marketplace Client.</li> | |
| <li>Or, if you want to install from the Eclipse IDE, complete the following steps: | |
| <ol> | |
| <li>Open the Eclipse IDE and navigate to <strong>Help</strong> > <strong>Eclipse Marketplace</strong>.</li> | |
| <li>Search for <em>Codewind</em>.</li> | |
| <li>Click the <strong>Install</strong> button.</li> | |
| <li>Finish the wizard and accept licenses as needed.</li> | |
| <li>When the installation is complete, restart Eclipse.</li> | |
| </ol> | |
| </li> | |
| </ul> | |
| </li> | |
| <li>Open the Codewind view. Navigate to <strong>Window</strong> > <strong>Show View</strong> > <strong>Other…</strong> > <strong>Codewind</strong> > <strong>Codewind Explorer</strong></li> | |
| <li>Codewind requires the installation of additional Docker images to run. Double-click on the <strong>Codewind</strong> item in the Codewind Explorer view to complete the installation. The installation may take a few minutes to complete.</li> | |
| <li>Codewind creates a folder called <code class="highlighter-rouge">codewind-workspace</code> within your home directory (<code class="highlighter-rouge">C:\codewind-workspace</code> on Windows) to contain your projects.</li> | |
| </ol> | |
| <p>You are now ready to use the tools. You can use the Codewind Explorer view to create new projects or add existing ones. Right-click an element in the Codewind Explorer to look at the features available.</p> | |
| <ol> | |
| <li>Create a new project or work with an existing project. | |
| <ul> | |
| <li>To create a new Codewind project, right-click the <em>Local Projects</em> item and select <strong>New Project</strong>. If you create a new project from within Eclipse, the new project is imported into the Eclipse workspace for you. | |
| <br /><img src="./dist/images/cdt-eclipse/cdt-eclipse-newproject.png" alt="Create a new project" /><br /></li> | |
| <li>To work with an existing project, right-click the <em>Local Projects</em> item and select <strong>Add Existing Project</strong>. Note that the project must already exist within the <code class="highlighter-rouge">codewind-workspace</code> folder, and have been added to the Eclipse workspace. | |
| <br /><img src="./dist/images/cdt-eclipse/cdt-eclipse-importproject.png" alt="Import your project" /><br /></li> | |
| </ul> | |
| </li> | |
| <li>Work with your project from within Eclipse including: | |
| <ul> | |
| <li>Editing</li> | |
| <li>Debugging</li> | |
| <li>Opening the application in a browser</li> | |
| <li>Viewing the logs</li> | |
| <li>Opening a shell into the application container</li> | |
| <li>And more | |
| <br /><img src="./dist/images/cdt-eclipse/cdt-eclipse-actions.png" alt="Work with your project" /><br /></li> | |
| </ul> | |
| </li> | |
| </ol> | |
| </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> |