maestro

Pelion Edge systems management daemon for Pelion Edge OS.

Overview

Maestro is a replacement for a number of typical Linux OS system utilities and management programs, while providing cloud-connected systems management. Maestro is designed specifically for cloud-connected Linux OS embedded computers, with somewhat limited RAM and disk space, where file systems are often flash - and would prefer less writing to the FS over time.

Major tasks maestro provides:

syslog daemon (replaces syslog-ng, syslogd, and others)
more advanced logging via the grease-log-client library
to-the-cloud logging
periodic system stats to cloud
config management for apps / container (config file templating, config API)
process creation & control
container management - starting / stoppping & installation
network setup (DHCP, static IP settings, with more to come)
critical systems control (reboot, remote command execution, etc.)
watchdog support
time sync
initial provisioning of system

Maestro can communicate in two ways:

locally with other process over its local API
a 'phone-home' style communication with its 'mothership' - this is WigWag's DCS

Advantages:

less memory footprint
less installation on disk
cloud connectivity
managment via local API

Maestro communicates to Pelion Cloud over https outbouund. It stores its config locally in a private database, but can also use DeviceDB for storage of applications, network settings, configs and other data when used in conjuction with standard Pelion Cloud services.

If you are locally on a gateway / edge system using maestro, you should explore maestro-shell which will let you interact with maestro directly using the local API.

Developing Maestro

Due to the large list of system services provided by Maestro, the recommended way to develop and test Maestro is in isolation using a virtual machine. Running Maestro on your local dev box, while possible, would create a lot of headaches and running Maestro in Docker is not possible. See the 'Why Vagrant?' section for additional info.

Pre-Requisites

Install the following tools:

vagrant (version 2.2.6)
virtualbox (version 6.0)
git bash (on windows only)

NOTE - For the following instructions to work correctly on Windows 10 you must install the latest version of Git and use Git Bash instead of Windows CLI to issue the commands.

Install Vagrant plugins. vagrant-reload is a plugin that allows vagrant to reboot a VM during provisioning. This is needed to reboot the vagrant VM while setting up required network interfaces.

vagrant plugin install vagrant-reload

On Windows use Git Bash to turn off Windows line conversions to protect the Linux scripts with the following command:

git config --global core.autocrlf false

Why Vagrant?

Maestro uses the vagrant for the following reasons:

Reliability - Vagrant guarantees that every user that tries to build maestro gets the same environment and toolset.
Network control - Unlike docker, vagrant allows us to specify network interfaces. Specifically, we setup a control and test network, which is explained in the vagrant folder README
System testing - Once again a limitation to docker, vagrant allows us to start and stop the maestro daemon and configure the system for complete system testing. Additionally, we can bring in other daemons into the system over time for additional testing (ex. devicedb, devicejs)

For more information as to how vagrant sets up the maestro environment, please read the README in the vagrant folder

Building

Start up the virtual machine. The very first time vagrant up is run, the VM will go through a provisioning phase.

git clone git@github.com:armPelionEdge/maestro.git
cd maestro
vagrant up

On Windows also do the following:

VAGRANT_PREFER_SYSTEM_BIN=1 vagrant ssh -c "chmod 400 ~/.ssh/id_rsa"

Then build maestro and its dependencies. You can run this whenever you desire as long as the VM is online

On Linux or Mac:

vagrant ssh -c "build_maestro"

On Windows:

VAGRANT_PREFER_SYSTEM_BIN=1 vagrant ssh -c "build_maestro"

Running

On Linux or Mac:

vagrant ssh -c "sudo maestro"

On Windows:

VAGRANT_PREFER_SYSTEM_BIN=1 vagrant ssh -c "sudo maestro"

Testing

Unit tests

Example of running a networking test:

vagrant ssh # Log in to VM
cd $MAESTRO_SRC # Go to maestro home dir

cd networking # Open networking tests
go test -v -run DhcpRequest # Run DhcpRequest test

System Tests

On the host machine, run the following commands: Note: Make sure you had built using vagrant up and vagrant ssh -c "build_maestro" before running tests.

cd tests # Go to SysTests folder
npm i # Only run once to download dependencies
npm test # Run mocha test suite

Additional Features/Information

Maestro Configuration

To view details on how to configure Maestro, see Maestro Config

DeviceDB

In order to test additional maestro functionality, the vagrant VM automatically installs and runs DeviceDB Edge and DeviceDB Cloud in the background. See DeviceDB for more information.

To view logs from DeviceDB Edge, run:

vagrant ssh
sudo journalctl -u devicedb_edge

To view logs from DeviceDB Cloud, run:

vagrant ssh
docker ps
docker logs <container-id>"

Where <container-id> is the ID of the DeviceDB Server docker container that was shown in docker ps

edhemphill/maestro