ISTIOCTL-PROXY-STATUS(1)

📦
version 1.31.3 · 2 versions
, in nixpkgs unstable

💅 istioctl-proxy-status 💅

okay bestie, welcome to the ISTIOCTL-PROXY-STATUS(1) manual page — this one is literally about checking the sync status of every Envoy in the mesh, and we are going to make it make sense. 🦋

✨ NAME ✨

istioctl-proxy-status — retrieves the synchronization status of each Envoy in the mesh. that's the assignment, no cap. 👑

🌸 SYNOPSIS 🌸

the whole vibe in one line:

istioctl proxy-status [/][.] [flags]

🎀 DESCRIPTION 🎀

okay so it retrieves the last sent and last acknowledged xDS sync from Istiod to each Envoy in the mesh. it's giving "sync tea, delivered fresh from Istiod to every Envoy." 💖

🔥 OPTIONS 🔥

  • --authority="" — XDS Subject Alternative Name (for example istiod.istio-system.svc). 🪪
  • --cert-dir="" — XDS Endpoint certificate directory. 📁
  • --file="" — Envoy config dump JSON file. 🗂️
  • -h, --help[=false] — help for proxy-status. the classic, iconic, always there. ✨
  • --insecure[=false] — Skip server certificate and domain verification. NOT SECURE! yes it literally says that, bestie — do not ignore the all-caps warning 🙈
  • -o, --output="table" — Output format: one of json|yaml|table. pick your aesthetic 💅
  • --plaintext[=false] — Use plain-text HTTP/2 when connecting to server (no TLS). 🫶
  • --proxy-admin-port=15000 — Envoy proxy admin port. 🔌
  • -r, --revision="" — Control plane revision. 🧚
  • --timeout=30s — The duration to wait before failing. ⏳
  • -v, --verbosity=0 — Verbosity level for proxy status output. 0=default, 1=show all xDS types (max verbosity). 👀
  • --xds-address="" — XDS Endpoint. 📍
  • --xds-label="" — Istiod pod label selector. 🏷️
  • --xds-port=15012 — Istiod pod port. 🚪

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

  • --as="" — Username to impersonate for the operation. User could be a regular user or a service account in a namespace. 🎭
  • --as-group=[] — Group to impersonate for the operation, this flag can be repeated to specify multiple groups. 👯
  • --as-uid="" — UID to impersonate for the operation. 🆔
  • --context="" — Kubernetes configuration context. 🧭
  • -i, --istioNamespace="istio-system" — Istio system namespace. 🏠
  • --kubeclient-timeout="15s" — Kubernetes client timeout as a time.Duration string, defaults to 15 seconds. ⏱️
  • -c, --kubeconfig="" — Kubernetes configuration file. 📜
  • -n, --namespace="" — Kubernetes namespace. 🌌
  • --vklog=0 — number for the log level verbosity. Like -v flag. ex: --vklog=9. 🔊

🌈 EXAMPLE 🌈

these are the exact examples, bestie — keep them verbatim, no edits, periodt:

  # Retrieve sync status for all Envoys in a mesh
  istioctl proxy-status

  # Retrieve sync status for Envoys in a specific namespace
  istioctl proxy-status --namespace foo

  # Retrieve sync diff for a single Envoy and Istiod
  istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system

  # SECURITY OPTIONS

  # Retrieve proxy status information directly from the control plane, using token security
  # (This is the usual way to get the proxy-status with an out-of-cluster control plane.)
  istioctl ps --xds-address istio.cloudprovider.example.com:15012

  # Retrieve proxy status information via Kubernetes config, using token security
  # (This is the usual way to get the proxy-status with an in-cluster control plane.)
  istioctl proxy-status

  # Retrieve proxy status information directly from the control plane, using RSA certificate security
  # (Certificates must be obtained before this step.  The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
  istioctl ps --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs

  # Retrieve proxy status information via XDS from specific control plane in multi-control plane in-cluster configuration
  # (Select a specific control plane in an in-cluster canary Istio configuration.)
  istioctl ps --xds-label istio.io/rev=default

  # Show the status of a specific proxy in JSON format
  istioctl proxy-status --output json

💜 SEE ALSO 💜

🫶 cute sign-off: this page was Auto generated by spf13/cobra, dated Jan 1980, and it's the ISTIOCTL-PROXY-STATUS(1) manual. bye bestie, go check those Envoys 💖✨
📦 where this page comes from