🥇Översikt av k9s — en avancerad terminalgränssnitt för Kubernetes

K9s tillhandahåller ett terminalgränssnitt för att interagera med Kubernetes-kluster. Målet med detta Open Source-projekt är att underlätta enkel navigering av applikationer i K8s, övervakning av dem samt hantering av dem. K9s övervakar kontinuerligt förändringar i Kubernetes och erbjuder snabba kommandon för arbete med de övervakade resurserna.

Projektet är skrivet i Go och har funnits i mer än ett och ett halvt år: den första committen gjordes den 1 februari 2019. Vid tidpunkten för skrivandet finns det över 9000 stjärnor på GitHub och cirka 80 bidragsgivare. Vad kan k9s göra?

Installera och köra

Detta är en klientapplikation (i förhållande till Kubernetes-klustret) som enklast kan köras som en Docker-bild:

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

För vissa Linux-distributioner och andra operativsystem finns det även paket som kan installeras. paketI allmänhet kan du för Linux-system installera en binärfil:

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

Det finns inga specifika krav på själva K8s-klustret. Enligt recensionerna fungerar applikationen även med äldre versioner av Kubernetes, som 1.12.

Applikationen startas med hjälp av standardkonfigurationsfilen .kube/config — på ett sätt som liknar hur det görs av kubectl.

Navigation

Som standard öppnas ett fönster med det standardnamnrymd som anges för kontexten. Det vill säga, om du angav kubectl config set-context --current --namespace=test, kommer namnområdet att öppnas test. (Om att byta mellan kontexter/namnrymder, se nedan.)

Övergång till kommandoläge sker genom att trycka på ‘:’. Efter det kan du styra k9s med hjälp av kommandon — till exempel för att visa listan över StatefulSets (i det aktuella namnområdet) kan du skriva :sts.

För några andra Kubernetes-resurser:

:ns — Namnrymder;
:deploy — Distributioner;
:ing — Ingress;
:svc — Tjänster.

För att får en komplett lista över resurstypen som är tillgängliga för visning finns det ett kommando :aliases.

Det är bekvämt att se en lista över kommandon som är tillgängliga med genvägar i det aktuella fönstret: för detta räcker det att trycka på ‘?’.

I k9s finns det också sökläge, för att övergå till detta räcker det att skriva ‘/’. Med det görs sökningar i innehållet i det aktuella ‘fönstret’. Anta att om du tidigare har angett :ns, har du en lista över namnrymder. Om det finns för många, så för att slippa scrolla för länge ner, räcker det att skriva i fönstret med namnrymder. /mynamespace.

För att söka efter etiketter kan du välja alla poddar i det önskade namnområdet och sedan till exempel skriva in, / -l app=whoami. Vi får en lista med poddar som har denna etikett:

Sökningen fungerar i alla typer av fönster, inklusive loggar, visning av YAML-manifest och objektet PVC: för resurser — mer information om dessa möjligheter finns nedan.

Hur ser sekvensen för navigation ut generellt?

Med kommandot :ctx kan du välja kontext:

För att välja namnområde finns det redan nämnda kommandot :ns, och sedan kan man använda sökfunktionen för det önskade namnområdet: /test.

Om vi nu väljer den resurs som intresserar oss (till exempel StatefulSet) kommer motsvarande information att visas: hur många poddar som körs med kort information om dem.

Kanske vill vi bara se poddar — då räcker det att skriva in :pod. När det gäller ConfigMap (:cm — för listan över dessa resurser) kan man välja det intressanta objektet och trycka på "u", då kommer K9s att föreslå vem som specifikt använder detta CM.

En annan praktisk funktion för att se resurser är deras "röntgen" (XRay view). Denna läge åkallas med kommandot :xray RESOURCE och... det är enklare att visa hur det fungerar än att förklara. Här är en illustration för StatefulSets:

(Varje av dessa resurser kan redigeras, ändras, göras objektet PVC:.)

Här är en Deployment med Ingress:

Arbeta med resurser

Om varje resurs kan man få information i YAML eller dess objektet PVC: genom att trycka på motsvarande tangentkombinationer ("y" och "d" respektive). Basoperationerna är naturligtvis ännu fler: deras lista och tangentkombinationer är alltid synliga tack vare en bekväm "huvud" i gränssnittet (den döljs med Ctrl + e).

Vid redigering av vilken resurs som helst ("e" efter att ha valt den) öppnas en textredigerare som definieras i miljövariabler (export EDITOR=vim).

Här är hur en detaljerad beskrivning av resursen ser ut (objektet PVC:):

Denna utdata (eller utdata från att visa YAML-manifestet för resursen) kan sparas med den vanliga tangentkombinationen Ctrl + s. Var den sparas blir känt från meddelandet från K9s:

Log /tmp/k9s-screens-root/kubernetes/Describe-1601244920104133900.yml sparad framgångsrikt!

Från de skapade backupfilerna kan resurser återställas, efter att ha tagit bort systemetiketter och anteckningar. För detta krävs det att gå till katalogen med dem (:dir /tmp), och sedan välja den nödvändiga filen och tillämpa apply.

För att nämna det, kan man när som helst återgå till föregående ReplicaSet om det nuvarande har problem. För att göra detta måste du välja den relevanta RS (:rs för deras lista):

