A robust Rust agent for provisioning and managing CI/CD runners through the Cirun platform, offering automated VM lifecycle management with Lume virtualization.

• Automatic VM Provisioning: Clone and configure runner VMs from templates
• Lifecycle Management: Provision and delete CI/CD runners on demand
• Template-based Deployment: Use a base template for consistent runner configurations
• Continuous Communication: Regular status reporting to the Cirun API
• Persistent Agent Identity: Maintains a consistent identifier across restarts
• Environment Detection: Auto-detects system information and capabilities

curl --proto '=https' --tlsv1.2 -LsSf https://raw.githubusercontent.com/cirunlabs/cirun-agent/refs/heads/main/install.sh | sh

cargo install cirun-agent

git clone https://github.com/cirun-io/cirun-agent
cd cirun-agent
cargo build --release

Checkout docs for quick start guide: https://docs.cirun.io/on-prem

Cirun-agent relies on Lume for VM provisioning and management. Lume is a lightweight virtualization platform that enables efficient cloning and management of virtual machines.

Note: The cirun-agent automatically manages the Lume process, so there's no need to install or configure Lume separately. The agent handles all interactions with Lume internally.

Set up the agent on any machine with virtualization capabilities to automatically provision CI/CD runners when needed, and clean them up after use.

# Run with custom polling interval (30 seconds)
cirun-agent --api-token YOUR_API_TOKEN --interval 30

1. Create a VM named cirun-runner-template using Lume
2. Configure it with your required tools and settings
3. Start the agent - it will clone this template when provisioning new runners

The agent works by:

1. Registering itself with the Cirun API using a persistent UUID
2. Polling the API at regular intervals for runner provisioning/deletion requests
3. Using Lume to clone VMs from a template and run provisioning scripts
4. Reporting VM status back to the Cirun platform

• Rust 1.54 or later
• Access to Lume virtualization
• Cirun API credentials

cargo build

cargo test

The project uses Clippy for linting and rustfmt for code formatting.

rustup component add clippy rustfmt

cargo clippy

To automatically fix some linting issues:

cargo clippy --fix

cargo fmt

Run both linting and formatting checks before committing:

cargo fmt -- --check && cargo clippy

Enable detailed logs by setting the RUST_LOG environment variable:

RUST_LOG=debug cirun-agent --api-token YOUR_API_TOKEN

For comprehensive documentation about Cirun and the on-premises deployment options, visit:

• Cirun Documentation
• On-Premises Guide

• Slack: slack.cirun.io
• Email: [email protected]

This project is licensed under the MIT License - see the LICENSE file for details.

• Update the version in Cargo.toml
• Make sure all changes are staged for commit
• Run the release script: ./release.sh

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request