Creating a Collector

A Collector must be created for your Deployment before the Edge Node can be installed, whether on a VM or on Neeve. Creating a Collector generates the files needed to activate the Edge Node: an ISO and OVA for a VM-based install, or a config file for a Neeve-based install.

⚠️ Only one Collector can remain active per Deployment at a time.

When should you create a new Collector?

Create a new Collector if:

• This is your first installation for the Deployment
• You need to run an updated version of the Collector
• You need to configure a static IP address (VM only)
• You need to enable audit access, e.g. for IT security scans (VM only)
• You need to allow Onboard WireGuard® VPN access for troubleshooting (VM only)

⚠️ Collector configurations cannot be edited after creation. If you need to modify static IP, audit access, or VPN settings, disable the existing Collector on the Management tab and provision a new one. Disabled collectors are automatically removed from the system 30 days after being disabled.

🖥️ Creating a Collector for a VM (VMware or Hyper-V)

1. Navigate to the Deployments page in the Onboard App.
2. Click on the building Deployment where you want to install the Edge Node.
3. Open the Management tab.
4. Click Create Collector.
   • You will see configuration options for Static IP, Audit SSH Key, and Onboard WireGuard Access.
   • If enabling Audit SSH Key, confirm your scanning tool supports Onboard's required SSH algorithms. See the Audit section of the Security Brief for the full list.
   • If none of these are required, leave the fields blank.
5. Click Submit. This will download filename.iso.gz.
   • You will also see a prompt to download the latest Onboard Edge Node OVA file. If you do not already have the latest version, download it using the link provided. The OVA contains the Edge Node software packaged as a virtual machine image, you will deploy this in your virtualization environment to run the Edge Node inside your building's network.
6. Decompress the downloaded iso.gz file using 7-Zip (Windows) or gunzip (Linux).
   • After extraction, you should have: filename.iso

⚠️ The ISO file is valid for 14 days from the date of creation and can be used up to 5 times.

Continue to Installing Edge Node on VMware or Installing Edge Node on Hyper-V depending on your platform.

🌐 Creating a Collector for Neeve

1. Navigate to the Deployments page in the Onboard App.
2. Click on the building Deployment where you want to launch the Edge Node.
3. Open the Management tab.
4. Click Create Collector, then select Neeve instead of the standard VM option.
5. Click Submit. This will download a config file.

Use the downloaded config file as the pod specification when deploying a custom service on your Neeve box. Refer to Neeve's Deploy a custom service documentation for the rest of the process.

See Onboard's listing on the Neeve App Marketplace for more details.

⚠️ What Onboard Cannot Manage on Neeve

Onboard cannot manage the following for a Neeve-hosted Collector, unlike a VM-based Collector:

• Collector updates/ restart
• Static IP configuration
• DNS Nameserver configuration
• Audit SSH Key access
• Host-level monitoring (CPU, disk usage)

These can be configured in the Neeve dashboard.

Note: To apply a Collector update, restart the Collector yourself from the Neeve dashboard andthe update will be triggered on restart. We will inform you when a restart is required.