Documentation
¶
Index ¶
- Constants
- func ConvertContainerdStatusToContainerState(status containerd.Status) intmodel.ContainerState
- func DefaultRootContainerSpec(containerdID, cellID, realmID, spaceID, stackID, cniConfigPath string) intmodel.ContainerSpec
- func NormalizeImageReference(image string) string
- type CPUResources
- type CgroupResources
- type CgroupSpec
- type Client
- type ContainerDeleteOptions
- type ContainerRuntime
- type ContainerSpec
- type IOResources
- type IOThrottleEntry
- type IOThrottleType
- type MemoryResources
- type NamespacePaths
- type RegistryCredentials
- type StopContainerOptions
- type TaskIO
- type TaskSpec
Constants ¶
const (
// DefaultRootContainerImage is the image used when none is provided.
DefaultRootContainerImage = "docker.io/library/busybox:latest"
)
Variables ¶
This section is empty.
Functions ¶
func ConvertContainerdStatusToContainerState ¶
func ConvertContainerdStatusToContainerState(status containerd.Status) intmodel.ContainerState
ConvertContainerdStatusToContainerState converts a containerd task status to internal ContainerState.
func DefaultRootContainerSpec ¶
func DefaultRootContainerSpec( containerdID, cellID, realmID, spaceID, stackID, cniConfigPath string, ) intmodel.ContainerSpec
DefaultRootContainerSpec returns a minimal ContainerSpec suitable for keeping the root container alive while other workload containers are managed. containerdID is the hierarchical ID used for containerd operations. The ID field will be set to "root" (base name).
func NormalizeImageReference ¶
NormalizeImageReference normalizes an image reference to a fully qualified format. Examples:
- "debian:latest" -> "docker.io/library/debian:latest"
- "alpine" -> "docker.io/library/alpine:latest"
- "user/image:tag" -> "docker.io/user/image:tag"
- "docker.io/library/debian:latest" -> "docker.io/library/debian:latest" (unchanged)
- "registry.example.com/image:tag" -> "registry.example.com/image:tag" (unchanged)
Types ¶
type CPUResources ¶
CPUResources maps to cpu*, cpuset* controllers.
type CgroupResources ¶
type CgroupResources struct {
CPU *CPUResources
Memory *MemoryResources
IO *IOResources
}
CgroupResources represents the subset of controllers we expose.
type CgroupSpec ¶
type CgroupSpec struct {
// Group is the target cgroup path, e.g. /kukeon/workloads/runner.
Group string
// Mountpoint overrides the default cgroup mount (/sys/fs/cgroup) when non-empty.
Mountpoint string
// Resources defines the controller knobs that should be configured for the cgroup.
Resources CgroupResources
}
CgroupSpec describes how to create a new cgroup.
func DefaultCellSpec ¶
func DefaultCellSpec(cell intmodel.Cell) CgroupSpec
func DefaultRealmSpec ¶
func DefaultRealmSpec(realm intmodel.Realm) CgroupSpec
func DefaultSpaceSpec ¶
func DefaultSpaceSpec(space intmodel.Space) CgroupSpec
func DefaultStackSpec ¶
func DefaultStackSpec(stack intmodel.Stack) CgroupSpec
type Client ¶
type Client interface {
Connect() error
Close() error
Namespace() string
CreateNamespace(namespace string) error
DeleteNamespace(namespace string) error
ListNamespaces() ([]string, error)
GetNamespace(namespace string) (string, error)
ExistsNamespace(namespace string) (bool, error)
SetNamespace(namespace string)
SetNamespaceWithCredentials(namespace string, creds []RegistryCredentials)
CleanupNamespaceResources(namespace, snapshotter string) error
GetRegistryCredentials() []RegistryCredentials
GetCgroupMountpoint() string
GetCurrentCgroupPath() (string, error)
CgroupPath(group, mountpoint string) (string, error)
NewCgroup(spec CgroupSpec) (*cgroup2.Manager, error)
LoadCgroup(group string, mountpoint string) (*cgroup2.Manager, error)
DeleteCgroup(group, mountpoint string) error
CreateContainerFromSpec(intmodel.ContainerSpec) (containerd.Container, error)
CreateContainer(spec ContainerSpec) (containerd.Container, error)
GetContainer(id string) (containerd.Container, error)
ListContainers(filters ...string) ([]containerd.Container, error)
ExistsContainer(id string) (bool, error)
DeleteContainer(id string, opts ContainerDeleteOptions) error
StartContainer(spec ContainerSpec, taskSpec TaskSpec) (containerd.Task, error)
StopContainer(id string, opts StopContainerOptions) (*containerd.ExitStatus, error)
TaskStatus(id string) (containerd.Status, error)
TaskMetrics(id string) (*apitypes.Metric, error)
}
type ContainerDeleteOptions ¶
type ContainerDeleteOptions struct {
// SnapshotCleanup indicates whether to clean up snapshots.
SnapshotCleanup bool
}
ContainerDeleteOptions describes options for deleting a container.
type ContainerRuntime ¶
type ContainerRuntime struct {
// Name is the runtime name (e.g., "io.containerd.runc.v2").
Name string
// Options are runtime-specific options.
Options interface{}
}
ContainerRuntime describes the runtime configuration.
type ContainerSpec ¶
type ContainerSpec struct {
// ID is the unique identifier for the container.
ID string
// Image is the image reference to use for the container.
Image string
// SnapshotKey is the key for the snapshot. If empty, defaults to ID.
SnapshotKey string
// Snapshotter is the snapshotter to use. If empty, uses default.
Snapshotter string
// Runtime is the runtime configuration.
Runtime *ContainerRuntime
// SpecOpts are OCI spec options to apply.
SpecOpts []oci.SpecOpts
// Labels are key-value pairs to attach to the container.
Labels map[string]string
// CNIConfigPath is the path to the CNI configuration to use for this container.
CNIConfigPath string
}
ContainerSpec describes how to create a new container.
func BuildContainerSpec ¶
func BuildContainerSpec( containerSpec intmodel.ContainerSpec, ) ContainerSpec
BuildContainerSpec converts an internal ContainerSpec to ctr.ContainerSpec with the expected defaults applied. Uses ContainerdID if available, otherwise falls back to ID.
func BuildRootContainerSpec ¶
func BuildRootContainerSpec( rootSpec intmodel.ContainerSpec, labels map[string]string, ) ContainerSpec
BuildRootContainerSpec converts the internal root container spec into an internal ctr.ContainerSpec with the expected defaults applied. Uses ContainerdID if available, otherwise falls back to ID.
func JoinContainerNamespaces ¶
func JoinContainerNamespaces(spec ContainerSpec, ns NamespacePaths) ContainerSpec
JoinContainerNamespaces returns a copy of spec with namespace spec options applied.
type IOResources ¶
type IOResources struct {
Weight uint16
Throttle []IOThrottleEntry
}
IOResources exposes IO weight + throttling.
type IOThrottleEntry ¶
type IOThrottleEntry struct {
Type IOThrottleType
Major int64
Minor int64
Rate uint64
}
IOThrottleEntry represents a single io.max entry.
type IOThrottleType ¶
type IOThrottleType string
IOThrottleType identifies the throttle file to target.
const ( IOTypeReadBPS IOThrottleType = IOThrottleType(cgroup2.ReadBPS) IOTypeWriteBPS IOThrottleType = IOThrottleType(cgroup2.WriteBPS) IOTypeReadIOPS IOThrottleType = IOThrottleType(cgroup2.ReadIOPS) IOTypeWriteIOPS IOThrottleType = IOThrottleType(cgroup2.WriteIOPS) )
type MemoryResources ¶
MemoryResources maps to memory controller knobs.
type NamespacePaths ¶
NamespacePaths describes the namespace file paths a container should join.
type RegistryCredentials ¶
type RegistryCredentials struct {
// Username is the registry username.
Username string
// Password is the registry password or token.
Password string
// ServerAddress is the registry server address (e.g., "docker.io", "registry.example.com").
// If empty, credentials apply to the registry extracted from the image reference.
ServerAddress string
}
RegistryCredentials contains authentication information for a container registry. This type matches the modelhub RegistryCredentials structure for use in the ctr package.
func ConvertRealmCredentials ¶
func ConvertRealmCredentials(creds []intmodel.RegistryCredentials) []RegistryCredentials
ConvertRealmCredentials converts modelhub RegistryCredentials slice to ctr RegistryCredentials slice.
type StopContainerOptions ¶
type StopContainerOptions struct {
// Signal is the signal to send (defaults to SIGTERM).
Signal string
// Timeout is the timeout for graceful shutdown.
Timeout *time.Duration
// Force indicates whether to force kill if timeout is exceeded.
Force bool
}
StopContainerOptions describes options for stopping a container.
type TaskIO ¶
type TaskIO struct {
// Stdin is the path to stdin (if any).
Stdin string
// Stdout is the path to stdout (if any).
Stdout string
// Stderr is the path to stderr (if any).
Stderr string
// Terminal indicates if the task should have a TTY.
Terminal bool
}
TaskIO describes the IO configuration for a task.
type TaskSpec ¶
type TaskSpec struct {
// IO is the IO configuration for the task.
IO *TaskIO
// Options are task creation options.
Options []containerd.NewTaskOpts
}
TaskSpec describes how to create a new task.