Remote Code Compiler

An online code compiler for Java, C, C++ and Python for competitive programming and coding interviews. This service execute your code remotely using docker containers to separate the different environements of executions.

Prerequisites

To run this project you need a docker engine running on your machine.

Getting Started

Build docker image by typing the following command :

docker image build . -t compiler

Run the container by typing the following command

sudo docker container run -p 8080:8082 -v /var/run/docker.sock:/var/run/docker.sock -e DELETE_DOCKER_IMAGE=true -t compiler

The value of the env variable DELETE_DOCKER_IMAGE is by default set to true, and that means that each docker image is deleted after the execution of the container.

Portainer

It might be a good idea if you run a Portainer instance and mount it to the same volume, in order to have a total view of created images and running containers.

docker container run -p 9000:9000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer

On K8s

You can use the provided helm chart to deploy the project on k8s

helm install compiler ./k8s/helm_charts/compiler_chart

kubectl get all  // display all resources

Note if you are running k8s using Minikube :

you can reuse the Docker daemon from Minikube by running this command : eval $(minikube docker-env).
set image pull policy to Never in the values.yml file.

How It Works

There is four endpoints, one for Java, one for C, one for C ++ and another for Python. The call is done through POST requests to the following urls :

localhost:8080/compiler/java
localhost:8080/compiler/c
localhost:8080/compiler/cpp
localhost:8080/compiler/python

For the documentation visit the swagger page at the following url : http://localhost:8080/swagger-ui.html

Visualize Docker images and containers info

It is also possible to visualize information about the images and docker containers that are currently running using these endpoints

Example of an Output

Docker Containers

Docker Images

How the docker image is generated

We generate an entrypoint.sh file depending on the information given by the user (time limit, memory limit, programming language, and also the inputs).

Metrics

Check out exposed prometheus metrics using the following url : http://localhost:8080/actuator/prometheus

Author

Zakaria Maaraki - Initial work - zakariamaaraki

pk210700 / remotecodecompiler Goto Github PK