Search…
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.
    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:
1
sudo vi /etc/yum.repos.d/traceable.repo
Copied!
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.
1
[traceable]
2
name=Traceable repository
3
baseurl=https://packages.traceable.ai/centos[7|8]/
4
enabled=1
5
gpgcheck=0
Copied!
For example,
1
[traceable]
2
name=Traceable repository
3
baseurl=https://packages.traceable.ai/centos7/
4
enabled=1
5
gpgcheck=0
Copied!
Hold down Shift + ZZ to exit Vi editor.

Install Traceable

1
sudo yum install traceable
Copied!

Configure Traceable

1. Set the refresh token

Add the refresh token to the file below
1
sudo vi /etc/traceable/agent/token
Copied!
Type Shift + ZZ to exit vi.

2. Reload systemd

Enter the following command to reload the systemd service:
1
sudo systemctl daemon-reload
Copied!

3. Set the environment variable

Enter the following command to set the environment variable:
1
sudo systemctl edit traceable
Copied!
Enter the following then exit the editor:
1
[Service]
2
Environment="TA_ENVIRONMENT=<expected environment>"
Copied!

Start Traceable

Enter the following command to start Traceable agent:
1
sudo systemctl start traceable
Copied!

Add Traceable to the system startup

1
sudo systemctl enable traceable && sudo systemctl restart traceable
Copied!

Verify installation

Enter the following command to verify a successful installation of the Traceable agent:
1
systemctl is-active traceable
Copied!
Ensure no ERROR logs are present and a Started metric exporter message appears in the logs
1
cat /var/traceable/log/traceable.YYYY_mm_dd_ss_mil.log
Copied!

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

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

Install Traceable

1
sudo apt-get install -y traceable
Copied!

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
1
sudo vi /etc/traceable/agent/token
Copied!

Reload systemd

Enter the following command to reload the systemd service:
1
sudo systemctl daemon-reload
Copied!

Set the environment variable

Enter the following command to set the environment variable:
1
sudo systemctl edit traceable
Copied!
Enter the following then exit the editor:
1
[Service]
2
Environment="TA_ENVIRONMENT=<expected environment>"
Copied!
Enter the following command to start the Traceable agent:
1
sudo systemctl start traceable
Copied!

Add Traceable to the system startup

Enter the following command to add Traceable agent to systemd startup:
1
sudo systemctl enable traceable && sudo systemctl restart traceable
Copied!

Verify installation

Enter the following command to verify a successful installation of Traceable agent:
1
systemctl is-active traceable
Copied!
Ensure no ERROR logs are present and a Started metric exporter message appears in the logs
1
cat /var/traceable/log/traceable.YYYY_mm_dd_ss_mil.log
Copied!

Troubleshooting

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

Next Steps

Last modified 2mo ago