README.md.bak

# EasyTP
<!--
>EasyTP is a web based solution that aims to facilitate and >customize cluster management by automating 
>deployement for different Tools/software used in students labs allowing user >management ~~~ (microservices, fully distributed in LAN, NFS , >worker nodes ...)
-->
![GitHub contributors](https://img.shields.io/github/contributors/TheDhm/container-manager-app)  ![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/y/TheDhm/container-manager-app)  ![GitHub last commit](https://img.shields.io/github/last-commit/TheDhm/container-manager-app) ![GitHub language count](https://img.shields.io/github/languages/count/TheDhm/container-manager-app) ![GitHub top language](https://img.shields.io/github/languages/top/TheDhm/container-manager-app)
## About 

The present project consisted of developing and deploying a solution that would allow
students of the school to access the software that they use in practical labs without worrying about installation, compatibility and lack of resources often encountered, using containerization using Docker and deployment using Kubernetes.

The proposed solution consists of containerizing two chosen applications (based on usage frequency) and implementing a custom onsite Kubernetes cluster architecture to deploy and manage students/teachers access and activity to these applications through a common web plateform named **EasyTP**.


## Built with
* [![Django][Django]][django-url]
* [![Docker][Docker]][docker-url]
* [![Kubernetes][Kubernetes]][kubernetes-url]
* [![PostG][PostG]][postg-url]


<!--## Project motivation
This project is a semester long project for 2CS Computer Systems speciality (SIQ) at ESI Algiers.
-->

## Chosen applications 
- Gns3
- Logisim 

## How did we dockerize them 

To dockerize and remotely access GUI applications, the container contains the following stack described in ``./Dockerfiles/\<appname>/Dockerfile``.

<img src="./screenshots/stack.png" height="400">
 
* Debian as the base image.
* Supervisord (insures/restrict application/user access inside container) described through supervisord.conf.
* Application and its dependencies
* Openbox (Windows manager) described through menu.xml file.
* x11 provided by TigerVNC
* VNC server provided by TigerVNC
* Websocket to view VNC content through browser provided by easy-novnc.



##  Kubernetes Cluster


<img src="./screenshots/cluster.png" height="400">

* Storage through NFS technology
* Networking through proxy / ingress.
* Deployement: the solution is ready to be deployed locally through LAN distributed cluster, VMs or through cloud (soon).

## EasyTP
EasyTP is a web application developed with Django that aims to
facilitate and customize cluster management according to our specific needs. It serves, in the first place,
authenticate the different users of the system, then communicates with the control plane to create pods and services associated with the applications requested by the users.
System users are : students, teachers and administrator.
Here are the functional and technical specifications of the EasyTP application in detail.

### Features
- The application starts a new pod and kubernetes service for each
application/user.
- The system allows all users to access the application from the
browser.
- The system allows all users of the application to authenticate themselves.
- The system allows to save the user's session for future use.
- The system allows to send an email to new users containing their usernames and passwords.
- The system should delete the pod/container after the user logs out.

We count 3 types of users:
#### 1. Administrator
- The system allows an "administrator" user to consult the dashboard.
- The system allows an "administrator" user to add a list of users from a CSV file.
- The administrator must be able to create, update and delete applications.
- The administrator must be able to assign applications to students.
- The administrator must be able to manage access and privileges.
#### 2. Teacher
- The system allows a "teacher" user to view all student pods.
- The system allows a "teacher" user to access any student's pod.
- The system allows a teacher user to access student storage spaces.
- The system allows a "teacher" user to launch applications.
- The system allows a teacher user to upload files related to the course to his/her own storage space to be shared with students.
#### 3. Student
- The system allows a "student" user to launch applications (Lab environement).
- The system allows a student user to upload files from his own local machine or from the space shared with the teacher to his allocated space.
- The system allows a students to collaborate in the same project .


### Screenshots
1. Authentication (only @esi.dz emails are allowed)

![](./screenshots/not_connected.png)
![](./screenshots/connexion.png)
_Login page_

2. Student


![](./screenshots/student_dashboard.png)
_student dashboard_

![](./screenshots/file_manager__.png)
_file manager page_

![](./screenshots/applications.png)
_Lab applications dashboard_

![](./screenshots/logisim.png)
_Logisim application preview_

![](./screenshots/gns3_usage.png)
_Gns3 application preview_

3. Teacher

![](./screenshots/teacher_dashboard.png)
_Teacher dashboard_

![](./screenshots/file_manager_.png)
_Teacher file manager page_

![](./screenshots/browse_students.png)
_student list page_

4. Admin


![](./screenshots/admin_instances.png)
_DB instances_

![](./screenshots/add_users.png)
_Add users via CSV file_

![](./screenshots/admin_users.png)
_Users dashboard_

![](./screenshots/email_credentials.png)
_Login credentials via email_



## Usage

- Connect to the web plateforme hosted locally (http://server_IP:31313/login).
- Authenticate, then choose an application to launch, you will be directed to a new tab to access the lab.
- Enter VNC password and connect to your lab !


## Getting started
These instructions will get you a copy of this project up running on your local environement.

### Prerequisites
* Docker
* cri-dockerd *(you can get it from [here](https://github.com/Mirantis/cri-dockerd))*
* Kubernetes (you can follow this [tutorial](https://phoenixnap.com/kb/install-kubernetes-on-ubuntu) to install kubeadm, kubelet and kubectl)

[//]: # (* Python 3 *&#40;you can get it from [here]&#40;https://www.python.org/downloads/&#41;&#41;*)

[//]: # (* virtualenv)

[//]: # (```sh)

[//]: # (pip install virtualenv)

[//]: # (```)

[//]: # (### Create a virtual environement)

[//]: # ()
[//]: # (```sh)

[//]: # (virtualenv "Your virtualenv name"  )

[//]: # (cd "Your virtualenv name")

[//]: # (Scripts\activate)

[//]: # (```)

### Installation
1. Create your cluster
```sh
swapoff -a
sudo kubeadm init --pod-network-cidr=10.244.0.0/16 --cri-socket=unix:///var/run/cri-dockerd.sock --apiserver-advertise-address=<your ip>

mkdir -p $HOME/.kube
sudo cp -i /etc/kubernetes/admin.conf $HOME/.kube/config
sudo chown $(id -u):$(id -g) $HOME/.kube/config
# install flannel: network plugin
kubectl apply -f https://raw.githubusercontent.com/coreos/flannel/master/Documentation/kube-flannel.yml
# enable scheduling on master
kubectl taint node --all node-role.kubernetes.io/master:NoSchedule-
kubectl taint node --all node-role.kubernetes.io/control-plane:NoSchedule-
```
2. Clone the repo
```sh
git clone https://github.com/TheDhm/container-manager-app.git
```
3. Create NFS storage (you can follow this [tutorial](https://www.tecmint.com/install-nfs-server-on-ubuntu/))
    * create DB folder in your nfs server (for postgres DB)
    * create USERDATA folder ( users storage space )
    * create READONLY folder
    * make sure to change nfs server IP in: 
      * postgres-pv.yaml
      * django-deployment.yaml
      * persistentVolume.yaml


4. Build the web app image
```sh
cd container-manager-app
docker build --rm -t django-app:latest .
```
5. Before you start the project make sur you have docker images locally :

[//]: # (* [Gns3]&#40;https://hub.docker.com/r/younes46/gns&#41;)

[//]: # (```sh )

[//]: # (docker pull younes46/gns)

[//]: # (docker tag younes46/gns gns3)

[//]: # (```)

[//]: # (* [Logisim]&#40;https://hub.docker.com/repository/docker/anii76/logisim&#41;)

[//]: # (```sh )

[//]: # (docker pull anii76/logisim)

[//]: # (docker tag anii76/logisim logisim)

[//]: # (```)

[//]: # (### Or)
you can build the images using dockerfiles in `Dockerfiles` (Logisim & GNS3)
```sh 
docker build -t <ImageName> <DockerfilePath>
```
6. Deploy on Kubernetes cluster
```sh
cd container-manager-app
sh deploy-all.sh
```
7. Migrate
```sh
kubectl -n django-space exec -it  <django pod> -- python manage.py migrate
```
8. Create superuser
```sh
kubectl -n django-space exec -it  <django pod> -- python manage.py createsuperuser
```
9. Add Users, Apps and AccessGroups using Django Admin. 
10. Congrats, You can now start your journey!
## Acknowledgment
Special thanks to M. BELHADI Zohir for helping us through this project.

## Ressources
The below space, a list of the most helpful resources that we would like to give credit to.
* [Delivering Desktop Apps in Containers.](https://youtu.be/L4nqky8qGm8)
* [How to create and run GUI application in a Docker container. ](https://www.digitalocean.com/community/tutorials/how-to-remotely-access-gui-applications-using-docker-and-caddy-on-debian-9)
* [VNC vs RDP: which remote desktop tool is the best?](https://www.realvnc.com/en/blog/vnc-vs-rdp-which-remote-desktop-tool-is-best/#:~:text=Both%20protocols%20provide%20access%20to,what%20the%20remote%20user%20sees)
* [Kubernetes tutorial](https://kubernetes.io/docs/tutorials/)
* [FIX: Pod IP address is out of range specified in --pod-network-cidr ](https://serverfault.com/questions/1101838/kubernetes-pod-ip-address-is-out-of-range-specified-in-pod-network-cidr)

## Contact
Contact KubeLeads Team:
> - Anfal Bourouina : ka_bourouina@esi.dz
> - Abderrahmane Melek : ha_melek@esi.dz 
> - Mohamed Branki Regani : im_regani@esi.dz  
> - Mohamed Elghazali Kimeche : km_kimeche@esi.dz
> - Younes Otmani : ky_otmani@esi.dz
> - Kenza Makhloufi : kk_makhloufi@esi.dz

## License
![GitHub](https://img.shields.io/github/license/TheDhm/container-manager-app?style=flat-square)  
The source code for this project is licensed under the MIT license, which you can find in the [LICENSE](./LICENSE) file.

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[Django]: https://img.shields.io/badge/Django-092E20?style=for-the-badge&logo=django&logoColor=white
[django-url]: https://www.djangoproject.com/
[Kubernetes]: https://img.shields.io/badge/kubernetes-%23326ce5.svg?style=for-the-badge&logo=kubernetes&logoColor=white
[kubernetes-url]: https://kubernetes.io/
[Docker]: https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white
[docker-url]: https://www.docker.com/
[PostG]: https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white
[postG-url]: https://www.postgresql.org/