Skip to content

Latest commit

 

History

History
87 lines (47 loc) · 3.16 KB

README.md

File metadata and controls

87 lines (47 loc) · 3.16 KB
Raw

Curve Sentinel

An all-powerful toolset for Curve.

Sentinel is an autonomous agent for persisting, processing and automating Curve 2.0.0.0 governance objects and tasks, and for expanded functions in the upcoming Curve V3 release.

Sentinel is implemented as a Python application that binds to a local version 2.0.0.0 curved instance on each Curve V2 Masternode.

This guide covers installing Sentinel onto an existing 2.0.0.0 Masternode in Ubuntu 14.04 / 16.04.

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
$ sudo apt-get -y install virtualenv

Make sure the local Curve daemon running is at least version 2.0.0.0 (protocol 70210)

$ curve-cli getinfo | grep version

2. Install Sentinel

Clone the Sentinel repo and install Python dependencies.

$ git clone https://github.com/curvecoin/CurveSentinel.git && cd CurveSentinel
$ 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 '/home/YOURUSERNAME/CurveSentinel' to the path where you cloned sentinel to:

* * * * * cd /home/YOURUSERNAME/CurveSentinel && ./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 curved and the installation is complete

Configuration

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

curve_conf=/path/to/curve.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

Contributing

Please follow the CurveCore guidelines for contributing.

Specifically:

  • Contributor Workflow

    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.

License

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