env

Documentation

Overview

Package env provides a unified method to create environment for envexec.

For linux, the env creates container & cgroup sandbox.

For windows, the env creates low mandatory level sandbox.

For macOS, the env creates sandbox_init sandbox.

Index

• func NewBuilder(c Config) (pool.EnvBuilder, map[string]any, error)
• type Config
• type Link
• type Logger
• type Mount
• type Mounts

Functions

func NewBuilder

func NewBuilder(c Config) (pool.EnvBuilder, map[string]any, error)

NewBuilder build a environment builder

Types

type Config

type Config struct {
	ContainerInitPath  string
	TmpFsParam         string
	NetShare           bool
	MountConf          string
	SeccompConf        string
	CgroupPrefix       string
	Cpuset             string
	ContainerCredStart int
	EnableCPURate      bool
	CPUCfsPeriod       time.Duration
	Logger
}

Config defines parameters to create environment builder

type Link

type Link struct {
	LinkPath string `yaml:"linkPath"`
	Target   string `yaml:"target"`
}

Link defines symlinks to be created after mounts

type Logger

type Logger interface {
	Debug(args ...interface{})
	Info(args ...interface{})
	Warn(args ...interface{})
	Error(args ...interface{})
}

Logger defines logger to print logs

type Mount

type Mount struct {
	Type     string `yaml:"type"`
	Source   string `yaml:"source"`
	Target   string `yaml:"target"`
	Readonly bool   `yaml:"readonly"`
	Data     string `yaml:"data"`
}

Mount defines single mount point configuration. type could be bind / tmpfs

type Mounts

type Mounts struct {
	Mount      []Mount  `yaml:"mount"`
	SymLinks   []Link   `yaml:"symLink"`
	MaskPaths  []string `yaml:"maskPath"`
	WorkDir    string   `yaml:"workDir"`
	HostName   string   `yaml:"hostName"`
	DomainName string   `yaml:"domainName"`
	UID        int      `yaml:"uid"`
	GID        int      `yaml:"gid"`
	Proc       bool     `yaml:"proc"`
}

Mounts defines mount points for the container.