… och utföra rollback med hjälp av Ctrl + l. Vi bör få en avisering om att allt har gått bra:

k9s/whoami-5cfbdbb469 har återställts framgångsrikt

För att skala upp repliker räcker det med att trycka på «s» (scale) och välja det antal instanser som behövs:

I vilken container som helst kan du gå in med hjälp av shell: gå till den önskade podden, tryck på «s» (shell) och välj containern.

Andra möjligheter

Självklart stöds även visning av loggar («l» för den valda resursen). För att se nya loggar behöver du inte kontinuerligt trycka på Enter: det räcker att markera («m»), varefter du bara följder de nya meddelandena.

I detta fönster kan du också välja en tidsperiod för loggarna:

tangenten «1» — för 1 minut;
«2» — 5 minuter;
«3» — 15 minuter;
«4» — 30 minuter;
«5» — 1 timme;
«0» — för hela livslängden för podden.

Ett speciellt läge i Pulse (kommandot :pulse) visar allmän information om Kubernetes-klustret:

Här kan du se antalet resurser och deras status (de med status visas i grönt Running).

En annan intressant funktion i K9s kallas Popeye. Den kontrollerar alla resurser efter vissa korrekthetskriterier och ger en «betyg» med förklaringar. Till exempel kan du se att det saknas begränsningar eller gränser, och att en viss container kan köras som root…

Det finns grundläggande stöd för Helm. Till exempel kan du på detta sätt se vilka releaser som har distribuerats till klustret:

:helm all # alla
:helm $namespace # i ett specifikt namnrymd

Benchmark

I K9s har de till och med byggt in hey — det är en enkel belastningstestare för HTTP-servrar, ett alternativ till den mer kända ab (ApacheBench).

För att aktivera det behöver du aktivera port-forward i podden. Välj podden och tryck på Shift + f, gå till undermenyn port-forward med aliaset «pf».

Efter val av port och tryck på Ctrl + b startas själva benchmarket. Resultaten av dess arbete sparas i /tmp och är tillgängliga för efterföljande visning i K9s.

För att ändra benchmark-konfigurationen måste du skapa en fil $HOME/.k9s/bench-.yml (det bestäms för varje kluster).

NB: Viktigt att alla YAML-filer i katalogen .k9s har just .yml (.yaml fungerar inte korrekt).

Exempelkonfiguration:

benchmark:
  defaults:
    # Antal trådar
    concurrency: 2
    # Antal förfrågningar
    requests: 1000
  containers:
    # Inställningar för containern med benchmark
    # Containern definieras som 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
 services:
    # Benchmarking kan göras på tjänster av typen NodePort och LoadBalancer
    # Syntax: namespace/service-name
    default/nginx:
      concurrency: 5
      requests: 500
      http:
        method: GET
        path: /auth
      auth:
        user: flant
        password: s3cr3tp455w0rd

Gränssnitt

Visning av kolumner för resurslistor modifieras genom att skapa en fil $HOME/.k9s/views.yml. Exempel på innehållet är:

k9s:
 views:
   v1/pods:
     columns:
       - ÅLDER
       - NAMESPACE
       - NAMN
       - IP
       - NOD
       - STATUS
       - KLAR
   v1/services:
     columns:
       - ÅLDER
       - NAMESPACE
       - NAMN
       - TYP
       - KLUSTER-IP

Det saknas dock en kolumn för etiketter, vilket finns som ett ärende i projektet.

Sortering av kolumner görs med tangentkombinationer:

Shift + n — efter namn;
Shift + o — efter noder;
Shift + i — efter IP;
Shift + a — efter behållarens livstid;
Shift + t — efter antalet omstarter;
Shift + r — efter status för beredskap;
Shift + c — efter CPU-användning;
Shift + m — efter minnesanvändning.

Om någon inte gillar den förvalda färgsättningen, stöder K9s till och med teman. Färdiga exempel (7 stycken) finns tillgängliga här. Här är ett exempel på ett av dessa teman (in the navy):

Plugins

Slutligen, plugins ökar K9s möjligheter. Jag har själv använt bara ett av dem — kubectl get all -n $namespace.

Det ser ut på följande sätt. Vi skapar en fil $HOME/.k9s/plugin.yml med följande innehåll:

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

Nu kan vi gå till namnområdet och trycka på "g" för att utföra kommandot:

Bland plugins finns till exempel integrationer med kubectl-jq och loggvisningsverktyget stern.

Slutsats

Efter min mening har K9s visat sig vara mycket användbar: man vänjer sig snabbt vid att hitta allt utan att använda kubectl. Jag blev glad över loggvisningen och deras sparande, snabb redigering av resurser, och hastigheten i allmänhet*, fungerade läget Popeye bra. Möjligheten att skapa plugins och anpassa applikationen efter egna behov förtjänar särskild uppmärksamhet.

* Även om jag har märkt att K9s arbetar långsamt vid stora loggningsvolymer. Under sådana tider "åt" verktyget 2 kärnor av Intel Xeon E312xx och kunde till och med frysa.

Vad saknas just nu? En snabb återgång till en tidigare version (inte RS) utan att gå in i katalogen. Dessutom sker återställningen endast för alla resursen: om du har tagit bort en annotation eller etikett måste du ta bort och återställa hela resursen (och här måste du gå in i katalogen). En annan småsak — det saknas datum för sådana sparade "backup-filer".