Repository files navigation

This repository defines a set of container images that packagethe language runtime dependencies required to enable step-by-stepdebugging of apps withskaffold debug.These container images are suitable for use asinitContainers ona pod. When executed, each container image copies these dependenciesto/dbg/<runtimeId>.

The idea is thatskaffold debug will transform k8s manifests tomake available any support files required to debug specific languageruntimes. For example, a Kubernetes podspec would be transformed to

• create a volume to hold the debugging support files
• run one or more of these images asinitContainers to populatethis volume, mounted as/dbg
• mount this volume on the applicable containers as/dbgwith suitably transformed command-line in the entrypoint and arguments

Current language runtimes:

• go: providesDelve
• python: providesptvsd,a debug adapter that can be used for VS Code and more, forPython 2.7 and 3.5+
• nodejs: provides anode wrapper that propagates--inspectargs to the application invokation
• netcore: providesvsdbg for .NET Core

The latest released images, which are used byskaffold debug, are available at:

gcr.io/k8s-skaffold/skaffold-debug-support

Images from a particular release are available at:

gcr.io/k8s-skaffold/skaffold-debug-support/<release>

Images from the latest commit to HEAD are available at our staging repository:

us-central1-docker.pkg.dev/k8s-skaffold/skaffold-staging/skaffold-debug-support

You can configure Skaffold to use a specific release or the stagingrepository with the following:

skaffold config set --global debug-helpers-registry <repository>

SeeCONTRIBUTING for how to contribute!