~larry-e-works/uci-engine/write-exitcode-to-file

ReadMe

======

 

Documentation for the Non Functional Stats Service (NFSS). NFSS is composed of a few different parts:

 

* A python3 / pyramid app that exposes a RESTful interface to a postgres data store.

* A client-side javascript-based UI that talks to the above.

 

While the system is generally very simple, there are a few things that sysadmins ought to be aware of:

 

Generating Client Keys

-----------------------

 

Test data is submitted to the data store via the RESTful api, and this API call is secured with oauth. Client access keys need to be generated for every external client that wants to be able to post data into the database. This is achieved by changing to the nf-stats-service directory and running:

 

$ python3 -m nfss keys-add

 

This is an interactive script that will ask for client details, and finally will write a python script that can be used by the external client to insert data into the data store.

 

A list of client keys can be generated in a similar fashion:

 

$ python3 -m nfss keys-list

 

A specific client id can be revoked by specifying it's client access key like so:

 

$ python3 -m nfss keys-del cj2DriLAGxmxinDyJzvDVQVltRSLNI

 

(obviously the client key will change, this is just an example).

 

Cleaning the database

----------------------

 

Part of the oauth authentication scheme involves storing nonce values in the database. In order to prevent this table from filling up, we install a daily cron job that cleans the database. This can be achieved manually by running:

 

$ python3 -m nfss database-clean

 

Although this should never need to be done manually, since the restish charm installs a cron daily job to run this command.