Add self-hosting documentation

[cloudymax]

Overview

This PR adds support for self-hosting GameCI runners and provides base-level resources necessary to resolve the following issues:

• Docker GPU Support? unity-test-runner#102
• NVIDIA Support unity-test-runner#113
• Document how to set up Gitlab CI NVIDIA GPU bound builds #323
• No docs for a standalone Docker environment #386

Features

Supported platforms:

• x86 / AMD64

Supported CI/CD Services:

• Github
• Gitlab
• Local Docker

Supported Host Operating Systems:

• Ubuntu 22.04 LTS Server
• Debian 12 Bookworm Server

Supported Guest Operating Systems:

• Windows 10
• Windows Server 2022
• Ubuntu 22.04+
• Debian 12+
• MacOS 11+

Supported Virtualization Tools:

• QEMU
• Multipass

Additional Information

• Kubernetes and Cloud-Runner support has been moved to a new branch and will be released at a later date.

• This guide details the host requirements and process to enable GPU support for NVIDIA devices. This will not be fully functional with GameCI until test-runner and builder are updated.

[github-actions]

[webbertakken]

Awesome work! 🧡

Added some comments to get the docs in a more consistent state, compared with existing docs.

[cloudymax]

Awesome work! 🧡

Added some comments to get the docs in a more consistent state, compared with existing docs.

Thanks a ton for the suggestions! I think you're spot-on with most of them.

I'll get these addressed and merged after work today!

[GabLeRoux]

Before talking about constraints and requirements, I think it would be interesting to also add a disclaimer about security and Prerequisites Knowledge.

Here's a draft

---

Security Disclaimer

This guide strives for best security practices, yet the evolving nature of threats demands user vigilance. Conduct your own security assessments and stay updated with best practices.

Prerequisites Knowledge

Users should be familiar with basic Linux commands and have a basic grasp of CI/CD concepts. New to these? Seek beginner resources to build a foundation before continuing in this path.

[cloudymax]

added in commit 1b6d057

[GabLeRoux]

Not sure if we should change something here, mostly an observation: These two scripts seem very similar, the - Create new guest: example only have -cdrom $IMAGE_NAME \ as a difference.

This might be a discussion for the future, but there seem to be quite a few scripts in the self-hosted docs. I started wondering if it would be easier to have a repository with scripts that are ready to use instead of relying on users having to copy everything on their own? This can definitely be done in the future btw.

[cloudymax]

Indeed they are similar, the major change is that the ISO is no longer passed into the VM when booting an existing VM to bypass any issues that may be caused if the machine tried to re-install over-top of your existing data.

I tried to approach these docs in a more "Medium Article / Substack blog" style as to absolved GameCI of having to directly miantain/host a fully-fledged piece of software. This was done based on some previous conversations in discord that trended towards gameci NOT taking ownership of new code as much as possible.

As a result, the docs are now written as a blog-style walkthrough that has pulled the important bits out of some existing software.

Heres where all the QEMU examples come from:

• https://github.com/cloudymax/Scrap-Metal/blob/main/virtual-machines/vm.sh

And heres where the Multipass examples come from:

• https://github.com/cloudymax/Scrap-Metal/blob/main/virtual-machines/multipass/multipass.sh

I'm happy to donate the code to GameCI (with proper docs created of course) if that's preferable but that's something we'd need to get buy-in for from the rest of the team.

[GabLeRoux]

Amazing work 🤯

[cloudymax]

@GabLeRoux thanks so much for your feedback, I've been preoccupied with paperwork for a new job and a bit ill this week but I'll get your changes integrated as soon as I can. 🙌