ParaViewWeb Generic container

Running pvw-{version}-{egl/osmesa}

This docker image aims to ease any ParaViewWeb application deployment by offering a standard way of strcuturing your web application and exposing it to the world.

Expected structure

<APP_ROOT>/www/
<APP_ROOT>/launcher/config.json
<APP_ROOT>/requirements.txt        (optional)
<APP_ROOT>/endpoints.txt           (optional)
<APP_ROOT>/server/                 (optional)

www is the directory that will be served by Apache inside docker.
launcher/config.json is the launcher configuration where SESSION_URL_ROOT and EXTRA_PVPYTHON_ARGS would be replaced with the proper docker environments properties.
requirements.txt allow you to install additional Python packages which will then be usable inside your ParaViewWeb application.
endpoints.txt allows you to set up custon endpoints (apache aliases) before apache is started within the container.
server/ is the directory where we tend to put our ParaViewWeb server scripts by convention.

Launcher configuration

The following configuration could be used as a base for your application.

{
  "resources": [ {"port_range": [9010, 9014], "host": "localhost"} ],
  "sessionData": {},
  "configuration": {
    "log_dir": "/opt/launcher/log",
    "host": "localhost",
    "endpoint": "paraview",
    "sessionURL": "SESSION_URL_ROOT/proxy?sessionId=${id}&path=ws",
    "timeout": 25,
    "upload_dir": "/data/upload",
    "fields": [],
    "port": 9000,
    "proxy_file": "/opt/launcher/proxy-mapping.txt",
    "sanitize": {
      "file": {
          "type": "regexp",
          "regexp": "^[-\\\\w./]+$",
          "default": "emptyFile"
      }
    }
  },
  "properties": {
    "dataDir": "/data",
    "webapps_dir": "/opt/paraview/share/paraview-5.6/web",
    "python_exec": "/opt/paraview/bin/pvpython"
  },
  "apps": {
    "MySuperPVWApp": {
      "cmd": [
        "${python_exec}",
        EXTRA_PVPYTHON_ARGS
        "/pvw/server/pvw-server.py",
        "--port", "${port}",
        "--authKey", "${secret}",
        "--timeout", "30"
      ],
      "ready_line" : "Starting factory"
    },
    "visualizer": {
      "cmd": [
        "${python_exec}",
        EXTRA_PVPYTHON_ARGS
        "${webapps_dir}/visualizer/server/pvw-visualizer.py",
        "--port", "${port}",
        "--data", "${dataDir}",
        "--authKey", "${secret}",
        "--viewport-max-width", "1920",
        "--viewport-max-height", "1080",
        "--timeout", "30"
      ],
      "ready_line" : "Starting factory"
    },
    "visualizer-with-file": {
      "cmd": [
        "${python_exec}",
        EXTRA_PVPYTHON_ARGS
        "${webapps_dir}/visualizer/server/pvw-visualizer.py",
        "--port", "${port}",
        "--data", "${dataDir}",
        "--authKey", "${secret}",
        "--viewport-max-width", "1920",
        "--viewport-max-height", "1080",
        "--timeout", "30",
        "--load-file", "${file}"
      ],
      "ready_line" : "Starting factory"
    },
    "paraview-lite": {
      "cmd": [
        "${python_exec}",
        EXTRA_PVPYTHON_ARGS
        "${webapps_dir}/lite/server/pvw-lite.py",
        "--port", "${port}",
        "--data", "${dataDir}",
        "--authKey", "${secret}",
        "--viewport-max-width", "1920",
        "--viewport-max-height", "1080",
        "--timeout", "30"
      ],
      "ready_line" : "Starting factory"
    },
    "divvy": {
      "cmd": [
        "${python_exec}",
        EXTRA_PVPYTHON_ARGS
        "${webapps_dir}/divvy/server/pvw-divvy.py",
        "--port", "${port}",
        "--data", "${dataDir}/${file}",
        "--authKey", "${secret}",
        "--viewport-max-width", "1920",
        "--viewport-max-height", "1080",
        "--timeout", "30"
      ],
      "ready_line" : "Starting factory"
    }
  }
}

Running docker

Configuration properties

We use environment variable (-e) for our Docker in order to dynamically configure our launcher configuration:

SERVER_NAME: Specify which hostname and port the service will be accessible to.
PROTOCOL: Specify which ws protocol you want to use ws or wss.
EXTRA_PVPYTHON_ARGS: Arbitrary set of arguments.

In the launcher configuration those properties will then be used to replace the following keywords:

SESSION_URL_ROOT: “${PROTOCOL}://${SERVER_NAME}”
EXTRA_PVPYTHON_ARGS: EXTRA_PVPYTHON_ARGS split by ‘,’

Use OSMesa for CPU only

export PORT=8080
export DATA=/my-datasets/
export DEPLOY=/my-pvw-app/
export SERVER_NAME=localhost:443
export PROTOCOL=wss

sudo docker                              \
    -p 0.0.0.0:${PORT}:80                 \
    -v ${DATA}:/data                       \
    -v ${DEPLOY}:/pvw                       \
    -e "SERVER_NAME=${SERVER_NAME}"          \
    -e "PROTOCOL=${PROTOCOL}"                 \
    -e EXTRA_PVPYTHON_ARGS="-dr,--mesa-swr"    \
    -ti kitware/paraviewweb:pvw-v5.6.0-osmesa

Use EGL for NVIDIA GPU

export PORT=8080
export DATA=/my-datasets/
export DEPLOY=/my-pvw-app/
export SERVER_NAME=localhost:443
export PROTOCOL=wss

sudo docker run --gpus all              \
    -p 0.0.0.0:${PORT}:80                \
    -v ${DATA}:/data                      \
    -v ${DEPLOY}:/pvw                      \
    -e "SERVER_NAME=${SERVER_NAME}"          \
    -e "PROTOCOL=${PROTOCOL}"                 \
    -ti kitware/paraviewweb:pvw-v5.6.0-egl