🥇K9s ülevaade - arenenud terminali liides Kubernetes'ile

K9s pakub terminali kasutajaliidese, et suhelda Kubernetes'i klastritega. Selle avatud lähtekoodi projekti eesmärk on hõlbustada navigeerimist K8s rakendustes, nende jälgimist ja haldamist. K9s jälgib pidevalt muutusi Kubernetes'is ja pakub kiireid käske jälgitavate ressursside haldamiseks.

Projekt on kirjutatud Go keeles ja on tegutsenud üle pooleteise aasta: esimene commit tehti 1. veebruaril 2019. Artikli kirjutamise hetkel on üle 9000 tähe ja umbes 80 kaastöötajat. GitHub Vaatame, mida k9s oskab?

Paigaldamine ja käivitamine

See on kliendirakendus (Kubernetes'i klastri suhtes), mida on kõige lihtsam käivitada kui Docker'i kujund:

docker run --rm -it -v $KUBECONFIG:/root/.kube/config quay.io/derailed/k9s

Mõnede Linux'i distributsioonide ja muude opsüsteemide jaoks on ka valmis installimiseks paketid. paketidÜldiselt võib Linux'i süsteemide jaoks paigaldada binaarfaili:

sudo wget -qO- https://github.com/derailed/k9s/releases/download/v0.22.0/k9s_Linux_x86_64.tar.gz | tar zxvf -  -C /tmp/
sudo mv /tmp/k9s /usr/local/bin

Klaster K8s jaoks ei ole mingeid spetsiifilisi nõudeid. Tagasiside põhjal töötab rakendus ka vanemate Kubernetes'i versioonidega, nagu 1.12.

Rakendus käivitub standardse konfi kasutamisega .kube/config — sarnaselt sellele, mida teeb kubectl.

Navigeerimine

Vaikimisi avatakse aken standardse namespace'iga, mis on märgitud kontekstiks. See tähendab, et kui olete kirjutanud kubectl config set-context --current --namespace=test, siis avataksegi namespace test. (Konteksti/nimi ruumide vahetamisest lugege allpool.)

Liikumine käskude režiimi toimub vajutades «:». Pärast seda saate k9s-i tööd juhtida käskudega — näiteks, et vaadata StatefulSets'i loendit (praeguses nime ruumis), saate sisestada :sts.

Mõnede teiste Kubernetes'i ressursside jaoks:

:ns — Nimi ruumid;
:deploy — Rakendused;
:ing — Sisenemised;
:svc — Teenused.

Kogu ressursside tüüpide loendi kuvamiseks on käsk :aliases.

Mugav on vaadata ka käskude loendit, mis on saadaval kuumade klahvikombinatsioonide kaudu praeguses aknas: selleks piisab, kui vajutada «?».

K9s-is on ka otsingu režiim, millele pääsemiseks piisab, kui sisestate «/». Sellega otsitakse praeguse «akna» sisu. Oletame, et olete enne seda sisestanud :ns, teil, et teil on nimekirja nimesid. Kui neid on liialt palju, et mitte pikalt all kerida, piisab, kui kirjutad namespaces aknas. /mynamespace.

Siltide otsimiseks saad valida kõik pod'id soovitud nimes, seejärel tippida näiteks / -l app=whoami. Me saame nimekirja pod'idest, millel on see silt:

Otsing toimib kõigis akendes, sealhulgas logides, YAML-manifeste vaadates ja describe ressursside jaoks — lisainfot nende võimaluste kohta vt allpool.

Milline on üldine tegevuste järjestus navigeerimiseks?

Käsk :ctx saad valida konteksti:

Nimespetsi valimiseks on juba mainitud käsk :ns, seejärel saad kasutada otsingut vajaliku nimespetsi jaoks: /test.

Kui nüüd valitakse huvipakkuv ressurss (näiteks sama StatefulSet), kuvatakse vastav teave: kui palju pod'e on käimas koos nende lühikese teabega.

Võib olla huvipakkuvad ainult pod'id — siis piisab, kui kirjutada :pod. ConfigMap'ide puhul (:cm — nende ressursside nimekirja jaoks) saad valida huvipakkuva objekti ja vajutada 'u', mille järel K9s näitab, kes konkreetset (seda CM) kasutab.

Veel üks mugav funktsioon ressursside vaatamiseks — nende "röntgen" (XRay view). Selline režiim käivitatakse käsuga :xray RESOURCE ja... on lihtsam näidata, kuidas see töötab, kui selgitada. Siin on illustreeriv näide StatefulSets'i kohta:

(Iga neid ressursse saab redigeerida, muuta, teha describe.)

Siin on Deployment koos Ingress'iga:

Töötamine ressurssidega

Iga ressursi kohta on võimalik saada teavet YAML formaadis või tema describe vajutades vastavaid klaviatuurikombinatsioone («y» ja «d» vastavalt). Põhitegevusi on muidugi veel rohkem: nende loetelu ja klaviatuurikombinatsioonid on alati nähtavad tänu mugavale «pealkirjale» liideses (mis peidetakse, vajutades Ctrl + e).

Ressursi redigeerimise korral (vajutades «e» pärast selle valimist) avaneb tekstiredaktor, mis on määratud keskkonnamuutujates (export EDITOR=vim).

Siin on, kuidas ressursi üksikasjalik kirjeldus välja näeb (describe):

Sellise väljundi (või YAML-maniifesti kuvamise väljundi) saab salvestada tavalise klaviatuurikombinatsiooni Ctrl + s abil. Kuhu see salvestatakse, selgub K9s'i sõnumist:

Log /tmp/k9s-screens-root/kubernetes/Describe-1601244920104133900.yml salvestatud edukalt!

Loodud varufailidest saab ka ressursse taastada, eemaldates eelnevalt süsteemi sildid ja annotatsioonid. Selleks tuleb minna kaustadesse, kus need asuvad (:dir /tmp), see valitud fail ja rakenda rakenda.

Muide, igal ajal on võimalik tagasi minna varasemale ReplicaSet'ile, kui praegusega on probleeme. Selleks tuleb valida soovitud RS (:rs nende loendist):

… ja teostada rollback klahv kombinatsiooniga Ctrl + l. Peame saama teate, et kõik on läinud edukalt:

k9s/whoami-5cfbdbb469 on edukalt tagasiviidud

Ja et koopiaid skaleerida, piisab, kui vajutada «s» (scale) ja valida soovitud eksemplaride arv:

Igas konteineris saab shell'i kaudu sisse minna: selleks liikuda soovitud pod'ile, vajutada «s» (shell) ja valida konteiner.

Teised võimalused

Loomulikult toetatakse ka logide vaatamist («l» valitud ressursi jaoks). Ja et vaadata uusi logisid, ei pea pidevalt vajutama Enter: piisab, kui teha märgistus («m»), pärast mida jälgida ainult uusi sõnumeid.

Samuti saab selles aknas valida ajavahemiku logide kuvamiseks:

klahv «1» — 1 minuti jooksul;
«2» — 5 minutit;
«3» — 15 minutit;
«4» — 30 minutit;
«5» — 1 tund;
«0» — kogu pod'i eluaja jooksul.

Pulse'i erirežiim (käsk :pulse) näitab üldteavet Kubernetes'i klastrist:

Selles saab näha ressursside arvu ja nende seisundit (roheline näitab neid, millel on staatus) Running).

