Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
1 result

ms-converter-gui

  • Clone with SSH
  • Clone with HTTPS
    • linsherpa's avatar
    Edit README.md
    linsherpa authored
    a4a1037d
    History
    linsherpa's avatar a4a1037d
    History
    Name Last commit Last update
    docker_images
    kubernetes_deployment_files
    LICENSE
    README.md
    README.md

    ms-converter-GUI

    A web interface to the converter service available at NFDI4chem-Converter-Service

    The entire repository is divided into docker image section [for frontend and backend ] and Kubernetes deployment

    Instructions

    Steps to create docker image of backend and run the container

    1. Git clone the repository
     git clone https://git.rwth-aachen.de/linsherpa/ms-converter-gui.git
    1. Navigate to the backend folder
    cd ms-converter-gui/msconverter_gui_backend
    1. Add your S3 credentials
    credentials/.env
    1. Build the Docker image
    docker build -t  .

    [Optional: If you want to run the container follow step 5 and 6]
    5. Run a container at port 5000 (by default)

    docker run -d -ti -p 5000:5000 --name < name of the container > < name of the docker image: set earlier >
    1. The Backend-Web service will be available on http://localhost:5000/.

    Steps to create docker image of frontend

    1. Navigate to the frontend directory
    cd ms-converter-gui/msconverter_gui_frontend
    1. Extract the frontend archive
    tar -xzf nfdi4chem-cs-gui-frontend.tar.gz
    1. Reconfigure the nginx.conf file routing as per your need under section proxy-pass
    2. Build the Docker image
    docker build -t  .

    [Optional: If you want to run the container follow step 5 and 6 ] 5. Run a container at port 8080 (by default)

    docker run -d -ti -p 8080:80 --name < name of the container > < name of the docker image: set earlier >
    1. The Frontend-Web service will be available on http://localhost:8080/

    Alternatively for ease of deployment in kubernetes

    A Docker image for the frontend is available at lincoln1010/msconverter_vue_ui_frontend:v1.4. By default, it is configured to route backend requests to the ClusterIP service at http://nfdi4chem-gui-vue-backend:5000.

    Steps to deploy frontend and backend in kubernetes

    By default:

    • The backend is configured to run with a ClusterIP service (internal access).

    • The frontend is exposed to the browser via a LoadBalancer (configurable)

    Necessary NGINX configurations are already included in the frontend Docker image.

    1. Navigate to the backend deployment folder:
    cd kubernetes_deployment_files/msconverter_vue_backend
    1. Ensure the Docker image name is correctly specified in deployment.yaml. The default value is msconverter_vue_ui_backend:v1.0
    2. Apply the Kubernetes configuration:
    kubectl apply -f .
    1. For Frontend, navigate to the frontend deployment folder:
    cd kubernetes_deployment_files/msconverter_vue_frontend
    1. Ensure the image name is correctly set in the deployment.yaml file. The default is msconverter_vue_ui_frontend:v1.0
    2. To check the external IP (where the frontend service is accessible):
     kubectl get svc

    Acknowledgement:

    Funded by the Deutsche Forschungsgesellschaft (DFG, German Research Foundation) under the National Resaerch Data Infrastructure – NFDI/1 – Project number 441958208