chore: Update README.

This commit is contained in:
greysoh 2024-07-19 10:45:42 -04:00
parent 7b7f90ff16
commit 49637b9825
Signed by: imterah
GPG key ID: 8FA7DD57BA6CEA37

View file

@ -1,6 +1,6 @@
# KittehCluster # KittehCluster
This is my (work in progress, deployed but nothing production running on it *yet*) Kubernetes clustered computing setup, based on Proxmox VE and Ubuntu Server. This is my (work in progress, deployed but nothing production running on it *yet*) Kubernetes clustered computing setup, based on Proxmox VE and Ubuntu Server.
Currently, I *really* cannot recommend that you use this setup in production yet. I have to delete and recreate my VMs multiple times a day, until I fix everything. Currently, I *really* cannot recommend that you use this setup in production yet. I have to delete and recreate my VMs multiple times a day, until I fix everything.
## Prerequisites ## Prerequisites
- A POSIX-compliant computer (preferably Unix of some sort, like macOS/Linux/*BSD, but Git Bash or Cygwin would probably work) with Python and Pyyaml - A POSIX-compliant computer (preferably Unix of some sort, like macOS/Linux/*BSD, but Git Bash or Cygwin would probably work) with Python and Pyyaml
@ -20,17 +20,19 @@ Currently, I *really* cannot recommend that you use this setup in production yet
### Kubernetes setup ### Kubernetes setup
1. SSH into any of the nodes. (i.e `ssh clusteradm@kitteh-node-2-k3s-server`) 1. SSH into any of the nodes. (i.e `ssh clusteradm@kitteh-node-2-k3s-server`)
2. As root, grab `/etc/rancher/k3s/k3s.yaml`, and copy it to wherever you store your k3s configurations (on macOS, this is `~/.kube/config`) 2. As root, grab `/etc/rancher/k3s/k3s.yaml`, and copy it to wherever you store your k3s configurations (on macOS, this is `~/.kube/config`)
3. Go into the `kubernetes` directory, and copy `example-secrets` to `secrets` and modify these to be your credentials.
4. Run `./kubesync.py`. If you recieve MetalLB errors while this happens, `rm -rf meta`, and try again. It should work on the second attempt. If not, report this issue.
## Updating ## Updating
Run `apt update` and `apt upgrade -y` for the base system. TODO for Kubernetes. Run `apt update` and `apt upgrade -y` for the base system. TODO for Kubernetes.
## Customization ## Customization
### Adding nodes ### Adding nodes
In `serverinfra/infrastructure.ini`, copy the role(s) from kitteh-node-2 to a new node (ex. `kitteh-node-2/server` -> `kitteh-node-3/server`, etc), and run the install script again. In `serverinfra/infrastructure.ini`, copy the role(s) from kitteh-node-2 to a new node (ex. `kitteh-node-2/server` -> `kitteh-node-3/server`, etc), and run the install script again.
### Custom cluster setup / Forking ### Custom cluster setup / Forking
This is a guide. You can change more stuff if you'd like, but this will get you started. This is a guide. You can change more stuff if you'd like, but this will get you started.
1. First, fork this Git repository if you haven't already. 1. First, fork this Git repository if you haven't already.
2. Modify `serverinfra/config/infrastructure.ini` to fit your needs. 2. Modify `serverinfra/config/infrastructure.ini` to fit your needs.
## Troubleshooting ## Troubleshooting
- I can't login via SSH! - I can't login via SSH!
- Your SSH public keys are automatically copied over! If not, did you generate an SSH keyring before installing? - Your SSH public keys are automatically copied over! If not, did you generate an SSH keyring before installing?
- Additionally, password authentication is disabled! - Additionally, password authentication is disabled!