container

Documentation

Overview

Package container provides utilities for managing containers, including creating, starting, stopping, and monitoring containers.

Index

• func CheckRuntimeAvailable() error
• func GetOrGenerateContainerName(containerName, image string) (string, string)
• func NewMonitor(rt runtime.Runtime, containerName string) runtime.Monitor
• type Factory
  • func NewFactory() *Factory
  • func (f *Factory) Clear()
  • func (f *Factory) Create(ctx context.Context) (runtime.Runtime, error)
  • func (f *Factory) CreateWithRuntimeName(ctx context.Context, runtimeName string) (runtime.Runtime, error)
  • func (f *Factory) GetRuntime(name string) (*RuntimeInfo, bool)
  • func (f *Factory) ListAvailableRuntimes() map[string]*RuntimeInfo
  • func (f *Factory) ListRuntimes() map[string]*RuntimeInfo
  • func (f *Factory) Register(info *RuntimeInfo) error
  • func (f *Factory) Unregister(name string)
• type RuntimeInfo
• type RuntimeInitializer

Functions

func CheckRuntimeAvailable

func CheckRuntimeAvailable() error

CheckRuntimeAvailable checks if any container runtime is available and returns a user-friendly error message if none are found

func GetOrGenerateContainerName

func GetOrGenerateContainerName(containerName, image string) (string, string)

GetOrGenerateContainerName generates a container name if not provided. It returns both the container name and the base name. If containerName is not empty, it will be used as both the container name and base name. If containerName is empty, a name will be generated based on the image.

func NewMonitor

func NewMonitor(rt runtime.Runtime, containerName string) runtime.Monitor

NewMonitor creates a new container monitor

Types

type Factory

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

Factory creates container runtimes with pluggable runtime support

func NewFactory

func NewFactory() *Factory

NewFactory creates a new container factory with default runtimes registered

func (*Factory) Clear

func (f *Factory) Clear()

Clear removes all registered runtimes This is useful for testing or when you want to start with a clean slate

func (*Factory) Create

func (f *Factory) Create(ctx context.Context) (runtime.Runtime, error)

Create creates a container runtime It first checks the TOOLHIVE_RUNTIME environment variable for a specific runtime, otherwise falls back to auto-detection

func (*Factory) CreateWithRuntimeName

func (f *Factory) CreateWithRuntimeName(ctx context.Context, runtimeName string) (runtime.Runtime, error)

CreateWithRuntimeName creates a container runtime with a specific runtime name If runtimeName is empty, it falls back to auto-detection

func (*Factory) GetRuntime

func (f *Factory) GetRuntime(name string) (*RuntimeInfo, bool)

GetRuntime retrieves a runtime info by name

func (*Factory) ListAvailableRuntimes

func (f *Factory) ListAvailableRuntimes() map[string]*RuntimeInfo

ListAvailableRuntimes returns all runtimes that are currently available

func (*Factory) ListRuntimes

func (f *Factory) ListRuntimes() map[string]*RuntimeInfo

ListRuntimes returns all registered runtimes

func (*Factory) Register

func (f *Factory) Register(info *RuntimeInfo) error

Register registers a new runtime with the factory

func (*Factory) Unregister

func (f *Factory) Unregister(name string)

Unregister removes a runtime from the factory

type RuntimeInfo

type RuntimeInfo struct {
	// Name is the runtime name (e.g., "docker", "kubernetes")
	Name string
	// Initializer is the function to create the runtime instance
	Initializer RuntimeInitializer
	// AutoDetector is an optional function to detect if this runtime is available
	// If nil, the runtime is always considered available
	AutoDetector func() bool
}

RuntimeInfo contains metadata about a runtime

type RuntimeInitializer

type RuntimeInitializer func(ctx context.Context) (runtime.Runtime, error)

RuntimeInitializer is a function that creates a new runtime instance