api

Dec 12, 2025

Changes in this version

+ var ErrLogStreamStalled = errors.New("log stream stopped responding")

+ func LogStreamTypeToProto(s LogStreamType) pb.ContainerLogEntry_StreamType

+ type ContainerLogEntry struct

+ Err error

+ Message []byte

+ Stream LogStreamType

+ Timestamp time.Time

+ type LogStreamType int

+ const LogStreamHeartbeat

+ const LogStreamStderr

+ const LogStreamStdout

+ const LogStreamUnknown

+ func LogStreamTypeFromProto(s pb.ContainerLogEntry_StreamType) LogStreamType

type Service

+ func (s *Service) MachineIDs() []string

type ServiceClient

+ StartService func(ctx context.Context, id string) error

+ StopService func(ctx context.Context, id string, opts container.StopOptions) error

+ type ServiceLogEntry struct

+ Metadata ServiceLogEntryMetadata

+ type ServiceLogEntryMetadata struct

+ ContainerID string

+ MachineID string

+ MachineName string

+ ServiceID string

+ ServiceName string

+ type ServiceLogsOptions struct

+ Follow bool

+ Machines []string

+ Since string

+ Tail int

+ Until string

Nov 12, 2025

Changes in this version

type ContainerClient

+ ExecContainer func(ctx context.Context, serviceNameOrID, containerNameOrID string, ...) (int, error)

type ContainerResources

+ DeviceReservations []container.DeviceRequest

+ type ExecOptions struct

+ AttachStderr bool

+ AttachStdin bool

+ AttachStdout bool

+ Command []string

+ Detach bool

+ Env []string

+ Privileged bool

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ Tty bool

+ User string

+ WorkingDir string

type ServiceContainer

+ func (c *ServiceContainer) ShortID() string

Oct 9, 2025

Changes in this version

+ func ValidateConfigsAndMounts(configs []ConfigSpec, mounts []ConfigMount) error

+ type ConfigMount struct

+ ConfigName string

+ ContainerPath string

+ Gid string

+ Mode *os.FileMode

+ Uid string

+ func (c *ConfigMount) GetNumericGid() (*uint64, error)

+ func (c *ConfigMount) GetNumericUid() (*uint64, error)

+ func (c *ConfigMount) Validate() error

+ type ConfigSpec struct

+ Content []byte

+ Name string

+ func (c *ConfigSpec) Equals(other ConfigSpec) bool

+ func (c *ConfigSpec) Validate() error

type ContainerSpec

+ ConfigMounts []ConfigMount

+ type ImageFilter struct

+ Machines []string

+ Name string

+ type MachineImages struct

+ ContainerdStore bool

+ Images []image.Summary

+ Metadata *pb.Metadata

type Service

+ func (s *Service) Images() []string

type ServiceSpec

+ Configs []ConfigSpec

+ func (s *ServiceSpec) Config(name string) (ConfigSpec, bool)

Aug 28, 2025

Changes in this version

type Container

+ func (c *Container) CreatedTime() time.Time

type ServiceContainer

+ func (c *ServiceContainer) UnmarshalJSON(data []byte) error

type ServiceSpec

+ func (s *ServiceSpec) CaddyConfig() string

Aug 15, 2025

Changes in this version

+ type CaddySpec struct

+ Config string

+ func (c *CaddySpec) Equals(other *CaddySpec) bool

type ServiceSpec

+ Caddy *CaddySpec

Aug 4, 2025

Changes in this version

type MachineClient

+ RenameMachine func(ctx context.Context, nameOrID, newName string) (*pb.MachineInfo, error)

+ UpdateMachine func(ctx context.Context, req *pb.UpdateMachineRequest) (*pb.MachineInfo, error)

May 1, 2025

Changes in this version

+ const Core

+ const DockerNetworkName

+ const MilliCore

type Container

+ func (c *Container) UncloudNetworkIP() netip.Addr

+ type ContainerResources struct

+ CPU int64

+ Memory int64

+ MemoryReservation int64

type ContainerSpec

+ LogDriver *LogDriver

+ Privileged bool

+ Resources ContainerResources

+ User string

+ type LogDriver struct

+ Name string

+ Options map[string]string

Apr 23, 2025

Changes in this version

+ const VolumeDriverLocal

+ const VolumeTypeBind

+ const VolumeTypeTmpfs

+ const VolumeTypeVolume

+ type BindOptions struct

+ CreateHostPath bool

+ HostPath string

+ Propagation mount.Propagation

+ Recursive string

type ContainerSpec

+ Env EnvVars

+ VolumeMounts []VolumeMount

+ type EnvVars map[string]string

+ func (e EnvVars) ToSlice() []string

+ type MachineFilter struct

+ Available bool

+ NamesOrIDs []string

+ type MachineMembersList []*pb.MachineMember

+ func (m MachineMembersList) FindByManagementIP(ip string) *pb.MachineMember

+ func (m MachineMembersList) FindByNameOrID(nameOrID string) *pb.MachineMember

+ type MachineVolume struct

+ MachineID string

+ MachineName string

+ Volume volume.Volume

+ func (v *MachineVolume) MatchesFilter(filter *VolumeFilter) bool

+ type Placement struct

+ Machines []string

+ type RunServiceResponse struct

+ ID string

+ Name string

type ServiceClient

+ RemoveService func(ctx context.Context, id string) error

+ RunService func(ctx context.Context, spec ServiceSpec) (RunServiceResponse, error)

type ServiceSpec

+ Placement Placement

+ Volumes []VolumeSpec

+ func (s *ServiceSpec) MountedDockerVolumes() []VolumeSpec

+ func (s *ServiceSpec) Volume(name string) (VolumeSpec, bool)

+ type VolumeClient interface

