debug_attachment.proto

Package: squash.solo.io

Types:
Source File: github.com/solo-io/squash/api/v1/debug_attachment.proto

DebugAttachment

Attachments store the information needed for squash to coordinate a debugging session

"metadata": .core.solo.io.Metadata
"status": .core.solo.io.Status
"plank_name": string
"debugger": string
"image": string
"process_name": string
"node": string
"match_request": bool
"debug_server_address": string
"pod": string
"container": string
"debug_namespace": string
"state": .squash.solo.io.DebugAttachment.State

Field Type Description Default
metadata .core.solo.io.Metadata
status .core.solo.io.Status
plank_name string
debugger string
image string
process_name string
node string
match_request bool
debug_server_address string
pod string
container string
debug_namespace string
state .squash.solo.io.DebugAttachment.State

State

Name Description
RequestingAttachment Newly created DebugAttachments have state RequestingAttachment
PendingAttachment When the event loop begins fullfilling an attachment request it sets DebugAttachments state to PendingAttachment
Attached When squash client successfully attaches, it sets state to Attached
RequestingDelete Indicates that user has requested an attachment be removed
PendingDelete When the event loop begins fullfilling a delete request it sets this status and triggers a cleanup routine When the cleanup routine completes, it deletes the CRD

Intent

Describes the user’s debug intentions

"debugger": string
"pod": .core.solo.io.ResourceRef
"container_name": string
"process_matcher": string

Field Type Description Default
debugger string type of debugger to use
pod .core.solo.io.ResourceRef pod to debug
container_name string name of container to debug
process_matcher string NOT YET IMPLEMENTED if a container has multiple processes and you do not want to debug the first process, this string is used to select a specific process

Plank

Describes the pod squash spawns for managing a particular debug session

"pod": .core.solo.io.ResourceRef
"ready_for_connect": bool

Field Type Description Default
pod .core.solo.io.ResourceRef plank pod reference
ready_for_connect bool indicates when plank has completed the debugger-specify preparation

PortSpec

Contains port information needed to connect or find a debugger

"plank": string
"target": string

Field Type Description Default
plank string the relevant debug port on the plank pod
target string the relevant debug port on the target pod