vaporio/opendcre repository overview

Overview

OpenDCRE provides a securable RESTful API for monitoring and control capabilities, including analog and digital sensors and power control of OCP servers. The OpenDCRE API is easy to integrate into third-party monitoring, management and orchestration providers, while providing a simple, curl-able interface for common and custom devops tasks. See the OpenMistOS web site for API reference and user's guide.

Requirements

• Raspberry Pi 2 Model B (other Raspberry Pi versions are not supported).
• 4GB Micro SD card - 8GB or larger recommended.
• 5V Micro USB power source.
• Wired ethernet connection (wireless supported but not recommended).
• OCP OpenDCRE HAT (optional)
• HDMI/HDMI-VGA video cable & monitor (optional)
• OpenMistOS v1.0.0 or later.

Running and Testing OpenDCRE

OpenDCRE expects a volume to be exposed for logs (/logs). Additionally, OpenDCRE, by default, uses TCP port 5000 to listen for API requests. In cases where the OpenDCRE HAT is used with the OpenDCRE container, the /dev/ttyAMA0 serial device is also required.

To start OpenDCRE with the HAT device attached:

docker run -d -p 5000:5000 -v /var/log/opendcre:/logs --device /dev/ttyAMA0:/dev/ttyAMA0 opendcre ./start_opendcre.sh

To start OpenDCRE in emulator mode:

docker run -d -p 5000:5000 -v /var/log/opendcre:/logs opendcre ./start_opendcre_emulator.sh

To run the OpenDCRE test suite:

docker run -ti -v /var/log/opendcre:/logs opendcre ./opendcre_southbound/bus-test.py

License

OpenDCRE is released under GPLv2 - see LICENSE for more information.