README

ABOUT PHPQstat
==============================================
PHPQstat is a web interface that allows to connect to the useful commands of the Sun Grid Engine (SGE) batch queue system. With this interface, you can monitor your job status and your queues health at real time. In the Slurm branch you will find similar interface for this workload manager.
This project is developed and maintained by HPCNow! consulting : http://www.hpcnow.com

AUTHOR : Written by Jordi Blasco Pallarès (jordi.blasco@hpcnow.com).
	 qstat reduce and remote master options added by Lydia Sevelt (LydiaSevelt@gmail.com)

REPORTING BUGS : Report bugs to GitHUB issue Tracker https://github.com/HPCNow/PHPQstat/issues

LICENSE : This is free software: you are free to change and redistribute it. GNU General Public License version 3.0 (GPLv3).
Version : 0.2.3 (January 2016)

https://github.com/HPCNow/PHPQstat

DEPENDENCIES
==============================================
You will need Apache server, php5, rrdtool and awk.

for remote master setup:

webserver: apache, php5, rrdtool, awk, snmp-utils
sge_master: snmpd, awk

INSTALL
==============================================
(1) Copy all files in your web accesible filesystem or download the project using GIT:
    git clone git://github.com/HPCKP/PHPQstat.git
(2) Setup the following paths on phpqstat.conf :
    SGE_ROOT=/sge
    RRD_ROOT=/var/www/PHPQstat/rrd
    WEB_ROOT=/var/www/PHPQstat
(3) Setup the following config variables in config.inc.php :
    $qstat_reduce="yes";
    $cache_time="3";
(4) If using qstat_reduce set LOAD_WAIT variable in phpqstat.conf for high load average protection :
    LOAD_WAIT=10.00
(5) Add the following line on the crontab :
    */3 * * * * /var/www/PHPQstat/accounting.sh > /dev/null 2>&1

SETTING UP A REMOTE MASTER CONFIG
----------------------------------------------
(6) Set REMOTE_MASTER in phpqstat.conf to the hostname of sge_master server :
    REMOTE_MASTER=sgemaster.company.com
(7) Configure snmpd on sge_master host to provide uptime and load information via community public :

    com2sec notConfigUser  default       public
    group   notConfigGroup v1           notConfigUser
    view    systemview    included   .1.3.6.1.4.1.2021.10
    access  notConfigGroup ""      any       noauth    exact  systemview none none

ROADMAP
==============================================
0.1 Functional
0.2 Real-time accounting
0.3 Security & Stable
0.4 Look & aspect improvement

TODO LIST
==============================================
* Group joblist
* all users joblist
* Job info (submission time, wait time, walltime, cputime, efficiency=(cputime/(walltime*slots))

CHANGELOG
==============================================
0.1.0 Project started
0.1.1 Install instructions and job details support
0.1.2 Solved problem on cputime request on pending job
0.1.3 Solved problems with Start time and Submission Time
0.2.0 Real-time accounting feature
0.2.1 Migration to HPCNow GitHUB repo
0.2.2 Added qstat_reduce to cache xml files and only refesh based a time interval with high load average protection
0.2.3 Added ability to run phpqstat on a webserver that is a submit host, eliminating the need to run on the sge_master node