Skip to content

swatchie-1/sentinel

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hilux Sentinel

An all-powerful toolset for Hilux.

Sentinel is an autonomous agent for persisting, processing and automating Hilux governance objects and tasks.

Sentinel is implemented as a Python application that binds to a local version hiluxd instance on each Hilux Masternode.

This guide covers installing Sentinel onto an existing Masternode in Ubuntu or Debian based distributions.

Installation

1. Install Prerequisites

Make sure Python version 2.7.x or above is installed:

python --version

Update system packages and ensure virtualenv is installed:

$ sudo apt-get update
$ sudo apt-get -y install python-virtualenv

Make sure the local Hilux daemon running is at least version (1000200)

$ hilux-cli getinfo | grep version

2. Install Sentinel

Clone the Sentinel repo and install Python dependencies.

$ git clone https://github.com/Hilux/sentinel.git && cd sentinel
$ virtualenv ./venv
$ ./venv/bin/pip install -r requirements.txt

3. Set up Cron

Set up a crontab entry to call Sentinel every minute:

$ crontab -e

In the crontab editor, add the lines below, replacing '~/sentinel' to the path where you cloned sentinel to:

* * * * * cd ~/sentinel && ./venv/bin/python bin/sentinel.py >/dev/null 2>&1

4. Test the Configuration

Test the config by runnings all tests from the sentinel folder you cloned into

$ ./venv/bin/py.test ./test

With all tests passing and crontab setup, Sentinel will stay in sync with hiluxd and the installation is complete

Configuration

An alternative (non-default) path to the hilux.conf file can be specified in sentinel.conf:

hilux_conf=/path/to/hilux.conf

Troubleshooting

To view debug output, set the SENTINEL_DEBUG environment variable to anything non-zero, then run the script manually:

$ SENTINEL_DEBUG=1 ./venv/bin/python bin/sentinel.py

License

Released under the MIT license, under the same terms as HiluxCore itself. See LICENSE for more info.

Releases

No releases published

Packages

No packages published