eclipse/che-machine-exec repository overview

⁠CHE machine exec

Go-lang server side to creation machine-execs for Eclipse CHE workspaces. Uses to spawn terminal or command processes.

CHE machine exec uses json-rpc protocol to communication with client.

⁠Build docker image

Build docker image with che-machine-exec manually:

docker build --no-cache -t eclipse/che-machine-exec .

⁠Run docker container

Run docker container with che-machine-exec manually:

docker run --rm -p 4444:4444 -v /var/run/docker.sock:/var/run/docker.sock eclipse/che-machine-exec

⁠How to use machine-exec image with Eclipse CHE workspace on the docker infrastructure

To configure Eclipse CHE on the docker infrastructure we are using che.env configuration file. che.env file located in the CHE data folder. Edit and save che.env file: apply docker.sock path (by default it's /var/run/docker.sock) to the workspace volume property CHE_WORKSPACE_VOLUME:

Example:

CHE_WORKSPACE_VOLUME=/var/run/docker.sock:/var/run/docker.sock;

⁠Test che-machine-exec with help UI on the docker infrastructure

Run Eclipse CHE. You can create new Eclipse CHE workspace with integrated Theia IDE from stack 'Theia IDE on docker'. Then you can test che-machine-exec with help eclipse-che-theia-terminal⁠ and test che-machine-exec with help che-theia-task-plugin⁠

⁠Test che-machine-exec on the local Openshift

To test che-machine-exec you need deploy Eclipse CHE to the openshift locally. Prepare Eclipse CHE to deploy⁠

To deploy Eclipse CHE to the local running openshift you can use ocp.sh sript⁠.

Move to the ocp.sh script:

cd ~/projects/che/deploy/openshift/

Run ocp.sh with arguments:

./ocp.sh --run-ocp --deploy-che --no-pull --debug --deploy-che-plugin-registry --multiuser

In the output you will get link to the deployed Eclipse CHE project. Use it to login to Eclipse CHE.

Register new user on the login page. After login you will be redirected to the Eclipse CHE user dashboard.

Create new workspace from openshift stack 'Java Theia on OpenShift' or 'CHE 7' stack. Run workspace. When workspace will be running you will see Theia IDE. Then you can test che-machine-exec with help che-theia-terminal-extension⁠ and test che-machine-exec with help che-theia-task-plugin⁠

⁠Test on the Minishift

To test che-machine-exec you need deploy Eclipse CHE to the Minishift. Prepare Eclipse CHE to deploy⁠.

Install minishift with help this instractions:

• https://docs.okd.io/latest/minishift/getting-started/preparing-to-install.html⁠
• https://docs.okd.io/latest/minishift/getting-started/setting-up-virtualization-environment.html⁠

Install oc tool: download oc binary for your platform⁠, extract and apply this binary path to the system environment variables PATH. After that oc become availiable from terminal:

$ oc version
oc v3.9.0+191fece
kubernetes v1.9.1+a0ce1bc657
features: Basic-Auth GSSAPI Kerberos SPNEGO

Start Minishift:

$ minishift start --memory=8GB
-- Starting local OpenShift cluster using 'kvm' hypervisor...
...
   OpenShift server started.
   The server is accessible via web console at:
       https://192.168.99.128:8443

   You are logged in as:
       User:     developer
       Password: developer

   To login as administrator:
       oc login -u system:admin

From this command output you need:

• Minishift master url. In this case it's https://192.168.42.159:8443. Let's call it 'CHE_INFRA_KUBERNETES_MASTER__URL'. We can store this variable in the terminal session to use it for next commands:

export CHE_INFRA_KUBERNETES_MASTER__URL=https://192.168.42.162:8443

Register new user on the CHE_INFRA_KUBERNETES_MASTER__URL page.

Login to minishift with help oc, use new user login and password for it:

$ oc login --server=${CHE_INFRA_KUBERNETES_MASTER__URL}

This command activates openshift context to use minishift instance:

To deploy Eclipse CHE you can use deploy_che.sh script⁠.

Move to deploy_che.sh script:

cd ~/projects/che/deploy/openshift

Run deploy_che.sh script with arguments:

export CHE_INFRA_KUBERNETES_MASTER__URL=${CHE_INFRA_KUBERNETES_MASTER__URL} && ./deploy_che.sh --no-pull --debug --multiuser

Create new workspace from openshift stack 'Java Theia on OpenShift' or 'CHE 7' stack. Run workspace. When workspace will be running you will see Theia IDE. Then you can test che-machine-exec with help che-theia-terminal-extension⁠ and test che-machine-exec with help che-theia-task-plugin⁠

⁠Test on the Kubernetes (MiniKube)

To test che-machine-exec you need deploy Eclipse CHE to the Minikube cluster. Prepare Eclipse CHE to deploy⁠.

Install minikube virtual machine on your computer: https://github.com/kubernetes/minikube/blob/master/README.md⁠

You can deploy Eclipse CHE with help helm. So, install Helm⁠

Start new minikube:

minikube start --cpus 2 --memory 8192 --extra-config=apiserver.authorization-mode=RBAC

Go to helm/che directory:

$ cd ~/projects/che/deploy/kubernetes/helm/che

• Add cluster-admin role for kube-system:default account

kubectl create clusterrolebinding add-on-cluster-admin --clusterrole=cluster-admin --serviceaccount=kube-system:default

• Set your default Kubernetes context:

kubectl config use-context minikube

• Install tiller on your cluster:
  • Create a [tiller serviceAccount]:

    kubectl create serviceaccount tiller --namespace kube-system
    

    Copy
  • Bind it to the almighty cluster-admin role:

    kubectl apply -f ./tiller-rbac.yaml
    

    Copy
  • Install tiller itself:

    helm init --service-account tiller
    

    Copy
• Start NGINX-based ingress controller:

  minikube addons enable ingress
  

  Copy

There are two configurations to deploy Eclipse CHE on the Kubernetes:

• first one: for each new workspace Eclipse CHE creates separated namespace:

    helm upgrade --install che --namespace che ./
  

  Copy
• second one: Eclipse CHE creates workspace in the same namespace:

  helm upgrade --install che --namespace=che --set global.cheWorkspacesNamespace=che ./
  

  Copy

minikube dashboard

Create new workspace from stack 'CHE 7'. Run workspace. When workspace will be running you will see Theia IDE. Then you can test che-machine-exec with help che-theia-terminal-extension⁠ and test che-machine-exec with help che-theia-task-plugin⁠

⁠Prepare Eclipse CHE to deploy

First of all clone Eclipse CHE:

$ git clone https://github.com/eclipse/che.git ~/projects/che

For test purpose it's not nessure build all Eclipse CHE, build 'assembly-main' maven module is pretty enough:

$ cd ~/projects/che/assembly/assembly-main
$ mvn clean install -DskipTests

⁠Test che-machine-exec with help eclipse-che-theia-terminal

Eclipse CHE workspace created from Theia stack contains included che-theia-terminal-extension. With help this extension you can test che-machine-exec.

Create new terminal with help main menu of the Theia: Terminal => Open Terminal in specific container. After that IDE will propose you select machine to creation terminal. Select one of the machines by click. After that Theia should create new terminal on the bottom panel. Or you could use command palette: Ctrl + Shift + P and type terminal. Then you could select with help keys Arrow Up or Arrow Down command for terminal creation and launch it by click on Enter.

⁠Test che-machine-exec with help che-theia-task-plugin

Eclipse CHE workspace created from Theia stack contains included che-theia-task-plugin. With help this plugin you can test che-machine-exec. Create new Theia task for your project: in the project root create folder .theia. Create tasks.json file in the folder .theia with such content:

{
    "tasks": [
        {
            "label": "che",
            "type": "che",
            "command": "echo hello"
        }
    ]
}

Run this task with help menu tasks: Terminal => Run Task... After that Theia should display widget with output content: 'echo hello'