runtime

Documentation

Index

• Constants
• type ContainerEnricher
  • func ContainerdEnricher(socket string) (ContainerEnricher, error)
  • func CrioEnricher(socket string) (ContainerEnricher, error)
  • func DockerEnricher(socket string) (ContainerEnricher, error)
• type ContainerMetadata
• type PodMetadata
• type RuntimeId
  • func FromString(str string) RuntimeId
  • func (runtime RuntimeId) String() string
• type Sockets
  • func Autodiscover(onRegisterFail func(err error, runtime RuntimeId, socket string)) Sockets
  • func (s *Sockets) Register(runtime RuntimeId, socket string) error
  • func (s *Sockets) Socket(runtime RuntimeId) string
  • func (s *Sockets) Supports(runtime RuntimeId) bool

Constants

const (
	PodNameLabel                 = "io.kubernetes.pod.name"
	PodNamespaceLabel            = "io.kubernetes.pod.namespace"
	PodUIDLabel                  = "io.kubernetes.pod.uid"
	ContainerNameLabel           = "io.kubernetes.container.name"
	ContainerTypeDockerLabel     = "io.kubernetes.docker.type"
	ContainerTypeContainerdLabel = "io.cri-containerd.kind"
	ContainerTypeCrioAnnotation  = "io.kubernetes.cri-o.ContainerType"
)

These labels are injected by kubelet on container creation, we can use them to gather additional data in a k8s context

Types

type ContainerEnricher

type ContainerEnricher interface {
	Get(ctx context.Context, containerId string) (ContainerMetadata, error)
}

func ContainerdEnricher

func ContainerdEnricher(socket string) (ContainerEnricher, error)

func CrioEnricher

func CrioEnricher(socket string) (ContainerEnricher, error)

func DockerEnricher

func DockerEnricher(socket string) (ContainerEnricher, error)

type ContainerMetadata

type ContainerMetadata struct {
	ContainerId string
	Name        string
	Image       string
	ImageDigest string
	Pod         PodMetadata
}

type PodMetadata

type PodMetadata struct {
	Name      string
	Namespace string
	UID       string
	Sandbox   bool
}

type RuntimeId

type RuntimeId int

Represents the internal ID of a container runtime

const (
	Unknown RuntimeId = iota
	Docker
	Containerd
	Crio
	Podman
	Garden
)

func FromString

func FromString(str string) RuntimeId

func (RuntimeId) String

func (runtime RuntimeId) String() string

type Sockets

type Sockets struct {
	// contains filtered or unexported fields
}

Sockets represent existing container runtime connections

func Autodiscover

func Autodiscover(onRegisterFail func(err error, runtime RuntimeId, socket string)) Sockets

check default paths for all supported container runtimes and aggregate them

func (*Sockets) Register

func (s *Sockets) Register(runtime RuntimeId, socket string) error

Register attempts to associate a file path with a container runtime, if the path doesn't exist registration will fail

func (*Sockets) Socket

func (s *Sockets) Socket(runtime RuntimeId) string

Socket returns the relevant socket for the runtime if one was registered

func (*Sockets) Supports

func (s *Sockets) Supports(runtime RuntimeId) bool

Supports check if the runtime was registered in the Sockets struct