cubi
Quelle: pkr-lab/pkr-lab-docs/cubi/index.md
cubi
Interaktives Terminal-Werkzeug für den Kubernetes-Alltag. cubi bündelt Werkzeuge, die schon installiert sind (kubectl, argocd, gh, tailscale, helm, ssh), in einem Menü, das man mit den Pfeiltasten bedient. Alles wird inline im normalen Terminal gezeichnet, der Verlauf bleibt sichtbar.
cubi
Repository: pkr-lab/cubi
Bereiche
| Bereich | Aufruf (Alias) | Inhalt | Doku |
|---|---|---|---|
| Connect | cubi connect |
SSH zu VMs und Hosts, gruppiert wie in der Konfiguration | connect.md |
| ArgoCD | cubi argocd (argo) |
Tabelle aller Apps mit Sync- und Health-Status, Filter, Sync (auch mehrere Apps), Diff, Refresh, Link zur GitHub-Quelle | argocd.md |
| Auto-Sync | cubi autosync (sync) |
Auto-Sync mehrerer Apps aus- und wieder einschalten, prune und selfHeal werden gemerkt | argocd-features.md |
| Feature-Testing | cubi feature-testing (branch, ft) |
Ziel-Branch mehrerer ArgoCD-Apps umstellen oder auf main zurücksetzen |
argocd-features.md |
| Pods skalieren | cubi scale |
Workloads mehrerer Apps auf 0 oder eine eigene Anzahl stellen und später wiederherstellen | argocd-features.md |
| Tailscale | cubi tailscale (ts) |
Geräteliste mit Status, Ping, SSH, up und down |
tailscale.md |
| GitHub | cubi github (gh) |
Workflow-Läufe, Pull Requests, Issues (auch bearbeiten), Commits, Kanban-Board | github.md |
| Kubernetes | cubi kubernetes (k8s, kubectl) |
Pods mit Logs und Shell, Nodes, Warnungen, Namespace und Kontext wechseln | kubernetes.md |
| Helm | cubi helm |
Releases mit Status, Values und Historie | helm.md |
| Tokens | cubi tokens (token) |
Alter, Ablauf und Rotation der Tokens aus dem Token-Register von capulus-core | tokens.md |
| Login | cubi login (auth) |
Login-Status für ArgoCD, GitHub und Tailscale samt Login-Befehlen | login.md |
Zusätzlich gibt es cubi-desktop, eine Desktop-Oberfläche in Rust mit allen Bereichen von cubi. Dazu kommen lokale CI-Checks vor dem git push, nach denen Push oder PR per Button möglich sind.
Jeder Bereich lässt sich direkt öffnen, zum Beispiel cubi argocd oder cubi login. Ohne Argument startet das Hauptmenü, cubi --help listet die Bereiche. Ein unbekannter Bereich beendet cubi mit Exit-Code 2.
Die ArgoCD-Ansicht sortiert Apps mit Problemen nach oben und lädt die Tabelle automatisch neu:
Architektur
cubi ist ein Python-3-Programm ohne Server und ohne eigenen Zustand auf dem Rechner. bin/cubi startet cubi.main, das einen Bereich (Modul) auswählt. Jedes Modul ruft die vorhandenen Werkzeuge als Unterprozess auf und stellt die Ausgabe mit rich als Tabelle oder Menü dar. cubi speichert weder Passwörter noch Tokens.
flowchart LR
U[Terminal] --> B[bin/cubi]
B --> M[main.py: Bereich wählen]
M --> MOD[modules/*.py]
MOD --> UI[ui.py / choice.py / term.py]
MOD --> SH[shell.py]
SH --> K[kubectl]
SH --> A[argocd]
SH --> G[gh]
SH --> T[tailscale]
SH --> H[helm]
SH --> S[ssh]
MOD --> CFG[config.py: targets.yaml]
MOD --> TR[token_register.py: capulus-core]
Datei (src/cubi/) |
Aufgabe |
|---|---|
main.py |
Argumente, Bereichsmenü, Aliase, Exit-Codes |
modules/*.py |
ein Modul je Bereich, Einstieg run() |
ui.py |
Fassade: Auswahl, Eingabe, Bestätigung, Ausgabe, guard() fängt CubiError |
choice.py, term.py |
inline gezeichnete Auswahl und Tastaturlesen, siehe Select-Komponente |
shell.py |
Unterprozesse mit Timeout, Fehlertext-Aufbereitung |
config.py |
targets.yaml suchen und laden |
argocd_config.py |
ArgoCD-Kontexte aus Config und ~/.config/argocd/config |
argocd_apps.py |
ArgoCD-Applications lesen und patchen, cubi-state-ConfigMap, ApplicationSet-Regeln |
token_register.py |
Token-Register lesen und Datumsfelder fortschreiben |
errors.py |
CubiError (Meldung an den Nutzer) und Finished (Programmende nach Änderung) |
timeutil.py |
Zeitstempel parsen, Alter als 3d, 5h, 2m |
Alle Code-Pfade beziehen sich auf pkr-lab/cubi.
Beziehung zu anderen Repos
- capulus-core:
cubi tokensliestops/token-register.yamlund führtscripts/check-token-register.pyaus dem Checkout aus.cubi argocd,autosync,scaleundfeature-testingändern die ArgoCD-Applications des Clusters, die dort per GitOps definiert sind (ArgoCD). - pkr-lab-docs: Runbooks mit dem Präfix
pkr-lab-docs:im Token-Register öffnetcubi tokensaus dem Checkout dieses Repos. - capulus-ansible: Die SSH-Ziele in
connectentsprechen den dort provisionierten Hosts.
Terminal-Verhalten
cubi bleibt immer in der normalen Terminal-Ansicht: kein Vollbild, kein Löschen des Terminals, kein Pager, Editor oder Browser. Details unter Bedienung. Ohne interaktives Terminal (Pipe, Cron) weigert sich cubi zu starten.
Seiten
| Seite | Inhalt |
|---|---|
| Installation | Voraussetzungen, install.sh, Prüfung, Deinstallation |
| Konfiguration | targets.yaml, Suchreihenfolge, alle Schlüssel |
| Nutzung | Aufruf, Tasten, typische Abläufe |
| Bedienung | Tasten, Einfach- und Mehrfachauswahl, Inline-Verhalten |
| ArgoCD | App-Tabelle, Filter, Sync, Diff, Refresh |
| ArgoCD-Features | Auto-Sync, Feature-Testing, Pods skalieren |
| Connect, Tailscale, GitHub, Kubernetes, Helm, Tokens, Login | je ein Bereich |
| Select-Komponente | Aufbau der Auswahl im Code |
| Debugging und Fehlersuche | Fehlermeldungen, Checkliste, lokales Debugging |
| Entwicklung | Tests, neuen Bereich ergänzen |
| Releases | Release-Prozess |
| cubi-desktop | Desktop-Oberfläche: alle Bereiche plus CI-Checks vor dem Push |
Fehlersuche
Meldungen, Checkliste und lokales Debugging: Debugging und Fehlersuche. Jeder Bereich hat auf seiner Seite einen Abschnitt „Debugging und Fehlersuche“.