+ CreateVolume func(ctx context.Context, machineNameOrID string, opts volume.CreateOptions) (MachineVolume, error)

+ ListVolumes func(ctx context.Context, filter *VolumeFilter) ([]MachineVolume, error)

+ RemoveVolume func(ctx context.Context, machineNameOrID, volumeName string, force bool) error

+ type VolumeFilter struct

+ Driver string

+ Labels map[string]string

+ Machines []string

+ Names []string

+ type VolumeMount struct

+ ContainerPath string

+ ReadOnly bool

+ VolumeName string

+ func (m *VolumeMount) Validate() error

+ type VolumeOptions struct

+ Driver *mount.Driver

+ Labels map[string]string

+ Name string

+ NoCopy bool

+ SubPath string

+ type VolumeSpec struct

+ BindOptions *BindOptions

+ Name string

+ TmpfsOptions *mount.TmpfsOptions

+ Type string

+ VolumeOptions *VolumeOptions

+ func (v *VolumeSpec) Clone() VolumeSpec

+ func (v *VolumeSpec) DockerVolumeName() string

+ func (v *VolumeSpec) Equals(other VolumeSpec) bool

+ func (v *VolumeSpec) MatchesDockerVolume(vol volume.Volume) bool

+ func (v *VolumeSpec) SetDefaults() VolumeSpec

+ func (v *VolumeSpec) Validate() error

Mar 31, 2025

Changes in this version

+ const LabelManaged

+ const LabelServiceID

+ const LabelServiceMode

+ const LabelServiceName

+ const LabelServicePorts

+ const PortModeHost

+ const PortModeIngress

+ const ProtocolHTTP

+ const ProtocolHTTPS

+ const ProtocolTCP

+ const ProtocolUDP

+ const PullPolicyAlways

+ const PullPolicyMissing

+ const PullPolicyNever

+ const ServiceModeGlobal

+ const ServiceModeReplicated

+ var ErrNotFound = errors.New("not found")

+ func PortsEqual(a, b []PortSpec) bool

+ func ProxyMachinesContext(ctx context.Context, cli MachineClient, namesOrIDs []string) (context.Context, error)

+ func ValidateServiceID(id string) bool

+ type Client interface

+ type Container struct

+ func (c *Container) Healthy() bool

+ func (c *Container) HumanState() (string, error)

+ func (c *Container) UnmarshalJSON(data []byte) error

+ type ContainerClient interface

+ CreateContainer func(ctx context.Context, serviceID string, spec ServiceSpec, machineID string) (container.CreateResponse, error)

+ InspectContainer func(ctx context.Context, serviceNameOrID, containerNameOrID string) (MachineServiceContainer, error)

+ RemoveContainer func(ctx context.Context, serviceNameOrID, containerNameOrID string, ...) error

+ StartContainer func(ctx context.Context, serviceNameOrID, containerNameOrID string) error

+ StopContainer func(ctx context.Context, serviceNameOrID, containerNameOrID string, ...) error

+ type ContainerSpec struct

+ Command []string

+ Entrypoint []string

+ Image string

+ Init *bool

+ PullPolicy string

+ Volumes []string

+ func (s *ContainerSpec) Clone() ContainerSpec

+ func (s *ContainerSpec) Equals(spec ContainerSpec) bool

+ func (s *ContainerSpec) SetDefaults() ContainerSpec

+ func (s *ContainerSpec) Validate() error

+ type DNSClient interface

+ GetDomain func(ctx context.Context) (string, error)

+ type ImageClient interface

+ InspectImage func(ctx context.Context, id string) ([]MachineImage, error)

+ InspectRemoteImage func(ctx context.Context, id string) ([]MachineRemoteImage, error)

+ type MachineClient interface

+ InspectMachine func(ctx context.Context, id string) (*pb.MachineMember, error)

+ ListMachines func(ctx context.Context) ([]*pb.MachineMember, error)

+ type MachineContainer struct

+ Container Container

+ MachineID string

+ type MachineImage struct

+ Image types.ImageInspect

+ Metadata *pb.Metadata

+ type MachineRemoteImage struct

+ Image RemoteImage

+ Metadata *pb.Metadata

+ type MachineServiceContainer struct

+ Container ServiceContainer

+ MachineID string

+ type PortSpec struct

+ ContainerPort uint16

+ HostIP netip.Addr

+ Hostname string

+ Mode string

+ Protocol string

+ PublishedPort uint16

+ func ParsePortSpec(port string) (PortSpec, error)

+ func (p *PortSpec) String() (string, error)

+ func (p *PortSpec) Validate() error

+ type RemoteImage struct

+ ImageManifest *v1.Manifest

+ IndexManifest *v1.Index

+ Reference reference.Canonical

+ type Service struct

+ Containers []MachineServiceContainer

+ ID string

+ Mode string

+ Name string

+ func ServiceFromProto(s *pb.Service) (Service, error)

+ func (s *Service) Endpoints() []string

+ type ServiceClient interface

+ InspectService func(ctx context.Context, id string) (Service, error)

+ type ServiceContainer struct

+ ServiceSpec ServiceSpec

+ func (c *ServiceContainer) ConflictingServicePorts(ports []PortSpec) ([]PortSpec, error)

+ func (c *ServiceContainer) ServiceID() string

+ func (c *ServiceContainer) ServiceMode() string

+ func (c *ServiceContainer) ServiceName() string

+ func (c *ServiceContainer) ServicePorts() ([]PortSpec, error)

+ type ServiceSpec struct

+ Container ContainerSpec

+ Mode string

+ Name string

+ Ports []PortSpec

+ Replicas uint

+ func (s *ServiceSpec) Clone() ServiceSpec

+ func (s *ServiceSpec) SetDefaults() ServiceSpec

+ func (s *ServiceSpec) Validate() error