README.md

anax

Introduction

This project contains the Horizon client system source code. To learn more about the Horizon system, including how to try the Blue Horizon instance of it, please browse to http://bluehorizon.network. Note that the HEAD of this repository's master branch includes alpha-grade code under current development. Stable versions of this application are packaged for many Debian-based distributions. They are available for download at http://pkg.bluehorizon.network/linux/. To build the packages yourself, consult https://github.com/open-horizon/horizon-deb-packager.

Related Projects:

• anax-ui (http://github.com/open-horizon/anax-ui): The source for the Anax web UI
• horizon-deb-packager (https://github.com/open-horizon/horizon-deb-packager): A system for packaging Horizon system debs for multiple distributions and architectures. It also produces Ubuntu snaps
• raspbian-image (http://github.com/open-horizon/raspbian-image): The Raspbian image builder for Raspberry Pi 2 and 3 models dedicated to Horizon

Documentation

• Anax APIs
• Managed Workloads

Development

Preconditions

• To execute the lint and other code checkers (make lint or make check), you must install: go vet, golint, and jshint

Operations

Note that the Makefile silences a lot of its output by default. If you want to see more output from build steps, execute a build like this:

make mostlyclean check verbose=y

Build executable

make

Execute code checks

make lint

Format code

make format

Fetch dependencies

make deps

Note that this target is automatically executed when executing targets check and all. It is not automatically executed when executing test, test-integration, and generating specific executables.

Execute both unit and integration tests

make check

Execute unit tests

make test

Execute integration tests

make test-integration

Debug Logging

• Add "ANAX_LOG_LEVEL=5" to the Environment= configuration in the systemd unit file /etc/systemd/system/snap.bluehorizon.anax.service. Note that the value 5 is the classification of most debug log messages, 6 is used for even more granular log messages, something like a 'trace' level.
• Reload the systemd unit file with systemctl daemon-reload.
• Restart the anax process with systemctl restart horizon.service.

Development Environment

Note that this Makefile can construct its own GOPATH and build from it; this is a convenience that can sometimes cause problems for development tooling that expects a project to be in a subdirector of $GOPATH/src. To get full tool support clone this project as $GOPATH/src/github.com/open-horizon/anax.