Documentation
¶
Index ¶
- Constants
- func NewSystemdNSpawnDriver(logger log.Logger) drivers.DriverPlugin
- type Config
- type Driver
- func (d *Driver) Capabilities() (*drivers.Capabilities, error)
- func (d *Driver) ConfigSchema() (*hclspec.Spec, error)
- func (d *Driver) CreateMachine(cfg *drivers.TaskConfig, taskConfig TaskConfig) (m *Machine, err error)
- func (d *Driver) DestroyTask(taskID string, force bool) error
- func (d *Driver) ExecTask(taskID string, cmd []string, timeout time.Duration) (*drivers.ExecTaskResult, error)
- func (d *Driver) Fingerprint(ctx context.Context) (<-chan *drivers.Fingerprint, error)
- func (d *Driver) GetMachine()
- func (d *Driver) InspectTask(taskID string) (*drivers.TaskStatus, error)
- func (d *Driver) KillMachine()
- func (d *Driver) PluginInfo() (*base.PluginInfoResponse, error)
- func (d *Driver) RecoverTask(handle *drivers.TaskHandle) error
- func (d *Driver) SetConfig(cfg *base.Config) error
- func (d *Driver) Shutdown(ctx context.Context) error
- func (d *Driver) SignalTask(taskID string, signal string) error
- func (d *Driver) StartTask(cfg *drivers.TaskConfig) (*drivers.TaskHandle, *drivers.DriverNetwork, error)
- func (d *Driver) StopTask(taskID string, timeout time.Duration, signal string) error
- func (d *Driver) TaskConfigSchema() (*hclspec.Spec, error)
- func (d *Driver) TaskEvents(ctx context.Context) (<-chan *drivers.TaskEvent, error)
- func (d *Driver) TaskStats(ctx context.Context, taskID string, interval time.Duration) (<-chan *drivers.TaskResourceUsage, error)
- func (d *Driver) TerminateMachine()
- func (d *Driver) WaitTask(ctx context.Context, taskID string) (<-chan *drivers.ExitResult, error)
- type Machine
- type TaskConfig
- type TaskState
Constants ¶
const ( MachineStateOpening = "opening" MachineStateRunning = "running" MachineStateClosing = "closing" )
Available state for machine.
const ( MachineClassContainer = "container" MachineClassVM = "vm" )
Available class for machine.
Variables ¶
This section is empty.
Functions ¶
func NewSystemdNSpawnDriver ¶
func NewSystemdNSpawnDriver(logger log.Logger) drivers.DriverPlugin
NewSystemdNSpawnDriver returns a new DriverPlugin implementation
Types ¶
type Config ¶
type Config struct { // Enabled is set to true to enable the systemd driver Enabled bool `codec:"enabled"` }
Config is the driver configuration set by the SetConfig RPC call
type Driver ¶
type Driver struct {
// contains filtered or unexported fields
}
Driver is a driver for running systemd nspawn containers
func (*Driver) Capabilities ¶
func (d *Driver) Capabilities() (*drivers.Capabilities, error)
Capabilities implements DriverPlugin's Capabilities.
func (*Driver) ConfigSchema ¶
ConfigSchema implements BasePlugin's ConfigSchema.
func (*Driver) CreateMachine ¶
func (d *Driver) CreateMachine(cfg *drivers.TaskConfig, taskConfig TaskConfig) (m *Machine, err error)
CreateMachine will create a new systemd-nspawn machine.
func (*Driver) DestroyTask ¶
DestroyTask implements DriverPlugin's DestroyTask.
func (*Driver) ExecTask ¶
func (d *Driver) ExecTask(taskID string, cmd []string, timeout time.Duration) (*drivers.ExecTaskResult, error)
ExecTask implements DriverPlugin's ExecTask.
func (*Driver) Fingerprint ¶
Fingerprint implements DriverPlugin's Fingerprint.
func (*Driver) GetMachine ¶
func (d *Driver) GetMachine()
GetMachine will get a new systemd-nspawn machine.
func (*Driver) InspectTask ¶
func (d *Driver) InspectTask(taskID string) (*drivers.TaskStatus, error)
InspectTask implements DriverPlugin's InspectTask.
func (*Driver) KillMachine ¶
func (d *Driver) KillMachine()
KillMachine will kill a new systemd-nspawn machine.
func (*Driver) PluginInfo ¶
func (d *Driver) PluginInfo() (*base.PluginInfoResponse, error)
PluginInfo implements BasePlugin's PluginInfo.
func (*Driver) RecoverTask ¶
func (d *Driver) RecoverTask(handle *drivers.TaskHandle) error
RecoverTask implements DriverPlugin's RecoverTask.
func (*Driver) SignalTask ¶
SignalTask implements DriverPlugin's SignalTask.
func (*Driver) StartTask ¶
func (d *Driver) StartTask(cfg *drivers.TaskConfig) (*drivers.TaskHandle, *drivers.DriverNetwork, error)
StartTask implements DriverPlugin's StartTask.
func (*Driver) TaskConfigSchema ¶
TaskConfigSchema implements DriverPlugin's TaskConfigSchema.
func (*Driver) TaskEvents ¶
TaskEvents implements DriverPlugin's TaskEvents.
func (*Driver) TaskStats ¶
func (d *Driver) TaskStats(ctx context.Context, taskID string, interval time.Duration) (<-chan *drivers.TaskResourceUsage, error)
TaskStats implements DriverPlugin's TaskStats.
func (*Driver) TerminateMachine ¶
func (d *Driver) TerminateMachine()
TerminateMachine will terminate a new systemd-nspawn machine.
type Machine ¶
type Machine struct { Name string ID []byte Timestamp time.Time TimestampMonotonic time.Time Service string Unit string Leader int Class string RootDirectory string NetworkInterfaces []int State string }
Machine Object in dbus.
node /org/freedesktop/machine1/machine/fedora_2dtree { interface org.freedesktop.machine1.Machine { methods: Terminate(); Kill(in s who, in s signal); GetAddresses(out a(iay) addresses); GetOSRelease(out a{ss} fields); signals: properties: readonly s Name = 'fedora-tree'; readonly ay Id = [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]; readonly t Timestamp = 1374193370484284; readonly t TimestampMonotonic = 128247251308; readonly s Service = 'nspawn'; readonly s Unit = 'machine-fedora\\x2dtree.scope'; readonly u Leader = 30046; readonly s Class = 'container'; readonly s RootDirectory = '/home/lennart/fedora-tree'; readonly ai NetworkInterfaces = [7]; readonly s State = 'running'; }; interface org.freedesktop.DBus.Properties { }; interface org.freedesktop.DBus.Peer { }; interface org.freedesktop.DBus.Introspectable { }; };
type TaskConfig ¶
type TaskConfig struct { // Image is the image name. Image string // Boot takes a boolean argument, which defaults to off. // If enabled, systemd-nspawn will automatically search for an init executable and invoke it. // In this case, the specified parameters using Parameters= are passed as additional arguments to the init process. // This option may not be combined with ProcessTwo=yes. Boot bool // Ephemeral takes a boolean argument, which defaults to off, If enabled, the container is run with a temporary // snapshot of its file system that is removed immediately when the container terminates. Ephemeral bool // ProcessTwo takes a boolean argument, which defaults to off. // If enabled, the specified program is run as PID 2. // A stub init process is run as PID 1. // This option may not be combined with Boot=yes. ProcessTwo bool // Parameters takes a space-separated list of arguments. // This is either a command line, beginning with the binary name to execute, // or – if Boot= is enabled – the list of arguments to pass to the init process. Parameters []string // Environment takes an environment variable assignment consisting of key and value. // Sets an environment variable for the main process invoked in the container. // This setting may be used multiple times to set multiple environment variables. Environment map[string]string // User takes a UNIX user name. // Specifies the user name to invoke the main process of the container as. // This user must be known in the container's user database. User string // WorkingDirectory selects the working directory for the process invoked in the container. // Expects an absolute path in the container's file system namespace. WorkingDirectory string // PivotRoot selects a directory to pivot to / inside the container when starting up. // Takes a single path, or a pair of two paths separated by a colon. // Both paths must be absolute, and are resolved in the container's file system namespace. PivotRoot string // Capability takes a list of Linux process capabilities (see capabilities(7) for details). // The Capability= setting specifies additional capabilities to pass on top of the default set of capabilities. // The DropCapability= setting specifies capabilities to drop from the default set. Capability []string // DropCapability used like Capability. DropCapability []string // NoNewPrivileges takes a boolean argument that controls the PR_SET_NO_NEW_PRIVS flag for the container payload. // ref: https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html#--no-new-privileges= NoNewPrivileges bool // KillSignal specify the process signal to send to the container's PID 1 when nspawn itself receives SIGTERM, // in order to trigger an orderly shutdown of the container. // Defaults to SIGRTMIN+3 if Boot= is used (on systemd-compatible init systems SIGRTMIN+3 triggers an // orderly shutdown). // For a list of valid signals, see signal(7). KillSignal uint32 // Personality configures the kernel personality for the container. // Currently, "x86" and "x86-64" are supported. // ref: https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html#--personality= Personality string // MachineID configures the 128-bit machine ID (UUID) to pass to the container. MachineID string // PrivateUsers configures support for usernamespacing. // ref: https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html#--private-users= PrivateUsers string // NotifyReady configures support for notifications from the container's init process. // ref: https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html#--notify-ready= NotifyReady bool // SystemCallFilter configures the system call filter applied to containers. // ref: https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html#--system-call-filter= SystemCallFilter []string // Configures various types of resource limits applied to containers. // Sets the specified POSIX resource limit for the container payload. // Expects an assignment of the form "SOFT:HARD" or "VALUE" // ref: https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html#--rlimit= LimitCPU string LimitFSIZE string LimitDATA string LimitSTACK string LimitCORE string LimitRSS string LimitNOFILE string LimitAS string LimitNPROC string LimitMEMLOCK string LimitLOCKS string LimitSIGPENDING string LimitMSGQUEUE string LimitNICE string LimitRTPRIO string LimitRTTIME string // OOMScoreAdjust changes the OOM ("Out Of Memory") score adjustment value for the container payload. // This controls /proc/self/oom_score_adj which influences the preference with which this container // is terminated when memory becomes scarce. // For details see proc(5). // Takes an integer in the range -1000…1000. OOMScoreAdjust int // CPUAffinity controls the CPU affinity of the container payload. // Takes a comma separated list of CPU numbers or number ranges (the latter's start and end value separated by // dashes). // See sched_setaffinity(2) for details. CPUAffinity []string // Hostname configures the kernel hostname set for the container. Hostname string // ResolvConf configures how /etc/resolv.conf inside of the container (i.e. DNS configuration synchronization from // host to container) shall be handled. // Takes one of "off", "copy-host", "copy-static", "bind-host", "bind-static", "delete" or "auto". // ref: https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html#--resolv-conf= ResolvConf string // Timezone configures how /etc/localtime inside of the container (i.e. local timezone synchronization from host // to container) shall be handled. // Takes one of "off", "copy", "bind", "symlink", "delete" or "auto". // ref: https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html#--timezone= Timezone string // LinkJournal controls whether the container's journal shall be made visible to the host system. // If enabled, allows viewing the container's journal files from the host (but not vice versa). // Takes one of "no", "host", "try-host", "guest", "try-guest", "auto". LinkJournal string // ReadOnly takes a boolean argument, which defaults to off. // If specified, the container will be run with a read-only file system. ReadOnly bool // Volatile takes "no", "yes", or the special value "state". // This configures whether to run the container with volatile state and/or configuration. // ref: https://www.freedesktop.org/software/systemd/man/systemd-nspawn.html#--volatile Volatile string // Bind adds a bind mount from the host into the container. // Takes a single path, a pair of two paths separated by a colon, or a triplet of two paths plus an // option string separated by colons. Bind []string BindReadOnly []string // TemporaryFileSystem adds a "tmpfs" mount to the container. // Takes a path or a pair of path and option string, separated by a colon. TemporaryFileSystem []string // Inaccessible masks the specified file or directly in the container, by over-mounting it with an empty file node of // the same type with the most restrictive access mode. // Takes a file system path as arugment. Inaccessible []string // Overlay adds an overlay mount point. // Takes a colon-separated list of paths. Overlay [][]string OverlayReadOnly [][]string // PrivateUsersChown configures whether the ownership of the files and directories in the container tree shall be adjusted // to the UID/GID range used, if necessary and user namespacing is enabled. PrivateUsersChown bool // Private takes a boolean argument, which defaults to off. // If enabled, the container will run in its own network namespace and not share network interfaces // and configuration with the host. Private bool // VirtualEthernet takes a boolean argument. // Configures whether to create a virtual Ethernet connection ("veth") between host and the container. // This setting implies Private=yes. VirtualEthernet bool // VirtualEthernetExtra takes a colon-separated pair of interface names. // Configures an additional virtual Ethernet connection ("veth") between host and the container. // The first specified name is the interface name on the host, the second the interface name in the container. // The latter may be omitted in which case it is set to the same name as the host side interface. // This setting implies Private=yes. // It is independent of VirtualEthernet=. This option is privileged. VirtualEthernetExtra []string // Interface takes a space-separated list of interfaces to add to the container. // This option implies Private=yes. Interface []string // MACVLAN and IPVLAN takes a space-separated list of interfaces to add MACLVAN or IPVLAN interfaces to, // which are then added to the container. // These options correspond to the --network-macvlan= and --network-ipvlan= command line switches and // imply Private=yes. // These options are privileged. MACVLAN []string IPVLAN []string // Bridge takes an interface name. // This setting implies VirtualEthernet=yes and Private=yes and has the effect that the host side of the // created virtual Ethernet link is connected to the specified bridge interface. // This option is privileged. Bridge string // Zone takes a network zone name. // This setting implies VirtualEthernet=yes and Private=yes and has the effect that the host side of the // created virtual Ethernet link is connected to an automatically managed bridge interface named after // the passed argument, prefixed with "vz-". // This option is privileged. Zone string // Port exposes a TCP or UDP port of the container on the host. // If private networking is enabled, maps an IP port on the host onto an IP port on the container. // Takes a protocol specifier (either "tcp" or "udp"), separated by a colon from a host port number in the // range 1 to 65535, separated by a colon from a container port number in the range from 1 to 65535. // The protocol specifier and its separating colon may be omitted, in which case "tcp" is assumed. // The container port number and its colon may be omitted, in which case the same port as the host port is // implied. // This option is only supported if private networking is used, such as with --network-veth, // --network-zone= --network-bridge=. // This option is privileged. Port []string }
TaskConfig is the driver configuration of a task within a job