Add your first probe

A probe is a small service that runs on your network. ITVA uses it to connect to your devices. In this guide, you create a probe in the portal, download its config file, install the probe, and test the connection.

You can install the probe on Linux, Windows, or in a Docker container. We recommend Linux.

Before you begin

• Access to the ITVA portal, with permission to manage probes.
• A host on the network that can reach your devices:
  • Linux: a distribution that uses systemd, on x86 (amd64) or ARM (arm64), with sudo access.
  • Windows: an account with administrator rights.
  • Docker: Docker installed on the host.
• Outbound network access from the host to your ITVA instance host on ports 443 and 8443.

Create the probe

1. In the portal, go to Inventory > Probes.
2. Select Provision Probe.
3. In Name, enter a name for the probe. For example, the site or network it serves.
4. Select Save. The portal opens the page for the new probe.

Download the config file

1. On the probe's page, select Access Config.
2. Select Download. The browser saves the file as itva.yml.
3. Copy itva.yml to the host where you will install the probe.

The config file contains the probe's authentication token. Keep it private, and do not commit it to source control.

Each probe has its own config file. Use the file only for the probe you downloaded it from.

Install on Linux (recommended)

The installer creates a systemd service named itva. The service reads the config file from the path you give the installer. Do not move or delete the config file after you install the probe.

1. Move the config file to a permanent location:

sudo mkdir -p /etc/itva
sudo mv ~/itva.yml /etc/itva/itva.yml

2. In the portal, go to Inventory > Probes. In Probe Download, copy the link for your host's CPU: Download Linux x86 Installer or Download Linux ARM Installer.
3. On the host, download and extract the package. Replace <DOWNLOAD_URL> with the link you copied:

mkdir itva-probe && cd itva-probe
wget -O itva-probe.tar.gz "<DOWNLOAD_URL>"
tar -xzvf itva-probe.tar.gz

4. Run the installer with sudo, and give the full path of the config file:

sudo CONFIG_FILE_PATH=/etc/itva/itva.yml ./install.sh

If you run sudo ./install.sh without CONFIG_FILE_PATH, the installer asks for the path.

5. Make sure the service is running:

systemctl status itva

Install on Windows

1. In the portal, go to Inventory > Probes. In Probe Download, select Download Windows Service.
2. Extract the downloaded .zip file.
3. Run the .msi installer from the extracted folder.
4. On the Specify File Path screen, enter the full path of the config file. For example, C:\ProgramData\Itva\itva.yml.
5. Complete the installer.

The installer adds a Windows service named Itva. The service reads the config file from the path you entered. Do not move or delete the config file after you install the probe.

Install with Docker

The probe image is itva/probe on Docker Hub.

1. Pull the latest image:

docker pull itva/probe:latest

2. Create the container:

docker create --name itva_probe --restart unless-stopped itva/probe:latest

3. Copy the config file into the container at /app/itva.yml. Replace <PATH_TO_ITVA_YML> with the path of the config file on the host:

docker cp <PATH_TO_ITVA_YML> itva_probe:/app/itva.yml

4. Start the container:

docker start itva_probe

The probe reads its config from /app/itva.yml. If you remove the container, copy the config file into the new container again.

Check that it worked

1. In the portal, go to Inventory > Probes and open your probe.
2. Select Test Connection.
3. Wait for the result:
   • Successful health check: the portal can reach the probe.
   • An error message: the portal cannot reach the probe. See Troubleshooting.

The portal also runs a health check on all active probes every 5 minutes.

Troubleshooting

If the Linux installer shows "The specified config file does not exist", the path is wrong. Run the installer again with the full path, for example /etc/itva/itva.yml.

If the Linux installer shows "This script must be run as root or with sudo privileges", run it again with sudo.

If Test Connection fails:

• Make sure the probe is running. On Linux, run systemctl status itva. On Windows, look for the Itva service in Services. On Docker, run docker ps and look for itva_probe.
• Make sure the host uses the config file for this probe.
• On the probe's page, open Logs from the Test Connection menu.