Minion Appliance Installation

The Appliance Service lets you set up, configure, and communicate with Minion Appliances. Both hardware and virtual appliances are supported.

Before you use the Appliance Service, you must have an appliance installed on your network and one instance of OpenNMS running OpenNMS Horizon 30.0+ or Meridian 2022+.

You can only assign one Minion per Minion Appliance.

Checklist: before you begin

Depending on your network environment, there are tasks that you must complete before installing a Minion Appliance. Answer the following questions about your network environment to determine what steps you must take:

  1. Does your network restrict outgoing connections?

  2. Does your network have direct access to the internet?

    • Yes: Proceed to the next question.

    • No: You need an HTTP/S proxy to download the Minion Appliance image files from the Docker Registry and Snap Store. Collect your HTTP/S proxy information and set it during deployment.

  3. Does your network restrict you from downloading images directly from Docker Hub?

  4. Does your network use DHCP?

    • Yes: Proceed to the next question.

    • No: You need to manually set the following information during deployment: static IP address, gateway address, DNS server, and DNS search names.

  5. Is your network set up with SSL?

Once you have completed these tasks, you can deploy an appliance.

Hardware appliance requirements

  • Mini or 1U appliance

  • Ethernet cable

Virtual appliance requirements

  • 2 vCPUs

  • 4 GB RAM

  • 15 GB disk space

  • VMware 7.x environment with vCenter (the Appliance does not support standalone ESXi)

Use an HTTP, HTTPS proxy

HTTP/S proxy settings indicate the route by which the Minion Appliance accesses the image files from the Docker Registry and Snap Store. You must reboot the system for settings to take effect. We recommend configuring this information as part of the initial deployment of the appliance.

All HTTPS connections from the appliance go through the configured HTTPS proxy. This includes the regular polling of the OpenNMS core to determine its version number and synchronize with the Minion. You cannot selectively bypass the HTTPS proxy. Proxy setup with basic authentication is not supported, as the username and password are in clear text, which is insecure.