ovishpc/ldms-web-svc repository overview

⁠LDMS Web Service (UI back-end) Docker Image

This image contains Web Service (UI back-end) components (based on Django) that provides LDMS-SOS data access over HTTP (served by uwsgi).

⁠References

• LDMS source code: https://github.com/ovis-hpc/ovis⁠
• LDMS Docker Images source code: https://github.com/ovis-hpc/ldms-containers⁠
• UI back-end sources:
  • https://github.com/nick-enoent/numsos/⁠
  • https://github.com/nick-enoent/sosdb-ui/⁠
  • https://github.com/nick-enoent/sosdb-grafana/⁠

⁠SYNOPSIS

$ docker run -d --name=<CONTAINER_NAME> --network=host --privileged
         -v /on-host/dsosd.conf:/opt/ovis/etc/dsosd.conf # dsosd.conf file, required to connect to dsosd
         -v /on-host/settings.py:/opt/ovis/ui/sosgui/settings.py # sosdb-ui Django setting file
         ovishpc/ldms-ui # the image name
             [ --http-socket=<ADDR>:<PORT> ] # addr:port to serve, ":80" by default
             [ OTHER uWSGI OPTIONS ]

⁠DESCRIPTION

ovishpc/ldms-ui execute uwsgi process with sosgui (the back-end GUI WSGI module) application module. It is the only process in the container. The uwsgi in this container by default will listen to port 80. The --http-socket=ADDR:PORT will override this behavior. Other options given to docker run will also be passed to the uwsgi command as well.

The sosgui WSGI application requires two configuration files:

1. dsosd.conf: containing a list of hostnames of dsosd, one per line. See here⁠ for an example.
2. settings.py: containing a WSGI application settings. Please pay attention to DSOS_ROOT and DSOS_CONF. See here⁠ for an example.

⁠EXAMPLES

## On a service node

# Pull the container image
$ docker pull ovishpc/ldms-ui

# Start ldms-ui container, using host network namespace
$ docker run -d --name=ui --network=host --privileged \
           -v /HOST/dsosd.conf:/opt/ovis/etc/dsosd.conf \
           -v /HOST/settings.py:/opt/ovis/ui/sosgui/settings.py \
         ovishpc/ldms-ui