| <!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>Installing Eclipse Che for Codewind | 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="Installing Eclipse Che for Codewind"> |
| <meta name="keywords" content="build, deploy, install, installing, installation, chart, Helm, develop, cloud, public cloud, services, command line, cli, command, start, stop, update, open,..."/> |
| <link rel="icon" type="image/png" sizes="16x16" href="images/favicon/favicon-16x16.png"> |
| <link rel="icon" type="image/png" sizes="32x32" href="images/favicon/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"> |
| <link rel="stylesheet" href="css/blog.css"> |
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.17.1/themes/prism.min.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" aria-label="topnav"> |
| <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 alt="Codewind logo image" title="Codewind logo image" src="images/header/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-docs"> |
| <a class="nav-link cw-nav-link cw-header-link-text" href="gettingstarted.html">Docs</a> |
| </li> |
| <li class="nav-item cw-navbar-item cw-header-link-news"> |
| <a class="nav-link cw-nav-link cw-header-link-text" href="news.html">News</a> |
| </li> |
| |
| <li class="nav-item cw-navbar-item cw-header-link-news"> |
| <a class="nav-link cw-nav-link cw-header-link-text" href="blog.html">Blog</a> |
| </li> |
| |
| <li class="nav-item cw-navbar-item cw-header-link"> |
| <a class="nav-link cw-nav-link" href="https://github.com/eclipse/codewind"><img alt="Codewind Github" class="banner-image" title="Codewind Github" data-toggle="tooltip" data-placement="top" id="cw_github_stars" title="..." src="images/header/github.svg"/></a> |
| </li> |
| |
| <li class="nav-item cw-navbar-item cw-header-link"> |
| <a class="nav-link cw-nav-link" href="https://twitter.com/EclipseCodewind"><img alt="Codewind Twitter" class="banner-image" title="Codewind Twitter" src="images/header/twitter.png"/></a> |
| </li> |
| <li class="nav-item cw-navbar-item cw-header-link"> |
| <a class="nav-link cw-nav-link" href="https://mattermost.eclipse.org/eclipse/channels/eclipse-codewind"><img alt="Codewind Mattermost" class="banner-image" title="Codewind Mattermost" src="images/header/mattermost.png"/></a> |
| </li> |
| <li class="nav-item cw-navbar-item cw-header-link"> |
| <a class="nav-link cw-nav-link" href="https://www.youtube.com/channel/UCnKCVK6RFDyHFqUmXlAhCHQ"><img alt="Codewind YouTube" class="banner-image" title="Codewind YouTube" src="images/header/youtube.png"/></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> --> |
| |
| |
| |
| <!-- Smaller devices menu END --> |
| |
| </ul> |
| </div> |
| |
| </nav> |
| <!-- End Bootstrap NavBar --> |
| <!-- Bootstrap row --> |
| <div class="row" id="body-row"> |
| <!-- Sidebar --> |
| <div id="sidebar-container" class="bg-light" role="navigation" aria-label="sidebar"> |
| <!-- Bootstrap List Group --> |
| <ul class="list-group sticky-top bg-light cw-sticky-offset"> |
| |
| <!-- Start single page getting started --> |
| |
| |
| |
| |
| |
| <a href="overview.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| What is Codewind? |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="#getting_started" data-url="gettingstarted.html" 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">Getting started</span> |
| <span class="submenu-icon"></span> |
| </div> |
| </a> |
| |
| <div id="getting_started" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="#vs_code" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| VS Code |
| <span class="submenu-icon"></span> |
| </a> |
| |
| <!-- 3d level - eclipse --> |
| <div id="vs_code" class="cw-sidebar-div cw-sidebar-submenu-submenu collapse" style=""> |
| |
| |
| |
| |
| |
| <a href="vsc-getting-started.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Installing Codewind for VS Code |
| </a> |
| |
| |
| |
| <a href="vsc-firstproject.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Creating your first VS Code Codewind project |
| </a> |
| |
| |
| |
| <a href="vsc-codechange.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Making a code change with VS Code |
| </a> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="#eclipse" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| Eclipse |
| <span class="submenu-icon"></span> |
| </a> |
| |
| <!-- 3d level - eclipse --> |
| <div id="eclipse" class="cw-sidebar-div cw-sidebar-submenu-submenu collapse" style=""> |
| |
| |
| |
| |
| |
| <a href="eclipse-getting-started.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Installing Codewind for Eclipse |
| </a> |
| |
| |
| |
| <a href="eclipse-firstproject.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Creating your first Eclipse Codewind project |
| </a> |
| |
| |
| |
| <a href="eclipse-codechange.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Making a code change with Eclipse |
| </a> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="#eclipse_che" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| Eclipse Che |
| <span class="submenu-icon"></span> |
| </a> |
| |
| <!-- 3d level - eclipse --> |
| <div id="eclipse_che" class="cw-sidebar-div cw-sidebar-submenu-submenu collapse" style=""> |
| |
| |
| |
| |
| |
| <a href="che-installinfo.html" |
| |
| |
| |
| class="cw-current-page bg-light list-group-item list-group-item-action"> |
| Installing Eclipse Che for Codewind |
| </a> |
| |
| |
| |
| <a href="che-setupregistries.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Adding an image registry in Codewind in Che |
| </a> |
| |
| |
| |
| <a href="che-createcodewindworkspace.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Creating a Codewind workspace in Che |
| </a> |
| |
| |
| |
| <a href="che-createfirstproject.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Creating your first project with Codewind for Eclipse Che |
| </a> |
| |
| |
| |
| <a href="che-tektonpipelines.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Configuring Codewind for Tekton pipelines |
| </a> |
| |
| |
| |
| <a href="che-odo-support.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| OpenShift Do (odo) support in Codewind |
| </a> |
| |
| |
| |
| <a href="openshiftregistry.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Adding the OpenShift internal registry with Codewind |
| </a> |
| |
| |
| |
| <a href="che-uninstall.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Uninstalling Codewind for Eclipse Che |
| </a> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="#intellij" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| IntelliJ |
| <span class="submenu-icon"></span> |
| </a> |
| |
| <!-- 3d level - eclipse --> |
| <div id="intellij" class="cw-sidebar-div cw-sidebar-submenu-submenu collapse" style=""> |
| |
| |
| |
| |
| |
| <a href="intellij-getting-started.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Installing Codewind for IntelliJ |
| </a> |
| |
| |
| |
| <a href="intellij-firstproject.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Creating your first IntelliJ Codewind project |
| </a> |
| |
| |
| |
| <a href="intellij-codechange.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Making a code change with IntelliJ |
| </a> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| |
| |
| |
| |
| <a href="remote-deploying-codewind.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Deploying Codewind remotely |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="#using_codewind_remotely" data-url="" 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">Using Codewind remotely</span> |
| <span class="submenu-icon"></span> |
| </div> |
| </a> |
| |
| <div id="using_codewind_remotely" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| |
| |
| |
| <a href="remote-codewind-overview.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Overview: Using Codewind remotely |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="#connecting_your_ide_to_remote_codewind" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| Connecting your IDE to remote Codewind |
| <span class="submenu-icon"></span> |
| </a> |
| |
| <!-- 3d level - eclipse --> |
| <div id="connecting_your_ide_to_remote_codewind" class="cw-sidebar-div cw-sidebar-submenu-submenu collapse" style=""> |
| |
| |
| |
| |
| |
| <a href="remotedeploy-vscode.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Connecting VS Code to remote Codewind |
| </a> |
| |
| |
| |
| <a href="remotedeploy-eclipse.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Connecting Eclipse to remote Codewind |
| </a> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="remote-setupregistries.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Adding an image registry in remote Codewind |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <a href="remotedeploy-projects-vscode.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Creating and importing projects |
| </a> |
| |
| |
| |
| |
| |
| </div> |
| |
| |
| |
| |
| <a href="workingwithtemplates.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Working with templates |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="#developing_projects" data-url="" 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">Developing projects</span> |
| <span class="submenu-icon"></span> |
| </div> |
| </a> |
| |
| <div id="developing_projects" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| |
| |
| |
| <a href="checkingstatuses.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Understanding application and build statuses |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <a href="importing-existing-projects.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Importing existing projects |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <a href="project-actions.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Project actions |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <a href="project-settings.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Project settings |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <a href="referencing-files.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Referencing files external to a project |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <a href="private-registries.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Developing with packages from private registries and repositories |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <a href="offline-codewind.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Using Codewind offline |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <a href="debugging.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Debugging in Codewind |
| </a> |
| |
| |
| |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="#performance_monitoring" data-url="" 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">Performance monitoring</span> |
| <span class="submenu-icon"></span> |
| </div> |
| </a> |
| |
| <div id="performance_monitoring" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| |
| |
| |
| <a href="metrics-dashboard.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Understanding the Metrics Dashboard |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <a href="performance.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Monitoring applications with the Performance Dashboard |
| </a> |
| |
| |
| |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="#openapi_tools" data-url="" 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">OpenAPI Tools</span> |
| <span class="submenu-icon"></span> |
| </div> |
| </a> |
| |
| <div id="openapi_tools" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| |
| |
| |
| <a href="open-api-tools-for-vscode.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Codewind OpenAPI Tools for VS Code |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <a href="open-api-tools-for-eclipse.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Codewind OpenAPI Tools for Eclipse |
| </a> |
| |
| |
| |
| |
| |
| </div> |
| |
| |
| |
| |
| <a href="troubleshooting.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Troubleshooting |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| </ul> |
| <!-- List Group END--> |
| </div> |
| <!-- sidebar-container END --> |
| <!-- MAIN --> |
| <div id="content-container"> |
| <div class="py-5 px-5"> |
| <div class="cw-docs-spacer"></div> |
| <div role="main"><h1 id="installing-eclipse-che-for-codewind">Installing Eclipse Che for Codewind</h1> |
| |
| <p>Install Che to use with Codewind or prepare to use Codewind with an existing Che installation.</p> |
| |
| <h2 id="prerequisites">Prerequisites</h2> |
| |
| <ol> |
| <li>Set up PersistentVolumes (PVs) that support both <code class="highlighter-rouge">ReadWriteOnce</code> (RWO) and <code class="highlighter-rouge">ReadWriteMany</code> (RWX) access modes and each have a minimum of 5 Gi storage. |
| <ul> |
| <li>One volume is required for Che, and two volumes are required for each Codewind workspace.</li> |
| <li>For Network File System (NFS) shares, set 777 permissions for the exported folders and ownership of <code class="highlighter-rouge">nobody:nogroup</code>.</li> |
| <li>Because Codewind uses <code class="highlighter-rouge">ReadWriteMany</code> (RWX) volumes to provide persistent storage, use NFS for storage on OpenShift 4.</li> |
| </ul> |
| </li> |
| <li>Ensure that the cluster can pull images from the <code class="highlighter-rouge">docker.io/eclipse</code> and <code class="highlighter-rouge">quay.io/eclipse</code> registries. |
| <ul> |
| <li>Both Eclipse Che and Eclipse Codewind host Docker images at these locations.</li> |
| <li>Many clusters have image policies that control which registries you can use to pull images. Check your cluster documentation and ensure that the cluster image pull policies permit both of these registries.</li> |
| </ul> |
| </li> |
| <li>Set up the ClusterRole for Codewind: |
| <code class="highlighter-rouge">kubectl apply -f https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.11.0/setup/install_che/codewind-clusterrole.yaml</code></li> |
| </ol> |
| |
| <h2 id="installing-che-with-chectl">Installing Che with chectl</h2> |
| |
| <p>Install Eclipse Che with HTTPS so that Codewind functions properly. See the <a href="#installing-che">Installing Che</a> section to set up Eclipse Che with TLS certificates.</p> |
| |
| <h3 id="installing-che">Installing Che</h3> |
| <p>The fastest way to install Eclipse Che for Codewind is to use the <code class="highlighter-rouge">chectl</code> CLI. To install the <code class="highlighter-rouge">chectl</code> CLI tool, see <a href="https://www.eclipse.org/che/docs/che-7/installing-the-chectl-management-tool/">Installing the chectl management tool</a>.</p> |
| |
| <p>After you install <code class="highlighter-rouge">chectl</code>, download the <a href="https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.11.0/setup/install_che/che-operator/codewind-checluster.yaml">codewind-checluster.yaml</a> file.</p> |
| <ul> |
| <li>You can modify this file, but leave the <code class="highlighter-rouge">spec.server.cheWorkspaceClusterRole</code> field set to <code class="highlighter-rouge">eclipse-codewind</code> and the <code class="highlighter-rouge">spec.storage.preCreateSubPaths</code> field set to <code class="highlighter-rouge">true</code>.</li> |
| </ul> |
| |
| <p><strong>Installing on OpenShift:</strong></p> |
| |
| <p>Eclipse Che on OpenShift makes use of the router’s existing certificates. |
| Run the following command to install Che on OpenShift with <code class="highlighter-rouge">chectl</code>:</p> |
| <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> $ chectl server:start --platform=openshift --installer=operator --che-operator-cr-yaml=codewind-checluster.yaml --che-operator-image=quay.io/eclipse/che-operator:7.9.2 |
| </code></pre></div></div> |
| |
| <p><strong>Installing on Kubernetes:</strong></p> |
| |
| <ol> |
| <li>Create the <code class="highlighter-rouge">che</code> namespace if it doesn’t already exist: <code class="highlighter-rouge">kubectl create namespace che</code>.</li> |
| <li>Determine your Ingress domain. |
| <ul> |
| <li>Set the <code class="highlighter-rouge">spec.server.ingressDomain</code> field in the Che <code class="highlighter-rouge">.yaml</code> file to the Ingress domain.</li> |
| <li>If you’re unsure of your Ingress domain, ask your cluster administrator.</li> |
| </ul> |
| </li> |
| <li>Generate TLS certificates and keys. For more information, see <a href="https://www.eclipse.org/che/docs/che-7/setup-che-in-tls-mode-with-self-signed-certificate/#generating-self-signed-certificates_setup-che-in-tls-mode-with-self-signed-certificate">Generating self-signed TLS certificates</a>.</li> |
| <li>Generate a Kubernetes secret containing the TLS secret and key you generated in the previous set: |
| <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ kubectl create secret tls che-tls --key=domain.key --cert=domain.crt -n che |
| </code></pre></div> </div> |
| </li> |
| <li>Generate a Kubernetes secret containing the certificate you generated in step 2: |
| <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ cp rootCA.crt ca.crt |
| $ kubectl create secret generic self-signed-certificate --from-file=ca.crt -n che |
| </code></pre></div> </div> |
| </li> |
| <li>In the <code class="highlighter-rouge">codewind-checluster.yaml</code> file, set <code class="highlighter-rouge">tlsSecretName: 'che-tls'</code></li> |
| <li>Run the following command to install Che: |
| <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ chectl server:start --platform=k8s --installer=operator --domain=<ingress-domain> --che-operator-cr-yaml=codewind-checluster.yaml --che-operator-image=quay.io/eclipse/che-operator:7.9.2 |
| </code></pre></div> </div> |
| </li> |
| </ol> |
| |
| <h2 id="updating-an-existing-che-installation">Updating an existing Che installation</h2> |
| |
| <p>If you already have a Che installation with TLS, you can update it for Codewind.</p> |
| |
| <p>Run the following command, where <code class="highlighter-rouge">$NAMESPACE</code> is the namespace that your Che workspaces run in. By default, this namespace is <code class="highlighter-rouge">che</code>.</p> |
| <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ kubectl apply -f https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.11.0/setup/install_che/codewind-clusterrole.yaml -n $NAMESPACE |
| </code></pre></div></div> |
| |
| <h2 id="adding-certificates-for-che-to-your-browser">Adding certificates for Che to your browser</h2> |
| |
| <p><strong>Note</strong>: If you configured Eclipse Che with self-signed certificates, you need to add the <code class="highlighter-rouge">ca.crt</code> for Eclipse Che to your browser. Examples of configuring Che with self-signed certificates include the following examples:</p> |
| <ul> |
| <li>Completing the previous steps for Kubernetes</li> |
| <li>Installing Che on an OpenShift cluster with self-signed-certificates</li> |
| </ul> |
| |
| <p>The following steps for adding certificates are not necessary if you installed Che with publicly signed certificates, such as on OpenShift on IBM Cloud.</p> |
| |
| <h3 id="download-the-openshift-router-cacrt">Download the OpenShift router ca.crt</h3> |
| <p>If running on OpenShift with self-signed certificates, follow these instructions:</p> |
| |
| <ol> |
| <li>Authenticate against your OpenShift cluster, or ask your cluster administrator to do so.</li> |
| <li>Run the following command to download the router’s <code class="highlighter-rouge">ca.crt</code>: |
| <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>$ oc get secret router-ca -n openshift-ingress-operator -o jsonpath="{.data.tls\.crt}" | base64 -d > rootCa.crt |
| </code></pre></div> </div> |
| </li> |
| </ol> |
| |
| <h3 id="adding-the-cacrt-to-google-chrome">Adding the ca.crt to Google Chrome</h3> |
| |
| <p>On macOS, follow these steps:</p> |
| |
| <ol> |
| <li>Open <strong>Keychain Access</strong> and click <strong>File</strong>><strong>Import items</strong>.</li> |
| <li>Locate the <code class="highlighter-rouge">rootCa.crt</code> that you downloaded and import it.</li> |
| <li>Find and click the certificate in Keychain.</li> |
| <li>In the window that opens, expand the <strong>Trust section</strong>. Under <strong>When using this certificate</strong>, select <strong>Always trust</strong>. Click <strong>save</strong>.</li> |
| <li>Reload Eclipse Che in your browser.</li> |
| </ol> |
| |
| <p>On Windows, follow these steps:</p> |
| |
| <ol> |
| <li>Open Google Chrome preferences, select <strong>Privacy and Security</strong>, and click <strong>Manage Certificates</strong>.</li> |
| <li>In the window that appears, click the <strong>Trusted Root Certificate Authorities</strong> tab.</li> |
| <li>Locate the <code class="highlighter-rouge">rootCa.crt</code> that you downloaded and import it.</li> |
| <li>Restart Google Chrome and access the Eclipse Che URL.</li> |
| </ol> |
| |
| <h3 id="adding-the-cacrt-to-firefox">Adding the ca.crt to Firefox</h3> |
| |
| <ol> |
| <li>Go to <strong>Preferences</strong>><strong>Privacy and Security</strong>><strong>View certificates</strong>.</li> |
| <li>Click <strong>Authorities</strong> and click <strong>Import</strong>.</li> |
| <li>Locate the <code class="highlighter-rouge">rootCa.crt</code> that you downloaded and import it.</li> |
| <li>Reload Eclipse Che in your browser.</li> |
| </ol> |
| |
| <h2 id="enabling-privileged-and-root-containers-to-run">Enabling privileged and root containers to run</h2> |
| |
| <p>Codewind needs to run as privileged and as root because it builds container images. If your cluster is running OpenShift, run the following commands, where <code class="highlighter-rouge"><che namespace></code> is the namespace into which you installed Che.</p> |
| <ol> |
| <li>To enable privileged containers, enter <code class="highlighter-rouge">oc adm policy add-scc-to-user privileged system:serviceaccount:<che namespace>:che-workspace</code>.</li> |
| <li>To enable containers to run as root, enter <code class="highlighter-rouge">oc adm policy add-scc-to-user anyuid system:serviceaccount:<che namespace>:che-workspace</code>.</li> |
| </ol> |
| |
| <p>Next step: <a href="che-createcodewindworkspace.html">Adding registries in Che</a></p> |
| </div> |
| </div> |
| |
| |
| <div class="py-5 px-5 text-right"> |
| Last update: Apr 06, 2020 |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <!-- footer row --> |
| <footer> |
| |
| <div id="footer-div-mobile"> |
| |
| <div class="row"> |
| <div class="col-sm-12 text-center"> |
| <span>Useful Links:</span> |
| <br/><br/> |
| <a class="cw-footer-links" href="http://www.eclipse.org">Eclipse Foundation</a><br/> |
| <a class="cw-footer-links" href="http://www.eclipse.org/legal/privacy.php">Privacy Policy</a><br/> |
| <a class="cw-footer-links" href="http://www.eclipse.org/legal/termsofuse.php">Website Terms of Use</a><br/> |
| <a class="cw-footer-links" href="http://www.eclipse.org/legal/copyright.php">Copyright Agent</a><br/> |
| <a class="cw-footer-links" href="http://www.eclipse.org/legal">Legal</a><br/> |
| </div> |
| </div> |
| <div class="cw_footer_display_flex cw-footer-same-height cw-footer-center"> |
| |
| <div class="cw_footer_display_icons row"> |
| <div class="cw-footer-col text-center col-md-3 col-sm-6 col-xs-12"> |
| <div> |
| <div> |
| <a href="mailto:codewind-dev@eclipse.org"><img alt="Send us an email" title="Send us an email" src="images/footer/email-icon.svg" class="cw-logo" /></a> |
| </div> |
| </div> |
| </div> |
| <div class="cw-footer-col text-center col-md-3 col-sm-6 col-xs-12"> |
| <div> |
| <div> |
| <a href="https://twitter.com/EclipseCodewind"><img alt="Codewind Twitter" title="Codewind Twitter" src="images/footer/twitter-logo.svg" class="cw-logo" /></a> |
| </div> |
| </div> |
| </div> |
| |
| <div class="cw-footer-col text-center col-md-3 col-sm-6 col-xs-12"> |
| <div> |
| <div> |
| <a href="https://github.com/eclipse/codewind"><img alt="Codewind Github" title="Codewind Github" src="images/footer/github-logo.svg" |
| class="cw-logo" /></a> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div class=" cw-footer-col text-center col-md-3 col-sm-6 col-xs-12"> |
| <div> |
| <div> |
| <a href="https://mattermost.eclipse.org/eclipse/channels/eclipse-codewind"><img alt="Codewind Mattermost" title="Codewind Mattermost" src="images/footer/mattermost-logo.png" class="cw-logo-mm" /></a> |
| </div> |
| </div> |
| </div> |
| <div class="cw-footer-col text-center col-md-3 col-sm-6 col-xs-12"> |
| <div> |
| <div> |
| <a href="https://www.youtube.com/channel/UCnKCVK6RFDyHFqUmXlAhCHQ"><img alt="Codewind YouTube" title="Codewind YouTube" src="images/footer/youtube-logo-dark.svg" |
| class="cw-logo" /></a> |
| </div> |
| </div> |
| </div> |
| <div class="cw-footer-col text-center col-md-3 col-sm-6 col-xs-12"> |
| <div> |
| <div> |
| |
| <a href="http://www.eclipse.org"><img class="cw-logo-eclipse-mobile" alt="Eclipse" title="Eclipse" src="images/footer/eclipse.svg"/></a> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <div class="row cw-footer-desktop" id="footer-div"> |
| <div class="cw-footer-left"> |
| <div class="px-5 cw-font-12> |
| <span class="cw-font-14">Useful Links:</span> |
| <br/><br/> |
| <a class="cw-footer-links" href="http://www.eclipse.org">Eclipse Foundation</a><br/> |
| <a class="cw-footer-links" href="http://www.eclipse.org/legal/privacy.php">Privacy Policy</a><br/> |
| <a class="cw-footer-links" href="http://www.eclipse.org/legal/termsofuse.php">Website Terms of Use</a><br/> |
| <a class="cw-footer-links" href="http://www.eclipse.org/legal/copyright.php">Copyright Agent</a><br/> |
| <a class="cw-footer-links" href="http://www.eclipse.org/legal">Legal</a><br/> |
| </div> |
| |
| </div> |
| <div class="cw-footer-border-right"></div> |
| <div class="cw_footer_display_flex cw-footer-same-height cw-footer-center"> |
| <div class="cw_footer_display_icons"> |
| <div class="cw-footer-col text-center"> |
| <div> |
| <div> |
| <a href="mailto:codewind-dev@eclipse.org"><img alt="Send us an email" title="Send us an email" src="images/footer/email-icon.svg" class="cw-logo" /></a> |
| </div> |
| </div> |
| </div> |
| <div class="cw-footer-col text-center"> |
| <div> |
| <div> |
| <a href="https://twitter.com/EclipseCodewind"><img alt="Codewind Twitter" title="Codewind Twitter" src="images/footer/twitter-logo.svg" class="cw-logo" /></a> |
| </div> |
| </div> |
| </div> |
| |
| <div class="cw-footer-col text-center"> |
| <div> |
| <div> |
| <a href="https://github.com/eclipse/codewind"><img alt="Codewind Github" title="Codewind Github" src="images/footer/github-logo.svg" |
| class="cw-logo" /></a> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div class=" cw-footer-col text-center"> |
| <div class="cw-logo-mm" > |
| <div class="cw-logo-mm" > |
| <a href="https://mattermost.eclipse.org/eclipse/channels/eclipse-codewind"><img alt="Codewind Mattermost" title="Codewind Mattermost" src="images/footer/mattermost-logo.png" class="cw-logo-mm" /></a> |
| </div> |
| </div> |
| </div> |
| <div class="cw-footer-col text-center"> |
| <div> |
| <div> |
| <a href="https://www.youtube.com/channel/UCnKCVK6RFDyHFqUmXlAhCHQ"><img alt="Codewind YouTube" title="Codewind YouTube" src="images/footer/youtube-logo-dark.svg" |
| class="cw-logo" /></a> |
| </div> |
| </div> |
| </div> |
| |
| </div> |
| |
| </div> |
| <div class="cw-footer-border-right"></div> |
| <div class="cw-footer-right cw-footer-same-height cw-footer-vcenter"> |
| <div class="cw-footer-eclipse-img cw-footer-same-height px-5 "> |
| |
| <a href="http://www.eclipse.org"> |
| <img alt="Eclipse" title="Eclipse" src="images/footer/eclipse.svg"/> |
| </a> |
| </div> |
| </div> |
| </div> |
| </footer> |
| <!-- footer row END --> |
| <!-- Main Col 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> |
| |
| <script src="js/jquery.matchHeight-min.js"></script> |
| <script src="js/index.js"></script> |
| <script src="js/docs.js"></script> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.17.1/prism.min.js"></script> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.17.1/components/prism-docker.min.js"></script> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.17.1/components/prism-json.min.js"></script> |
| |
| </div> |
| </body> |
| |
| </html> |
| |
| |
| |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.0/anchor.min.js"></script> |
| <script> |
| $(document).ready(function(){ |
| |
| anchors.options.placement = 'left'; |
| anchors.add('h1'); |
| anchors.add('h2'); |
| anchors.add('h3'); |
| anchors.add('h4'); |
| }); |
| </script> |
| |
