driver

package
v0.4.3 Latest Latest
Warning

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

 Go to latest Published: Sep 22, 2016 License: MPL-2.0 Imports: 35 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// NoSuchContainerError is returned by the docker daemon if the container
	// does not exist.
	NoSuchContainerError = "No such container"
)

Variables

View Source 
var (

	// The statistics the Docker driver exposes
	DockerMeasuredMemStats = []string{"RSS", "Cache", "Swap", "Max Usage"}
	DockerMeasuredCpuStats = []string{"Throttled Periods", "Throttled Time", "Percent"}
)
View Source 
var BuiltinDrivers = map[string]Factory{
	"docker":   NewDockerDriver,
	"exec":     NewExecDriver,
	"raw_exec": NewRawExecDriver,
	"java":     NewJavaDriver,
	"qemu":     NewQemuDriver,
	"rkt":      NewRktDriver,
}

BuiltinDrivers contains the built in registered drivers which are available for allocation handling

View Source 
var HandshakeConfig = plugin.HandshakeConfig{
	ProtocolVersion:  1,
	MagicCookieKey:   "NOMAD_PLUGIN_MAGIC_COOKIE",
	MagicCookieValue: "e4327c2e01eabfd75a8a67adb114fb34a757d57eee7728d857a8cec6e91a7255",
}

Functions

func GetAbsolutePath added in v0.3.1 

func GetAbsolutePath(bin string) (string, error)

GetAbsolutePath returns the absolute path of the passed binary by resolving it in the path and following symlinks.

func GetKillTimeout added in v0.3.1 

func GetKillTimeout(desired, max time.Duration) time.Duration

GetKillTimeout returns the kill timeout to use given the tasks desired kill timeout and the operator configured max kill timeout.

func GetPluginMap added in v0.3.0 

func GetPluginMap(w io.Writer) map[string]plugin.Plugin

func GetTaskEnv added in v0.3.0 

func GetTaskEnv(allocDir *allocdir.AllocDir, node *structs.Node,
	task *structs.Task, alloc *structs.Allocation) (*env.TaskEnvironment, error)

GetTaskEnv converts the alloc dir, the node, task and alloc into a TaskEnvironment.

Types

type DockerDriver 

type DockerDriver struct {
	DriverContext
}

func (*DockerDriver) Fingerprint 

func (d *DockerDriver) Fingerprint(cfg *config.Config, node *structs.Node) (bool, error)

func (*DockerDriver) Open 

func (d *DockerDriver) Open(ctx *ExecContext, handleID string) (DriverHandle, error)

func (*DockerDriver) Periodic added in v0.3.1 

func (d *DockerDriver) Periodic() (bool, time.Duration)

func (*DockerDriver) Start 

func (d *DockerDriver) Start(ctx *ExecContext, task *structs.Task) (DriverHandle, error)

func (*DockerDriver) Validate added in v0.3.2 

func (d *DockerDriver) Validate(config map[string]interface{}) error

Validate is used to validate the driver configuration

type DockerDriverAuth added in v0.2.0 

type DockerDriverAuth struct {
	Username      string `mapstructure:"username"`       // username for the registry
	Password      string `mapstructure:"password"`       // password to access the registry
	Email         string `mapstructure:"email"`          // email address of the user who is allowed to access the registry
	ServerAddress string `mapstructure:"server_address"` // server address of the registry
}

type DockerDriverConfig added in v0.2.0 

