Erweiterte kubectl get Techniken: Filtern von Ausgaben mit Labels und JSONPath

kubectl get wird wesentlich nützlicher, wenn Sie die Ausgabe auf die genauen Ressourcen und Felder eingrenzen können, die Sie benötigen. In einem belebten Namespace kann der Unterschied zwischen einer Wand von Pods und einer fokussierten Liste von Namen, Nodes und Images während eines Vorfalls Minuten sparen.

Diese Anleitung zeigt, wie Sie Label-Selektoren mit JSONPath-Ausgabe kombinieren. Sie werden auch sehen, wann custom-columns oder jq besser geeignet sind, als alles in einen JSONPath-Ausdruck zu zwängen.

Grundlegendes zu Kubernetes-Labels: Die Grundlage der Ressourcenauswahl

Bevor wir in die erweiterte Filterung eintauchen, ist es entscheidend, Kubernetes-Labels zu verstehen. Labels sind Schlüssel-Wert-Paare, die an Kubernetes-Objekte (wie Pods, Services, Deployments usw.) angehängt werden und zur Identifizierung und Organisation von Ressourcen dienen. Sie sind Metadaten, die Clients und Benutzer verwenden können, um Teilmengen von Objekten auszuwählen.

Labels unterscheiden sich von Annotationen; Labels sind zur Identifizierung von Merkmalen gedacht, die für Benutzer sinnvoll und relevant sind, um Objekte abzufragen und auszuwählen, während Annotationen für nicht identifizierende Metadaten sind. Gute Label-Praktiken sind für ein effektives Ressourcenmanagement und erweiterte kubectl get-Operationen unerlässlich.

Um die Labels zu sehen, die Ihren Ressourcen derzeit zugewiesen sind, können Sie das Flag --show-labels verwenden:

kubectl get pods --show-labels

Dadurch wird Ihrer Ausgabe eine Spalte LABELS hinzugefügt, die alle mit jedem Pod verbundenen Labels anzeigt.

Erweiterte Label-Selektoren mit `kubectl get -l`

Das Flag -l oder --selector ist Ihr primäres Werkzeug zum Filtern der kubectl get-Ausgabe basierend auf Labels. Es ermöglicht Ihnen, eine Reihe von Label-Anforderungen festzulegen, die Ressourcen erfüllen müssen, um in die Ausgabe aufgenommen zu werden. Die Selektoren können einfache Schlüssel-Wert-Paare oder komplexere set-basierte Ausdrücke sein.

Einfache Label-Auswahl

Exakte Übereinstimmung

Um Ressourcen auszuwählen, die ein bestimmtes Label mit einem exakten Wert haben, verwenden Sie die Syntax key=value.

# Alle Pods mit dem Label 'app' mit Wert 'nginx' abrufen
kubectl get pods -l app=nginx

# Alle Services im Namespace 'default' mit dem Label 'tier' mit Wert 'frontend' abrufen
kubectl get services -n default -l tier=frontend

Ungleichheitsübereinstimmung

Um Ressourcen auszuwählen, die ein bestimmtes Label nicht auf einen bestimmten Wert gesetzt haben, verwenden Sie die Syntax key!=value.

# Alle Pods abrufen, bei denen das Label 'app' nicht 'nginx' ist
kubectl get pods -l app!=nginx

Existenz (nur Schlüssel)

Um Ressourcen auszuwählen, die einfach ein bestimmtes Label haben, unabhängig von seinem Wert, geben Sie einfach den key an.

# Alle Pods abrufen, die das Label 'environment' haben, unabhängig von seinem Wert
kubectl get pods -l environment

Nicht-Existenz (nur Schlüssel)

Um Ressourcen auszuwählen, die kein bestimmtes Label haben, stellen Sie dem key ein ! voran.

# Alle Pods abrufen, die das Label 'component' NICHT haben
kubectl get pods -l !component

Kombinieren mehrerer Label-Selektoren (UND-Logik)

Sie können mehrere Label-Selektoren kombinieren, indem Sie sie mit einem Komma trennen. Dies impliziert eine AND-Beziehung, was bedeutet, dass eine Ressource alle angegebenen Label-Bedingungen erfüllen muss, um aufgenommen zu werden.

