Sentinel is an autonomous agent for persisting, processing and automating Citrus V12.1 governance objects and tasks, and for expanded functions in the upcoming Citrus V13 release (Evolution).
Sentinel is implemented as a Python application that binds to a local version 12.1 citrusd instance on each Citrus V12.1 Masternode.
This guide covers installing Sentinel onto an existing 12.1 Masternode in Ubuntu 14.04 / 16.04.
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 Citrus daemon running is at least version 1.0 (100000)
$ citrus-cli getinfo | grep version
Clone the Sentinel repo and install Python dependencies.
$ git clone https://github.com/Citrus/Sentiel.git && cd sentinel
$ export LC_ALL=C
$ virtualenv ./venv
$ ./venv/bin/pip install -r requirements.txt
Check the configuration setting appending any missing parameters.
rpcuser=<ADD A RANDOM STRING HERE>
rpcpassword=<ADD A RANDOM STRING HERE>
listen=1
server=1
discover=1
rpcport=3132
rpcthreads=8
rpcallowip=127.0.0.1
daemon=1
staking=0
Enter the wallet folder and stop the wallet
citrus-cli stop
Enter the citrus config folder mentioned during the installation
cd ~/.citruscore
rm mncache.dat
rm mnpayments.dat
Enter the wallet folder and restart the wallet
citrusd -daemon=1 -reindex=1
Check the sync status
watch citrus-cli mnsync status
As soon as you see the following response press CTRL+C
citrus-cli mnsync status
{
"AssetID": 999,
"AssetName": "MASTERNODE_SYNC_FINISHED",
"Attempt": 0,
"IsBlockchainSynced": true,
"IsMasternodeListSynced": true,
"IsWinnersListSynced": true,
"IsSynced": true,
"IsFailed": false
}
Finally start the masternode
citrus-cli masternode start
Set up a crontab entry to call Sentinel every minute:
$ crontab -e
In the crontab editor, add the lines below, replacing '/home/YOURUSERNAME/sentinel' to the path where you cloned sentinel to:
* * * * * cd /home/YOURUSERNAME/sentinelLinux && ./venv/bin/python bin/sentinel.py >/dev/null 2>&1
Test the config by runnings all tests from the sentinel folder you cloned into
$ cd ~/sentinelLinux && ./venv/bin/py.test ./test
With all tests passing and crontab setup, Sentinel will stay in sync with citrusd and the installation is complete
An alternative (non-default) path to the citrus.conf file can be specified in sentinel.conf:
citrus_conf=/path/to/citrus.conf
To view debug output, set the SENTINEL_DEBUG environment variable to anything non-zero, then run the script manually:
$ cd ~/sentinelLinux && SENTINEL_DEBUG=1 ./venv/bin/python bin/sentinel.py
Please follow the CitrusCore guidelines for contributing.
Specifically:
-
To contribute a patch, the workflow is as follows:
- Fork repository
- Create topic branch
- Commit patches
In general commits should be atomic and diffs should be easy to read. For this reason do not mix any formatting fixes or code moves with actual code changes.
Commit messages should be verbose by default, consisting of a short subject line (50 chars max), a blank line and detailed explanatory text as separate paragraph(s); unless the title alone is self-explanatory (like "Corrected typo in main.cpp") then a single title line is sufficient. Commit messages should be helpful to people reading your code in the future, so explain the reasoning for your decisions. Further explanation here.
Released under the MIT license, under the same terms as CitrusCore itself. See LICENSE for more info.