type DockerDriverConfig struct {
	ImageName        string              `mapstructure:"image"`              // Container's Image Name
	LoadImages       []string            `mapstructure:"load"`               // LoadImage is array of paths to image archive files
	Command          string              `mapstructure:"command"`            // The Command/Entrypoint to run when the container starts up
	Args             []string            `mapstructure:"args"`               // The arguments to the Command/Entrypoint
	IpcMode          string              `mapstructure:"ipc_mode"`           // The IPC mode of the container - host and none
	NetworkMode      string              `mapstructure:"network_mode"`       // The network mode of the container - host, nat and none
	PidMode          string              `mapstructure:"pid_mode"`           // The PID mode of the container - host and none
	UTSMode          string              `mapstructure:"uts_mode"`           // The UTS mode of the container - host and none
	PortMapRaw       []map[string]int    `mapstructure:"port_map"`           //
	PortMap          map[string]int      `mapstructure:"-"`                  // A map of host port labels and the ports exposed on the container
	Privileged       bool                `mapstructure:"privileged"`         // Flag to run the container in privileged mode
	DNSServers       []string            `mapstructure:"dns_servers"`        // DNS Server for containers
	DNSSearchDomains []string            `mapstructure:"dns_search_domains"` // DNS Search domains for containers
	Hostname         string              `mapstructure:"hostname"`           // Hostname for containers
	LabelsRaw        []map[string]string `mapstructure:"labels"`             //
	Labels           map[string]string   `mapstructure:"-"`                  // Labels to set when the container starts up
	Auth             []DockerDriverAuth  `mapstructure:"auth"`               // Authentication credentials for a private Docker registry
	SSL              bool                `mapstructure:"ssl"`                // Flag indicating repository is served via https
	TTY              bool                `mapstructure:"tty"`                // Allocate a Pseudo-TTY
	Interactive      bool                `mapstructure:"interactive"`        // Keep STDIN open even if not attached
	ShmSize          int64               `mapstructure:"shm_size"`           // Size of /dev/shm of the container in bytes
	WorkDir          string              `mapstructure:"work_dir"`           // Working directory inside the container
	Logging          []DockerLoggingOpts `mapstructure:"logging"`            // Logging options for syslog server
	Volumes          []string            `mapstructure:"volumes"`            // Host-Volumes to mount in, syntax: /path/to/host/directory:/destination/path/in/container
	VolumesFrom      []string            `mapstructure:"volumes_from"`       // List of volumes-from
}

func NewDockerDriverConfig added in v0.4.0 

func NewDockerDriverConfig(task *structs.Task) (*DockerDriverConfig, error)

NewDockerDriverConfig returns a docker driver config by parsing the HCL config

func (*DockerDriverConfig) Validate added in v0.2.0 

func (c *DockerDriverConfig) Validate() error

Validate validates a docker driver config

type DockerHandle added in v0.2.1 

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

func (*DockerHandle) ContainerID added in v0.2.1 

func (h *DockerHandle) ContainerID() string

func (*DockerHandle) ID added in v0.2.1 

func (h *DockerHandle) ID() string

func (*DockerHandle) Kill added in v0.2.1 

func (h *DockerHandle) Kill() error

Kill is used to terminate the task. This uses `docker stop -t killTimeout`

func (*DockerHandle) Stats added in v0.4.0 

func (h *DockerHandle) Stats() (*cstructs.TaskResourceUsage, error)

func (*DockerHandle) Update added in v0.2.1 

func (h *DockerHandle) Update(task *structs.Task) error

func (*DockerHandle) WaitCh added in v0.2.1 

func (h *DockerHandle) WaitCh() chan *dstructs.WaitResult

type DockerLoggingOpts added in v0.4.2 

type DockerLoggingOpts struct {
	Type      string              `mapstructure:"type"`
	ConfigRaw []map[string]string `mapstructure:"config"`
	Config    map[string]string   `mapstructure:"-"`
}

type Driver 

type Driver interface {
	// Drivers must support the fingerprint interface for detection
	fingerprint.Fingerprint

	// Start is used to being task execution
	Start(ctx *ExecContext, task *structs.Task) (DriverHandle, error)

	// Open is used to re-open a handle to a task
	Open(ctx *ExecContext, handleID string) (DriverHandle, error)

	// Drivers must validate their configuration
	Validate(map[string]interface{}) error
}

Driver is used for execution of tasks. This allows Nomad to support many pluggable implementations of task drivers. Examples could include LXC, Docker, Qemu, etc.

func NewDockerDriver 

func NewDockerDriver(ctx *DriverContext) Driver

func NewDriver 

func NewDriver(name string, ctx *DriverContext) (Driver, error)

