Advanced Installation

This page includes manual installation instructions, as well as instructions on installing the VividCortex agent using Chef, Puppet, or Ansible.

Manual Installation

You will need your agent API token. You can find your token in the Add Host wizard from the Hosts dashboard. Open the wizard and click “Containerized,” which will show you the token.

For Linux and FreeBSD, this installation script will download the supervisor and install a VividCortex init script:

curl https://download.vividcortex.com/install > install
sh install

For Windows, download and run the VividCortex installer. If you don’t have a packet capture driver in place, it will ask you to install one if you intend to do on-host monitoring. Please download Npcap. Make sure to use following configuration:

  • Automatically start the Npcap driver at boot time TICK
  • Support loopback traffic (“Npcap Loopback Adapter” will be created) TICK
  • Use DLT_NULL as the loopback interface link layer protocol instead of DLT_EN10MB TICK (default)
  • Restrict Npcap driver’s access to Administrators only TICK
  • Support raw 802.11 traffic (and monitor mode) for wireless adaptors UNTICK
  • Support 802.1Q VLAN tag when capturing and sending data TICK (default)
  • Install Npcap in WinPcap API-compatible mode TICK (default)

Then, for both Linux and Windows, continue the installation by waiting a few moments and then check the Hosts list in the VividCortex app. You should see the new OS host appear as the supervisor registers it.

The database-specific metrics agent needs a login to capture status metrics and the like. You can use an existing user, or create a new one, provided that it has the correct permissions. For MySQL, you could use:

CREATE USER vividcortex@'%' IDENTIFIED BY 'somepass';
GRANT SELECT, PROCESS, REPLICATION CLIENT ON *.* TO monitor@'%';

For PostgreSQL:

CREATE ROLE vividcortex NOSUPERUSER NOCREATEDB NOCREATEROLE INHERIT LOGIN PASSWORD '<password here>';

For more information on the privileges the VividCortex user needs, and what data each privilege provides, see here.

After creating this user, find the host on the Hosts List and click on the settings gear to the right:

Edit Host

Enter the credentials in the dialog that appears.

Installing With Chef

We also provide a Chef cookbook that acts as an installation wrapper: github.com/VividCortex/chef-cookbook.

In order to use it, you must set the vividcortex['token'] attribute to your API token, and add its default recipe to your runlist. To find your API token, open the Add Hosts wizard and click “Containerized”; your API token will be displayed.

# Attribute example
{
    "vividcortex" => {
        "token" => "12345678901234567890123456789012"
    }
}

# Add it to your runlist:
{
    "run_list": ["recipe[vividcortex]"]
}

Installing From RPM Packages

We can provide an RPM repository with packages for your convenience. The RPM does not contain a complete set of agent binaries; instead it contains a stable version of the agent (and any plugins) which will upgrade and install itself.

Installing From Puppet

We also provide a Puppet manifest for installing the repo, at github.com/VividCortex/puppet. This installs the repo and the agent. It accepts various parameters such as your API token.

If you do not use a configuration management system such as Ansible, Chef, or Puppet to generate the /etc/vividcortex/global.conf file, you must generate it manually. The agent will not work without it, and the RPM installation will fail as a result. The configuration file must be created before installing the RPM.

To install the repository and then the agent, run the following commands:

rpm -Uvh https://repo.vividcortex.com/repo/centos/6/x86_64/vividcortex-release-1-1.amzn1.noarch.rpm
yum install vividcortex-agents