VPS.CONF(5) FreeBSD File Formats Manual VPS.CONF(5)

NAME

vps.conf — configuration file for a Virtual Private Systems instance

DESCRIPTION

Options are set with ‘‘name = value’’ assignments, one per line. name is case insensetive. value needs quoting if it contains whitespace. Comments start with #.

The following list provides a name and short description for each variable that can be set in the vps.conf file:

NAME

The desired name for the vps instance.

FSROOT

The filesystem root of the vps instance.

[FSROOT_PRIV]

If some sort of virtal file system (like mount_vpsfs(8) is used), this lets you specify the underlying path that will be synced on migration instead of the virtual mount.

[INIT]

Command line to execute in vps instance after starting. If not specified, no processes are started in the vps instance.

[ROOT_MOUNT]

Command line for mounting root filesystem of vps instance, if necessary.

[ROOT_MOUNT]

Command line for unmounting root filesystem of vps instance, if necessary.

[NETWORK_ANNOUNCE]

Command line for announcing vps instance on the network. E.g. setting routes somewhere.

[NETWORK_REVOKE]

Command line for revoking vps instance from the network. E.g. deleting routes somewhere.

[IP_NETWORKS]

List of IPv4 and IPv6 networks the VPS instance is allowed to use on its interfaces.

Following formats are valid:

192.168.123.231
192.168.213.0/255.255.255.0
fc00::200:20
fc00::100:0/112

Multiple networks can be specified on at once, separated by ’,’.

[LIMITS]

Resource limits for the vps instance, specified as resource:softlimit:hardlimit. Following resources are valid:

phys

Physical memory.

virt

Virtual memory.

pctcpu

CPU utilization in percent.

blockio

Block I/O Operations per second.

threads

Number of threads allowed.

procs

Number of processes allowed.

Separate multiple resource limit specifications by ’,’.

[PRIV_ALLOW]

List of priv(9) privileges that are allowed for the vps instance. This is used in addition to the quite reasonable default set. Specifiy either numeric value or name, separate by ’,’. See /usr/include/sys/priv.h for a list of valid privileges.

[PRIV_NOSYS]

List of priv(9) privileges that are forbidden for the vps instance, but instead of EPERM error ENOSYS error is returned. This is necessary for some applications.

[NETIF_<index>_ADDRESS]

A list of IPv4 and/or IPv6 addresses that the vps instance may use on the network interface vps<index>.

For every NETIF_<index>_ADDRESS specification a if_vps interface with the name vps<index> is created in the vps instance.

The difference to specifing the addresses in IP_NETWORKS is that for each address an ARP entry and a routing entry is automatically created.

FILES
/etc/vps/vps_<ID>.conf

for each VPS instance with id <ID>.

EXAMPLES

Example of a vps instance configuration file:

# This is a comment.
NAME = ’vps190’
FSROOT = ’/usr/vps/vps190’
FSROOT_PRIV = ’/usr/vps/vps190_priv’
NETIF_0_ADDRESS = ’10.142.178.190, 2001:10:10::beef:190’
ROOT_MOUNT = ’mount_vpsfs /usr/vps/vps190_priv /usr/vps/vps190’
ROOT_UNMOUNT = ’umount /usr/vps/vps190’
INIT = ’/sbin/init’
LIMITS = ’phys:0:0,virt:100000000:160000000,pctcpu:100:200,threads:12:12’

SEE ALSO

vps(4), vps(9), vpsctl(8), mount_vpsfs(8), http://www.7he.at/freebsd/vps/

HISTORY

Work on VPS was started in February 2009.

AUTHORS

Virtual Private Systems for FreeBSD and this manual page as well, were written by Klaus P. Ohrhallinger.

Development of this software was partly funded by:

TransIP.nl <http://www.transip.nl/>

BUGS

VPS is in an early stage of development and has to be considered as experimental. This means many bugs have to be expected.

Please submit bug reports to freebsd-vps@7he.at.

VERSION

$Id: vps.conf.5 120 2012-08-30 11:14:36Z klaus $

FreeBSD 10.0 August 29, 2012 FreeBSD 10.0