# Pods mit 'app=nginx' UND 'env=production' abrufen
kubectl get pods -l app=nginx,env=production

# Deployments mit 'tier=backend' UND die das Label 'version' NICHT haben, abrufen
kubectl get deployments -l tier=backend,!version

Set-basierte Label-Selektoren

Kubernetes unterstützt auch leistungsfähigere set-basierte Label-Selektoren, die besonders nützlich sind, wenn mehrere mögliche Werte für ein einzelnes Label vorhanden sind.

`key in (value1, value2, ...)`

Um Ressourcen auszuwählen, bei denen der Wert eines Labels einer der angegebenen Liste von Werten ist.

# Pods abrufen, bei denen das Label 'app' entweder 'nginx' ODER 'redis' ist
kubectl get pods -l 'app in (nginx,redis)'

# Services im Namespace 'kube-system' abrufen, bei denen das Label 'k8s-app' 'kube-dns' ODER 'kubernetes-dashboard' ist
kubectl get services -n kube-system -l 'k8s-app in (kube-dns,kubernetes-dashboard)'

`key notin (value1, value2, ...)`

Um Ressourcen auszuwählen, bei denen der Wert eines Labels nicht einer der angegebenen Liste von Werten ist.

# Pods abrufen, bei denen das Label 'env' WEDER 'dev' NOCH 'test' ist
kubectl get pods -l 'env notin (dev,test)'

Tipp: Wenn Sie set-basierte Selektoren oder Selektoren mit Sonderzeichen verwenden, setzen Sie den gesamten Selektorausdruck in einfache Anführungszeichen ('...'), um Probleme mit der Shell-Interpretation zu vermeiden.

Best Practices für die Labelvergabe

Konsistenz: Legen Sie ein klares Label-Schema fest und halten Sie sich in Ihrem gesamten Cluster daran. Dies macht die Filterung vorhersagbar und zuverlässig.
Aussagekräftige Namen: Verwenden Sie Labels, die die Eigenschaften der Ressource klar beschreiben (z. B. app, tier, environment, version).
Granularität: Labels sollten spezifisch genug sein, um eine präzise Auswahl zu ermöglichen, aber nicht so granular, dass sie unhandlich werden.
Unveränderlichkeit: Vermeiden Sie die Verwendung von Labels für Daten, die sich häufig ändern. Labels eignen sich am besten für statische identifizierende Eigenschaften.
Gängige Labels: Verwenden Sie weit verbreitete Labels wie app.kubernetes.io/name, app.kubernetes.io/instance, app.kubernetes.io/version usw. für eine bessere Interoperabilität mit Tools.

Extrahieren benutzerdefinierter Daten mit JSONPath

Während Label-Selektoren Ihnen helfen zu identifizieren, welche Ressourcen Sie möchten, hilft Ihnen JSONPath zu definieren, welche Informationen Sie aus diesen Ressourcen extrahieren möchten und wie sie formatiert werden sollen. kubectl get ermöglicht es Ihnen, Ressourcendetails in verschiedenen Formaten wie yaml, json und wide auszugeben; -o jsonpath ist nützlich, wenn Sie eine kompakte benutzerdefinierte Ausgabe benötigen.

kubectl hat eine eigene JSONPath-Implementierung zum Navigieren in der JSON-Struktur von Kubernetes-Objekten. Es unterstützt nützliche Vorlagentexte und range-Schleifen, ist aber nicht dasselbe wie Go-Vorlagen oder jq.

Um JSONPath zu verwenden, geben Sie das Ausgabeformat mit -o jsonpath='<template>' an.

JSONPath-Grundlagen und häufige Anwendungsfälle

Zuerst ist es oft hilfreich, die vollständige JSON-Ausgabe einer Ressource anzuzeigen, um ihre Struktur zu verstehen, bevor Sie einen JSONPath-Ausdruck schreiben:

# Vollständige JSON-Struktur eines Pods abrufen
kubectl get pod <pod-name> -o json

Dies gibt Ihnen eine klare Karte, um Ihre JSONPath-Abfragen zu erstellen.

Zugriff auf ein einzelnes Feld

Verwenden Sie {.field.subfield}, um auf bestimmte Werte zuzugreifen. Um beispielsweise den Namen eines Pods zu erhalten:

