Zum Inhalt springen
Trainingslager IT-Trainingslager

Anhang A: Spickzettel

Alles Wichtige aus Tag 0–15 auf wenigen Seiten. Die Zahl in Klammern ist der Tag, an dem du es geübt hast. Im Zweifel gelten developer.konghq.com, die Admin API selbst (/schemas/plugins/<name>) und deck --help.

Tagesstart und Gelände

source ~/kong-lab/setup/env.sh      # LAB, ADMIN, PROXY, PROXYS, KC (0)
kreload                             # kong.yaml neu laden, ohne Datenbank (1, 2)
ksync                               # kong.yaml per decK einspielen, mit Datenbank (8)
TOKEN=$(token)                      # Access Token von Keycloak (6)
ssh -N -L 8001:localhost:8001 -L 8002:localhost:8002 ubuntu@$KONG_IP   # Laptop (1)
Port Zweck Tag
8000 / 8443 Proxy HTTP / HTTPS 1, 10
8001 Admin API (nur 127.0.0.1) 1
8002 Kong Manager 1
8005 Cluster: Data Planes zur Control Plane 13
8100 Status und /metrics 1, 12

Admin API

Aufruf Zweck Tag
GET / Version, Konfiguration, Plugins 1
GET /status Verbindungen, configuration_hash 1
POST /config ganze Konfiguration laden (ohne DB, nur Speicher) 1
GET /services, /routes, /consumers, /plugins Objekte lesen 2, 5
POST /schemas/plugins/validate Plugin-Konfiguration prüfen 11
GET /upstreams/<name>/health Zustand der Targets (nicht im Hybrid auf der CP) 9, 15
DELETE /proxy-cache Cache leeren 4
GET /clustering/data-planes Data Planes und sync_status 13

decK

deck gateway ping | dump --skip-defaults | validate | diff | sync   # (3, 7)
deck file validate kong.yaml                                         # nur Form (3)
deck file openapi2kong -s api.yaml | deck file namespace --path-prefix=/api/v2  # (3)
deck file merge a.yaml b.yaml -o neu.yaml                            # (3, 5)
deck file add-plugins -s kong.yaml plugins.yaml -o kong.yaml         # (4)
deck file add-plugins -s kong.yaml --selector '<jsonpath>' --config '{…}'  # (4, 11)
deck file patch -s kong.yaml --selector '<jsonpath>' --value 'feld:wert'   # (3, 8)
deck file add-tags -s kong.yaml --selector '<jsonpath>' team-notes   # (3)
deck file kong2kic -s kong.yaml --class-name kong                    # (14)

JSONPath-Beispiele: $.services[?(@.name=="notes")], $..routes[?(@.name=="notes-lesen")], $..routes[?(@.name=="notes-schreiben")].plugins[?(@.name=="rate-limiting")].

Plugins im Buch

Plugin Priorität Zweck Tag
correlation-id 100001 ID für jede Anfrage 4
cors 2000 Browser-Zugriff, Vorabfrage OPTIONS 4
jwt 1450 Token prüfen (RS256, iss) 6
jwt-identity 1400 eigenes Plugin: Name aus dem Token als Header 11
key-auth / basic-auth 1250 / 1100 Schlüssel / Passwort 5
request-size-limiting 951 Anfragen über einer Größe: 413 8
acl 950 Gruppen erlauben oder sperren 5
rate-limiting 910 Anfragen pro Zeitfenster: 429 8
request-transformer 801 Header setzen, entfernen 4, 5
proxy-cache 100 Antworten zwischenspeichern 4
prometheus, file-log, opentelemetry – Metriken, Logs, Traces 12
request-termination 2 Wartungsmodus 4

Kubernetes (KIC)

Ressource Zweck Tag
GatewayClass mit konghq.com/gatewayclass-unmanaged Kong aus Helm benutzen 14
Gateway, HTTPRoute Routen mit Gateway API 14
KongPlugin + Annotation konghq.com/plugins Plugin an eine Route 14
KongConsumer + Secret mit konghq.com/credential Consumer mit Schlüssel 14
Filter URLRewrite, RequestHeaderModifier Pfad und Header (statt eigenem request-transformer) 14

Fehlerbilder

Symptom Ursache Fix
no Route matched with those values keine Route passt Pfad, Methode, Host prüfen (2)
404 page not found (Text des Backends) strip_path oder falscher Präfix Route und Service-Pfad (2, 15)
502 invalid response falscher Port, Backend weg, TLS-Prüfung Log, tls_verify, CA (2, 10)
503 name resolution failed Host weder Upstream noch DNS Host im Service (2, 15)
503 failure to get a peer from the ring-balancer kein gesundes Target Backend, /healthz, DB (9, 15)
504 upstream server is timing out read_timeout Timeout oder Backend (2)
405 cannot create … when not using a database DB-less Datei + kreload (1, 3)
HTTP 500 bei ?tags= Fehler in 3.9.4 ohne DB mit DB filtern (3, 7)
Invalid signature / 403 mit anonymous Token verändert oder Schlüssel gewechselt Schlüssel neu eintragen (6, 15)
{"exp":"token expired"} Token abgelaufen neues Token (6)
426 Please use HTTPS protocol Route nur HTTPS über 8443 (10)
curl Fehler 60 Standard-Zertifikat, SNI fehlt SNI ergänzen (10, 15)
Kong startet nicht, Plugin unbekannt Plugin in DB, nicht in KONG_PLUGINS KONG_PLUGINS (11)
Permission denied für cluster.key Schlüssel gehört nicht UID 1001 chown 1001:1001 (13, 15)
DP plugin_set_incompatible Plugin fehlt auf der DP Plugin auf jede DP (13, 15)
Änderung kommt in der DP nicht an policy: cluster in der DP local oder redis (13, 15)
neue Route kurz 404 Worker oder DP noch nicht aktualisiert einige Sekunden warten (1, 7)