kubespy

kubespy: non-invasive debugging tool for kubernetes

kubespy is a kubectl plugin which can non-invasively load common system tools into a particular running pod for debugging. So you don't have to modify the spec of the pod or the image of the container just for debugging purpose.

Examples

Installation

curl -so kubectl-spy https://raw.githubusercontent.com/huazhihao/kubespy/master/kubespy
sudo install kubectl-spy /usr/local/bin/

Usage

Load common system tools into a particular running pod for debugging

Usage:

  kubectl spy POD [-c CONTAINER] [--spy SPY_IMAGE]

Examples:

  # spy the first container nginx from mypod
  kubectl spy mypod

  # sspy container nginx from mypod
  kubectl spy mypod -c nginx

  # spy container nginx from mypod using busybox
  kubectl spy mypod -c nginx --spy busybox

Architecture

local machine: kubectl spy
                    |
                    v
master node:   kube-apiserver
                    |
                    v
worker node:   kubelet
                    |
                    v
               spy pod (eg. busybox)
                    | (chroot)
                    v
               docker runtime
                    | (run)
                    v
               sidecar container
                    | (share namespace: pid/net/ipc)
                    v
               target pod (eg. nginx)