readme

2025-08-30 11:13:05 -05:00 · 2025-08-30 11:13:05 -05:00 · e08759531d
commit e08759531d
parent 74cafaa556
1 changed files with 63 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1,3 +1,65 @@
 # ingress-debugger

-Debug ingress and reachability issues.
+Debug ingress and reachability issues in kubernetes deployments.
+
+> Warning: this is vibe coded gpt 4o output done as a proof of concept.
+
+``` bash
+❯ ./ingress_debugger.py inspect --help
+
+ Usage: ingress_debugger.py inspect [OPTIONS] DEPLOYMENT
+
+ Inspect a Deployment's Services & Ingresses and run connectivity checks.
+
+╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮
+│ *    deployment      TEXT  Deployment name [required]                                  │
+╰────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ──────────────────────────────────────────────────────────────────────────────╮
+│ --namespace  -n                   TEXT   Namespace (if omitted, will try to            │
+│                                          auto-detect)                                  │
+│ --timeout                         FLOAT  HTTP/TCP timeout (seconds) [default: 5.0]     │
+│ --insecure       --no-insecure           Skip TLS verification for HTTPS checks        │
+│                                          [default: no-insecure]                        │
+│ --json                                   Print JSON report instead of a table          │
+│ --help                                   Show this message and exit.                   │
+╰────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+``` bash
+❯ ./ingress_debugger.py inspect avatars -n avatars
+╭─────────────────────────────────────── Overview ───────────────────────────────────────╮
+│ Deployment: avatars  Namespace: avatars  Context: local                                │
+╰────────────────────────────────────────────────────────────────────────────────────────╯
+                      Pods
+
+  Pod                        IP           Ports
+ ───────────────────────────────────────────────
+  avatars-787cdcf447-ns8wh   10.42.0.20   8000
+
+╭────────────────────────────────────────────────────────────────────────────────────────╮
+│ Health Probe                                                                           │
+│ Kind: readiness                                                                        │
+│ Path: /ready                                                                           │
+│ Port: 8000                                                                             │
+│ Scheme: http                                                                           │
+╰────────────────────────────────────────────────────────────────────────────────────────╯
+                       Services
+
+  Service   Namespace   Port   TargetPort   Protocol
+ ────────────────────────────────────────────────────
+  avatars   avatars     8000   8000         TCP
+
+                     Ingress Bindings
+
+  Ingress   Host               Path   TLS   Service:Port
+ ────────────────────────────────────────────────────────
+  avatars   avatars.wayl.one   /      yes   avatars:8000
+
+                                       Reachability
+
+  Via        Target            URL               OK    Status   Latency (ms)   Error
+ ────────────────────────────────────────────────────────────────────────────────────────
+  ingress    avatars.wayl.o…   https://avatar…   yes   200      87             -
+  pod-ip     10.42.0.20:8000   -                 no    -        -              timed out
+  svc-fqdn   http://avatars…   http://avatars…   yes   200      -              -
+```