update docs

This commit is contained in:
Tyler Perkins 2024-11-03 13:15:26 -05:00
parent e8485322f7
commit 0354c2fa11
Signed by: tyler
GPG Key ID: 03B27509E17EFDC8
7 changed files with 112 additions and 4 deletions

View File

@ -1,6 +1,6 @@
# Cluster Architecture
The cluster consists of a `k3s` cluster, a dedicated bastion host
The cluster consists of a [`k3s`](https://k3s.io) cluster, a dedicated bastion host
running an nginx reverse proxy, and a dedicated NAS.
```mermaid
@ -10,6 +10,7 @@ architecture-beta
group home(server)[Home]
service bastion(server)[Bastion] in home
service router(server)[OpenWRT] in home
service nas(disk)[Gluttony NAS] in home
group cluster(server)[K3S Cluster] in home
@ -21,16 +22,36 @@ architecture-beta
service metallb(cloud)[MetalLB] in cluster
service storage(cloud)[K3S Storage] in cluster
group vps(cloud)[VPS]
internet:L -- R:bastion
bastion:T -- R:metallb
service sloth(server)[Sloth] in vps
service greed(server)[Greed] in vps
service alb(cloud)[ALB] in vps
internet:L -- R:router
router:L -- R:bastion
bastion:T -- B:metallb
metallb:T -- B:gluttony
metallb:T -- B:gluttonygpu
metallb:T -- B:gluttonym3
storage:B -- T:nas
internet:T -- B:alb
alb:R -- L:sloth
alb:R -- L:greed
```
An interesting thing to note is that all server equipment (all hosts listed above)
reside in a deticated VLAN to isolate them from other hosts on the network.
Although not exactly like an enterprise network, within my subnetting I have accounted
for multiple physical locations, each with networks of servers, mobile clients, and
normal clients.

View File

@ -1,2 +1,9 @@
# MetalLB
To setup MetalLB, add a helm release for the application.
By convention, place it in its own namespace.
> NOTE
>
> Be sure to not install the `IPAddressPool` and `L2Advertisement` CRDs untill after the
> MetalLB controllers are installed.

View File

@ -0,0 +1,7 @@
# Sealed Secrets
Add the normal helm release for sealed secrets. Place into its own namespace.
## Adding an Existing Certificate
## Explanation of Certificate Rotation

View File

@ -37,3 +37,9 @@ Its important to note that this playbook will bootstrap flux, which will push a
to your git repo that you configured. Therefore, do a `git pull` before
continuing past this step.
## Local machine `kubectl` (Optional)
If you want `kubectl` on your local machine, just copy over `/etc/rancher/k3s/k3s.yaml`
from any master node to your local machine at `~/.kube/config`.
Just be sure to adjust the server url in the config file to point to an actual server.

View File

@ -1 +1,7 @@
# Registering an account
Most services are authenticated using
[Single Sign On](https://en.wikipedia.org/wiki/Single_sign-on).
To register an account, navigate to the sigle sign on provider url,
[auth.clortox.com](auth.clortox.com)

46
docs/user/mailcow.md Normal file
View File

@ -0,0 +1,46 @@
# Registering a Mail Account
E-Mail accounts are offered via [mail.clortox.com](mail.clortox.com).
Currently due to spam, self registering is not an option. Therefore please reach out
directly if you would like an email account. All email accounts end with `@clortox.com`.
## Checking your mail
### Web Client
Login with your account credentials into [sogo](http://mail.clortox.com/SOGo/) to view
your mail.
### Email Client
Using a dedicated email client (I recomend
[thunderbird](https://www.thunderbird.net/en-US/) on PC and
[K-9](https://www.thunderbird.net/en-US/) on android) use the following details to login.
#### IMAP
| Key | Value |
| -- | -- |
| Server Name/Address | mail.clortox.com |
| Port | 993 |
| Security | SSL/TLS |
| Authentication Method | Normal Password |
| Username | Your Email Address |
| Password | Your password |
#### SMTP
| Key | Value |
| -- | -- |
| Server Name/Address | mail.clortox.com |
| Port | 465 |
| Security | SSL/TLS |
| Authentication Method | Normal Password |
| Username | Your Email Address |
| Password | Your password |
## Managing Your Account
To setup things like email aliases, spam filters, and more, login with your email
credentials at [mail.clortox.com](mail.clortox.com). To learn more about what you can do,
refer to the [mailcow docs](https://docs.mailcow.email).

View File

@ -4,6 +4,7 @@ site_description: Documentation on maintaining a datacenter at home
docs_dir: docs/
repo_name: Gitea
repo_url: https://git.clortox.com/Infrastructure/Gluttony-Cluster
edit_uri: src/branch/main/docs
nav:
- Introduction:
@ -12,17 +13,31 @@ nav:
- Setup Cluster: setup.md
- User Documentation:
- Overview: user/index.md
- Registering a mail account: user/mailcow.md
- Registering an account: user/account.md
- Requesting Media: user/request.md
- Downloading Media: user/download.md
- Technical:
- MetalLB: services/metallb.md
- Sealed Secrets: services/sealed-secrets.md
theme:
name: material
#custom_dir: docs/overrides
language: "en"
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to dark mode
logo: img/logo.png
favicon: img/logo.png
features:
- navigation.tabs
- navigation.tabs.sticky