GARM charms

GARM (GitHub Actions Runner Manager) deploys and manages self-hosted GitHub Actions runners. This project provides two Juju charms:

• the garm charm, which deploys and operates GARM;

• the garm-configurator charm, which configures runner scale sets for GARM.

Together, these charms let platform engineers and site reliability engineers deploy GARM on Kubernetes, connect it to GitHub, and configure the runner capacity required by their workflows.

In this documentation

Get started	Deploy GARM and configure a runner scale set
Operations	Retrieve GARM administrator credentials
Design	Architecture overview | Charm reference
Releases	Changelog | Charm release and promotion process

How this documentation is organized

This documentation uses the Diátaxis documentation structure.

• Tutorial takes you step-by-step through deploying GARM and configuring a runner scale set.

• How-to guides assume you have basic familiarity with the GitHub runner charms. They cover setup, configuration, customization, maintenance, and development tasks.

• Reference provides technical details about charm actions, configuration, relations, and integrations.

• Explanation includes topic overviews, architecture, background, context, and design discussion for the GitHub runner charms.

Contributing to this documentation

Documentation is an important part of the GARM charms project. We welcome community contributions, suggestions, fixes, and constructive feedback on the GARM and garm-configurator documentation. See the How to contribute guide for more information.

If you find a missing or incorrect topic, open an issue on GitHub.

Project and community

The garm and garm-configurator charms are open-source Juju charms maintained in the github-runner-operators repository. The project welcomes community contributions, suggestions, fixes, and constructive feedback.

Governance and policies

• Code of conduct

Get involved

• Report an issue

• Get support

• Join our online chat

• Contribute

Releases

• Changelog

• Charm release and promotion process

For questions, suggestions, or support, use the project issue tracker or one of the community channels listed above.