port

Documentation

Index

• type ContainerAdapter
• type ContainerEnvAdapter
• type ContainerEnvService
• type ContainerHandler
• type ContainerLogsAdapter
• type ContainerLogsService
• type ContainerRunnerAdapter
• type ContainerRunnerService
• type ContainerService
• type ContainerServiceAdapter
• type ContainerServiceService
• type ContainerSettingsAdapter
• type ContainerSettingsService
• type ContainersHandler
• type DockerAdapter
• type DockerKernelHandler
• type DockerService
• type MetricsService
• type ServiceAdapter
• type ServiceHandler
• type ServiceService
• type ServicesHandler

Types

type ContainerAdapter

type ContainerAdapter interface {
	Create(uuid uuid.UUID) error
	Delete(uuid uuid.UUID) error
	GetAll() ([]uuid.UUID, error)
}

type ContainerEnvAdapter

type ContainerEnvAdapter interface {
	Save(uuid uuid.UUID, env types.ContainerEnvVariables) error
	Load(uuid uuid.UUID) (types.ContainerEnvVariables, error)
}

type ContainerEnvService

type ContainerEnvService interface {
	Save(inst *types.Container, env types.ContainerEnvVariables) error
	Load(inst *types.Container) error
}

type ContainerHandler

type ContainerHandler interface {
	Get(c *router.Context)
	Delete(c *router.Context)
	Patch(c *router.Context)
	Start(c *router.Context)
	Stop(c *router.Context)
	PatchEnvironment(c *router.Context)
	GetDocker(c *router.Context)
	RecreateDocker(c *router.Context)
	GetLogs(c *router.Context)
	UpdateService(c *router.Context)
	GetVersions(c *router.Context)
	WaitStatus(c *router.Context)
	Events(c *router.Context)
}

type ContainerLogsAdapter

type ContainerLogsAdapter interface {
	Register(uuid uuid.UUID) error
	Unregister(uuid uuid.UUID) error
	UnregisterAll() error

	Push(uuid uuid.UUID, line types.LogLine)
	Pop(uuid uuid.UUID) (types.LogLine, error)

	// LoadBuffer will load the latest logs kept in memory.
	LoadBuffer(uuid uuid.UUID) ([]types.LogLine, error)
}

type ContainerLogsService

type ContainerLogsService interface {
	GetLatestLogs(uuid uuid.UUID) ([]types.LogLine, error)
}

type ContainerRunnerAdapter

type ContainerRunnerAdapter interface {
	DeleteContainer(inst *types.Container) error
	DeleteMounts(inst *types.Container) error
	Start(inst *types.Container, setStatus func(status string)) (stdout io.ReadCloser, stderr io.ReadCloser, err error)
	Stop(inst *types.Container) error
	Info(inst types.Container) (map[string]any, error)
	WaitCondition(inst *types.Container, cond types.WaitContainerCondition) error

	CheckForUpdates(inst *types.Container) error
	HasUpdateAvailable(inst types.Container) (bool, error)
	GetAllVersions(inst types.Container) ([]string, error)
}

type ContainerRunnerService

type ContainerRunnerService interface {
	Install(uuid uuid.UUID, service types.Service) error
	Delete(inst *types.Container) error
	Start(inst *types.Container) error
	Stop(inst *types.Container) error
	GetDockerContainerInfo(inst types.Container) (map[string]any, error)
	GetAllVersions(inst *types.Container, useCache bool) ([]string, error)
	CheckForUpdates(inst *types.Container) error
	RecreateContainer(inst *types.Container) error
	WaitStatus(inst *types.Container, status string) error
}

type ContainerService

type ContainerService interface {
	Get(uuid uuid.UUID) (*types.Container, error)
	GetAll() map[uuid.UUID]*types.Container
	GetTags() []string
	Search(query types.ContainerSearchQuery) map[uuid.UUID]*types.Container
	Exists(uuid uuid.UUID) bool
	Delete(inst *types.Container) error
	StartAll()
	StopAll()
	LoadAll()
	DeleteAll()
	Install(service types.Service, method string) (*types.Container, error)
	CheckForUpdates() (map[uuid.UUID]*types.Container, error)
	SetDatabases(inst *types.Container, databases map[string]uuid.UUID, options map[string]*types.SetDatabasesOptions) error
}

type ContainerServiceAdapter

type ContainerServiceAdapter interface {
	Save(uuid uuid.UUID, service types.Service) error
	Load(uuid uuid.UUID) (types.Service, error)
	LoadRaw(uuid uuid.UUID) (interface{}, error)
}

type ContainerServiceService

type ContainerServiceService interface {
	CheckForUpdate(inst *types.Container, latest types.Service) error
	Update(inst *types.Container, service types.Service) error
	Save(inst *types.Container, service types.Service) error
	Load(uuid uuid.UUID) (types.Service, error)
}

