docs: README

This commit is contained in:
Ryan Yin
2024-02-18 13:12:13 +08:00
parent 0c60bc495f
commit 996b1dd077
2 changed files with 21 additions and 18 deletions

View File

@@ -14,7 +14,13 @@
</a>
</p>
This repository is home to the nix code that builds my systems.
This repository is home to the nix code that builds my systems:
1. NixOS Desktops: NixOS with home-manager, i3, hyprland, agenix, etc.
2. macOS Desktops: nix-darwin with home-manager, zsh, kitty, etc. Share the same home-manager configuration with NixOS Desktops.
3. NixOS Servers: virtual machines running on Proxmox, with various services, such as homepage, prometheus, grafana, etc.
See [./hosts](./hosts) for details of each host.
## Why NixOS & Flakes?
@@ -75,10 +81,6 @@ See [./home/base/desktop/editors/neovim/](./home/base/desktop/editors/neovim/) f
See [./home/base/desktop/editors/emacs/](./home/base/desktop/editors/emacs/) for details.
## Hosts
See [./hosts](./hosts) for details.
## Secrets Management
See [./secrets](./secrets) for details.

View File

@@ -2,21 +2,22 @@
> WIP, not finished yet.
I'm running two Kubernetes clusters, one for production and one for testing.
I prefer to use [k3s] as the Kubernetes distribution, because it's lightweight, easy to install, and full featured(see [what-have-k3s-removed-from-upstream-kubernetes] for details).
## Hosts
1. For production:
1. `k8s-prod-master-1`
2. `k8s-prod-worker-1`
2. `k8s-prod-worker-2`
2. `k8s-prod-worker-3`
1. `k3s-prod-master-1`
2. `k3s-prod-worker-1`
2. `k3s-prod-worker-2`
2. `k3s-prod-worker-3`
1. For testing:.
1. `k8s-test-master-1`
2. `k8s-test-worker-1`
3. `k8s-test-worker-2`
4. `k8s-test-worker-3`
## References
- https://github.com/justinas/nixos-ha-kubernetes
- https://github.com/misumisumi/nixos-k8s-config
1. `k3s-test-master-1`
2. `k3s-test-worker-1`
3. `k3s-test-worker-2`
4. `k3s-test-worker-3`
[k3s]: https://github.com/k3s-io/k3s/
[what-have-k3s-removed-from-upstream-kubernetes]: https://github.com/k3s-io/k3s/?tab=readme-ov-file#what-have-you-removed-from-upstream-kubernetes