A Juju charm for building VM images for GitHub self-hosted runners.
This charm simplifies the initial deployment and building images for GitHub self-hosted runners.
Some of the charm dependencies upgrades on a schedule to migrate security risks. The landscape-client charm can be deployed with this charm to ensure other dependencies are up to date.
The charm operates a set of isolated single-use OpenStack virtual machines, to build up-to-date images for GitHub runners.
This charm will make operating GitHub self-hosted runners simple and straightforward for DevOps or SRE teams through Juju’s clean interface.
In this documentation
| Tutorials Get started - a hands-on introduction to using the GitHub runner image builder charm for new users |
How-to guides Step-by-step guides covering key operations and common tasks |
Contributing to this documentation
Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions and constructive feedback on our documentation. Our documentation is hosted on the Charmhub forum to enable easy collaboration. Please use the “Help us improve this documentation” links on each documentation page to either directly change something you see that’s wrong, ask a question, or make a suggestion about a potential change via the comments section.
If there’s a particular area of documentation that you’d like to see that’s missing, please file a bug.
Project and community
The GitHub runner image builder charm is a member of the Ubuntu family. It’s an open-source project that warmly welcomes community projects, contributions, suggestions, fixes, and constructive feedback.
Thinking about using the GitHub runner image builder charm for your next project? Get in touch!
Navigation
| Level | Path | Navlink |
|---|---|---|
| 1 | how-to | How To |
| 2 | how-to-configure-base-image | How to configure base-image |
| 2 | how-to-configure-build-interval | How to configure build-interval |
| 2 | how-to-configure-revision-history | How to configure revision-history |
| 2 | how-to-pin-github-runner-version | How to configure pin-github-runner-version |
| 1 | tutorial | Tutorial |
| 2 | tutorial-quick-start | Quick start |
| 1 | explanation | Explanation |
| 2 | explanation-charm-architecture | Charm architecture |