Veel üks huvitav funktsioon K9s kannab nime Popeye. See kontrollib kõiki ressursse teatud korrektsuse kriteeriumide järgi ja kuvab saadud "hindamise" koos selgitustega. Näiteks saab näha, et puudu on vahemikud või piirangud, ning mõni konteiner võib käivituda root'i all…

Helmi põhitoe olemasolu. Näiteks saab vaadata klastrisse paigaldatud väljalaskeid:

:helm all # kõik
:helm $namespace # konkreetses nimede ruumis

Benchmark

K9s on sisseehitatud isegi hey — lihtne koormuse generaator HTTP-serverile, alternatiiv tuntud ab-le (ApacheBench).

Selle sisselülitamiseks on vajalik port-forward aktiviseerimine pod'is. Selleks valime pod'i ja vajutame Shift + f, seejärel liigume port-forward alammenüüsse alias'iga «pf».

Pärast pordi valimist ja Ctrl + b vajutamist käivitub ise benchmark. Tema töö tulemused salvestatakse /tmp ja on K9s'is hilisemaks vaatamiseks saadaval.

Benchmark'i konfiguratsiooni muutmiseks tuleb luua fail $HOME/.k9s/bench-.yml (määratakse igas klastris eraldi).

NB: Oluline on, et kõikide YAML-failide laiend nimekirjas .k9s oleks täpselt .yml (.yaml ei tööta korralikult).

