stack

package
v1.10.27 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 11, 2026 License: AGPL-3.0 Imports: 16 Imported by: 0

Documentation

Overview

Package stack groups apps organizationally; deleting a stack detaches its apps, which keep running.

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrNameRequired = errors.New("stack name is required")
	ErrNameTaken    = errors.New("a stack with this name already exists")
	// The name derives DockerName, network and volumes, and GitOps matches on it; use DisplayName for a label.
	ErrNameImmutable   = errors.New("a stack's name cannot be changed; edit its display name instead")
	ErrNotFound        = errors.New("stack not found")
	ErrAppNotFound     = errors.New("application not found in workspace")
	ErrAppInOtherStack = errors.New("application already belongs to another stack")
	ErrInvalidAction   = errors.New("invalid stack action")
	ErrKeyRequired     = errors.New("environment variable key is required")
	ErrEnvVarNotFound  = errors.New("environment variable not found")
	ErrAppsRunning     = errors.New("stop the stack before deleting it with its applications")
)
View Source
var ErrComposeInvalid = errors.New("invalid docker-compose content")

Functions

This section is empty.

Types

type Action

type Action string

Action is a stack-wide container lifecycle operation.

const (
	ActionStart   Action = "start"
	ActionStop    Action = "stop"
	ActionRestart Action = "restart"
)

type AppActionResult

type AppActionResult struct {
	AppID   uint   `json:"app_id"`
	AppName string `json:"app_name"`
	Status  string `json:"status"`
	Error   string `json:"error,omitempty"`
}

type AppService

type AppService interface {
	Start(ctx context.Context, app *models.Application) (*models.Deployment, error)
	Stop(ctx context.Context, app *models.Application) error
	Restart(ctx context.Context, app *models.Application) (*models.Deployment, error)
	WaitRunning(ctx context.Context, app *models.Application) error
	Deploy(app *models.Application, registryOverride *uint, tagOverride string, strategy models.DeployStrategy) (*models.Deployment, error)
	MarkRedeployRequired(app *models.Application) (bool, error)
	Delete(ctx context.Context, app *models.Application) error
	LiveStatus(ctx context.Context, app *models.Application) application.LiveStatus
	Create(workspaceID uint, in application.CreateInput) (*models.Application, error)
	SetEnvVar(appID uint, key, value string, isSecret bool) error
	AttachVolume(app *models.Application, volumeID uint, path string) error
}

An interface keeps the stack service unit-testable with a fake.

type DeployResult

type DeployResult struct {
	AppID        uint   `json:"app_id"`
	AppName      string `json:"app_name"`
	Status       string `json:"status"` // queued | failed
	DeploymentID uint   `json:"deployment_id,omitempty"`
	Error        string `json:"error,omitempty"`
}

DeployResult reports the outcome of a deploy for one member app.

type ImportPlacement added in v1.10.8

type ImportPlacement struct {
	ClusterID uint
	ServerID  uint
}

ImportPlacement is where an imported stack runs: its location and the single node its apps and volumes share.

type ImportResult

type ImportResult struct {
	Stack         *models.Stack  `json:"stack"`
	Created       []string       `json:"created"`
	Volumes       []string       `json:"volumes"`
	PortRequests  int            `json:"port_requests"`
	PortConflicts []PortConflict `json:"port_conflicts"`
	Skipped       []ImportSkip   `json:"skipped"`
	// Warnings name the variables the file references that the .env did not set.
	Warnings []string `json:"warnings"`
}

ImportResult summarizes a compose import.

type ImportSkip

type ImportSkip struct {
	Service string `json:"service"`
	Reason  string `json:"reason"`
}

ImportSkip records a service that could not be imported.

type Input

type Input struct {
	Name        string
	DisplayName string
	Description string
	// Callers may set reserved "miabi.io/" provenance keys; a missing managed-by defaults to "user".
	Metadata    models.Metadata
	Annotations models.Metadata
	// ClusterID is the location the stack's members run in; 0 is the default cluster.
	ClusterID uint
}

type NetworkManager

type NetworkManager interface {
	EnsureNetwork(ctx context.Context, name string) (string, error)
	RemoveNetwork(ctx context.Context, name string) error
	EnsureNetworkSpec(ctx context.Context, spec docker.NetworkSpec) (string, error)
	ListNetworks(ctx context.Context) ([]docker.Network, error)
}

type PortConflict

type PortConflict struct {
	Service  string `json:"service"`
	HostPort int    `json:"host_port"`
	Protocol string `json:"protocol"`
	UsedBy   string `json:"used_by"`
}

The binding is filed pending so the stack still imports cleanly.

