| <!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>Configuring your remote deployment of 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="Configuring your environment to use your remote deployment of Codewind"> |
| <meta name="keywords" content="users, projects, Kubernetes, LDAP, user management, access management, login, deployment, pod, security, securing cloud connection"/> |
| <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"> |
| <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-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="https://medium.com/codewind">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="github icon" class="banner-image" title="github icon" data-toggle="tooltip" data-placement="top" id="cw_github_stars" title="..." src="images/banner/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="twitter icon" class="banner-image" title="twitter icon" src="images/banner/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="mattermost icon" class="banner-image" title="mattermost icon" src="images/banner/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="youtube icon" class="banner-image" title="youtube icon" src="images/banner/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="gettingstarted.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Getting started |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="#developing_with_codewind" 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 with Codewind</span> |
| <span class="submenu-icon"></span> |
| </div> |
| </a> |
| |
| <div id="developing_with_codewind" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <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"> |
| Codewind for Eclipse |
| <span class="submenu-icon"></span> |
| </a> |
| |
| <!-- 3d level - eclipse --> |
| <div id="codewind_for_eclipse" class="cw-sidebar-div cw-sidebar-submenu-submenu collapse" style=""> |
| |
| |
| |
| |
| |
| <a href="mdteclipseoverview.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Overview |
| </a> |
| |
| |
| |
| <a href="mdt-eclipse-installinfo.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Installing Codewind for Eclipse |
| </a> |
| |
| |
| |
| <a href="mdteclipseworkingwithtemplates.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Working with templates |
| </a> |
| |
| |
| |
| <a href="mdteclipseimportedprojects.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Adding existing projects |
| </a> |
| |
| |
| |
| <a href="mdteclipsemanagingprojects.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Managing Codewind projects |
| </a> |
| |
| |
| |
| <a href="mdteclipsebuildproject.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Building Codewind projects |
| </a> |
| |
| |
| |
| <a href="mdteclipsedebugproject.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Debugging Codewind projects |
| </a> |
| |
| |
| |
| <a href="mdteclipsetroubleshooting.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Troubleshooting Codewind for Eclipse |
| </a> |
| |
| |
| |
| <a href="mdteclipseuninstall.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Uninstalling Codewind for Eclipse |
| </a> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="#codewind_for_vs_code" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| Codewind for VS Code |
| <span class="submenu-icon"></span> |
| </a> |
| |
| <!-- 3d level - eclipse --> |
| <div id="codewind_for_vs_code" class="cw-sidebar-div cw-sidebar-submenu-submenu collapse" style=""> |
| |
| |
| |
| |
| |
| <a href="mdt-vsc-overview.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Overview |
| </a> |
| |
| |
| |
| <a href="mdt-vsc-installinfo.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Installing Codewind for VS Code |
| </a> |
| |
| |
| |
| <a href="mdt-vsc-workingwithtemplates.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Working with templates |
| </a> |
| |
| |
| |
| <a href="mdt-vsc-importedprojects.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Adding existing projects |
| </a> |
| |
| |
| |
| <a href="mdt-vsc-tutorial.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Tutorial |
| </a> |
| |
| |
| |
| <a href="mdt-vsc-commands-overview.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Commands overview |
| </a> |
| |
| |
| |
| <a href="mdt-vsc-commands-project.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Project commands |
| </a> |
| |
| |
| |
| <a href="mdt-vsc-commands-restart-and-debug.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Restart and debug commands |
| </a> |
| |
| |
| |
| <a href="mdt-vsc-nodejsprofiling.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Installing and running the Codewind language server for Node.js profiling |
| </a> |
| |
| |
| |
| <a href="mdt-vsc-troubleshooting.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Troubleshooting |
| </a> |
| |
| |
| |
| <a href="mdt-vsc-uninstall.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Uninstalling Codewind for VS Code |
| </a> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="#codewind_for_eclipse_che" data-toggle="collapse" aria-expanded="false" class="bg-light list-group-item list-group-item-action flex-column align-items-start collapsed"> |
| Codewind for Eclipse Che |
| <span class="submenu-icon"></span> |
| </a> |
| |
| <!-- 3d level - eclipse --> |
| <div id="codewind_for_eclipse_che" class="cw-sidebar-div cw-sidebar-submenu-submenu collapse" style=""> |
| |
| |
| |
| |
| |
| <a href="mdt-che-overview.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Overview |
| </a> |
| |
| |
| |
| <a href="mdt-che-installinfo.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Installing Codewind for Eclipse Che |
| </a> |
| |
| |
| |
| <a href="mdt-che-odo-support.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| OpenShift Do (odo) support in Codewind |
| </a> |
| |
| |
| |
| <a href="image-registry-credentials.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Docker Registry Guidance |
| </a> |
| |
| |
| |
| <a href="openshiftregistry.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Using the OpenShift Registry |
| </a> |
| |
| |
| |
| <a href="supportingmultipleusers.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Support for multiple users |
| </a> |
| |
| |
| |
| <a href="viewkibanalogs.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Installing Kibana and filtering logs in IBM Cloud Private |
| </a> |
| |
| |
| |
| <a href="mdt-che-uninstall.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Uninstalling Codewind for Eclipse Che |
| </a> |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="#deploying_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">Deploying Codewind remotely</span> |
| <span class="submenu-icon"></span> |
| </div> |
| </a> |
| |
| <div id="deploying_codewind_remotely" class="cw-sidebar-div cw-sidebar-submenu collapse" style=""> |
| |
| |
| |
| <a href="remoteoverview.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Overview |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <a href="remoteconfiguring.html" |
| |
| |
| |
| |
| class="cw-current-page bg-light list-group-item list-group-item-action"> |
| Configuring your remote deployment of Codewind |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <a href="remoteconnectionui.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Entering remote connection settings |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <a href="remoteremoving.html" |
| |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Removing your remote deployment of Codewind |
| </a> |
| |
| |
| |
| |
| |
| </div> |
| |
| |
| |
| |
| <a href="guide_performance.html" |
| |
| |
| |
| class="bg-light list-group-item list-group-item-action"> |
| Performance monitoring |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <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="configuring-your-remote-deployment-of-codewind">Configuring your remote deployment of Codewind</h1> |
| |
| <p>Configure your remote deployment of Codewind by following these steps.</p> |
| |
| <h2 id="prerequisites">Prerequisites</h2> |
| <ul> |
| <li>Install your preferred IDE on your local machine. For more information about installing Eclipse, see <a href="mdteclipsegettingstarted.html">Getting started with Codewind for Eclipse</a>, or for more information about installing VS Code, see <a href="mdt-vsc-getting-started.html">Getting started with Codewind for VS Code</a>.</li> |
| <li>Ensure that you have access to the Codewind CLI <code class="highlighter-rouge">cwctl</code>. To access the Codewind CLI, open a terminal window, and navigate to the following hidden folder: <code class="highlighter-rouge">~/.codewind/<version></code> On Windows, navigate to the following folder: <code class="highlighter-rouge">%SystemDrive%\Users\<username>\.codewind\<version></code>.</li> |
| <li>The installer can install Keycloak on its own, Keycloak and Codewind together, or Codewind pointing at an existing Keycloak. If you decide you want to deploy Keycloak on its own first, install using the <code class="highlighter-rouge">cwctl install remote \</code> commands described in the following installation procedures, and add the <code class="highlighter-rouge">--konly</code> flag. Then install a Codewind instance that uses Keycloak by adding the <code class="highlighter-rouge">--kurl</code> flag, which is the ingress of the Keycloak service. Best practice is to deploy Keycloak first, and then deploy your Codewind instances.</li> |
| <li>Have an active Kubernetes context that points to your cluster.</li> |
| <li>Access to a keyring, a software application designed to store security credentials such as usernames, passwords, and keys, together with a small amount of relevant metadata. Examples of a keyring are Keychain on macOS, Credential Manager on Windows, and Secret Service on Linux.</li> |
| </ul> |
| |
| <h2 id="procedure">Procedure</h2> |
| |
| <p>To securely configure your remote deployment of Codewind, there are two options, configuring Kubernetes for Docker Desktop, or configuring a cloud deployment that does not have an Ingress NGINX controller, for example, OpenShift.</p> |
| |
| <h3 id="configuring-kubernetes-for-docker-desktop">Configuring Kubernetes for Docker Desktop</h3> |
| |
| <ol> |
| <li> |
| <p>Validate you have an ingress controller installed on your cluster by typing the following command:</p> |
| |
| <p><code class="highlighter-rouge">kubectl get service -n ingress-nginx</code></p> |
| |
| <p>If you do not have an ingress controller, install one using the following commands:</p> |
| |
| <ul> |
| <li><code class="highlighter-rouge">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/mandatory.yaml</code></li> |
| <li><code class="highlighter-rouge">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/cloud-generic.yaml</code></li> |
| </ul> |
| </li> |
| <li> |
| <p>To resolve the address of the cluster network and to enable the <code class="highlighter-rouge">cwctl</code> browsers and client side software to communicate with your installation, map the cluster network to <code class="highlighter-rouge">lo0</code> using the following commands:</p> |
| |
| <ul> |
| <li><code class="highlighter-rouge">export INGRESS_DOMAIN=$(kubectl get services --namespace ingress-nginx -o jsonpath='<.items[*].spec.clusterIP>')</code></li> |
| <li><code class="highlighter-rouge">sudo ifconfig lo0 alias $<INGRESS_DOMAIN></code></li> |
| </ul> |
| </li> |
| <li> |
| <p>Create the remote deployment of Codewind by entering the following <code class="highlighter-rouge">cwctl</code> command:</p> |
| |
| <p><code class="highlighter-rouge">cwctl install remote \</code> |
| <code class="highlighter-rouge">--namespace <your_namespace> \</code> |
| <code class="highlighter-rouge">--kadminuser <keycloakAdminUser> \</code> |
| <code class="highlighter-rouge">--kadminpass <keycloakAdminPassword> \</code> |
| <code class="highlighter-rouge">--krealm codewind \</code> |
| <code class="highlighter-rouge">--kclient codewind \</code> |
| <code class="highlighter-rouge">--kdevuser <keycloakDevUser> \</code> |
| <code class="highlighter-rouge">--kdevpass <keycloakDevUserPassword></code></p> |
| </li> |
| </ol> |
| |
| <p>Where <code class="highlighter-rouge">keycloakAdminUser</code> and <code class="highlighter-rouge">keycloakAdminPassword</code> are the Keycloak Administrator’s user credentials, and <code class="highlighter-rouge">keycloakDevUser</code> and <code class="highlighter-rouge">keycloakDevUserPassword</code> are the credentials of the first user to use the service.</p> |
| |
| <h3 id="configuring-other-cloud-deployments">Configuring other cloud deployments</h3> |
| |
| <ol> |
| <li> |
| <p>If you are deploying to a cloud that does not have an Ingress NGINX controller, for example, OpenShift, you must provide the ingress value in the <code class="highlighter-rouge">cwctl install remote \</code> command during installation. You can derive the <code class="highlighter-rouge">ingress</code> value from the cluster URL. To do this, go to the OpenShift console, for example, <code class="highlighter-rouge">https://<mycluster>|<myaddress>.nip.io:7443/console</code>, and then derive the <code class="highlighter-rouge">ingress</code> value, for example, from the previous address, this would be <code class="highlighter-rouge">apps.<mycluster>.<myaddress>.nip.io</code>. OpenShift also refer to this as the <code class="highlighter-rouge">routing-suffix</code>.</p> |
| </li> |
| <li> |
| <p>Create the remote deployment of Codewind by issuing the following example <code class="highlighter-rouge">cwctl</code> command:</p> |
| |
| <p><code class="highlighter-rouge">cwctl install remote \</code> |
| <code class="highlighter-rouge">--namespace <your_namespace> \</code> |
| <code class="highlighter-rouge">--kadminuser <keycloakAdminUser> \</code> |
| <code class="highlighter-rouge">--kadminpass <keycloakAdminPassword> \</code> |
| <code class="highlighter-rouge">--krealm codewind \</code> |
| <code class="highlighter-rouge">--kclient codewind \</code> |
| <code class="highlighter-rouge">--kdevuser <keycloakDevUser> \</code> |
| <code class="highlighter-rouge">--kdevpass <keycloakDevUserPassword></code> |
| <code class="highlighter-rouge">--ingress "apps.myopenshiftserver.10.20.30.40.nip.io</code></p> |
| |
| <p>Where <code class="highlighter-rouge">keycloakAdminUser</code> and <code class="highlighter-rouge">keycloakAdminPassword</code> are the Keycloak Administrator’s user credentials, and <code class="highlighter-rouge">keycloakDevUser</code> and <code class="highlighter-rouge">keycloakDevUserPassword</code> are the credentials of the first user to use the service.</p> |
| </li> |
| <li> |
| <p>Codewind is required 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"><namespace></code> is the namespace into which you plan to install Codewind:</p> |
| <ul> |
| <li>To enable privileged containers, enter <code class="highlighter-rouge">oc adm policy add-scc-to-group privileged system:serviceaccounts:<namespace></code>.</li> |
| <li>To enable containers to run as root, enter <code class="highlighter-rouge">oc adm policy add-scc-to-group anyuid system:serviceaccounts:<namespace></code>.</li> |
| </ul> |
| </li> |
| </ol> |
| |
| <h3 id="codewind-cli-command-explanation-and-sample-output">Codewind CLI command explanation and sample output</h3> |
| |
| <p>The <code class="highlighter-rouge">cwctl install remote</code> command:</p> |
| |
| <ol> |
| <li>Checks your cloud is valid.</li> |
| <li>Determines the ingress domain based on NGINX ingress that you added earlier, or using the supplied value from the <code class="highlighter-rouge">--ingress</code> flag.</li> |
| <li>Creates the SSL certificates for the keycloak server and adds these to the ingress endpoint, and then starts Keycloak.</li> |
| <li>It then populates all of the database entries inside Keycloak with the values that you added to the command.</li> |
| <li>Sets up the performance pods.</li> |
| <li>Waits for Codewind to start. When Codewind has started, in Kubernetes, you see new four new pods including keycloak plus the services and the deployment configurations for those pods. If you are deploying on to OpenShift, you can use routes instead of ingress.</li> |
| <li>On successful completion of the command, the command returns a Gatekeeper URL which is the one and only secure remote access entry point for the service.</li> |
| </ol> |
| |
| <p>You see example output similar to the following, this for a Linux/macOS deployment on Kubernetes:</p> |
| |
| <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>~ cwctl <span class="nt">--insecure</span> <span class="nb">install </span>remote <span class="se">\</span> |
| <span class="nt">--namespace</span> codewind <span class="se">\</span> |
| <span class="nt">--kadminuser</span> admin <span class="se">\</span> |
| <span class="nt">--kadminpass</span> passw0rd <span class="se">\</span> |
| <span class="nt">--krealm</span> codewind <span class="se">\</span> |
| <span class="nt">--kclient</span> codewind <span class="se">\</span> |
| <span class="nt">--kdevuser</span> developer <span class="se">\</span> |
| <span class="nt">--kdevpass</span> passw0rd |
| INFO[0000] Checking namespace codewind exists |
| INFO[0000] Creating codewind namespace |
| INFO[0000] Using namespace : codewind |
| INFO[0000] Container images : |
| INFO[0000] eclipse/codewind-pfe-amd64:latest |
| INFO[0000] eclipse/codewind-performance-amd64:latest |
| INFO[0000] eclipse/codewind-keycloak-amd64:latest |
| INFO[0000] eclipse/codewind-gatekeeper-amd64:latest |
| INFO[0000] Running on openshift: <span class="nb">false |
| </span>INFO[0000] Attempting to discover Ingress Domain |
| INFO[0000] Using ingress domain: 10.99.117.86.nip.io |
| INFO[0000] Creating service account definition <span class="s1">'codewind-k3rdhvxk'</span> |
| INFO[0000] Creating service account definition <span class="s1">'keycloak-k3rdhvxk'</span> |
| INFO[0000] Creating codewind-keycloak-k3rdhvxk.10.99.117.86.nip.io server Key |
| INFO[0000] Creating codewind-keycloak-k3rdhvxk.10.99.117.86.nip.io server certificate |
| INFO[0000] Creating Codewind Keycloak PVC |
| INFO[0000] Deploying Codewind Keycloak Secrets |
| INFO[0000] Deploying Codewind Keycloak TLS Secrets |
| INFO[0000] Deploying Codewind Keycloak Ingress |
| INFO[0000] Waiting <span class="k">for </span>pod: codewind-keycloak-k3rdhvxk |
| INFO[0000] codewind-keycloak-k3rdhvxk, phase: Pending Unschedulable |
| INFO[0001] codewind-keycloak-k3rdhvxk, phase: Pending ContainersNotReady |
| INFO[0005] codewind-keycloak-k3rdhvxk, phase: Running |
| INFO[0005] Waiting <span class="k">for </span>Keycloak to start |
| .......... |
| INFO[0028] Configuring Keycloak... |
| INFO[0028] https://codewind-keycloak-k3rdhvxk.10.99.117.86.nip.io |
| INFO[0029] Creating Keycloak realm |
| INFO[0030] Checking <span class="k">for </span>Keycloak client <span class="s1">'codewind-k3rdhvxk'</span> |
| INFO[0030] Creating Keycloak client |
| INFO[0030] Creating access role <span class="s1">'codewind-k3rdhvxk'</span> <span class="k">in </span>realm <span class="s1">'codewind'</span> |
| INFO[0030] Creating Keycloak initial user |
| INFO[0030] Updating Keycloak user password |
| INFO[0030] Grant <span class="s1">'developer'</span> access to this deployment |
| INFO[0030] Adding role <span class="s1">'codewind-k3rdhvxk'</span> to user : <span class="s1">'c00750c7-4b10-4317-b328-e21c4c930913'</span> |
| INFO[0030] Fetching client secret |
| INFO[0030] Checking <span class="k">if</span> <span class="s1">'eclipse-codewind-x.x.dev'</span> cluster access roles are installed |
| INFO[0030] Cluster roles <span class="s1">'eclipse-codewind-x.x.dev'</span> already installed |
| INFO[0030] Checking <span class="k">if</span> <span class="s1">'codewind-rolebinding-k3rdhvxk'</span> role bindings exist |
| INFO[0030] Adding <span class="s1">'codewind-rolebinding-k3rdhvxk'</span> role binding |
| INFO[0030] Creating and setting Codewind PVC codewind-pfe-pvc-k3rdhvxk to 1Gi |
| INFO[0030] Deploying Codewind Service |
| INFO[0030] Waiting <span class="k">for </span>pod: codewind-pfe-k3rdhvxk |
| INFO[0030] codewind-pfe-k3rdhvxk, phase: Pending Unschedulable |
| INFO[0041] codewind-pfe-k3rdhvxk, phase: Pending ContainersNotReady |
| INFO[0084] codewind-pfe-k3rdhvxk, phase: Running |
| INFO[0084] Deploying Codewind Performance Dashboard |
| INFO[0084] Waiting <span class="k">for </span>pod: codewind-performance-k3rdhvxk |
| INFO[0084] codewind-performance-k3rdhvxk, phase: Pending |
| INFO[0084] codewind-performance-k3rdhvxk, phase: Pending ContainersNotReady |
| INFO[0091] codewind-performance-k3rdhvxk, phase: Running |
| INFO[0091] Preparing Codewind Gatekeeper resources |
| INFO[0091] Creating codewind-gatekeeper-k3rdhvxk.10.99.117.86.nip.io server Key |
| INFO[0091] Creating codewind-gatekeeper-k3rdhvxk.10.99.117.86.nip.io server certificate |
| INFO[0092] Deploying Codewind Gatekeeper Secrets |
| INFO[0092] Deploying Codewind Gatekeeper Session Secrets |
| INFO[0092] Deploying Codewind Gatekeeper TLS Secrets |
| INFO[0092] Deploying Codewind Gatekeeper Deployments |
| INFO[0092] Deploying Codewind Gatekeeper Service |
| INFO[0092] Deploying Codewind Gatekeeper Ingress |
| INFO[0092] Waiting <span class="k">for </span>pod: codewind-gatekeeper-k3rdhvxk |
| INFO[0092] codewind-gatekeeper-k3rdhvxk, phase: Pending |
| INFO[0092] codewind-gatekeeper-k3rdhvxk, phase: Pending ContainersNotReady |
| INFO[0100] codewind-gatekeeper-k3rdhvxk, phase: Running |
| INFO[0100] Waiting <span class="k">for </span>Codewind Gatekeeper to start on https://codewind-gatekeeper-k3rdhvxk.10.99.117.86.nip.io |
| .. |
| INFO[0101] Waiting <span class="k">for </span>Codewind PFE to start |
| <span class="nb">.</span> |
| INFO[0101] Codewind is available at: https://codewind-gatekeeper-k3rdhvxk.10.99.117.86.nip.io |
| </code></pre></div></div> |
| </div> |
| </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="email icon" title="email icon" src="images/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="twitter icon" title="twitter icon" src="images/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="github icon" title="github icon" src="images/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="mattermose icon" title="mattermose icon" src="images/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="youtube icon" title="youtube icon" src="images/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 icon" title="eclipse icon" src="images/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="email icon" title="email icon" src="images/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="twitter icon" title="twitter icon" src="images/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="github icon" title="github icon" src="images/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="mattermost icon" title="mattermost icon" src="images/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="youtube icon" title="youtube icon" src="images/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 icon" title="eclipse icon" src="images/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> |
| |
