Update docs

This commit is contained in:
Tyler Perkins 2024-11-02 22:00:12 -04:00
parent cdbe0b2d71
commit 36bc3d895d
Signed by: tyler
GPG Key ID: 03B27509E17EFDC8
13 changed files with 47 additions and 25054 deletions

View File

@ -6,3 +6,11 @@ vault_gitea_token: !vault |
3437633564376634650a613963323535653536303362386262643237356239396263363466643533 3437633564376634650a613963323535653536303362386262643237356239396263363466643533
32313361633365373734323137643862313134313864306632373730633930623837356636303862 32313361633365373734323137643862313134313864306632373730633930623837356636303862
6233323463306436363763616466626161316234613034396336 6233323463306436363763616466626161316234613034396336
vault_gitea_token: !vault |
$ANSIBLE_VAULT;1.1;AES256
32666436373763373432666537613336616430303836383332666431303433633064623537656532
3264366565626262626337373966623466626266333736650a613438636433373530313338393262
39633265386633626462313034303530643462313964656530316332613265633866316532383239
3933393765653738630a653630306231383062303036636162386662316164323633346334363161
32383761643862373432366563343939393835366638393833383266623065373436646331626464
3261393733316335626335633661643037636432663733353837

File diff suppressed because it is too large Load Diff

View File

@ -2,6 +2,8 @@
Welcome to the documentation for my k3s cluster, aka my datacenter at home. Welcome to the documentation for my k3s cluster, aka my datacenter at home.
If you are looking for user documentation, navigate to [the user docs](./user/index.md)
## About this project ## About this project
This project is a small datacenter that I run in my house. This project is a small datacenter that I run in my house.

2
docs/services/metallb.md Normal file
View File

@ -0,0 +1,2 @@
# MetalLB

View File

@ -30,10 +30,10 @@ bootstrap-longhorn-drive.yaml
## Setup Cluster (Flux) ## Setup Cluster (Flux)
Flux is the tool that will pull from the git repository and update the cluster state. To install K3S into the cluster, just run the ansible playbook `bootstrap-k3s.yaml`.
If you ran the ansible scripts, all hosts will have `flux` installed. Thats it!
To bootstrap the cluster, run the following,
Its important to note that this playbook will bootstrap flux, which will push a commit
to your git repo that you configured. Therefore, do a `git pull` before
continuing past this step.
```bash
flux bootstrap gitea --owner=Infrastructure --repository=Gluttony-Cluster --private=false --path=cluster/ --branch=main
```

1
docs/user/account.md Normal file
View File

@ -0,0 +1 @@
# Registering an account

0
docs/user/download.md Normal file
View File

19
docs/user/index.md Normal file
View File

@ -0,0 +1,19 @@
# User Documentation
Welcome to the user facing documentation! This documentation is intended for those
utilizing one of my services I host for friends and family.
## FAQ
### How do I register an account?
See [Registering an account](./account.md)
### How do I request media?
See [Requesting Media](./request.md)
### How do I download media?
See [Downloading Media](./download.md)

0
docs/user/request.md Normal file
View File

File diff suppressed because it is too large Load Diff

View File

@ -1,27 +0,0 @@
# This manifest was generated by flux. DO NOT EDIT.
---
apiVersion: source.toolkit.fluxcd.io/v1
kind: GitRepository
metadata:
name: flux-system
namespace: flux-system
spec:
interval: 1m0s
ref:
branch: main
secretRef:
name: flux-system
url: ssh://git@git.clortox.com/Infrastructure/Gluttony-Cluster
---
apiVersion: kustomize.toolkit.fluxcd.io/v1
kind: Kustomization
metadata:
name: flux-system
namespace: flux-system
spec:
interval: 10m0s
path: ./
prune: true
sourceRef:
kind: GitRepository
name: flux-system

View File

@ -1,5 +0,0 @@
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- gotk-components.yaml
- gotk-sync.yaml

View File

@ -8,8 +8,15 @@ repo_url: https://git.clortox.com/Infrastructure/Gluttony-Cluster
nav: nav:
- Introduction: - Introduction:
- Overview: index.md - Overview: index.md
- Architecture: architecture.md - Cluster Architecture: architecture.md
- Setup: setup.md - Setup Cluster: setup.md
- User Documentation:
- Overview: user/index.md
- Registering an account: user/account.md
- Requesting Media: user/request.md
- Downloading Media: user/download.md
- Technical:
- MetalLB: services/metallb.md
theme: theme:
name: material name: material