https://github.com/googlecontainertools/container-debug-support

Language-runtime support files for in-container debugging
https://github.com/googlecontainertools/container-debug-support

containers debugging kubernetes language-runtime microservices skaffold

Last synced: 6 months ago
JSON representation

Language-runtime support files for in-container debugging

• Host: GitHub
• URL: https://github.com/googlecontainertools/container-debug-support
• Owner: GoogleContainerTools
• License: apache-2.0
• Created: 2018-06-06T16:21:07.000Z (over 7 years ago)
• Default Branch: duct-tape
• Last Pushed: 2025-01-22T14:41:34.000Z (9 months ago)
• Last Synced: 2025-03-29T12:06:48.805Z (6 months ago)
• Topics: containers, debugging, kubernetes, language-runtime, microservices, skaffold
• Language: Go
• Homepage:
• Size: 362 KB
• Stars: 95
• Watchers: 22
• Forks: 27
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![experimental](https://img.shields.io/badge/stability-experimental-orange.svg)

# Container Runtime Debugging Support Images (aka Duct Tape)

This repository defines a set of container images that package

the language runtime dependencies required to enable step-by-step

debugging of apps with

[`skaffold debug`](https://skaffold.dev/docs/how-tos/debug/). 

These container images are suitable for use as `initContainer`s on

a pod.  When executed, each container image copies these dependencies

to `/dbg/`.

The idea is that `skaffold debug` will transform k8s manifests to

make available any support files required to debug specific language

runtimes.  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 as `initContainer`s to populate

    this volume, mounted as `/dbg`

  - mount this volume on the applicable containers as `/dbg`

    with suitably transformed command-line in the entrypoint and arguments

Current language runtimes:

  * `go`: provides [Delve](https://github.com/go-delve/delve)

  * `python`: provides [`ptvsd`](https://github.com/Microsoft/ptvsd),

    a debug adapter that can be used for VS Code and more, for

    Python 2.7 and 3.5+

  * `nodejs`: provides a `node` wrapper that propagates `--inspect`

    args to the application invokation

  * `netcore`: provides `vsdbg` for .NET Core

## Distribution

The latest released images, which are used by `skaffold 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/

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 staging

repository with the following:

    skaffold config set --global debug-helpers-registry 

# Contributing

See [CONTRIBUTING](CONTRIBUTING.md) for how to contribute!