README.md

SIMPLE YAML compiler Web UI (backend)

Backend for the SIMPLE YAML Compiler GUI web application.

Frontend repository can be found here.

How to deploy to OpenShift

0. Download the OKD client oc.

1. Go to https://openshift.cern.ch/console/catalog

2. Select Python from the list of options

3. Select your project, set application name and select the repository. Supported Python version is 2.7.

4. Create route and expose it to the internet using oc annotate route <SERVICE NAME HERE> router.cern.ch/network-visibility=Internet

5. (Optional) Add health-check to the backend deployment on /health endpoint.

Available endpoints

• /versions - GET list of installed compiler versions
• /compile - POST site-level config file to be compiled/augmented

  // Request
  {
    "version": "v1.0.6",
    "site_conf": (binary)
  }
  
  // Response (success)
  {
    "augmented_conf": "...",
    "schema": "..."
  }
  
  // Response (failure)
  {
    "Input File": "<site-level conf>",
    "error": "<error traceback>",
    "file_name1": "...",
    "file_name2": "...",
    "file_name3": "...",
    ...
  }

• /health - GET health check endpoint

Installing new compiler versions

In order to install a new compiler simply download it from the SIMPLE Grid YAML compiler package page in PyPi here and extract it inside the compilers directory. The backend will take care of picking up the installed compilers and providing a list of available versions to the frontend.