--- title: Charmhub | Deploy GitHub runner using Charmhub - The Open Operator Collection description: Deploy the latest version of GitHub runner on any cloud. Creates a group of self-hosted github runners. url: https://charmhub.io/github-runner --- # GitHub runner [Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps") * [Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps") Platform: 24.04 22.04 20.04 stable 24801f1f ``` juju deploy github-runner ``` [Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications) --- #### Relevant links * [Contact](https://launchpad.net/~canonical-is-devops) --- #### Contacts ##### Maintainers + [Launchpad Team](https://launchpad.net/~canonical-is-devops) * [Submit a bug](https://github.com/canonical/github-runner-operator/issues) --- Share your thoughts on this charm with the community on discourse. [Join the discussion](https://discourse.charmhub.io/) # GitHub runner operator A [Juju](https://juju.is/) [charm](https://documentation.ubuntu.com/juju/3.6/reference/charm/) for deploying and managing [GitHub self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners) on virtual machines. The charm maintains a set of self-hosted runners, each isolated in a single-use virtual machine instance. Like any Juju charm, this charm supports one-line deployment, configuration, integration, scaling, and more. For the github-runner-operator charm, this includes: * Stateless operation. * Configurable resource limits. * Ability to redeploy without losing any data (no need to back up). * Supported observability through the `cos-agent` integration. * Scheduled dependencies upgrades to mitigate security risks. Furthermore, the Landscape Client charm can be deployed with this charm to ensure other dependencies are kept up to date. Operating a self-hosted runner comes with [certain security concerns according to GitHub](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#self-hosted-runner-security). Just like GitHub’s runners, the self-hosted runners managed by the charm are isolated in a single-use virtual machine. Metrics and logs about the runners and the charm itself are collected and sent to the [Canonical Observability Stack](https://charmhub.io/topics/canonical-observability-stack) for analysis and visualisation. The charm enforces a set of GitHub repository settings as best practice. This is planned to be opt-in in the future. See [How to comply with security requirements](https://charmhub.io/github-runner/docs/how-to-comply-security). ## [In this documentation](https://charmhub.io/github-runner#p-30370-in-this-documentation) | | | | --- | --- | | [Overview](https://charmhub.io/github-runner) Overview of the charm | [How-to guides](https://charmhub.io/github-runner/docs/how-to-openstack-runner) Step-by-step guides covering key operations and common tasks | | [Reference](https://charmhub.io/github-runner/docs/reference-actions) Technical information - specifications, APIs, architecture | [Explanation](https://charmhub.io/github-runner/docs/explanation-charm-architecture) Concepts - discussion and clarification of key topics | If you want to use ephemeral LXD virtual machines spawned by charm, you can refer to the section [Track local-lxd](https://charmhub.io/github-runner). ## [Contributing to this documentation](https://charmhub.io/github-runner#p-30370-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](https://discourse.charmhub.io/t/github-runner-documentation-overview/7817) 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](https://github.com/canonical/github-runner-operator/issues). ## [Project and community](https://charmhub.io/github-runner#p-30370-project-and-community) The GitHub runner 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. * [Code of conduct](https://ubuntu.com/community/code-of-conduct) * [Get support](https://discourse.charmhub.io/) * [Join our online chat](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) * [Contribute](https://github.com/canonical/github-runner-operator/blob/main/CONTRIBUTING.md) Thinking about using the GitHub runner charm for your next project? [Get in touch](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)! --- [Help improve this document in the forum](https://discourse.charmhub.io/t/github-runner-documentation-overview/13347) ([guidelines](https://discourse.charmhub.io/t/how-to-write-docs-our-documentation-guidelines-for-contributors/1245)). Last updated 1 year, 10 days ago.