instances

package

Go to main page

Versions in this module

v0

v0.2.0

Jul 8, 2026

v0.1.1

Jun 12, 2026

Changes in this version

type CreateInstanceRequest

+ Platform string

type StoredMetadata

+ EnableRosetta bool

+ Platform string

+ ResolvedImage string

v0.1.0

Jun 4, 2026

Changes in this version

+ const SnapshotKindStandby

+ const SnapshotKindStopped

+ const WaitForStateDefaultTimeout

+ const WaitForStateMaxTimeout

+ const WaitForStatePollInterval

+ var ErrSnapshotNotFound = errors.New("snapshot not found")

+ var ErrSnapshotScheduleNotFound = errors.New("snapshot schedule not found")

type CreateInstanceRequest

+ AutoStandby *autostandby.Policy

+ Credentials map[string]CredentialPolicy

+ HealthCheck *healthcheck.Policy

+ HypervisorVersion string

+ NetworkEgress *NetworkEgressPolicy

+ RestartPolicy *restartpolicy.Policy

+ SnapshotPolicy *SnapshotPolicy

+ Tags tags.Tags

+ type CreateSnapshotRequest struct

+ Compression *snapshot.SnapshotCompressionConfig

+ Kind SnapshotKind

+ Name string

+ Tags tags.Tags

+ type CredentialInjectAs struct

+ Format string

+ Header string

+ type CredentialInjectRule struct

+ As CredentialInjectAs

+ Hosts []string

+ type CredentialPolicy struct

+ Inject []CredentialInjectRule

+ Source CredentialSource

+ type CredentialSource struct

+ Env string

+ type EgressEnforcementMode string

+ const EgressEnforcementModeAll

+ const EgressEnforcementModeHTTPHTTPSOnly

+ type ForkSnapshotRequest struct

+ Name string

+ TargetHypervisor hypervisor.Type

+ TargetState State

+ type HealthCheckController struct

+ func NewHealthCheckController(manager Manager, log *slog.Logger) *HealthCheckController

+ func (c *HealthCheckController) Run(ctx context.Context) error

+ type ImageUsageRecorder interface

+ MarkUsed func(ctx context.Context, imageName, digest string) error

+ type ImageUsageRecorderSetter interface

+ SetImageUsageRecorder func(recorder ImageUsageRecorder)

type Instance

+ BootMarkersHydrated bool

+ HealthCheckRuntime *healthcheck.Runtime

+ type LifecycleEvent struct

+ Action LifecycleEventAction

+ Instance *Instance

+ InstanceID string

+ type LifecycleEventAction string

+ const LifecycleEventCreate

+ const LifecycleEventDelete

+ const LifecycleEventFork

+ const LifecycleEventRestore

+ const LifecycleEventStandby

+ const LifecycleEventStart

+ const LifecycleEventStop

+ const LifecycleEventUpdate

+ type LifecycleEventConsumer string

+ const LifecycleEventConsumerAutoStandby

+ const LifecycleEventConsumerHealthCheck

+ const LifecycleEventConsumerRestartPolicy

+ const LifecycleEventConsumerWaitForState

type ListInstancesFilter

+ Tags tags.Tags

+ type ListSnapshotsFilter = snapshot.ListSnapshotsFilter

type Manager

+ func NewManagerWithConfig(p *paths.Paths, imageManager images.Manager, systemManager system.Manager, ...) Manager

+ func NewManagerWithConfigE(p *paths.Paths, imageManager images.Manager, systemManager system.Manager, ...) (Manager, error)

+ CreateSnapshot func(ctx context.Context, id string, req CreateSnapshotRequest) (*Snapshot, error)

+ DeleteSnapshot func(ctx context.Context, snapshotID string) error

+ ForkSnapshot func(ctx context.Context, snapshotID string, req ForkSnapshotRequest) (*Instance, error)

+ GetSnapshot func(ctx context.Context, snapshotID string) (*Snapshot, error)

+ ListSnapshots func(ctx context.Context, filter *ListSnapshotsFilter) ([]Snapshot, error)

+ RestoreSnapshot func(ctx context.Context, id string, snapshotID string, req RestoreSnapshotRequest) (*Instance, error)

+ SubscribeLifecycleEvents func(consumer LifecycleEventConsumer) (<-chan LifecycleEvent, func())

+ UpdateInstance func(ctx context.Context, id string, req UpdateInstanceRequest) (*Instance, error)

+ type ManagerConfig struct

+ FirecrackerSnapshotMemoryBackend string

+ FirecrackerUFFDCacheMaxBytes int64

+ LifecycleEventBufferSize int

+ MaxConcurrentRestoresByHypervisor map[hypervisor.Type]int

+ func (c ManagerConfig) Normalize() ManagerConfig

+ type NetworkEgressPolicy struct

+ Enabled bool

+ EnforcementMode EgressEnforcementMode