type ContainerSettingsAdapter

type ContainerSettingsAdapter interface {
	Save(uuid uuid.UUID, settings types.ContainerSettings) error
	Load(uuid uuid.UUID) (types.ContainerSettings, error)
}

type ContainerSettingsService

type ContainerSettingsService interface {
	Save(inst *types.Container, settings types.ContainerSettings) error
	Load(inst *types.Container) error
	SetLaunchOnStartup(inst *types.Container, value bool) error
	SetDisplayName(inst *types.Container, value string) error
	SetDatabases(inst *types.Container, databases map[string]uuid.UUID) error
	SetVersion(inst *types.Container, value string) error
	SetTags(inst *types.Container, tags []string) error
}

type ContainersHandler

type ContainersHandler interface {
	Get(c *router.Context)
	GetTags(c *router.Context)
	Search(c *router.Context)
	CheckForUpdates(c *router.Context)
	Events(c *router.Context)
}

type DockerAdapter

type DockerAdapter interface {
	ListContainers() ([]types.DockerContainer, error)
	DeleteContainer(id string) error
	CreateContainer(options types.CreateContainerOptions) (types.CreateContainerResponse, error)
	StartContainer(id string) error
	StopContainer(id string) error
	InfoContainer(id string) (types.InfoContainerResponse, error)
	LogsStdoutContainer(id string) (io.ReadCloser, error)
	LogsStderrContainer(id string) (io.ReadCloser, error)
	WaitContainer(id string, cond types.WaitContainerCondition) error

	InfoImage(id string) (types.InfoImageResponse, error)
	PullImage(options types.PullImageOptions) (io.ReadCloser, error)
	BuildImage(options types.BuildImageOptions) (dockertypes.ImageBuildResponse, error)
}

type DockerKernelHandler

type DockerKernelHandler interface {
	// GetContainers handles the retrieval of all Docker containers.
	GetContainers(c *router.Context)
	// CreateContainer handles the creation of a Docker container.
	CreateContainer(c *router.Context)
	// DeleteContainer handles the deletion of a Docker container.
	DeleteContainer(c *router.Context)
	// StartContainer handles the starting of a Docker container.
	StartContainer(c *router.Context)
	// StopContainer handles the stopping of a Docker container.
	StopContainer(c *router.Context)
	// InfoContainer handles the retrieval of information about a Docker container.
	InfoContainer(c *router.Context)
	// LogsStdoutContainer handles the retrieval of the stdout logs of a Docker container.
	LogsStdoutContainer(c *router.Context)
	// LogsStderrContainer handles the retrieval of the stderr logs of a Docker container.
	LogsStderrContainer(c *router.Context)
	// WaitContainer handles the waiting for a Docker container to reach a certain condition.
	WaitContainer(c *router.Context)
	// DeleteMounts handles the deletion of all mounts of a Docker container.
	DeleteMounts(c *router.Context)

	// InfoImage handles the retrieval of information about a Docker image.
	InfoImage(c *router.Context)
	// PullImage handles the pulling of a Docker image.
	PullImage(c *router.Context)
	// BuildImage handles the building of a Docker image.
	BuildImage(c *router.Context)
}

type DockerService

type DockerService interface {
	ListContainers() ([]types.DockerContainer, error)
	DeleteContainer(id string) error
	CreateContainer(options types.CreateContainerOptions) (types.CreateContainerResponse, error)
	StartContainer(id string) error
	StopContainer(id string) error
	InfoContainer(id string) (types.InfoContainerResponse, error)
	LogsStdoutContainer(id string) (io.ReadCloser, error)
	LogsStderrContainer(id string) (io.ReadCloser, error)
	WaitContainer(id string, cond types.WaitContainerCondition) error
	DeleteMounts(uuid string) error

	InfoImage(id string) (types.InfoImageResponse, error)
	PullImage(options types.PullImageOptions) (io.ReadCloser, error)
	BuildImage(options types.BuildImageOptions) (vtypes.ImageBuildResponse, error)
}

type MetricsService

type MetricsService interface{}

type ServiceAdapter

type ServiceAdapter interface {
	// Get a service with its id. Returns ErrServiceNotFound if
	// the service was not found.
	Get(id string) (types.Service, error)

	GetScript(id string) ([]byte, error)

	// GetRaw gets a service by id, without any processing.
	// Returns ErrServiceNotFound if the service was not found.
	GetRaw(id string) (interface{}, error)

	// GetAll gets all available services.
	GetAll() []types.Service

	// Reload the adapter
	Reload() error
}

type ServiceHandler

type ServiceHandler interface {
	Get(c *router.Context)
	Install(c *router.Context)
}

type ServiceService

type ServiceService interface {
	GetAll() []types.Service
	GetById(id string) (types.Service, error)
}

type ServicesHandler

type ServicesHandler interface {
	Get(c *router.Context)
}