Deploying Sensor Collector in Docker

System Requirements

• 100 GB disk space
• 4 CPU
• 2 GB RAM
• Docker 24.0.4 or later installed from the Docker software repositories and not a snap
• Tested operating systems: Debian 11 or higher, CentOS 7.3 or higher - should work with anything that supports Docker 24.0.4. You can follow this on how to install Docker on your system.
• No Firewall or if required, traffic to outside world on TCP port 443 (secured port for HTTPS) should be allowed.

Setting up your environment

To standardize deployments

We have come up with a directory structure to follow for deployments.

1. Create a directory for your Sensor Collector (formerly Roadrunner) software in /opt/
   > sudo mkdir -p /opt/roadrunner
2. Create a directory for your data in: /var/lib/data/
   > sudo mkdir -p /var/lib/data/roadrunner

Setting up Sensor Collector Configuration

To set up Sensor Collector configuration

1. Log in to your Cisco Provider Connectivity Assurance (formerly Skylight performance analytics) deployment.

2. Navigate to Settings on the bottom left of the application navigation menu.

3. Navigate to Session setting menu at the top.

4. Sensor Collector configurations are under the Connectors submenu.

5. Click the + button on the right to add a Sensor Collector configuration.

6. Add a name for this connector.

7. Select your datasource type (FileWatcher for CSV upload).

8. Select the Path to your data which should match to the directory in your environment (i.e. /var/lib/data/roadrunner)

9. Specify a Zone name (MUST BE UNIQUE per connector)
   Sample Configuration:
   

10. Press the ✅ on the top-right to save the configuration.

11. Wait for the success message.

12. Download the Sensor Collector by pressing the ellipsis (...) beside the connector you added on the table and select Download Connector Config.

Running Sensor Collector

After you have downloaded the Sensor Collector archive, extract it and run Sensor Collector.

To run Sensor Collector

1. Copy the newly downloaded 'connectornameyyyy-mm-dd'.tar.gz to your VM.
2. Move it to the path you have previously set up for Sensor Collector software:

sudo mv 'connectornameyyyy-mm-dd'.tar.gz /opt/roadrunner/.*

3. Go to that directory:

cd /opt/roadrunner*

4. Extract the tar.gz file:

sudo tar xfv 'connectornameyyyy-mm-dd'.tar.gz*

5. Run Sensor Collector:

sudo ./run.sh

On first startup, Sensor Collector sets up M2M authentication and will require your Cisco Provider Connectivity Assurance credentials. When it asks you for password, enter the same credentials that you used for logging in to DataHUB.

Upgrading Sensor Collector

To upgrade Sensor Collector

1. Go to your Cisco Provider Connectivity Assurance portal (login if necessary).
2. Go to Settings ▶ Session ▶ Connectors.
3. Select the Connector you wish to upgrade
4. Click the connector's Ellipsis icon (...) on the row and choose to Download Connector Config.
5. Wait until the browser has downloaded the file. The file will be named: 'connectornameyyyy-mm-dd'.tar.gz.
6. Copy the downloaded file to your existing Sensor Collector directory.
7. Extract the downloaded file using the following command (this will overwrite the old Sensor Collector docker image)

sudo tar xfv 'connectornameyyyy-mm-dd'.tar.gz*

4. Verify that your file sizes and dates have changed.
5. Move the old Sensor Collector certs so it can be refreshed:

sudo mv .rr_ssh .rr_ssh.bk

6. Now you can restart Sensor Collector by executing the run.sh file:

sudo ./run.sh*

7. (Optional) Clean up docker images after a successful major upgrade.
   For information, see docker image prune and docker image rm.