+ type PendingStandbyCompression struct

+ NotBefore time.Time

+ Policy snapshot.SnapshotCompressionConfig

type ResourceValidator

+ FinishAllocation func(instanceID string)

+ ReserveAllocation func(ctx context.Context, instanceID string, vcpus int, memoryBytes int64, ...) error

+ type RestoreSnapshotRequest struct

+ TargetHypervisor hypervisor.Type

+ TargetState State

+ type SetSnapshotScheduleRequest = scheduledsnapshots.SetRequest

+ type Snapshot = snapshot.Snapshot

+ type SnapshotKind = snapshot.SnapshotKind

+ type SnapshotPolicy struct

+ Compression *snapshot.SnapshotCompressionConfig

+ StandbyCompressionDelay *time.Duration

+ type SnapshotSchedule = scheduledsnapshots.Schedule

+ type SnapshotScheduleManager interface

+ DeleteSnapshotSchedule func(ctx context.Context, instanceID string) error

+ GetSnapshotSchedule func(ctx context.Context, instanceID string) (*SnapshotSchedule, error)

+ RunSnapshotSchedules func(ctx context.Context) error

+ SetSnapshotSchedule func(ctx context.Context, instanceID string, req SetSnapshotScheduleRequest) (*SnapshotSchedule, error)

+ type SnapshotScheduleRetention = scheduledsnapshots.Retention

+ type StandbyInstanceRequest struct

+ Compression *snapshot.SnapshotCompressionConfig

+ CompressionDelay *time.Duration

type State

+ const StateInitializing

type StoredMetadata

+ AutoStandby *autostandby.Policy

+ Credentials map[string]CredentialPolicy

+ FirecrackerDeferredSnapshotMemoryPath string

+ FirecrackerSnapshotCacheKey string

+ FirecrackerUFFDPagerVersion string

+ FirecrackerUFFDSessionID string

+ FirecrackerUseUFFDOnNextRestore bool

+ GuestAgentReadyAt *time.Time

+ HealthCheck *healthcheck.Policy

+ NetworkEgress *NetworkEgressPolicy

+ PendingStandbyCompression *PendingStandbyCompression

+ Phases phasetracking.Tracker

+ ProgramStartedAt *time.Time

+ RestartPolicy *restartpolicy.Policy

+ RestartStatus restartpolicy.Status

+ SnapshotPolicy *SnapshotPolicy

+ Tags tags.Tags

+ type UpdateInstanceRequest struct

+ AutoStandby *autostandby.Policy

+ Env map[string]string

+ HealthCheck *healthcheck.Policy

+ RestartPolicy *restartpolicy.Policy

+ RestartPolicySet bool

+ type WaitForStateResult struct

+ State State

+ StateError *string

+ TimedOut bool

+ func WaitForState(ctx context.Context, mgr Manager, inst *Instance, targetState State, ...) (*WaitForStateResult, error)

v0.0.7

Mar 3, 2026

Changes in this version

+ var ErrInvalidRequest = errors.New("invalid request")

+ var ErrNotSupported = errors.New("operation not supported")

+ type ForkInstanceRequest struct

+ FromRunning bool

+ Name string

+ TargetState State

+ type ListInstancesFilter struct

+ Metadata map[string]string

+ State *State

+ func (f *ListInstancesFilter) Matches(inst *Instance) bool

type Manager

+ ForkInstance func(ctx context.Context, id string, req ForkInstanceRequest) (*Instance, error)

v0.0.6

Feb 16, 2026

Changes in this version

+ const DefaultStopTimeout

+ var ErrInsufficientResources = errors.New("insufficient resources")

type CreateInstanceRequest

+ Cmd []string

+ Entrypoint []string

+ Metadata map[string]string

+ SkipGuestAgent bool

+ SkipKernelHeaders bool

type Manager

+ GetVsockDialer func(ctx context.Context, instanceID string) (hypervisor.VsockDialer, error)

+ ListRunningInstancesInfo func(ctx context.Context) ([]resources.InstanceUtilizationInfo, error)

+ SetResourceValidator func(v ResourceValidator)

+ type ResourceValidator interface

+ ValidateAllocation func(ctx context.Context, vcpus int, memoryBytes int64, networkDownloadBps int64, ...) error

+ type StartInstanceRequest struct

+ Cmd []string

+ Entrypoint []string

type StoredMetadata

+ Cmd []string

+ Entrypoint []string

+ ExitCode *int

+ ExitMessage string

+ Metadata map[string]string

+ SkipGuestAgent bool

+ SkipKernelHeaders bool

+ StopTimeout int

v0.0.5

Jan 16, 2026

Changes in this version

type CreateInstanceRequest

+ GPU *GPUConfig

+ type GPUConfig struct

+ Profile string

type StoredMetadata

+ GPUMdevUUID string

+ GPUProfile string

