Minion Appliance installation

The Appliance Service lets you set up, configure, and communicate with Minion Appliances (hardware and virtual). Before you use the Appliance Service, you must have a Minion Appliance installed on your network.

You can only assign one Minion per Minion Appliance.

Checklist: before you begin

Depending on your network environment, there are tasks 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?

    1. Yes: Review and implement the security and Minion Appliance firewall rules. (Even if you answer "no," you should still review the firewall rules.)

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

    1. 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 use DHCP?

    1. No: You need to set the following information: static IP address, gateway address, DNS server, and DNS search name(s). Make sure you have this information and set it during deployment.

  4. Is your network set up with SSL?

    1. Yes: You need to add a certificate to the Minion Appliance’s default trust store.

Once you have completed these tasks, you can deploy a hardware or virtual appliance.

Hardware appliance requirements

  • Mini or 1U appliance

  • Ethernet cable

  • one instance of OpenNMS running OpenNMS Horizon 29.0+ or or Meridian 2022+

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)

  • One instance of OpenNMS running OpenNMS Horizon 29.0+ or Meridian 2022+

About the HTTP(S) 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 Minion 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 user name/password are in clear text, which is insecure.