NewDriver is used to instantiate and return a new driver given the name and a logger

func NewExecDriver 

func NewExecDriver(ctx *DriverContext) Driver

NewExecDriver is used to create a new exec driver

func NewJavaDriver 

func NewJavaDriver(ctx *DriverContext) Driver

NewJavaDriver is used to create a new exec driver

func NewQemuDriver 

func NewQemuDriver(ctx *DriverContext) Driver

NewQemuDriver is used to create a new exec driver

func NewRawExecDriver added in v0.2.0 

func NewRawExecDriver(ctx *DriverContext) Driver

NewRawExecDriver is used to create a new raw exec driver

func NewRktDriver added in v0.2.0 

func NewRktDriver(ctx *DriverContext) Driver

NewRktDriver is used to create a new exec driver

type DriverContext 

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

DriverContext is a means to inject dependencies such as loggers, configs, and node attributes into a Driver without having to change the Driver interface each time we do it. Used in conjection with Factory, above.

func NewDriverContext 

func NewDriverContext(taskName string, config *config.Config, node *structs.Node,
	logger *log.Logger, taskEnv *env.TaskEnvironment) *DriverContext

NewDriverContext initializes a new DriverContext with the specified fields. This enables other packages to create DriverContexts but keeps the fields private to the driver. If we want to change this later we can gorename all of the fields in DriverContext.

func NewEmptyDriverContext added in v0.3.2 

func NewEmptyDriverContext() *DriverContext

NewEmptyDriverContext returns a DriverContext with all fields set to their zero value.

type DriverHandle 

type DriverHandle interface {
	// Returns an opaque handle that can be used to re-open the handle
	ID() string

	// WaitCh is used to return a channel used wait for task completion
	WaitCh() chan *dstructs.WaitResult

	// Update is used to update the task if possible and update task related
	// configurations.
	Update(task *structs.Task) error

	// Kill is used to stop the task
	Kill() error

	// Stats returns aggregated stats of the driver
	Stats() (*cstructs.TaskResourceUsage, error)
}

DriverHandle is an opaque handle into a driver used for task manipulation

type ExecContext 

type ExecContext struct {
	sync.Mutex

	// AllocDir contains information about the alloc directory structure.
	AllocDir *allocdir.AllocDir

	// Alloc ID
	AllocID string
}

ExecContext is shared between drivers within an allocation

func NewExecContext 

func NewExecContext(alloc *allocdir.AllocDir, allocID string) *ExecContext

NewExecContext is used to create a new execution context

type ExecDriver 

type ExecDriver struct {
	DriverContext
}

ExecDriver fork/execs tasks using as many of the underlying OS's isolation features.

func (*ExecDriver) Fingerprint 

func (d *ExecDriver) Fingerprint(cfg *config.Config, node *structs.Node) (bool, error)

func (*ExecDriver) Open 

func (d *ExecDriver) Open(ctx *ExecContext, handleID string) (DriverHandle, error)

func (*ExecDriver) Periodic added in v0.3.0 

func (d *ExecDriver) Periodic() (bool, time.Duration)

func (*ExecDriver) Start 

func (d *ExecDriver) Start(ctx *ExecContext, task *structs.Task) (DriverHandle, error)

func (*ExecDriver) Validate added in v0.3.2 

func (d *ExecDriver) Validate(config map[string]interface{}) error

Validate is used to validate the driver configuration

type ExecDriverConfig added in v0.2.0 

type ExecDriverConfig struct {
	Command string   `mapstructure:"command"`
	Args    []string `mapstructure:"args"`
}

type ExecutorPlugin added in v0.3.0 

type ExecutorPlugin struct {
	Impl *ExecutorRPCServer
	// contains filtered or unexported fields
}

func (*ExecutorPlugin) Client added in v0.3.0 

func (p *ExecutorPlugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error)

func (*ExecutorPlugin) Server added in v0.3.0 

func (p *ExecutorPlugin) Server(*plugin.MuxBroker) (interface{}, error)

type ExecutorRPC added in v0.3.0 

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

