From 5b96c4f991319c8ff176fbc473786615a8147548 Mon Sep 17 00:00:00 2001 From: Guillem Hernandez Sola Date: Thu, 5 Mar 2026 12:42:34 +0100 Subject: [PATCH] Added readme file 6 --- debian/README.md | 72 +++++++++++++++++++++++++++++++++++++ ubuntu/README.md | 94 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 166 insertions(+) create mode 100644 debian/README.md create mode 100644 ubuntu/README.md diff --git a/debian/README.md b/debian/README.md new file mode 100644 index 0000000..c807435 --- /dev/null +++ b/debian/README.md @@ -0,0 +1,72 @@ +# Debian Vagrant — Descripció i ús + +Aquest directori inclou una infraestructura Vagrant per muntar màquines Debian que suporten un petit clúster k3s d'estudi. + +Contingut +- `Vagrantfile` — Fitxer principal per crear les màquines virtuals (controlador i agents). +- `.vagrant/` — Estat local de Vagrant (no versionar). +- `shared/` — Conté fitxers compartits entre host i les VM: + - `k3s.yaml` — Fitxer kubeconfig generat pel clúster k3s dins les VM. + - `token` — Token d'unió per a workers (k3s join token). + +Prerequisits +- Instal·lar `Vagrant` i un provider (ex. VirtualBox). Si fas servir `libvirt` o un altre provider, configura'l prèviament. +- Xarxa i permisos per crear màquines virtuals. + +Com arrencar el lab +1. Situa't a la carpeta `debian`: + +```bash +cd debian +``` + +2. Inicia totes les màquines: + +```bash +vagrant up +``` + +3. Opcional — iniciar només una màquina concreta (ex.: `server`): + +```bash +vagrant up server +``` + +Accedir al kubeconfig +- Un cop el clúster està operatiu, trobaràs el `kubeconfig` generat a `shared/k3s.yaml`. Per usar-lo localment, pots fer: + +```bash +export KUBECONFIG=$PWD/shared/k3s.yaml +kubectl get nodes +``` + +o copiar-lo al teu fitxer de kubeconfig: + +```bash +cp shared/k3s.yaml ~/.kube/config +``` + +Ús del token +- El fitxer `shared/token` conté normalment el token per unir workers al clúster. No el comparteixis públicament. + +Neteja i aturada +- Aturar màquines: + +```bash +vagrant halt +``` + +- Destruir màquines i alliberar recursos: + +```bash +vagrant destroy -f +``` + +Consells i consideracions +- No versionis la carpeta `.vagrant` ni fitxers sensibles (secrets, tokens) al repositori. +- Si utilitzes un provider diferent de VirtualBox (ex. libvirt), assegura't d'haver instal·lat i configurat el plugin de Vagrant corresponent. +- Si el `kubeconfig` mostra nodes en estat NotReady, comprova que les VM tenen connectivitat i que k3s està en execució (`vagrant ssh server` i `sudo systemctl status k3s`). + +Vols que: +- faci un `git commit` d'aquest `README.md`? +- o que generi instruccions més detallades per personalitzar la topologia (nombre d'agents, recursos, etc.)? diff --git a/ubuntu/README.md b/ubuntu/README.md new file mode 100644 index 0000000..7485006 --- /dev/null +++ b/ubuntu/README.md @@ -0,0 +1,94 @@ +# Ubuntu Vagrant + k3s — Guia ràpida + +Aquest directori inclou fitxers i scripts per muntar un petit entorn de desenvolupament basat en Ubuntu amb k3s utilitzant Vagrant. + +Contingut principal +- `Vagrantfile` — Fitxer de Vagrant per crear les VM (controlador i agents). +- `libvirtVagrantfile` — Variante per a provider `libvirt` (si s'utilitza). +- `k3s_control.sh` — Script d'inicialització/gestió per al node controlador k3s. +- `k3s_worker.sh` — Script per unir nodes worker al clúster. +- `.vagrant/` — Estat local de Vagrant (no versionar). +- `shared/` — Fitxer compartit amb el host: + - `k3s.yaml` — kubeconfig generat pel clúster dins les VM. + - `token` — Token per unir workers (mantenir privat). + +Prerequisits +- `Vagrant` instal·lat i un provider configurat (VirtualBox, libvirt, etc.). +- Accés suficient per crear màquines virtuals i configurar xarxes. + +Arrencar l'entorn +1. Obre un terminal i entra a la carpeta `ubuntu`: + +```bash +cd ubuntu +``` + +2. Inicia les màquines (totes): + +```bash +vagrant up +``` + +3. Si utilitzes `libvirt` i tens el `libvirtVagrantfile`, inicia amb el provider corresponent: + +```bash +vagrant up --provider=libvirt +``` + +Ús dels scripts +- Per preparar o controlar k3s al node controlador, pots executar `k3s_control.sh` (pot requerir `vagrant ssh server` o execució dins la VM): + +```bash +vagrant ssh server -- "sudo /vagrant/k3s_control.sh" +``` + +- Per unir un worker manualment utilitzant el token compartit: + +```bash +vagrant ssh agent1 -- "sudo /vagrant/k3s_worker.sh $(cat /vagrant/token)" +``` + +Accedir al kubeconfig +- El `kubeconfig` generat pel clúster es troba a `shared/k3s.yaml`. Per utilitzar-lo localment: + +```bash +export KUBECONFIG=$PWD/shared/k3s.yaml +kubectl get nodes +``` + +o copiar-lo al teu `~/.kube/config`: + +```bash +cp shared/k3s.yaml ~/.kube/config +``` + +Token i seguretat +- `shared/token` conté el token per unir nodes; tracta'l com a secret i no el versionis. + +Aturar i netejar +- Aturar les màquines: + +```bash +vagrant halt +``` + +- Destruir-les (alliberar recursos): + +```bash +vagrant destroy -f +``` + +Consells i resolució d'errors comuns +- Si alguna màquina no arrenca, comprova el provider (VirtualBox/libvirt) i l'espai disponible. +- Si els nodes surten `NotReady`, fes `vagrant ssh server` i comprova l'estat de k3s: + +```bash +sudo systemctl status k3s +sudo journalctl -u k3s -n 200 +``` + +- Revisa permisos i SELinux/ AppArmor si tens problemes de muntatge de carpetes compartides. + +Vols que: +- faci un `git commit` d'aquest `README.md`? +- o que modifiqui els scripts per fer-los més automàtics (per exemple, script que arrenca i configuri tot automàticament)?