type PortRequester

type PortRequester interface {
	Request(workspaceID, userID uint, in portbinding.RequestInput) (*models.PortBinding, error)
	RequestImport(workspaceID, userID uint, in portbinding.RequestInput) (*models.PortBinding, string, error)
}

type Service

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

func (*Service) AddApp

func (s *Service) AddApp(workspaceID, stackID, appID uint) (*models.Stack, error)

func (*Service) AggregateStatus

func (s *Service) AggregateStatus(stackID uint) (StatusCounts, error)

AggregateStatus summarizes the statuses of a stack's member apps.

func (*Service) AppCount

func (s *Service) AppCount(stackID uint) (int64, error)

AppCount returns the number of applications in a stack.

func (*Service) Create

func (s *Service) Create(ctx context.Context, workspaceID uint, in Input) (*models.Stack, error)

func (*Service) Delete

func (s *Service) Delete(ctx context.Context, workspaceID, id uint, withApps bool) error

func (*Service) DeleteEnvVar

func (s *Service) DeleteEnvVar(workspaceID, stackID uint, key string) (int, error)

func (*Service) DeployAll

func (s *Service) DeployAll(workspaceID, stackID uint) ([]DeployResult, error)

func (*Service) DeployOutdated added in v1.9.5

func (s *Service) DeployOutdated(workspaceID, stackID uint) ([]DeployResult, error)

DeployOutdated leaves current and never-deployed apps alone, rather than restarting the whole stack.

func (*Service) Events

func (s *Service) Events(workspaceID, stackID uint, limit int) ([]models.AppEvent, error)

Events returns the combined recent activity feed across the stack's apps.

func (*Service) Get

func (s *Service) Get(workspaceID, id uint) (*models.Stack, error)

func (*Service) IDByUID

func (s *Service) IDByUID(uid string) (uint, error)

IDByUID resolves a stack's portable uid to its numeric id.

func (*Service) ImportCompose

func (s *Service) ImportCompose(ctx context.Context, workspaceID, userID uint, name, composeYAML, dotEnv string, at ImportPlacement) (*ImportResult, error)

ImportCompose creates a stack from a Compose file; dotEnv, when given, plays the part of the .env beside it.

func (*Service) ImportEnvVars

func (s *Service) ImportEnvVars(workspaceID, stackID uint, content string, isSecret bool) (imported, stale int, err error)

func (*Service) Lifecycle

func (s *Service) Lifecycle(ctx context.Context, workspaceID, stackID uint, action Action, rolling bool) ([]AppActionResult, error)

Lifecycle is best-effort per app; with rolling, each app runs before the next so the stack never fully stops.

func (*Service) List

func (s *Service) List(workspaceID uint) ([]models.Stack, error)

func (*Service) ListEnvVars

func (s *Service) ListEnvVars(workspaceID, stackID uint) ([]models.StackEnvVar, error)

func (*Service) Reencrypt

func (s *Service) Reencrypt(ctx context.Context, workspaceID uint) (int, error)

func (*Service) RemoveApp

func (s *Service) RemoveApp(workspaceID, stackID, appID uint) (*models.Stack, error)

func (*Service) RevealEnvVar added in v1.9.5

func (s *Service) RevealEnvVar(workspaceID, stackID uint, key string) (string, error)

Reading plaintext is gated to workspace admins by the route and audited by the handler.

func (*Service) SetAllocator

func (s *Service) SetAllocator(a *netalloc.Service)

Nil falls back to Docker's default address pool.

func (*Service) SetEnvVar

func (s *Service) SetEnvVar(workspaceID, stackID uint, key, value string, isSecret bool) (int, error)

func (*Service) Update

func (s *Service) Update(workspaceID, id uint, in UpdateInput) (*models.Stack, error)

type StatusCounts

type StatusCounts struct {
	Total   int `json:"total"`
	Running int `json:"running"`
	Stopped int `json:"stopped"`
	Failed  int `json:"failed"`
	Other   int `json:"other"`
}

StatusCounts is an aggregate of member-app statuses for the health badge.

type UpdateInput

type UpdateInput struct {
	// The current name is a no-op so whole-object PATCH clients work; a different one is refused.
	Name        *string
	DisplayName *string
	Description *string
	// Annotations, when non-nil, replaces the stack's annotations wholesale.
	Annotations models.Metadata
}

type VolumeCreator

type VolumeCreator interface {
	Create(ctx context.Context, workspaceID, serverID uint, name string, sizeBytes int64, meta, annotations models.Metadata) (*models.Volume, error)
}

Jump to

Keyboard shortcuts

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