# Den Namen eines bestimmten Pods abrufen
kubectl get pod my-nginx-pod-12345 -o jsonpath='{.metadata.name}'

# Den Node-Namen abrufen, auf dem ein Pod läuft
kubectl get pod my-nginx-pod-12345 -o jsonpath='{.spec.nodeName}'

Zugriff auf Array-Elemente

Um auf Elemente innerhalb eines Arrays zuzugreifen, können Sie [*] verwenden, um alle Elemente zu durchlaufen, oder [index] für ein bestimmtes.

# Die Namen aller Container in einem bestimmten Pod abrufen
kubectl get pod my-nginx-pod-12345 -o jsonpath='{.spec.containers[*].name}'

# Das Image des ersten Containers in einem bestimmten Pod abrufen
kubectl get pod my-nginx-pod-12345 -o jsonpath='{.spec.containers[0].image}'

Iterieren über eine Liste von Ressourcen (mit `range`)

Wenn kubectl get mehrere Ressourcen zurückgibt (z. B. alle Pods), ist die Ausgabe normalerweise ein Objekt, das ein items-Array enthält. Sie benötigen die Go-Vorlagenfunktion range, um durch sie zu iterieren.

# Alle Pod-Namen und ihre IPs auflisten, jede in einer neuen Zeile
kubectl get pods -o jsonpath='{range .items[*]}{.metadata.name}{"\t"}{.status.podIP}{"\n"}{end}'

# Alle Deployment-Namen und die Anzahl der bereiten Replikate auflisten
kubectl get deployments -o jsonpath='{range .items[*]}{.metadata.name}{"\t"}{.status.readyReplicas}{"\n"}{end}'

{range .items[*]}: Startet eine Iteration über jedes Element im .items-Array.
{.metadata.name}: Innerhalb der Schleife bezieht sich . auf das aktuelle Element (z. B. ein einzelnes Pod-Objekt).
{"\t"}: Fügt ein Tabulatorzeichen zur Formatierung ein.
{"\n"}: Fügt ein Zeilenumbruchzeichen ein.
{end}: Schließt die range-Schleife.

Bedingte Ausgabe: Verwenden Sie stattdessen Go-Vorlagen

kubectl -o jsonpath unterstützt keine Go-Vorlagenblöcke wie if, with oder else. Wenn Sie eine bedingte Darstellung benötigen, wechseln Sie zu -o go-template:

# Pod-Namen auflisten und N/A ausgeben, wenn podIP leer ist
kubectl get pods -o go-template='{{range .items}}{{.metadata.name}}{{"\t"}}{{if .status.podIP}}{{.status.podIP}}{{else}}N/A{{end}}{{"\n"}}{{end}}'

Für nicht-bedingte Ausgaben ist JSONPath kürzer:

kubectl get pods -o jsonpath='{range .items[*]}{.metadata.name}{"\t"}{.status.podIP}{"\n"}{end}'

Benutzerdefinierte Formatierung und Kopfzeile

Sie können Ihren eigenen statischen Text hinzufügen und eine Kopfzeile für Ihre tabellenartige Ausgabe erstellen.

# Benutzerdefinierte Ausgabe für Pod-Namen, Images und Node, mit einer Kopfzeile
kubectl get pods -o=jsonpath='{"NAME\tIMAGE\tNODE\n"}{range .items[*]}{.metadata.name}{"\t"}{.spec.containers[*].image}{"\t"}{.spec.nodeName}{"\n"}{end}'

Warnung: kubectl hat eine eigene JSONPath-Implementierung. Sie ist nützlich für Feldextraktion und range-Schleifen, aber nicht dasselbe wie jq und unterstützt nicht alle JSONPath-Funktionen, die Sie möglicherweise aus anderen Tools kennen.

Tipps für JSONPath

Fangen Sie einfach an: Beginnen Sie mit einem einfachen Pfad und fügen Sie dann mehr Komplexität hinzu.
JSON inspizieren: Verwenden Sie immer kubectl get <resource> <name> -o json, um die genaue Struktur zu verstehen, die Sie abfragen.
Escape-Zeichen: Denken Sie daran, Sonderzeichen wie Zeilenumbrüche (\n) und Tabulatoren (\t) innerhalb Ihrer JSONPath-Vorlagenzeichenfolge zu escapen, wenn sie als Literale in der Ausgabe dargestellt werden sollen.
Vorlagen speichern: Für komplexe oder häufig verwendete JSONPath-Ausdrücke speichern Sie sie in einer Datei und verwenden Sie -o jsonpath-file=/path/to/template.jsonpath.