func (*ExecutorRPC) DeregisterServices added in v0.3.2 

func (e *ExecutorRPC) DeregisterServices() error

func (*ExecutorRPC) Exit added in v0.3.0 

func (e *ExecutorRPC) Exit() error

func (*ExecutorRPC) LaunchCmd added in v0.3.0 

func (e *ExecutorRPC) LaunchCmd(cmd *executor.ExecCommand, ctx *executor.ExecutorContext) (*executor.ProcessState, error)

func (*ExecutorRPC) LaunchSyslogServer added in v0.3.2 

func (e *ExecutorRPC) LaunchSyslogServer(ctx *executor.ExecutorContext) (*executor.SyslogServerState, error)

func (*ExecutorRPC) ShutDown added in v0.3.0 

func (e *ExecutorRPC) ShutDown() error

func (*ExecutorRPC) Stats added in v0.4.0 

func (e *ExecutorRPC) Stats() (*cstructs.TaskResourceUsage, error)

func (*ExecutorRPC) SyncServices added in v0.3.2 

func (e *ExecutorRPC) SyncServices(ctx *executor.ConsulContext) error

func (*ExecutorRPC) UpdateLogConfig added in v0.3.0 

func (e *ExecutorRPC) UpdateLogConfig(logConfig *structs.LogConfig) error

func (*ExecutorRPC) UpdateTask added in v0.3.2 

func (e *ExecutorRPC) UpdateTask(task *structs.Task) error

func (*ExecutorRPC) Version added in v0.3.2 

func (e *ExecutorRPC) Version() (*executor.ExecutorVersion, error)

func (*ExecutorRPC) Wait added in v0.3.0 

func (e *ExecutorRPC) Wait() (*executor.ProcessState, error)

type ExecutorRPCServer added in v0.3.0 

type ExecutorRPCServer struct {
	Impl executor.Executor
	// contains filtered or unexported fields
}

func (*ExecutorRPCServer) DeregisterServices added in v0.3.2 

func (e *ExecutorRPCServer) DeregisterServices(args interface{}, resp *interface{}) error

func (*ExecutorRPCServer) Exit added in v0.3.0 

func (e *ExecutorRPCServer) Exit(args interface{}, resp *interface{}) error

func (*ExecutorRPCServer) LaunchCmd added in v0.3.0 

func (e *ExecutorRPCServer) LaunchCmd(args LaunchCmdArgs, ps *executor.ProcessState) error

func (*ExecutorRPCServer) LaunchSyslogServer added in v0.3.2 

func (e *ExecutorRPCServer) LaunchSyslogServer(args LaunchSyslogServerArgs, ss *executor.SyslogServerState) error

func (*ExecutorRPCServer) ShutDown added in v0.3.0 

func (e *ExecutorRPCServer) ShutDown(args interface{}, resp *interface{}) error

func (*ExecutorRPCServer) Stats added in v0.4.0 

func (e *ExecutorRPCServer) Stats(args interface{}, resourceUsage *cstructs.TaskResourceUsage) error

func (*ExecutorRPCServer) SyncServices added in v0.3.2 

func (e *ExecutorRPCServer) SyncServices(args SyncServicesArgs, resp *interface{}) error

func (*ExecutorRPCServer) UpdateLogConfig added in v0.3.0 

func (e *ExecutorRPCServer) UpdateLogConfig(args *structs.LogConfig, resp *interface{}) error

func (*ExecutorRPCServer) UpdateTask added in v0.3.2 

func (e *ExecutorRPCServer) UpdateTask(args *structs.Task, resp *interface{}) error

func (*ExecutorRPCServer) Version added in v0.3.2 

func (e *ExecutorRPCServer) Version(args interface{}, version *executor.ExecutorVersion) error

func (*ExecutorRPCServer) Wait added in v0.3.0 

func (e *ExecutorRPCServer) Wait(args interface{}, ps *executor.ProcessState) error

type Factory 

type Factory func(*DriverContext) Driver

Factory is used to instantiate a new Driver

type JavaDriver 