v0.0.4

Jan 12, 2026

Changes in this version

+ const MaxVolumesPerInstance

+ var ErrAlreadyExists = errors.New("instance already exists")

+ var ErrAmbiguousName = errors.New("multiple instances with the same name")

+ var ErrImageNotReady = errors.New("image not ready")

+ var ErrInvalidState = errors.New("invalid state transition")

+ var ErrLogNotFound = fmt.Errorf("log file not found")

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

+ var ErrTailNotFound = fmt.Errorf("tail command not found: required for log streaming")

+ var ValidTransitions = map[State][]State

+ func NewLivenessChecker(m Manager) devices.InstanceLivenessChecker

+ func WaitForProcessExit(pid int, timeout time.Duration) bool

+ type AggregateUsage struct

+ TotalMemory int64

+ TotalVcpus int

+ type AttachVolumeRequest struct

+ MountPath string

+ Readonly bool

+ type CreateInstanceRequest struct

+ Devices []string

+ DiskIOBps int64

+ Env map[string]string

+ HotplugSize int64

+ Hypervisor hypervisor.Type

+ Image string

+ Name string

+ NetworkBandwidthDownload int64

+ NetworkBandwidthUpload int64

+ NetworkEnabled bool

+ OverlaySize int64

+ Size int64

+ Vcpus int

+ Volumes []VolumeAttachment

+ type HostTopology struct

+ CoresPerSocket int

+ Sockets int

+ ThreadsPerCore int

+ type IngressResolver struct

+ func NewIngressResolver(manager Manager) *IngressResolver

+ func (r *IngressResolver) InstanceExists(ctx context.Context, nameOrID string) (bool, error)

+ func (r *IngressResolver) ResolveInstance(ctx context.Context, nameOrID string) (string, string, error)

+ func (r *IngressResolver) ResolveInstanceIP(ctx context.Context, nameOrID string) (string, error)

+ type Instance struct

+ HasSnapshot bool

+ State State

+ StateError *string

+ func (i *Instance) GetHypervisorType() string

+ type LogSource string

+ const LogSourceApp

+ const LogSourceHypeman

+ const LogSourceVMM

+ type Manager interface

+ AttachVolume func(ctx context.Context, id string, volumeId string, req AttachVolumeRequest) (*Instance, error)

+ CreateInstance func(ctx context.Context, req CreateInstanceRequest) (*Instance, error)

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

+ DetachVolume func(ctx context.Context, id string, volumeId string) (*Instance, error)

+ GetInstance func(ctx context.Context, idOrName string) (*Instance, error)

+ ListInstanceAllocations func(ctx context.Context) ([]resources.InstanceAllocation, error)

+ ListInstances func(ctx context.Context) ([]Instance, error)

+ RestoreInstance func(ctx context.Context, id string) (*Instance, error)

+ RotateLogs func(ctx context.Context, maxBytes int64, maxFiles int) error

+ StandbyInstance func(ctx context.Context, id string) (*Instance, error)

+ StartInstance func(ctx context.Context, id string) (*Instance, error)

+ StopInstance func(ctx context.Context, id string) (*Instance, error)

+ StreamInstanceLogs func(ctx context.Context, id string, tail int, follow bool, source LogSource) (<-chan string, error)

+ func NewManager(p *paths.Paths, imageManager images.Manager, systemManager system.Manager, ...) Manager

+ type Metrics struct

+ type ResourceLimits struct

+ MaxMemoryPerInstance int64

+ MaxOverlaySize int64

+ MaxTotalMemory int64

+ MaxTotalVcpus int

+ MaxVcpusPerInstance int

+ type State string

+ const StateCreated

+ const StatePaused

+ const StateRunning

+ const StateShutdown

+ const StateStandby

+ const StateStopped

+ const StateUnknown

+ func (s State) CanTransitionTo(target State) error

+ func (s State) IsTerminal() bool

+ func (s State) RequiresVMM() bool

+ func (s State) String() string

+ type StoredMetadata struct

+ CreatedAt time.Time

+ DataDir string

+ Devices []string

+ DiskIOBps int64

+ Env map[string]string

+ HotplugSize int64

+ HypervisorPID *int

+ HypervisorType hypervisor.Type

+ HypervisorVersion string

+ IP string

+ Id string

+ Image string

+ KernelVersion string

+ MAC string

+ Name string

+ NetworkBandwidthDownload int64

+ NetworkBandwidthUpload int64

+ NetworkEnabled bool

+ OverlaySize int64

+ Size int64

+ SocketPath string

+ StartedAt *time.Time

+ StoppedAt *time.Time

+ Vcpus int

+ Volumes []VolumeAttachment

+ VsockCID int64

+ VsockSocket string

+ type VolumeAttachment struct

+ MountPath string

+ Overlay bool

+ OverlaySize int64

+ Readonly bool

+ VolumeID string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL