Skip to content
home
1.21.x
Reference
CLI reference
If you are interested in trying out Gloo Gateway with the Kubernetes Gateway API, check out Solo Enterprise for kgateway. This version adds enterprise functionality on top of the kgateway open source project.

glooctl debug

Page as Markdown
Reference for the ‘glooctl debug’ command.
glooctl debug

Debug Gloo Gateway (requires Gloo running on Kubernetes)
Synopsis

Dumps Kubernetes, Gloo Gateway controller, and Envoy state information to a local directory. This is useful for debugging failures. The dump includes:
  • the Kubernetes cluster state
  • logs from all pods in the given namespaces
  • YAML manifests of all solo.io CRs in the given namespaces
  • the gloo controller logs, metrics, xds snapshot, and krt snapshot
  • the envoy config dump, stats, clusters, and listeners
glooctl debug [flags]
Options

  -d, --directory string         directory to write debug info to (default "debug")
  -h, --help                     help for debug
  -N, --namespaces stringArray   namespaces from which to dump logs and resources (use flag multiple times to specify multiple namespaces, e.g. '-N gloo-system -N default') (default [gloo-system])
Options inherited from parent commands

  -c, --config string              set the path to the glooctl config file (default "<home_directory>/.gloo/glooctl-config.yaml")
      --consul-address string      address of the Consul server. Use with --use-consul (default "127.0.0.1:8500")
      --consul-allow-stale-reads   Allows reading using Consul's stale consistency mode.
      --consul-datacenter string   Datacenter to use. If not provided, the default agent datacenter is used. Use with --use-consul
      --consul-root-key string     key prefix for the Consul key-value storage. (default "gloo")
      --consul-scheme string       URI scheme for the Consul server. Use with --use-consul (default "http")
      --consul-token string        Token is used to provide a per-request ACL token which overrides the agent's default token. Use with --use-consul
  -i, --interactive                use interactive mode
      --kube-context string        kube context to use when interacting with kubernetes
      --kubeconfig string          kubeconfig to use, if not standard one
      --use-consul                 use Consul Key-Value storage as the backend for reading and writing config (VirtualServices, Upstreams, and Proxies)
SEE ALSO

  • glooctl - CLI for Gloo
  • glooctl debug yaml - Print YAML representing the current Gloo state of a Kubernetes cluster (top level “debug” command is preferred)
glooctl checkglooctl debug yaml