type JavaDriver struct {
	DriverContext
	fingerprint.StaticFingerprinter
}

JavaDriver is a simple driver to execute applications packaged in Jars. It literally just fork/execs tasks with the java command.

func (*JavaDriver) Fingerprint 

func (d *JavaDriver) Fingerprint(cfg *config.Config, node *structs.Node) (bool, error)

func (*JavaDriver) Open 

func (d *JavaDriver) Open(ctx *ExecContext, handleID string) (DriverHandle, error)

func (*JavaDriver) Start 

func (d *JavaDriver) Start(ctx *ExecContext, task *structs.Task) (DriverHandle, error)

func (*JavaDriver) Validate added in v0.3.2 

func (d *JavaDriver) Validate(config map[string]interface{}) error

Validate is used to validate the driver configuration

type JavaDriverConfig added in v0.2.0 

type JavaDriverConfig struct {
	JarPath string   `mapstructure:"jar_path"`
	JvmOpts []string `mapstructure:"jvm_options"`
	Args    []string `mapstructure:"args"`
}

type LaunchCmdArgs added in v0.3.0 

type LaunchCmdArgs struct {
	Cmd *executor.ExecCommand
	Ctx *executor.ExecutorContext
}

LaunchCmdArgs wraps a user command and the args for the purposes of RPC

type LaunchCollectorArgs added in v0.3.0 

type LaunchCollectorArgs struct {
	Ctx *logging.LogCollectorContext
}

type LaunchSyslogServerArgs added in v0.3.2 

type LaunchSyslogServerArgs struct {
	Ctx *executor.ExecutorContext
}

LaunchSyslogServerArgs wraps the executor context for the purposes of RPC

type PluginReattachConfig added in v0.3.0 

type PluginReattachConfig struct {
	Pid      int
	AddrNet  string
	AddrName string
}

ExecutorReattachConfig is the config that we seralize and de-serialize and store in disk

func NewPluginReattachConfig added in v0.3.0 

func NewPluginReattachConfig(c *plugin.ReattachConfig) *PluginReattachConfig

func (*PluginReattachConfig) PluginConfig added in v0.3.0 

func (c *PluginReattachConfig) PluginConfig() *plugin.ReattachConfig

PluginConfig returns a config from an ExecutorReattachConfig

type QemuDriver 

type QemuDriver struct {
	DriverContext
	fingerprint.StaticFingerprinter
}

QemuDriver is a driver for running images via Qemu We attempt to chose sane defaults for now, with more configuration available planned in the future

func (*QemuDriver) Fingerprint 

func (d *QemuDriver) Fingerprint(cfg *config.Config, node *structs.Node) (bool, error)

func (*QemuDriver) Open 

func (d *QemuDriver) Open(ctx *ExecContext, handleID string) (DriverHandle, error)

func (*QemuDriver) Start 

func (d *QemuDriver) Start(ctx *ExecContext, task *structs.Task) (DriverHandle, error)

Run an existing Qemu image. Start() will pull down an existing, valid Qemu image and save it to the Drivers Allocation Dir

func (*QemuDriver) Validate added in v0.3.2 

func (d *QemuDriver) Validate(config map[string]interface{}) error

Validate is used to validate the driver configuration

type QemuDriverConfig added in v0.2.0 

type QemuDriverConfig struct {
	ImagePath   string           `mapstructure:"image_path"`
	Accelerator string           `mapstructure:"accelerator"`
	PortMap     []map[string]int `mapstructure:"port_map"` // A map of host port labels and to guest ports.
	Args        []string         `mapstructure:"args"`     // extra arguments to qemu executable
}

type RawExecDriver added in v0.2.0 

type RawExecDriver struct {
	DriverContext
	fingerprint.StaticFingerprinter
}

The RawExecDriver is a privileged version of the exec driver. It provides no resource isolation and just fork/execs. The Exec driver should be preferred and this should only be used when explicitly needed.

func (*RawExecDriver) Fingerprint added in v0.2.0 

func (d *RawExecDriver) Fingerprint(cfg *config.Config, node *structs.Node) (bool, error)

