ISTIOCTL-PROXY-CONFIG-ROUTE(1)

πŸ“¦ version 1.31.3, in nixos 26.05, nixpkgs unstable

πŸ’… istioctl-proxy-config-route β€” the manual page, but make it make sense

okay so bestie, welcome to the istioctl-proxy-config-route page of the istioctl manual (section 1, for the record πŸ‘‘). this is the one that tells you everything about the route config inside the Envoy that's chilling in a pod you pick. let's get into it 🫢


✨ NAME ✨

istioctl-proxy-config-route β€” literally retrieves the route configuration for the Envoy that's running in the pod you specify. that's it, that's the whole gig πŸ’–


🌈 SYNOPSIS 🌈

istioctl proxy-config route [/][.] [flags]

yes the [/][.] is real, it's not a typo, it's just how this one is written down. slay.


πŸ¦‹ DESCRIPTION πŸ¦‹

so you wanna know what routes your Envoy has going on? this command pulls up all the info about route configuration for the Envoy instance inside the pod you point it at. it's giving "let me peek at your itinerary" energy and honestly we're obsessed ✨


πŸŽ€ OPTIONS πŸŽ€

  • -f, --file="" β€” an Envoy config dump JSON file, so you can read a dump you already saved instead of touching the cluster. no cap.
  • -h, --help[=false] β€” help for route. your little "what does this even do" button πŸ’…
  • --name="" β€” filters listeners by the route name field. yes, it says listeners, that's what it says, don't come for me 😭
  • -o, --output="short" β€” output format, and it has to be one of json, yaml, or short. default is short if you don't say anything.
  • --verbose[=true] β€” outputs more information. more is more, periodt πŸ”₯

πŸ‘‘ OPTIONS INHERITED FROM PARENT COMMANDS πŸ‘‘

these don't live here, they're hand-me-downs from the parent command, but you can absolutely use them here and they are iconic for it:

  • --as="" β€” username to impersonate for the operation. can be a regular user or a service account in a namespace 🌸
  • --as-group=[] β€” group to impersonate for the operation. this flag can be repeated if you need multiple groups, so go off πŸŽ€
  • --as-uid="" β€” UID to impersonate for the operation.
  • --context="" β€” Kubernetes configuration context.
  • -i, --istioNamespace="istio-system" β€” Istio system namespace. defaults to istio-system.
  • --kubeclient-timeout="15s" β€” Kubernetes client timeout as a time.Duration string, and it defaults to 15 seconds. so 15s unless you're feeling different πŸ’œ
  • -c, --kubeconfig="" β€” Kubernetes configuration file.
  • -n, --namespace="" β€” Kubernetes namespace.
  • --proxy-admin-port=15000 β€” Envoy proxy admin port. 15000 is the default, as is tradition.
  • --vklog=0 β€” a number for the log level verbosity, like the -v flag. example given is --vklog=9, so go wild πŸ™ˆ

πŸ’€ EXAMPLE πŸ’€

these are copied exactly, bestie. do not remix them. i'm serious 😭
# Retrieve summary about route configuration for a given pod from Envoy.
istioctl proxy-config routes <pod-name[.namespace]>

# Retrieve summary about route configuration for a pod under a deployment from Envoy.
istioctl proxy-config routes deployment/<deployment-name[.namespace]>

# Retrieve route summary for route 9080.
istioctl proxy-config route <pod-name[.namespace]> --name 9080

# Retrieve full route dump for route 9080
istioctl proxy-config route <pod-name[.namespace]> --name 9080 -o json

# Retrieve route summary without using Kubernetes API
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
istioctl proxy-config routes --file envoy-config.json

quick note that the examples say routes (plural) while the synopsis says route (singular) β€” that's just how it is in the original, both are in here, i'm not touching it πŸ’…


πŸ”₯ SEE ALSO πŸ”₯


okay that's the whole page, you're officially smarter than you were five minutes ago, i'm so proud of you πŸ₯ΉπŸ’–

this absolute banger of a manpage was auto generated by spf13/cobra, dated Jan 1980 (yes really, we love a vintage moment ⭐), and it belongs to ISTIOCTL-PROXY-CONFIG-ROUTE(1). mwah πŸ’‹

πŸ“¦ where this page comes from