Installing a Linux Agent

This document provides instructions on how to set up and install a Linux-based On-Premises Agent to use with Liongard.

👍

Supported Distributions

Currently, the Linux Agent only officially supports Ubuntu and Red Hat. Although most of the data collection is generic to any Linux distribution, thus far testing has only been completed on Ubuntu and Red Hat.

Installing the Agent:

🚧

What user should I run the Agent as?

We recommend using a normal local user with sudo access on the system and not running as root.

  • Log in to the Linux system
  • Copy the following script over to the Linux system. Fill out the top-level parameters and save in a file called, "install-roar.sh"
    • INSTANCE = Your Liongard instance. You only need to include the first part of the subdomain, "app.liongard.com" is assumed
    • AGENT_NAME = The name you wish to give to the Agent
    • DESCRIPTION = An optional description to give to the Agent
    • ACCESS_KEY = Your Access Key from Liongard
    • ACCESS_SECRET = Your Access Secret from Liongard
    • SERVICE_PROVIDER = The name of your company as it appears in the top left corner of your Liongard instance
    • ENVIRONMENT = The name of the Environment in Liongard to associate the Agent to
      • Note: You can remove --environment $ENVIRONMENT from Line #12 below if you wish to associate the Environment via the Liongard UI later
    • USER = The username of the user on the system you wish to run the Agent as
  • Run chmod 775 install-roar.sh
  • Run sudo install-roar.sh
#!/bin/bash
INSTANCE="us4"
AGENT_NAME="myagentname"
DESCRIPTION="This agent is for XXX"
ACCESS_KEY=""
ACCESS_SECRET=""
SERVICE_PROVIDER=""
ENVIRONMENT=""
USER="ubuntu"
curl -k https://$INSTANCE.app.liongard.com/api/v1/agents/scripts/setup-roar-agent/ -o setup-roar-agent
chmod 775 setup-roar-agent
sudo -u $USER ./setup-roar-agent --url "$INSTANCE.app.liongard.com" --name "$AGENT_NAME" --description "$DESCRIPTION" --access-key $ACCESS_KEY --access-secret $ACCESS_SECRET --service-provider "$SERVICE_PROVIDER" --environment "$ENVIRONMENT"

Downloading the Agent Install Script Manually (Note: You can usually skip this step.)

  • Log in to Liongard
  • Click on the Admin menu and select Agents
  • Hover over the Download Agent Installer button in the top-right corner and select Linux
  • You can either download the install script by clicking on the Download Setup-Roar-Agent button or copy the curl command to download it in the Shell.

FAQs

  • Do I need to whitelist specific URLs?

Yes. You must whitelist npmjs.org and nodejs.org as well as your Liongard instance in order to download and install the Agent successfully.

For further information about whitelisting URLs with the Agent, please visit the Deployment via MSI Installer document under the Whitelisting Requirements
section.

  • Do you support all Linux distributions and versions?

We have attempted to support across all versions and distributions. However, most of the testing has been done on Ubuntu. If you encounter problems on a specific distribution, please Support Portal: Chat with Support.

  • What if I need to uninstall a Linux Agent?

Step 1. Download the uninstall script with the following command

curl -k https://roar2.app.liongard.com/api/v1/agents/scripts/uninstall-roar-agent/ -o uninstall-roar-agent

Step 2. Open terminal in uninstall script location and run the following command

chmod +x uninstall-roar-agent

Step 3. Finally, run the following command

sh -e uninstall-roar-agent

Did this page help you?