docs: advise bare metal or KVM support for Github Runner (#397)

This commit is contained in:
Brian McGee 2024-03-13 10:08:56 +00:00 committed by GitHub
parent fbd2789948
commit 640f83f6eb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -6,6 +6,9 @@ This article looks at how to install a GitHub runner in your own NixOS infrastru
We have built a [NixOS module](https://nixos.wiki/wiki/NixOS_modules) that installs one or more [self-hosted github action runner](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners), along with a [cachix](https://www.cachix.org/) watch store service with the most secure defaults.
> __NOTE__: if you intend to run NixOS VM tests you must ensure your hosting provider supports [nested virtualization](https://docs.fedoraproject.org/en-US/quick-docs/using-nested-virtualization-in-kvm/)
> or use bare-metal hosts, otherwise your tests will take a long time to execute.
## Authentication
In order to use a self-hosted GitHub action runner, you will need to register the runner with your GitHub account or organization. There are three different ways a self hosted runner can register itself on GitHub: