scenarios

Documentation

Index

• func RunApps(ctx context.Context, config RunAppsConfig, apps ...Application) error
• type Application
• type Container
  • func (c Container) GetIP() net.IP
  • func (c Container) GetName() string
  • func (c Container) GetTaskFunc(config RunAppsConfig, appHosts map[string]net.IP, spawn parallel.SpawnFn, ...) task.Func
• type Embedded
  • func (e Embedded) GetIP() net.IP
  • func (e Embedded) GetName() string
  • func (e Embedded) GetTaskFunc(config RunAppsConfig, appHosts map[string]net.IP, spawn parallel.SpawnFn, ...) task.Func
• type ExposedPort
• type LogsConfig
• type Mount
• type RunAppsConfig

Functions

func RunApps

func RunApps(ctx context.Context, config RunAppsConfig, apps ...Application) error

RunApps runs applications.

Types

type Application

type Application interface {
	GetName() string
	GetIP() net.IP
	GetTaskFunc(config RunAppsConfig, appHosts map[string]net.IP, spawn parallel.SpawnFn, logsCh chan<- logEnvelope) task.Func
}

Application represents an app to run in isolation.

type Container

type Container struct {
	// Name is the name of the container.
	Name string

	// Image is the name of the image.
	Image string

	// Tag is the tag of the image.
	Tag string

	// EnvVars sets environment variables inside container.
	EnvVars map[string]string

	// User is the username or UID to use.
	User string

	// Mounts are the mounts to configure inside container.
	Mounts []Mount

	// WorkingDir specifies a path to working directory.
	WorkingDir string

	// Entrypoint sets entrypoint for container.
	Entrypoint []string

	// Args sets args for container.
	Args []string

	// IP is the IP address of the container.
	IP *net.IPNet

	// DNS is the list of nameservers to configure inside container.
	DNS []net.IP

	// Hosts is the list of hosts and their IP addresses to resolve inside namespace.
	Hosts map[string]net.IP

	// ExposedPorts is the list of ports to expose.
	ExposedPorts []ExposedPort
}

Container defines container.

func (Container) GetIP

func (c Container) GetIP() net.IP

GetIP returns IP of the container.

func (Container) GetName

func (c Container) GetName() string

GetName returns the name of the container.

func (Container) GetTaskFunc

func (c Container) GetTaskFunc(config RunAppsConfig, appHosts map[string]net.IP, spawn parallel.SpawnFn, logsCh chan<- logEnvelope) task.Func

GetTaskFunc returns task function running the container.

type Embedded

type Embedded struct {
	// Name is the name of the function.
	Name string

	// Mounts are the mounts to configure inside embedded function.
	Mounts []Mount

	// Args sets args for embedded function.
	Args []string

	// IP is the IP address of the embedded function.
	IP *net.IPNet

	// DNS is the list of nameservers to configure inside embedded function.
	DNS []net.IP

	// Hosts is the list of hosts and their IP addresses to resolve inside namespace.
	Hosts map[string]net.IP

	// ExposedPorts is the list of ports to expose.
	ExposedPorts []ExposedPort
}

Embedded defines embedded function to run inside isolation.

func (Embedded) GetIP

func (e Embedded) GetIP() net.IP

GetIP returns IP of the function.

func (Embedded) GetName

func (e Embedded) GetName() string

GetName returns the name of the function.

func (Embedded) GetTaskFunc

func (e Embedded) GetTaskFunc(config RunAppsConfig, appHosts map[string]net.IP, spawn parallel.SpawnFn, logsCh chan<- logEnvelope) task.Func

GetTaskFunc returns task function running the embedded function.

type ExposedPort

type ExposedPort struct {
	Protocol      string
	HostIP        net.IP
	HostPort      uint16
	NamespacePort uint16
	Public        bool
}

ExposedPort defines a port to be exposed from the container.

type LogsConfig

type LogsConfig struct {
	Address string
}

LogsConfig is the configuration of remote loki logs receiver.

type Mount

type Mount struct {
	Host      string
	Namespace string
	Writable  bool
}

Mount defines the mount to be configured inside container.

type RunAppsConfig

type RunAppsConfig struct {
	CacheDir   string
	AppsDir    string
	LogsConfig LogsConfig
}

RunAppsConfig is the config for running applications.