Install NetBeez Agents

Requirements

 

NetBeez supported options for Agents

  • Linux Debian
  • Virtual appliance (OVA)
  • Raspberry Pi image
  • Odroid image
  • Docker container

 

 

software-agent-icon-150x150.png Option 1 - Debian Linux package

1. Log into the Linux host where you want to install the software Agent.
2. 
Fetch the installation script:

curl -L -O https://raw.githubusercontent.com/netbeez/agent-installation/master/agent_setup.sh

3. Execute the script as sudo user (replace <secret_key_received_via_email> in the following command with the actual secret key received upon registration of your dashboard or find it on the About page in your NetBeez Settings):

sudo bash agent_setup.sh --modify-interface --secret=<secret_key_received_via_email>

Please note: 32 bit versions of Linux are not supported.

 

virtual-agent-icon.png Option 2 - Virtual appliance

1. Download the NetBeez Agent virtual appliance at the following URL:

IMG: https://storage.googleapis.com/netbeez-public/netbeez-virtual-agent.ova

2. Import the appliance into your virtual environment (VMWare, vBox, etc.)

     Note: If you are using vBox manager, make sure to select Linux/Ubuntu as OS Type.

     Note: By default the OVA is provisioned with 1 vCPU and 1 GB of RAM; these resources should be enough for most installations.

3. Log in to the virtual appliance using netbeez/netbeez as username/password.

4. Fetch the installation script:

curl -L -O https://raw.githubusercontent.com/netbeez/agent-installation/master/agent_setup.sh

5. Execute the script as sudo user (replace <secret_key_received_via_email> in the following command with the actual secret key received upon registration of your dashboard or find it on the About page in your NetBeez settings):

sudo bash agent_setup.sh --secret="<secret_key_received_via_email>"

 

rpi-agent-icon.png Option 3 - Raspberry Pi image

1.  Download the NetBeez Raspbian image:

IMG: https://storage.googleapis.com/netbeez-public/generic_free_rpi-model-b.img.zip

MD5: https://storage.googleapis.com/netbeez-public/generic_free_rpi-model-b.img.zip.md5

To decompress the image file, please use an application that supports the 7z format. Please note that this image supports the Raspberry Pi 3B but not 3B+. For 3B+ boards, please use the software agent version.

2. Install the NetBeez Raspbian image on an 8 GB SD card. Instructions can be found here.

3. Insert the SD card into your Raspberry Pi and boot the device.

4. Once booted, log in to the Raspberry Pi using netbeez/netbeez as username/password.

5. Fetch the installation script:

curl -L -O https://raw.githubusercontent.com/netbeez/agent-installation/master/agent_setup.sh

6. Execute the script as sudo user (replace <secret_key_received_via_email> in the following command with the actual secret key received upon registration of your dashboard or find it on the About page in your NetBeez settings):

sudo bash agent_setup.sh --modify-interface --secret="<secret_key_received_via_email>"

Please note: The Raspberry Pi 3 is also equipped with a WiFi interface. For the correct operation of the NetBeez Agent, it is recommended that you disable the WiFi interface.

 

C2 Option 4 - Odroid C2 image

1.  Download the NetBeez Odroid C2 image:

IMG: https://storage.googleapis.com/netbeez-public/generic_free_odroid-model-c2.img.zip

MD5: https://storage.googleapis.com/netbeez-public/generic_free_odroid-model-c2.img.zip.md5

To decompress the image file, please use an application that supports the 7z format.

2. Install the Odroid Debian image on an 8 GB SD card. Instructions can be found here.

3. Insert the SD card into your Odroid and boot the device.

4. Once booted, log in to the Odroid using netbeez/netbeez as username/password.

5. Fetch the installation script:

curl -L -O https://raw.githubusercontent.com/netbeez/agent-installation/master/agent_setup.sh

6. Execute the script as sudo user (replace <secret_key_received_via_email> in the following command with the actual secret key received upon registration of your dashboard or find it on the About page in your NetBeez settings):

sudo bash agent_setup.sh --secret="<secret_key_received_via_email>"

If you are having problems, please read the FAQ at the bottom of this page or send an email to support [at] netbeez [dot] net.

 

docker_facebook_share.png Option 5 - Docker Container

NetBeez has released the Docker Agent, an Agent that runs in a Docker container. To install a Docker Agent, run the following command:

docker run -d --mac-address="02:42:$(openssl rand -hex 4 | sed 's/\(..\)/\1:/g; s/.$//')" \ -e "NB_SECRET_KEY=xxx" netbeez/nb-agent

Make sure to replace the 'xxx' with your server's secret key, as well as the volume with a created docker volume.

To configure the Docker Agent, follow the setup guide on DockerHub

 

FAQ

Q: What should I do after I have loaded the Agents?

A: Log in to your dashboard instance, the URL of which was sent with the welcome email, and then create and review your monitoring Targets.

Q: The OVA file I downloaded has an .ovf extension.

A: This is a known issue with Chrome. Please see the reported issue here. You can still load and use the image.

Q: Why doesn't the virtual Agent seem to boot after I have imported it in vBox?

A: Make sure to select Linux/Ubuntu-64 as machine type.

Q: Where is the Agent log?

A: The default agent log file location is /var/log/netbeez/nbagent_prod.log for virtual and Raspberry Pi images, while it's /var/log/netbeez/netbeez-agent.log for the software Agent.

Q: What happens if the Agent does not show up on the dashboard?

A: Check out this troubleshooting guide

Q: I get an error decompressing the Raspberry Pi image on Windows.

A: Use the 7-Zip program in Windows.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.