demo-in-a-box

This is a set of materials designed to allow anyone to create a portable set of computers that will allow people to demonstrate most aspects of Open Horizon and OH-delivered applications in a single location. It should contain a Bill of Materials, initial configuration, setup instructions, and examples of how to demonstrate most features.

Pre-requisites

You must have the following utilities installed in order to provision:

• make
• vagrant
• virtualbox

Additionally, this must be run on an x86_64 architecture machine running a Debian-based OS such as Ubuntu.

System Configurations

The x86_64 architecture host can be configured one of four ways:

• Unicycle -- As two VMs, with
  • the primary running the Exchange and an Agent using 1/2 of the available resources, and
  • the remaining VM running an Agent also using 1/2 of the available resources.
• Bicycle -- As three VMs, with
  • the primary running the Exchange and an Agent using 1/2 of the available resources, and
  • the remaining two running Agents each using 1/4 of the available resources.
• Car -- As five VMs (recommended for the 16GB RAM configuration only), with
  • the primary running the Exchange and an Agent using 1/2 of the available resources, and
  • the remaining four running Agents each using 1/8 of the available resources.
• Semi -- As seven VMs (recommended for the 16GB RAM configuration only), with
  • the primary running the Exchange and an Agent using 1/4 of the available resources, and
  • the remaining six running Agents each using 1/8 of the available resources.

Installation

Clone the repository, then cd into the repo folder.

Run make check to verify dependencies are installed and defaults are correct. Further, run make status to confirm that Vagrant is installed and running properly.

Running make init will provision the default system configuration ("unicycle"). To use any other configuration, first export SYSTEM_CONFIGURATION=<system configuration string> where <system configuration string> is one of "unicycle", "bicycle", "car", or "semi" without the quotes. Installation should take between 30 minutes for unicycle to an hour for semi.

If you only want the hub running in a VM with an agent, and not a separate agent in a VM, just run make up-hub instead of make init, but make sure you copy over the credentials from the "mycreds.env" file on the host.

Running make down will de-provision the system and cannot be undone. Make sure you really want to do this.

Usage

Run make connect to SSH to the first agent VM in unicycle configuration. For all other configurations, specify the "VMNAME" as an argument: make connect VMNAME=agent3. The credentials can be set by running export $(cat agent-install.cfg). To test that the installation is configured and working, run the following commands:

hzn version

This should return matching version numbers for both the CLI and the agent.

hzn node list

This will show the agent is running and the HelloWorld sample workload is configured and running.

hzn ex user ls

This will confirm that the CLI can connect to the exchange in the hub's VM, and that the credentials are valid.

hzn ex node ls

This will show all of the agents registered with the exchange in the hub VM.

exit

Will disconnect from the agent VM and end the SSH session.

make down

Will remove all of the VMs and delete temporary files.

Advanced details