Virtual Machine
  • 31 Dec 2021
  • 2 Minutes to read

Virtual Machine


How to install Traceable's API Security agent on a Virtual Machine.


The document details steps to install Traceable agent on virtual machines having one of the following two operating systems:


Prerequisites

Complete the following prerequisites before installing the Traceable agent:

  1. Generate authentication token. The authentication token is available in Traceable's Onboarding UI page.

Generate Auth Token

  1. Contact Traceable to obtain access to DefenseAI.
  2. Navigate to the onboarding screen.
  3. Copy the generated token and save it for later use. 

Amazon Linux 2 (CentOS)

The set of instructions are compatible with Amazon Linux 2 (CentOS). Complete the following steps to install Traceable agent:

  1. Setup the repository
  2. Select the version of Traceable agent 
  3. Install Traceable agent
  4. Configure Traceable agent
  5. Start Traceable agent
  6. Verify installation

Setup the repository

Enter the following command to set up the Traceable repo:

sudo vi /etc/yum.repos.d/traceable.repo

Paste the following contents (type i to enter edit mode)

Replace [7|8] with the version of CentOS you are using. Execute rpm -E %{rhel} to fetch the CentOS version.

In the following sample snippet, in baserul, replace the centos[7/8] with the required version of CentOS as shown in the example.

[traceable]
name=Traceable repository
baseurl=https://packages.traceable.ai/centos[7|8]/
enabled=1
gpgcheck=0

For example,

[traceable]
name=Traceable repository
baseurl=https://packages.traceable.ai/centos7/
enabled=1
gpgcheck=0

Hold down Shift + ZZ to exit Vi editor.

Install Traceable

sudo yum install traceable

Configure Traceable

  1. Set the refresh token

Add the refresh token to the file below

sudo vi /etc/traceable/agent/token

 Type Shift + ZZ to exit vi.

  1. Reload systemd

Enter the following command to reload the systemd service:

sudo systemctl daemon-reload
  1. Set the environment variable

Enter the following command to set the environment variable:

sudo systemctl edit traceable

 Enter the following then exit the editor:

[Service]
Environment="TA_ENVIRONMENT=<expected environment>"

Start Traceable

Enter the following command to start Traceable agent:

sudo systemctl start traceable

 Add Traceable to the system startup

sudo systemctl enable traceable && sudo systemctl restart traceable

Verify installation

Enter the following command to verify a successful installation of the Traceable agent:

systemctl is-active traceable

 Ensure no ERROR logs are present and a Started metric exporter message appears in the logs

cat /var/traceable/log/traceable.YYYY_mm_dd_ss_mil.log

Ubuntu

The set of instructions to install Traceable agent are compatible with Ubuntu 18.04 and 20.04. Complete the following steps to install Traceable agent:

  1. Setup the repository
  2. Install Traceable agent
  3. Configure Traceable agent
  4. Start Traceable agent
  5. Verify installation

Setup Repository

sudo apt-get update
sudo apt-get install -y ca-certificates
sudo echo "deb [trusted=yes] https://packages.traceable.ai/ubuntu/ focal main" | sudo tee -a /etc/apt/sources.list.d/traceable.list
sudo apt-get update

Install Traceable

sudo apt-get install -y traceable

Configure Traceable

Configuring Traceable involves the following two steps:

  1. Editing the config.yaml file
  2. Reloading systemd service

Set the refresh token

Add the refresh token to the file below

sudo vi /etc/traceable/agent/token

Reload systemd

Enter the following command to reload the systemd service:

sudo systemctl daemon-reload

 Set the environment variable

Enter the following command to set the environment variable:

sudo systemctl edit traceable

 Enter the following then exit the editor:

[Service]
Environment="TA_ENVIRONMENT=<expected environment>"

Enter the following command to start the Traceable agent:

sudo systemctl start traceable

Add Traceable to the system startup

Enter the following command to add Traceable agent to systemd startup:

sudo systemctl enable traceable && sudo systemctl restart traceable

Verify installation

Enter the following command to verify a successful installation of Traceable agent:

systemctl is-active traceable

 Ensure no ERROR logs are present and a Started metric exporter message appears in the logs

cat /var/traceable/log/traceable.YYYY_mm_dd_ss_mil.log

Troubleshooting

Startup logs for the Traceable Agent can be found in /var/traceable/log


Next Steps


Was this article helpful?