| <!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 Codewind on the Cloud | 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 Codewind on the Cloud"> |
| <meta name="keywords" content="build, deploy, IBM Cloud Private, install, installing, installation, chart, Helm, develop, cloud, public cloud, services, command line, cli, command, start, ..."/> |
| <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="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">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"><h1 id="setting-up-a-codewind-ready-install-of-che">Setting up a Codewind-ready install of Che</h1> |
| |
| <p>To setup a Codewind-ready install of Che, follow these instructions. Alternatively, the install script at https://github.com/eclipse/codewind-che-plugin/tree/master/setup/install_che can be used instead.</p> |
| |
| <h1 id="table-of-contents">Table of Contents</h1> |
| <ol> |
| <li><a href="#prerequisites">Prerequisites</a></li> |
| <li><a href="#setting-up-okd-and-openshift">Setting up OKD and OpenShift</a></li> |
| <li><a href="#setting-up-other-kubernetes">Setting up other Kubernetes</a></li> |
| <li><a href="#after-installing-che">After installing Che</a></li> |
| <li><a href="#creating-the-codewind-workspace">Creating the Codewind workspace</a></li> |
| </ol> |
| |
| <h2 id="prerequisites">Prerequisites</h2> |
| <ul> |
| <li>Set up the PersistentVolume (PV) with either Network File System (NFS) or GlusterFS. |
| <ul> |
| <li>For NFS, if running on IBM Cloud Private, follow these instructions:<a href="https://www.ibm.com/developerworks/community/blogs/fe25b4ef-ea6a-4d86-a629-6f87ccf4649e/entry/Working_with_storage?lang=en">NFS Storage Install Instructions</a> and use 777 permissions for the folders.</li> |
| <li>You do not need to set up the PV for local Kube, such as Minikube, Minishift, Docker Desktop, and others.</li> |
| </ul> |
| </li> |
| <li>Set up the ClusterRole. |
| <ul> |
| <li><strong>Important:</strong> If you are running on OKD or OpenShift, install Che first and then set up the ClusterRole. |
| <ol> |
| <li>Clone the <a href="https://github.com/eclipse/codewind-che-plugin">Codewind Che plug-in repository</a></li> |
| <li>Enter the <code class="highlighter-rouge">cd</code> command to go to the <code class="highlighter-rouge">codewind-che-plugin</code> repository.</li> |
| <li>Log in to the IBM Cloud Private cluster and target cluster to the namespace that you are planning to install.</li> |
| <li>Run the <code class="highlighter-rouge">kubectl apply -f setup/install_che/codewind-clusterrole.yaml</code> command to create a cluster role with the required permission.</li> |
| <li>Next, run <code class="highlighter-rouge">kubectl apply -f setup/install_che/codewind-rolebinding.yaml</code> command.</li> |
| </ol> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| |
| <h2 id="setting-up-okd-and-openshift">Setting up OKD and OpenShift</h2> |
| |
| <h3 id="installing-che-with-deployment-scripts">Installing Che with deployment scripts</h3> |
| <ol> |
| <li>Git clone the <a href="https://github.com/eclipse/che">Eclipse Che repository</a>.</li> |
| <li>Enter the <code class="highlighter-rouge">cd</code> command to go to the <code class="highlighter-rouge">deploy/openshift</code> directory.</li> |
| <li>Deploy Che with <code class="highlighter-rouge">./deploy_che.sh</code>.</li> |
| <li>From the <a href="https://github.com/eclipse/codewind-che-plugin">Codewind Che plug-in repository</a> run the <code class="highlighter-rouge">kubectl apply -f setup/install_che/codewind-clusterrole.yaml</code> command to create a cluster role with the required permission.</li> |
| <li>From the <a href="https://github.com/eclipse/codewind-che-plugin">Codewind Che plug-in repository</a> run the <code class="highlighter-rouge">kubectl apply -f setup/install_che/codewind-rolebinding.yaml</code> command.</li> |
| </ol> |
| |
| <h3 id="enable-privileged-and-root-containers-to-run">Enable privileged and root containers to run</h3> |
| <p>Codewind is currently required to run as privileged (as it builds container images) and as root. Run the following commands to enable that functionality:</p> |
| <ol> |
| <li>Enter <code class="highlighter-rouge">oc adm policy add-scc-to-group privileged system:serviceaccounts:eclipse-che</code> to enable privileged containers</li> |
| <li>Enter <code class="highlighter-rouge">oc adm policy add-scc-to-group anyuid system:serviceaccounts:eclipse-che</code> to enable containers to run as root.</li> |
| </ol> |
| |
| <h2 id="setting-up-other-kubernetes">Setting up other Kubernetes</h2> |
| |
| <h3 id="ibm-cloud-private-set-the-clusterimagepolicy">IBM Cloud Private: Set the ClusterImagePolicy</h3> |
| <p>If you’re running on IBM Cloud Private, you must add the images that Che uses to the ClusterImagePolicy before deploying Che:</p> |
| <ol> |
| <li>Log in to the IBM Cloud Private cluster.</li> |
| <li>Run the <code class="highlighter-rouge">kubectl edit clusterimagepolicy</code> command. Then, add the following lines: |
| <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> - name: gcr.io/* |
| - name: docker.io/* |
| </code></pre></div> </div> |
| </li> |
| </ol> |
| |
| <h3 id="step-1-setting-up-the-che-helm-chart">Step 1: Setting up the Che Helm chart</h3> |
| <ol> |
| <li>Clone the <a href="https://github.com/eclipse/che">Che repository</a>.</li> |
| <li>Enter the <code class="highlighter-rouge">cd</code> command to go to the <code class="highlighter-rouge">deploy/kubernetes/helm/che</code> directory. Then, edit the <code class="highlighter-rouge">values.yaml</code> file. |
| <ul> |
| <li>Set up multiuser if you need the multiple users feature: <code class="highlighter-rouge">multiuser: true</code></li> |
| </ul> |
| </li> |
| </ol> |
| |
| <h3 id="step-2-installing-che-with-the-helm-chart">Step 2: Installing Che with the Helm chart</h3> |
| <p>Clone the <a href="https://github.com/eclipse/che">Che repository</a>.</p> |
| <ol> |
| <li>Enter the <code class="highlighter-rouge">cd</code> command to go to the <code class="highlighter-rouge">deploy/kubernetes/helm/che</code> directory.</li> |
| <li>Run the <code class="highlighter-rouge">helm dependency update</code> command.</li> |
| <li>Run the following command: |
| <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> helm upgrade --install che --namespace <ns> \ |
| --set cheImage=eclipse/che-server:7.0.0-RC-2.0 \ |
| --set global.ingressDomain=<cluster proxy ip>.nip.io \ |
| --set global.cheWorkspaceClusterRole=eclipse-codewind \ |
| --set global.cheWorkspacesNamespace=<ns> \ |
| --set che.workspace.devfileRegistryUrl="https://che-devfile-registry.openshift.io/" \ |
| --set che.workspace.pluginRegistryUrl="https://che-plugin-registry.openshift.io/v3" ./ |
| </code></pre></div> </div> |
| </li> |
| </ol> |
| |
| <p>Append the <code class="highlighter-rouge">--tls</code> flag if the tiller is configured with SSL in your Kubernetes cluster.</p> |
| |
| <h2 id="after-installing-che">After installing Che</h2> |
| |
| <h3 id="adding-registries-in-che">Adding registries in Che</h3> |
| <p>After Che is started and running, add the container registry that will be used with Codewind.</p> |
| <ul> |
| <li>On IBM Cloud Private, push your |
| to any Docker registry <em>except</em> the internal Docker registry</li> |
| <li>On OpenShift or other Kube platforms, you can push your images to any Docker registry, such as Dockerhub, Quay.io, Google Cloud Registry (GCR), and more.</li> |
| </ul> |
| |
| <p>Complete the following instructions to add the registries:</p> |
| <ul> |
| <li>Server: <code class="highlighter-rouge"><registry-to-push-images-to></code></li> |
| </ul> |
| |
| <p>For further information on adding deployment registries to Che, consult https://www.eclipse.org/codewind/dockerregistry.html</p> |
| |
| <h3 id="optional-hosting-a-devfile-for-creating-the-che-workspace-with-codewind">Optional: Hosting a Devfile for creating the Che workspace with Codewind</h3> |
| |
| <p>Skip this step if you are using the devfiles that Codewind provides by default. If you wish to host your own devfile, follow these instructions:</p> |
| |
| <ol> |
| <li>Clone the [Codewind Che plug-in repositoryhttps://github.com/eclipse/codewind-che-plugin).</li> |
| <li>Make your modifications as you see fit.</li> |
| <li>The <code class="highlighter-rouge">devfile.yaml</code> and <code class="highlighter-rouge">meta.yaml</code> files need to be hosted in a location that Che can access, such as Github.</li> |
| <li>In <code class="highlighter-rouge">devfile.yaml</code>, modify the <code class="highlighter-rouge">codewind-sidecar</code> and <code class="highlighter-rouge">codewind-theia</code> components so that their ID formats match. |
| For example, <code class="highlighter-rouge">https://raw.githubusercontent.com/eclipse/codewind-che-plugin/master/plugins/codewind/codewind-sidecar/0.2.0/meta.yaml |
| </code> and <code class="highlighter-rouge">https://raw.githubusercontent.com/eclipse/codewind-che-plugin/master/plugins/codewind/codewind-theia/0.2.0/meta.yaml |
| </code> host the <code class="highlighter-rouge">meta.yaml</code> files.</li> |
| </ol> |
| |
| <h2 id="creating-the-codewind-workspace">Creating the Codewind workspace</h2> |
| |
| <h3 id="confirm-the-docker-registry-secrets">Confirm the Docker registry secrets.</h3> |
| <p>Confirm that you added the docker registry secrets in the Che dashboard. Go to <strong>Administration</strong>><strong>Add Registry</strong> to check for the secrets.</p> |
| |
| <h3 id="creating-the-codewind-workspace-with-a-devfile">Creating the Codewind workspace with a Devfile</h3> |
| <p>The general format for creating a Che workspace via a factory is:</p> |
| <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>http://<che ingress domain>/f?url=<hosted devfile URL> |
| </code></pre></div></div> |
| |
| <p>We provide a ready to use devfile with some sample projects and the Codewind plugins. To create a workspace from it:</p> |
| <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>http://<che ingress domain>/f?url=https://raw.githubusercontent.com/eclipse/codewind-che-plugin/master/devfiles/0.2.0/devfile.yaml |
| </code></pre></div></div> |
| |
| <p>For other sample devfiles, see https://github.com/kabanero-io/codewind-templates/tree/master/devfiles</p> |
| |
| <h3 id="checking-for-the-codewind-pod">Checking for the Codewind pod</h3> |
| <ol> |
| <li>If you are using the Terminal, switch to use the workspace namespace. You can check for the namespace with <code class="highlighter-rouge">kubectl get ns</code>.</li> |
| <li>Ensure the projects are cloned into the workspace. You might need to refresh the browser to trigger the clone.</li> |
| </ol> |
| |
| <h2 id="after-installing-codewind">After installing Codewind</h2> |
| |
| <h3 id="setting-the-docker-registry">Setting the Docker registry</h3> |
| <p>Upon creating a Codewind workspace. The container registry to deploy your projects to must be set. When you go to create or add an existing project to Codewind, Codewind will prompt you for the registry. See (Docker registry docs) for guidance on using proper container registries</p> |
| |
| <p>If you would like to change the registry that’s used at any time, run the <code class="highlighter-rouge">Codewind: Set Deployment Registry</code> command in Theia to dynamically set a new registry for your workspace. <br /></p> |
| |
| <p><img src="dist/images/che-docs/SetDockerRegistry-1.png" alt="Set deployment registry" height="90px" width="623px" />. <br /></p> |
| |
| <p><img src="dist/images/che-docs/SetDockerRegistry-2.png" alt="Set deployment registry location" height="85px" width="633px" />. <br /></p> |
| |
| <p><img src="dist/images/che-docs/SetDockerRegistry-3.png" alt="Test deployment" height="208px" width="801px" />. <br /></p> |
| |
| <p><strong>Note:</strong> To proceed, you need to have added the registry credentials with Che.</p> |
| <ul> |
| <li>Codewind restarts with the changes added.</li> |
| </ul> |
| |
| <h2 id="using-codewind-from-the-che-theia-ide">Using Codewind from the Che Theia IDE</h2> |
| |
| <h3 id="binding-a-project">Binding a project:</h3> |
| <p>Go to <strong>View</strong>><strong>Find Command…</strong>><strong>Codewind: Add Project</strong>.</p> |
| |
| <ul> |
| <li>Alternative instructions: |
| <ul> |
| <li>From the sidecar container, run the following command: |
| <code class="highlighter-rouge">curl -k -H "Content-Type: application/json" -X POST https://codewind-release:9191/api/v1/projects/bind -d '{"name": "microproj", "path": "/microclimate-workspace/microproj", "language": "java", "projectType": "liberty"}'</code></li> |
| </ul> |
| </li> |
| </ul> |
| |
| <h3 id="checking-the-status-of-a-project">Checking the status of a project</h3> |
| <p>Go to <strong>View</strong>><strong>Find Command…</strong>><strong>Codewind: App status</strong>.</p> |
| |
| <ul> |
| <li>Alternative instructions: |
| <ul> |
| <li>From the sidecar container, run the following command: <code class="highlighter-rouge">curl -k -H "Content-Type: application/json" -X GET https://codewind-release:9191/api/v1/projects</code></li> |
| </ul> |
| </li> |
| </ul> |
| |
| <h3 id="building-a-project">Building a project </h3> |
| <p>Go to <strong>View</strong>><strong>Find Command…</strong>><strong>Codewind: Build</strong>.</p> |
| |
| <ul> |
| <li>Alternative instructions: |
| <ul> |
| <li>Enter the following command: <code class="highlighter-rouge">curl -k -H "Content-Type: application/json" -X POST https://codewind-release:9191/api/v1/projects/8801a6d0-7805-11e9-b22f-19482c5ffbd6/build -d '{"action": "build"}'</code></li> |
| </ul> |
| </li> |
| </ul> |
| </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> |
