You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 28, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: docs/_documentations/mdt-che-installinfo.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ Installing Codewind for Eclipse Che comprises the following steps:
28
28
- Because Codewind uses RWX (ReadWriteMany) volumes to provide persistent storage, you need to use NFS for storage on OpenShift 4.
29
29
2. Ensure that the cluster can pull images from `docker.io/eclipse` and `quay.io/eclipse`.
30
30
- Both Eclipse Che and Eclipse Codewind host their Docker images at those locations. Ensure that your cluster can pull from that registry and does not have `ImagePullPolicies` blocking it from accessing Docker Hub.
31
-
3. Set up the ClusterRole for Codewind. Run `kubectl apply -f https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.6.0/setup/install_che/codewind-clusterrole.yaml`
31
+
3. Set up the ClusterRole for Codewind. Run `kubectl apply -f https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.7.0/setup/install_che/codewind-clusterrole.yaml`
32
32
33
33
# Setting up Che
34
34
@@ -38,7 +38,7 @@ The fastest way to install Eclipse Che for use with Codewind is to use the `chec
38
38
39
39
Complete the following steps after you install `chectl`:
40
40
41
-
1. Download the [codewind-che checluster yaml](https://github.com/eclipse/codewind-che-plugin/blob/master/setup/install_che/che-operator/codewind-checluster.yaml) file to your machine.
41
+
1. Download the [codewind-che checluster yaml](https://github.com/eclipse/codewind-che-plugin/blob/0.7.0/setup/install_che/che-operator/codewind-checluster.yaml) file to your machine.
42
42
- You can modify this file, but leave the `spec.server.cheWorkspaceClusterRole` field set to `eclipse-codewind` and the `spec.storage.preCreateSubPaths` field set to `true`.
43
43
2. If you're installing on a Kubernetes platform other than OpenShift, determine your Ingress domain. If you're unsure of your Ingress domain, ask your cluster administrator.
44
44
- Set the `spec.server.ingressDomain` field in the Che `.yaml` to the Ingress domain.
@@ -51,7 +51,7 @@ Complete the following steps after you install `chectl`:
51
51
If you already have an existing Che install, it's relatively easy to update it for Codewind.
52
52
53
53
After creating the Codewind ClusterRole in the prerequisites step, run the following command, where `$NAMESPACE` is the namespace your Che workspaces run in (by default `che`):
To use Codewind remote, configure your system by following these steps.
15
+
Configure your remote deployment of Codewind by following these steps.
16
16
17
17
## Prerequisites
18
18
- Install your preferred IDE on your local machine. For more information about installing Eclipse, see [Getting started with Codewind for Eclipse](mdteclipsegettingstarted.html), or for more information about installing VS Code, see [Getting started with Codewind for VS Code](mdt-vsc-getting-started.html).
@@ -21,7 +21,7 @@ To use Codewind remote, configure your system by following these steps.
21
21
22
22
## Procedure
23
23
24
-
To securely configure Codewind remote 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.
24
+
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.
25
25
26
26
### Configuring Kubernetes for Docker Desktop
27
27
@@ -39,7 +39,7 @@ To securely configure Codewind remote there are two options, configuring Kuberne
39
39
-`export INGRESS_DOMAIN=$(kubectl get services --namespace ingress-nginx -o jsonpath='<.items[*].spec.clusterIP>')`
40
40
-`sudo ifconfig lo0 alias $<INGRESS_DOMAIN>`
41
41
42
-
3. Create the remote deployment by entering the following `cwctl` command:
42
+
3. Create the remote deployment of Codewind by entering the following `cwctl` command:
43
43
44
44
`cwctl install remote \`
45
45
`--namespace <your_namespace> \`
@@ -56,7 +56,7 @@ To securely configure Codewind remote there are two options, configuring Kuberne
56
56
57
57
1. 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 `cwctl install remote \` command during installation. You can derive the `ingress` value from the cluster URL. To do this, go to the OpenShift console, for example, `https://<mycluster>|<myaddress>.nip.io:7443/console`, and then derive the `ingress` value, for example, from the previous address, this would be `apps.<mycluster>.<myaddress>.nip.io`. OpenShift also refer to this as the `routing-suffix`.
58
58
59
-
2. Create the remote deployment by issuing the following example `cwctl` command:
59
+
2. Create the remote deployment of Codewind by issuing the following example `cwctl` command:
60
60
61
61
`cwctl install remote \`
62
62
`--namespace <your_namespace> \`
@@ -70,6 +70,10 @@ To securely configure Codewind remote there are two options, configuring Kuberne
70
70
71
71
Where `keycloakAdminUser` and `keycloakAdminPassword` are the Keycloak Administrator's user credentials, and `keycloakDevUser` and `keycloakDevUserPassword` are the credentials of the first user to use the service.
72
72
73
+
3. 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 `<namespace>` is the namespace into which you plan to install Codewind:
74
+
- To enable privileged containers, enter `oc adm policy add-scc-to-group privileged system:serviceaccounts:<namespace>`.
75
+
- To enable containers to run as root, enter `oc adm policy add-scc-to-group anyuid system:serviceaccounts:<namespace>`.
76
+
73
77
### Codewind CLI command explanation and sample output
74
78
75
79
The `cwctl install remote` command:
@@ -84,7 +88,7 @@ The `cwctl install remote` command:
84
88
85
89
You see example output similar to the following, this for a Linux/macOS deployment on Kubernetes:
keywords: users, projects, Kubernetes, LDAP, user management, access management, login, deployment, pod, security, securing cloud connection, remote deployment of Codewind
6
6
duration: 5 minutes
7
7
permalink: remoteoverview
8
8
type: document
9
9
parent: installoncloud
10
10
order: 1
11
11
---
12
12
13
-
# Deploying Codewind remote
13
+
# Deploying Codewind remotely
14
14
15
-
Codewind remote is where you develop your code locally and build and run it remotely and securely in the cloud. This option is incredibly useful because it frees up your local machine to focus purely on developing code and you use the cloud's resources to build and run your apps. Codewind enables you to develop your apps securely by securing the connection between your local editor and your remote cloud deployment. To do this, Codewind uses Keycloak, an open source identity and access management solution for modern applications and services which is highly configurable to your environment.
15
+
Deploying Codewind remotely enables you to develop your code locally and then build and run it remotely and securely in the cloud. This option is incredibly useful because it frees up local resource usage and you use the cloud's resources to build and run your apps. By using [Keycloak](https://www.keycloak.org/), the connection between your local editor and your remote cloud deploymentis secure.
16
16
17
17
You install your preferred IDE on your local machine. For more information about installing Eclipse, see [Getting started with Codewind for Eclipse](mdteclipsegettingstarted.html), or for more information about installing VS Code, see [Getting started with Codewind for VS Code](mdt-vsc-getting-started.html).
18
18
@@ -22,7 +22,7 @@ You then use the Codewind features inside your preferred IDE to create a connect
22
22
23
23
Codewind enables you to choose which preferred IDE you want to use, however do not use two different IDEs at the same time. For the best user experience, choose which one you want to use, and disable the other.
24
24
25
-
To configure Codewind remote, see [Configuring Codewind remote](remoteconfiguring.html).
25
+
To configure your remote deployment of Codewind, see [Configuring your remote deployment of Codewind](remoteconfiguring.html).
To remove Codewind remote, enter the following `cwctl`command: `cwctl remove remote --namespace {mynamespace} --workspace {workspaceID}`
15
+
The Codewind CLI `cwctl`is designed to do almost all the steps required to remove a remote deployment of Codewind by chaining together a number of Kubernetes operations.
16
16
17
+
There are two modes of use. You can:
18
+
1. Remove Codewind.
19
+
2. Remove Keycloak. A Keycloak service can provide authentication services to many Codewind deployments in different namespaces, so only remove it when you are sure it is no longer used.
20
+
21
+
## Removing a remote deployment of Codewind
22
+
23
+
To remove a remote deployment of Codewind, enter the following `cwctl` command:
Where the command parameters `<namespace>` and `<workspaceID>` are used to identify which Kubernetes resources to remove. If you are unsure of the `<workspaceID>`, you can find it as part of the ingress or route URL, for example:
#### ✨ Remote Deploy with Codewind: Tech Preview ✨
14
+
15
+
You can now develop your code locally and securely build and deploy your apps in the cloud! Why is this cool?
16
+
- Free up local resources. 👏
17
+
- It's secure! 🔐 We use [Keycloak](https://keycloak.org/) to secure the connection between your local editor and remote cloud deployment.
18
+
19
+
Curious? [Learn more](remoteoverview.html)!
20
+
21
+
#### New Features and Highlights for 0.7.0
22
+
23
+
**OpenShift Do (odo)**
24
+
- You can now easily import existing projects into Codewind and [use odo](https://github.com/eclipse/codewind/issues/1115) to build and deploy projects to your OpenShift or OKD cluster.
25
+
- Introducing [support for Java template](https://github.com/eclipse/codewind/issues/450) and Java projects can build and deploy [once configured](//permalink to landing page).
26
+
- You no longer have to create your [docker registry secret](https://github.com/eclipse/codewind/issues/665) in Codewind.
27
+
28
+
29
+
30
+
#### List of Fixes
31
+
- Changes to the Eclipse plugin for Spring Server [post-code generation stability for OpenAPI](https://github.com/eclipse/codewind/issues/1116)
32
+
- Appsody binary updated from 0.5.0 to 0.5.2 in the codewind-appsody-extension
0 commit comments