Kombinieren von Labels und JSONPath

Die wahre Stärke liegt in der Kombination dieser Techniken. Verwenden Sie zuerst Label-Selektoren, um die Ressourcen einzugrenzen, und wenden Sie dann JSONPath an, um bestimmte Daten aus dieser gefilterten Menge zu extrahieren und zu formatieren.

# Die Namen und Container-Images aller Pods mit 'app=my-app' und 'env=production' abrufen
kubectl get pods -l 'app=my-app,env=production' -o jsonpath='{range .items[*]}{.metadata.name}{"\t"}{.spec.containers[*].image}{"\n"}{end}'

# Die Namen und Cluster-IPs aller Services abrufen, die das Label 'tier' auf 'backend' gesetzt haben
kubectl get services -l tier=backend -o jsonpath='{range .items[*]}{.metadata.name}{"\t"}{.spec.clusterIP}{"\n"}{end}'

# Alle Pods finden, die auf einem bestimmten Node 'worker-node-1' laufen, und ihre Namen und Status auflisten
kubectl get pods --field-selector spec.nodeName=worker-node-1 -o jsonpath='{range .items[*]}{.metadata.name}{"\t"}{.status.phase}{"\n"}{end}'

Hinweis: Während Label-Selektoren (-l) für beliebige Schlüssel-Wert-Paare sind, bietet kubectl auch --field-selector zum Filtern basierend auf Ressourcenfeldern (z. B. status.phase=Running, metadata.namespace=default). Dies bietet eine weitere leistungsstarke Filterebene, die sowohl mit Labels als auch mit JSONPath kombiniert werden kann.

Fehlerbehebung und häufige Fallstricke

JSONPath-Syntaxfehler: Selbst ein kleiner Tippfehler kann die Vorlage zerstören. Überprüfen Sie geschweifte Klammern, Punkte und Array-Zugriffe doppelt.
Fehlende Felder: Wenn ein Feld für eine bestimmte Ressource nicht existiert, gibt JSONPath möglicherweise <no value> oder eine leere Zeichenfolge aus. Verwenden Sie if- oder with-Go-Vorlagenkonstrukte, um diese elegant zu behandeln.
Shell-Escaping: Die einfachen Anführungszeichen um den JSONPath-Ausdruck sind entscheidend. Wenn Ihr Ausdruck interne Anführungszeichen oder Sonderzeichen enthält, benötigen Sie möglicherweise zusätzliches Shell-Escaping.
Go-Vorlage vs. reines JSONPath: Denken Sie daran, dass kubectl Go-Vorlagen verwendet, nicht eine universelle JSONPath-Engine. Funktionen wie erweiterte Filterung (?()) sind normalerweise Teil von jq oder anderen dedizierten JSON-Prozessoren und werden in kubectls -o jsonpath nicht direkt unterstützt.
Leeres items-Array: Wenn Ihr Label-Selektor keine Ressourcen findet, ist items leer und Ihre range-Schleife erzeugt keine Ausgabe.

Fazit

Die Beherrschung erweiterter kubectl get-Techniken mit Label-Selektoren und JSONPath ist eine unschätzbare Fähigkeit für jeden Kubernetes-Benutzer. Diese leistungsstarken Filter- und Formatierungsoptionen verwandeln kubectl get von einem einfachen Auflistungswerkzeug in ein ausgeklügeltes Datenextraktionswerkzeug. Sie können schnell problematische Ressourcen identifizieren, benutzerdefinierte Berichte erstellen oder präzise Daten in Automatisierungsskripte einspeisen.

Verwenden Sie Labels, um die Ressourcen auszuwählen, und wählen Sie dann das einfachste Ausgabeformat, das Ihnen die benötigten Felder liefert. JSONPath eignet sich hervorragend für die kompakte Extraktion, custom-columns ist einfacher für schnelle Tabellen, und jq oder Go-Vorlagen sind besser, wenn die Ausgabe echte Logik erfordert.