vmanage-agent 0.2.1

Pip module for node to join salt-master

Table of Contents

---

• Overview
• Requirements
• Installation
• Pre-requisites
• Usage
• File Location
• Contributing
• License

Overview

Module vmanage-agent allows node to make request to vmanage and add this device to USDN system.

Enhanced Security Features

The agent now implements three separate cryptographic key types for maximum security:

1. Controller WireGuard Keys - Management plane (node ↔ controller)
2. Tunnel WireGuard Keys - Data plane (node ↔ node via VPP)
3. Blockchain RSA Keys - Configuration encryption/decryption

Security Guarantee: Private keys NEVER leave the device. Only public keys are transmitted to backend.

See SECURITY_KEY_MANAGEMENT.md for complete details.

Requirements

Make sure python and the package manager pip are installed. Salt-minion >= 3005.1 is also required.

• python >=3.10
• pip >= 3.10
• salt-minion == 3005.1

Installation

Install package with the command below:

sudo pip3 install vmanage-agent

Pre-requisites

Salt-minion is running

Checking if salt-minion is running

sudo systemctl status salt-minion

If the output return error, try to stop salt-minion and run in debug mode (salt-minion -l debug)

Usage

Run manually

sudo /usr/local/bin/vmanage-agent -m [master-address] -mf [master-fingerprint] -e [environment]

Arguments

• -m, --master (required): Salt master address
• -mf, --master-finger (required): Salt master fingerprint to verify master
• -e, --env (optional): Environment - either production or staging (default: production)

Examples

Production (default):

sudo /usr/local/bin/vmanage-agent -m salt.usdatanetworks.com -mf a1:b2:c3:d4:e5:f6

Staging:

sudo /usr/local/bin/vmanage-agent -m salt-staging.usdatanetworks.com -mf a1:b2:c3:d4:e5:f6 -e staging

Environment-Specific API Endpoints

• Production: https://api.usdatanetworks.com
• Staging: https://staging-api.usdatanetworks.com

File Location

• Log: /var/log/minion.log
• Config: /opt/minion/config.ini

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

US Data Networks