Skip to content

Commit 1b6d057

Browse files
author
Max Roby
committed
add sections to overview
1 parent b7d5010 commit 1b6d057

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

docs/12-self-hosting/01-overview.mdx

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
toc_max_heading_level: 4
33
---
44

5-
# Overview
5+
# About Self-Hosting
66

77
Projects often encounter a constraint or requirement which makes free-tier hosted CI/CD runners
88
insufficient for their needs. In these cases hosting your own CI/CD runner can be a viable
@@ -19,7 +19,17 @@ and the additional tooling required to mitigate those risks such as
1919
[Kaniko](https://github.com/GoogleContainerTools/kaniko) or
2020
[Kata Containers](https://katacontainers.io/).
2121

22-
## Constraints
22+
## 📚 Prerequisite Knowledge
23+
24+
Users of this guide should already be familiar with the Linux command-line, Shell scripting, and
25+
have a basic grasp of CI/CD concepts. For users who are not familiar with these concepts, we have
26+
included some resources for you to start your learning journey below.
27+
28+
- [Techworld with Nana](https://www.youtube.com/@TechWorldwithNana)
29+
- [DevOps Toolit](https://www.youtube.com/@DevOpsToolkit)
30+
- [Introduction to Bash Scripting](https://itsfoss.com/bash-scripting-tutorial/)
31+
32+
## 📋 Constraints
2333

2434
There are many ways to self-host CI/CD runners, and which one is best for you will depend on your
2535
own situation and constraints. For the purpose of this guide we will make the following assumptions:
@@ -31,7 +41,15 @@ own situation and constraints. For the purpose of this guide we will make the fo
3141
operating-system level configuration and life-cycle-management of a given compute resource (metal,
3242
on-prem, cloud VM, VPS etc...)
3343

34-
## Power Consumption
44+
## ⚠️ Security Disclaimer
45+
46+
This guide strives to maintain a balance between convenience and security for the sake of usability.
47+
The examples included in this guide are intended for use with on-prem hardware without public IP
48+
addresses accessible from external networks. Security is a constantly moving target which requires
49+
continuous effort to maintain. Users should conduct their own security review before using the
50+
following techniques on production or public systems.
51+
52+
## ⚡️ Power Costs
3553

3654
Hosting your own runners also comes with an increase in power consumption. This will vary based on
3755
the hardware you use and the prices of energy in your area. Below are some useful resources for
@@ -40,7 +58,7 @@ discovering the potential energy costs of self-hosting.
4058
- https://outervision.com/power-supply-calculator
4159
- https://energyusecalculator.com/electricity_computer.htm
4260

43-
## Requirements
61+
## 💻 System Requirements
4462

4563
This guide is tested on devices which meet the following requirements:
4664

@@ -49,7 +67,9 @@ This guide is tested on devices which meet the following requirements:
4967
- Root access to the operating system
5068
- Network connectivity
5169

52-
## Host Creation
70+
## 📎 Quick Links:
71+
72+
### Host Creation
5373

5474
"Host Creation" in this context is the process of installing an operating system onto a piece of
5575
physical hardware, or the creation and configuration of virtualised compute resources.
@@ -58,7 +78,7 @@ physical hardware, or the creation and configuration of virtualised compute reso
5878
- [Virtual Machines using Multipass](./03-host-creation/02-multipass.mdx)
5979
- [Virtual Machines using QEMU](./03-host-creation/03-QEMU/01-overview.mdx)
6080

61-
## Host Provisioning
81+
### Host Provisioning
6282

6383
"Provisioning" here refers to the process of installing additional resources onto, and the
6484
configuration of your host beyond installing the base operating-system. Both manual and declarative
@@ -68,7 +88,7 @@ workflows are supported.
6888
- [Manual Debian 12 Setup](./04-host-provisioning/01-debian-setup.mdx)
6989
- [Declarative provisioning via Cloud-Init](./04-host-provisioning/03-cloud-init/01-about.mdx)
7090

71-
## Runner Application Installation
91+
### Runner Application Installation
7292

7393
Once your host has been provisioned, you will then need to install the appropriate runner
7494
application. The guides below will walk you through that process.

0 commit comments

Comments
 (0)