func (*RawExecDriver) Open added in v0.2.0 

func (d *RawExecDriver) Open(ctx *ExecContext, handleID string) (DriverHandle, error)

func (*RawExecDriver) Start added in v0.2.0 

func (d *RawExecDriver) Start(ctx *ExecContext, task *structs.Task) (DriverHandle, error)

func (*RawExecDriver) Validate added in v0.3.2 

func (d *RawExecDriver) Validate(config map[string]interface{}) error

Validate is used to validate the driver configuration

type RktDriver added in v0.2.0 

type RktDriver struct {
	DriverContext
	fingerprint.StaticFingerprinter
}

RktDriver is a driver for running images via Rkt We attempt to chose sane defaults for now, with more configuration available planned in the future

func (*RktDriver) Fingerprint added in v0.2.0 

func (d *RktDriver) Fingerprint(cfg *config.Config, node *structs.Node) (bool, error)

func (*RktDriver) Open added in v0.2.0 

func (d *RktDriver) Open(ctx *ExecContext, handleID string) (DriverHandle, error)

func (*RktDriver) Start added in v0.2.0 

func (d *RktDriver) Start(ctx *ExecContext, task *structs.Task) (DriverHandle, error)

Run an existing Rkt image.

func (*RktDriver) Validate added in v0.3.2 

func (d *RktDriver) Validate(config map[string]interface{}) error

Validate is used to validate the driver configuration

type RktDriverConfig added in v0.2.0 

type RktDriverConfig struct {
	ImageName        string   `mapstructure:"image"`
	Command          string   `mapstructure:"command"`
	Args             []string `mapstructure:"args"`
	TrustPrefix      string   `mapstructure:"trust_prefix"`
	DNSServers       []string `mapstructure:"dns_servers"`        // DNS Server for containers
	DNSSearchDomains []string `mapstructure:"dns_search_domains"` // DNS Search domains for containers
	Debug            bool     `mapstructure:"debug"`              // Enable debug option for rkt command
}

type SyncServicesArgs added in v0.3.2 

type SyncServicesArgs struct {
	Ctx *executor.ConsulContext
}

SyncServicesArgs wraps the consul context for the purposes of RPC

type SyslogCollectorPlugin added in v0.3.0 

type SyslogCollectorPlugin struct {
	Impl *SyslogCollectorRPCServer
	// contains filtered or unexported fields
}

func (*SyslogCollectorPlugin) Client added in v0.3.0 

func (p *SyslogCollectorPlugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error)

func (*SyslogCollectorPlugin) Server added in v0.3.0 

func (p *SyslogCollectorPlugin) Server(*plugin.MuxBroker) (interface{}, error)

type SyslogCollectorRPC added in v0.3.0 

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

func (*SyslogCollectorRPC) Exit added in v0.3.0 

func (e *SyslogCollectorRPC) Exit() error

func (*SyslogCollectorRPC) LaunchCollector added in v0.3.0 

func (e *SyslogCollectorRPC) LaunchCollector(ctx *logging.LogCollectorContext) (*logging.SyslogCollectorState, error)

func (*SyslogCollectorRPC) UpdateLogConfig added in v0.3.0 

func (e *SyslogCollectorRPC) UpdateLogConfig(logConfig *structs.LogConfig) error

type SyslogCollectorRPCServer added in v0.3.0 

type SyslogCollectorRPCServer struct {
	Impl logging.LogCollector
}

func (*SyslogCollectorRPCServer) Exit added in v0.3.0 

func (s *SyslogCollectorRPCServer) Exit(args interface{}, resp *interface{}) error

func (*SyslogCollectorRPCServer) LaunchCollector added in v0.3.0 

func (s *SyslogCollectorRPCServer) LaunchCollector(args LaunchCollectorArgs,
	resp *logging.SyslogCollectorState) error

func (*SyslogCollectorRPCServer) UpdateLogConfig added in v0.3.0 

func (s *SyslogCollectorRPCServer) UpdateLogConfig(logConfig *structs.LogConfig, resp *interface{}) error

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.