How ripe-ncc/ripe-atlas-software-probe works
Overview:
This project is the RIPE Atlas Software Probe—a network measurement agent whose purpose is to be built and deployed in multiple formats: RPM packages (for Oracle EL8/EL9 and Rocky Linux 9), DEB packages (for Debian 11/12), and OpenWRT packages (for OpenWRT 22.03). The probe’s role is to run on target systems, gather measurements (and optionally send interface traffic statistics), and communicate over TCP ports 2023 and 8080. It also integrates with an external registration service via its public key at /etc/ripe-atlas/probe_key.pub.
Build & Packaging Infrastructure
• Docker Containers: Represent the role of the .gitlab-docker directory, which includes Dockerfiles for different base distributions (debian11, debian12, ol8, etc.). These containers provide a controlled build environment for generating packages.
• Build Scripts & Makefiles: Include components like Makefile.am at the project root, bin/Makefile.am, config/Makefile.am, and various custom shell scripts within bin/arch/* that drive the build and customization of the probe.
Probe Core and Supporting Modules
• Core Probe Logic: Indicate the main execution and probe scripts such as bin/ripe-atlas.in, along with the several shell scripts in bin/arch/* that encapsulate the probe’s platform-specific functions (e.g., debian-sw-probe and openwrt versions).
• Library and Configuration Files: It is useful to show where shared scripts and libraries reside. For example, files like atlas_log.lib.sh, class.lib.sh, json.lib.sh, and reginit.sh.in provide core functionalities and initialization routines.
• Busybox Integration: Note the "probe-busybox" directory. It contains modifications and additions to the busybox source tree, including core utilities, networking components, and additional tooling that are used on constrained environments (for example, on OpenWRT).
Configuration & Deployment
• Runtime Configuration: Include the config directory, where configuration files (and templates with .in suffixes) are stored. Emphasize that runtime options (like enabling traffic statistics via /etc/ripe-atlas/config.txt) are part of the probe’s operational behavior.
• Security & Registration: Mark the usage of the public key (/etc/ripe-atlas/probe_key.pub) and indicate the probe registration process via the external URL.
Relationships and Data Flow
• Runtime Flow: Indicate that once the package is deployed, the probe reads its configuration (located in /etc/ripe-atlas) and then operates using its network ports 2023 and 8080 to perform measurements and communicate with the central Atlas service.
• Branch out into two main sections: (a) Build & Packaging Infrastructure and (b) Probe Core Execution.
• Under Build & Packaging:
– List Docker Build Environments (.gitlab-docker) targeting multiple OS distributions.
– Show the packaging branches (debian, rhel, openwrt, and .repo configuration) and their relationships to the build scripts (Makefiles, shell scripts in bin, config templates).
• Under Probe Core Execution:
– Illustrate core probe components (located in bin/, along with shared libraries such as atlas_log.lib.sh and others).
– Include a sub-node representing Busybox Customizations (probe-busybox), highlighting that these modifications are used to tailor the probe for certain platforms.
– Sketch out the configuration files (config/) and indicate the external aspects like key registration and runtime configurations.
Summary and Best Practices:
• To show both the offline build processes (Docker-based environments, packaging configuration) and the runtime operations (probe configuration, network communications, registration with RIPE Atlas).