kssadanand / kubectl-sick-pods

Kubectl plugins for diagnosing pods that are sick

kubectl-sick-pods

kubectl plugins for diagnosing Pods.

The idea for these plugins has been shamelessly stolen from Melanie Cebula's QCOn London Talk and enhanced to be slightly less opinionated.

This plugin helps find and debug Kubernetes Pods that are "Not Ready" (that have failing Pod Conditions or Containers)

This plugin also supports the standard Pod selection arguments as well as one or multiple pod names to explicitly diagnose.

Installation

Using krew

kubectl krew install sick-pods

Manually for Mac / Linux

curl -sL https://raw.githubusercontent.com/alecjacobs5401/kubectl-sick-pods/master/install.sh | sh -s

Manually for Windows

Download Windows binaries from releases

Upgrading

Using krew

kubectl krew upgrade sick-pods

Manually

See installation.

Usage

kubectl sick-pods

usage: kubectl sick-pods [<flags>] [<pod>...]

A kubectl plugin used to find Pods that are in a 'NotReady' state and display debugging information about them

Flags:
  -h, --help                   Show context-sensitive help (also try --help-long and --help-man).
      --version                Show application version.
  -l, --selector=SELECTOR      Pod Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2)
      --field-selector=FIELD-SELECTOR
                               Pod Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type.
      --kubeconfig=KUBECONFIG  The path to a pre-existing kubeconfig file that you want to have the new cluster authorization merged into. If not provided, the KUBECONFIG environment variable will be checked for a file. If that is empty, $HOME/.kube/config will be used.
  -n, --namespace=NAMESPACE    The Kubernetes namespace to use. Default to the current namespace in your kube config file.
      --context=CONTEXT        The Kubernetes context to use. Defaults to the current context in your kube config file.

Args:
  [<pod>]  A pod name to target (Accepts multiple pod names)

Example Usages

Without Arguments / Flags

$ kubectl sick-pods
'bad-pod-764ccf854d-kbsq2' is not ready! Reason Provided: None
	Failed Pod Conditions:
		CONDITION	    REASON		MESSAGE
		Ready		    ContainersNotReady	containers with unready status: [bad-container]
		ContainersReady	    ContainersNotReady	containers with unready status: [bad-container]

	Pod Events:
		LAST SEEN			TYPE	REASON			MESSAGE
		2020-05-29 14:15:32 -0700 PDT	Warning	DNSConfigForming	Search Line limits were exceeded, some search paths have been omitted, the applied search line is: some-namespace.svc.cluster.local svc.cluster.local cluster.local ec2.internal cluster-dns dns

	Container 'bad-container' is not ready!
		Container Logs:
			-e:1:in `<main>': ah (RuntimeError)
			yo

With provided pod names

kubectl sick-pods pod-abc-123 pod-def-456

Looking for kubectl-podevents?

kubectl-podevents has been migrated to its own repository