debug

package
v1.39.14 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 22, 2023 License: Apache-2.0 Imports: 15 Imported by: 1

Documentation

Index

Constants

View Source
const (
	// DebuggingSupportVolume is the name of the volume used to hold language runtime debugging support files.
	DebuggingSupportFilesVolume = "debugging-support-files"
)

Variables

View Source
var ConfigRetriever = func(ctx context.Context, image string, builds []graph.Artifact, registries map[string]bool) (ImageConfiguration, error) {
	if artifact := findArtifact(image, builds); artifact != nil {
		return RetrieveImageConfiguration(ctx, artifact, registries)
	}
	return ImageConfiguration{}, fmt.Errorf("no build artifact for %q", image)
}
View Source
var Protocols = []string{}

Functions

func EncodeConfigurations added in v1.31.0

func EncodeConfigurations(configurations map[string]types.ContainerDebugConfiguration) string

func NewDlvTransformer added in v1.31.0

func NewDlvTransformer() containerTransformer

func NewJDWPTransformer added in v1.31.0

func NewJDWPTransformer() containerTransformer

func NewNetcoreTransformer added in v1.31.0

func NewNetcoreTransformer() containerTransformer

func NewNodeTransformer added in v1.31.0

func NewNodeTransformer() containerTransformer

func NewPythonTransformer added in v1.31.0

func NewPythonTransformer() containerTransformer

func RegisterContainerTransformer added in v1.31.0

func RegisterContainerTransformer(t containerTransformer)

RegisterContainerTransformer allows calling packages to register their own transformer implementation with the global transform list.

func TransformContainer added in v1.31.0

func TransformContainer(adapter types.ContainerAdapter, config ImageConfiguration, portAlloc PortAllocator) (types.ContainerDebugConfiguration, string, error)

TransformContainer rewrites the container definition to enable debugging. Returns a debugging configuration description with associated language runtime support container image, or an error if the rewrite was unsuccessful.

func UnregisterContainerTransformer added in v1.31.0

func UnregisterContainerTransformer(t containerTransformer)

UnregisterContainerTransformer removes the provided transformer from the global transformer set.

Types

type Config added in v1.27.0

type Config interface {
	Mode() config.RunMode
}

type ConfigurationRetriever added in v1.31.0

type ConfigurationRetriever func(string) (ImageConfiguration, error)

configurationRetriever retrieves an container image configuration

type Debugger added in v1.27.0

type Debugger interface {
	// Start starts the debugger.
	Start(context.Context) error

	// Stop stops the debugger.
	Stop()

	// Name returns an identifier string for the debugger.
	Name() string
}

Debugger defines the behavior for any implementation of a component that attaches to and helps debug deployed resources from Skaffold.

type DebuggerMux added in v1.27.0

type DebuggerMux []Debugger

func (DebuggerMux) Name added in v1.27.0

func (d DebuggerMux) Name() string

func (DebuggerMux) Start added in v1.27.0

func (d DebuggerMux) Start(ctx context.Context) error

func (DebuggerMux) Stop added in v1.27.0

func (d DebuggerMux) Stop()

type ImageConfiguration added in v1.31.0

type ImageConfiguration struct {
	// Artifact is the corresponding Artifact's image name (`pkg/skaffold/build.Artifact.ImageName`)
	Artifact string

	Author     string
	Labels     map[string]string
	Env        map[string]string
	Entrypoint []string
	Arguments  []string
	WorkingDir string
}

ImageConfiguration captures information from a docker/oci image configuration. It also includes a "artifact", usually containing the corresponding artifact's' image name from `skaffold.yaml`.

func RetrieveImageConfiguration added in v1.32.0

func RetrieveImageConfiguration(ctx context.Context, artifact *graph.Artifact, insecureRegistries map[string]bool) (ImageConfiguration, error)

RetrieveImageConfiguration retrieves the image container configuration for the given build artifact

type NoopDebugger added in v1.27.0

type NoopDebugger struct{}

func (*NoopDebugger) Name added in v1.27.0

func (n *NoopDebugger) Name() string

func (*NoopDebugger) Start added in v1.27.0

func (n *NoopDebugger) Start(context.Context) error

func (*NoopDebugger) Stop added in v1.27.0

func (n *NoopDebugger) Stop()

type PortAllocator added in v1.31.0

type PortAllocator func(int32) int32

PortAllocator is a function that takes a desired port and returns an available port Ports are normally uint16 but Kubernetes types.ContainerPort is an integer

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL