Repository navigation
v1.0.0 Initial release
garm-provider-cloudstack v1.0.0
🎉 Initial stable release of the CloudStack external provider for GARM.
This provider enables GARM to create and manage GitHub Actions self-hosted runners on Apache CloudStack virtual machines.
Features
- Full GARM integration - Implements the external provider interface for creating, listing, and destroying runner VMs
- Flexible resource configuration - Supports both symbolic names and UUIDs for zones, service offerings, templates, and projects
- Per-pool overrides - Use
--flavorand--imageCLI options orextra_specsJSON to customize pools - CloudStack project support - Deploy runners into specific CloudStack projects
- SSH key injection - Optionally inject SSH keys for debugging access
- NFS mount support - Configure shared storage mounts (build caches, datasets, artifacts) via
extra_specs - Configurable async timeout - Tune the timeout for long-running VM deployments
- Auto-expunge option - Permanently delete VMs instead of leaving them in "Destroyed" state
- Runner customization - Support for
extra_packages,disable_updates,enable_boot_debug, custom install templates, and pre-install scripts
Extra Specs
Pools can be customized with the following extra_specs options:
zone_id,service_offering_id,template_id,project_id- Override defaultsnetwork_ids- Attach VMs to specific networksssh_key_name- Override SSH keypairnfs_mounts- Configure NFS shared storageextra_packages,disable_updates,enable_boot_debug- Guest customizationrunner_install_template,pre_install_scripts,extra_context- Advanced runner installation
Requirements
- Go 1.25+ (for building from source)
- GARM v0.1.0+
- Apache CloudStack with API access
Getting Started
See the README for configuration and usage instructions.