Garm External Provider For Linode

About Garm:

GARM enables you to create and automatically maintain pools of self-hosted runners in both Github and Gitea with auto-scaling that can be used inside your workflow runs.

The idea, the implementation and the maintenance of Garm is mainly done by Cloudbase folks. This repository host the Linode external provider to create Linux runners on top of Linode virtual machines with Garm.

Build

Clone the repo:

git clone https://github.com/flatcar/garm-provider-linode

Build the binary:

cd garm-provider-linode
make

Copy the binary on the same system where garm is running, and point to it in the config.

Usage example

garm-provider-linode configuration:

# /etc/garm/providers.d/garm-provider-linode.toml
# token is generated from Linode with the following permissions:
# - Linodes r/w
token = "foo..."
# region where to deploy things (optional, default: us-ord)
region = "us-ord"

Garm configuration to use the garm-provider-linode binary in /etc/garm/updates:

# /etc/garm/config.toml
[[provider]]
  name = "akamai-linode-amd64"
  provider_type = "external"
  description = "Akamai Linode (amd64)"
  [provider.external]
    provider_executable = "/etc/garm/updates/garm-provider-linode"
    config_file = "/etc/garm/providers.d/garm-provider-linode.toml"

Add the pool:

$ garm-cli pool add \
  --org="${ORG}" \
  --flavor g6-standard-2 \
  --image=linode/ubuntu24.04 \
  --provider-name=akamai-linode-amd64 \
  --tags=test,linode \
  --enabled \
  --min-idle-runners 1 \
  --max-runners 2

A Flatcar Container Linux project

Flatcar Container Linux is a fully open source, minimal-footprint, secure by default and always up-to-date Linux distribution for running containers at scale.

This repository is maintained by the Flatcar community and contributors. Development and design decisions are guided by the principles of transparency, modularity, and collaboration.

Please find information on:

• Contribution Guide – how to get involved and submit patches.
• Repository Codeowners – who's assigned for contribution reviews in this repository.
• Repository Maintainers – who’s responsible for what in this repository.
• Flatcar Project Maintainers – who’s responsible for what at Flatcar.
• Governance – how decisions are made and who the stakeholders are.
• Code of Conduct – our commitment to a welcoming and inclusive community.
• LICENSE - License under which the software is released.