Linux Binary

Prerequisites

• A Linux or Darwin (macOS) system with the appropriate architecture (x86_64 or arm64)

• (For cloud-connected mode) Registration Token: Valid registration token from app.qpoint.io

• (For local mode) Configuration Files: Prepare your Qtap YAML config file

Installation Steps

Download the Binary

Choose the appropriate command based on your operating system and architecture:

For Linux x86_64 architecture:

wget "https://artifactregistry.googleapis.com/download/v1/projects/qpoint-edge/locations/us/repositories/qpoint/files/linux:v0.2.3:qpoint_Linux_x86_64.tar.gz:download?alt=media" -O qpoint_Linux_x86_64_v0.2.3.tar.gz

For Linux arm64 architecture:

wget "https://artifactregistry.googleapis.com/download/v1/projects/qpoint-edge/locations/us/repositories/qpoint/files/linux:v0.2.3:qpoint_Linux_arm64.tar.gz:download?alt=media" -O qpoint_Linux_arm64_v0.2.3.tar.gz

For Darwin (macOS) arm64 architecture:

wget "https://artifactregistry.googleapis.com/download/v1/projects/qpoint-edge/locations/us/repositories/qpoint/files/darwin:v0.2.3:qpoint_Darwin_arm64.tar.gz:download?alt=media" -O qpoint_Darwin_arm64_v0.2.3.tar.gz

For Darwin (macOS) x86_64 architecture:

wget "https://artifactregistry.googleapis.com/download/v1/projects/qpoint-edge/locations/us/repositories/qpoint/files/darwin:v0.2.3:qpoint_Darwin_x86_64.tar.gz:download?alt=media" -O qpoint_Darwin_x86_64_v0.2.3.tar.gz

Extract the Binary

tar -xzf qpoint_<OS>_<ARCH>_v0.2.3.tar.gz

Replace <OS> and <ARCH> with your operating system and architecture (e.g., Linux_x86_64).

Navigate to the Binary Directory

cd qpoint

Make the Binary Executable

chmod +x qpoint

Running Qtap

Cloud-Connected Mode

To run Qtap in cloud-connected mode, use the following command:

./qpoint tap \
  --log-level=info \
  --log-encoding=console \
  --registration-token=$TOKEN

Replace $TOKEN with your actual registration token obtained from app.qpoint.io.

Local Mode

To run Qtap in local mode, use the following command:

./qpoint tap \
  --log-level=info \
  --log-encoding=console \
  --qpoint-config=/path/to/your/qpoint.yaml

Replace /path/to/your/qpoint.yaml with the actual path to your YAML configuration file.

Available Flags and Options

To see all available options and flags, run:

./qpoint tap --help

Key flags include:

• --[no-]help: Show context-sensitive help (also try --help-long and --help-man).

• --[no-]version: Show application version.

• --registration-endpoint="https://api.qpoint.io": Registration endpoint. (Env: $REGISTRATION_ENDPOINT)

• --registration-token=REGISTRATION-TOKEN: Registration token. (Env: $REGISTRATION_TOKEN)

• --data-dir="/tmp/qpoint": Directory to store state. (Env: $DATA_DIR)

• --qpoint-config=QPOINT-CONFIG: Configuration file path. (Env: $QPOINT_CONFIG)

• --audit-log-buffer-size=1000: Buffer size for audit logs. (Env: $AUDIT_LOG_BUFFER_SIZE)

• --log-level=error: Log level. (Env: $LOG_LEVEL)

• --log-encoding=json: Log encoding. (Env: $LOG_ENCODING)

• --[no-]log-caller: Log caller. (Env: $LOG_CALLER)

• --status-listen="0.0.0.0:10001": IP:PORT of status server to listen on. (Env: $STATUS_LISTEN)

Important Notes

1. Ensure you're using the correct version of Qtap. The examples use v0.2.3, but you should use the version appropriate for your needs.

2. For cloud-connected mode, the --registration-token flag is essential for associating your Qtap instance with app.qpoint.io. Ensure you replace $TOKEN with your actual registration token.

3. For local mode, ensure the path to your configuration file is correct.

4. Some options can be set via environment variables. The corresponding environment variable is listed for each flag where applicable.

5. Depending on your system configuration, you may need to run Qtap with elevated privileges (e.g., using sudo) to access certain system resources required for eBPF operations.