A debugger for Kubernetes applications.
Clone or download
Latest commit 3d9908c Oct 5, 2018
Permalink
Failed to load latest commit information.
cmd update dlv version Sep 24, 2018
extension/vscode support private repo and remote path Oct 5, 2018
hack added release scripts Aug 8, 2018
images add logo May 15, 2018
pkg use dlv protocol v2 Oct 5, 2018
vendor update vendor Aug 9, 2018
.gitignore vendor May 11, 2018
Gopkg.lock update vendor Aug 9, 2018
Gopkg.toml initial import form squash repo May 11, 2018
Makefile added release scripts Aug 8, 2018
README.md update readme Aug 9, 2018

README.md

squash

Debug your application running on Kubernetes


KubeSquash is a tool for live debugging of microservices running on Kubernetes. By attaching modern debuggers to your microservices application, KubeSquash gives you the full strength of live debugging : getting/setting the value of variables, adding pauses and sleeps in certain portions of the code, forcing the execution of specific code paths, etc.

KubeSquash is extremely easy to launch, and requires No server. Its user interface is dead simple: invoke with a single command ksquash, target the desired pod, and the debugging session is initiated automatically with zero configuration or effort.

You can use KubeSquash from the command line, or use Visual Studio Code as its user interface by installing the KubeCode extension.

Right now KubeSquash supports debugging using either gdb or dlv.

To learn more about the motivation behind project KubeSquash, read our blog post or watch session (slides). To stay up-to-date with KubeSquash, follow us @GetSoloIO and join us on our slack channel.

Prerequisites

  • Kubernetes cluster with ability to run privileged containers (such as minikube).
  • kubectl configured to your cluster.

To Use

Download KubeSquash from here, and simply run it. The first time it runs takes longer, as it needs to download a container containing the debugger.

How to Build

Build binary and container:

make DOCKER_REPO=your-docker-repo

Push containers to docker hub:

make DOCKER_REPO=your-docker-repo push-containers

Road map

  • More debuggers (python, java..)
  • Enhanced Skaffold integration (autodetect more settings)