Konfiguratsiooni näidis:

benchmark'id:
  defaults:
    # Süsteemi lõime arv
    concurrency: 2
    # Küsimuste arv
    requests: 1000
  konteinerid:
    # Seaded konteineri jaoks benchmark'iga
    # Kase on määritud kui namespace/pod-name:container-name
    default/nginx:nginx:
      concurrency: 2
      requests: 10000
      http:
        path: /
        method: POST
        body:
          {"foo":"bar"}
        header:
          Accept:
            - text/html
          Content-Type:
            - application/json
 teenused:
    # Benchmark'i võib viia läbi teenustes nagu NodePort ja LoadBalancer
    # Süntaks: namespace/service-name
    default/nginx:
      concurrency: 5
      requests: 500
      http:
        method: GET
        path: /auth
      auth:
        user: flant
        password: s3cr3tp455w0rd

Liides

Ressurside loendi veergude välimus muutub faili loomisega $HOME/.k9s/views.yml. Näide selle sisust:

k9s:
 views:
   v1/pods:
     columns:
       - AGE
       - NAMESPACE
       - NAME
       - IP
       - NODE
       - STATUS
       - READY
   v1/services:
     columns:
       - AGE
       - NAMESPACE
       - NAME
       - TYPE
       - CLUSTER-IP

Tõsi, veergu siltide kohta jääb puudu, mille kohta on probleem projektis.

Veergude järgi sorteerimiseks kasutatakse klaviatuuri kombinatsioone:

Shift + n — nime järgi;
Shift + o — sõlmede järgi;
Shift + i — IP järgi;
Shift + a — konteineri eluea järgi;
Shift + t — taaskäivituste arvu järgi;
Shift + r — valmiduse staatuse järgi;
Shift + c — CPU kasutuse järgi;
Shift + m — mälu kasutuse järgi.

Kui aga kellegile ei meeldi vaikimisi värvitoonid, toetab K9s isegi nahkasid. Valmis näited (7 tükki) on saadaval siit. Siin on üks sellise nahka näide (laevastikus):

Pluginad

Lõpuks, pluginate laiendavad K9s-i võimalusi. Olen ise kasutanud töös vaid üht neist — kubectl get all -n $namespace.

See näeb välja järgmine. Loome faili $HOME/.k9s/plugin.yml sellise sisuga:

plugin:
 get-all:
   shortCut: g    
   confirm: false    
   description: get all
   scopes:
   - all
   command: sh
   background: false
   args:
   - -c
   - "kubectl -n $NAMESPACE get all -o wide | less"

Nüüd saab liikuda nimekonda ja vajutada «g», et vastava käsuga edasi minna:

Pluginite seas on näiteks integratsioonid kubectl-jq ja logide vaatamise utiliidiga stern.

Kokkuvõte

Minu arvates on K9s töö tegemisel väga mugav: selle abil harjub kiiresti leidma vajadused ilma kasutamata kubectl. Logide vaatamine ja nende salvestamine, kiire ressursside redigeerimine ja töö kiirus olid kokkuvõttes kasulikud, samuti osutus kasulikuks режим Popeye. Eraldi mainimist väärivad pluginite loomise ning rakenduse kohandamise võimalused.

* Kuigi suurt logi töötledes on K9s aeg-ajalt aeglane. Sellistel hetkedel kasutas utiliit isegi kaks Intel Xeon E312xx südamikku ja võis isegi hanguda.

Mida hetkel puudub? Kiire tagasimine minevikku (mitte RS) ilma katalooge sisenemata. Lisaks toimub taastamine vaid kogu ressursi osas: kui kustutatud on annotatsioon või silt, tuleb kustutada ja taastada kogu ressurss (siin tuleb tõepoolest minna katalooge). Veel üks pisiasi - puudub salvestatud 'backupide' kuupäev.