poudriere jail.8

This page is auto-generated from src/bin/poudriere-jail.8

POUDRIERE-JAIL(8)

FreeBSD System Manager's Manual

POUDRIERE-JAIL(8)

NAME

poudriere-jail —

manage jails used to build ports

SYNOPSIS

poudriere

[ poudriere-options ] jail subcommand [ options ]

DESCRIPTION

This command manages the poudriere-jail jails which are used as different building environments.

One subcommand must be supplied.

SUBCOMMANDS

-c

Creates a jail. See CAVEATS for restrictions on the names of jails.

-d

Deletes a jail.

If the stdin is a TTY then the command is going to ask for confirmation, which defaults to “N” (for “no”). Othwerwise, the specified jail is deleted without confirmation.

-i

Show information about a jail. See also poudriere-status(8).

-l

List all poudriere jails.

-n

When combined with -l, only display jail name.

-s

Starts a jail.

-k

Kills a jail (stops it).

-r name

Rename a jail to name.

-u

Update a jail.

OPTIONS

Except for -l, all of the subcommands require the -j option (see below).

-b

Build the source provided with the -m src=PATH option.

-J number

The number of make jobs will run in parallel for buildworld. Defaults to the number of CPUs reported by: sysctl hw.ncpu.

-q

Remove the header when -l is the specified mandatory option. Otherwise, it has no effect.

-j name

Specifies the name of the jail.

-v version

Specifies which version of FreeBSD to use in the jail. If you are using method ftp then the version should in the form of: 9.0-RELEASE. If you are using method of svn then the version should be in the form of git or svn branches: stable/9 or head for CURRENT. Other methods only use the value for display.

-a architecture

Specifies which architecture of FreeBSD to use in the jail. (Default: same as host)

-m method

Specifies which method to use to create the jail. (default: http)

Pre-built distribution options:

allbsd

Use http://www.allbsd.org.

ftp http

Fetch from configured FREEBSD_HOST variable from poudriere.conf.

ftp-archive

Fetch from http://ftp-archive.freebsd.org.

null

This option can be used to import an existing directory that already contains an installed system. The path must be specified with -M path. It is expected that this directory be installed to with the following:

/usr/src# make installworld DESTDIR=PATH DB_FROM_SRC=1 
/usr/src# make distrib-dirs DESTDIR=PATH DB_FROM_SRC=1 
/usr/src# make distribution DESTDIR=PATH DB_FROM_SRC=1
        

The path will be null-mounted during builds. It will not be copied at the time of running jail. Deleting the jail will attempt to revert any files changed by poudriere.

src=PATH

Install from the given src directory at PATH. This directory will not be built from. It is expected that it is already built and maps to a corresponding /usr/obj directory.

tar=PATH

Install from the tarball at the given PATH. Note that this method requires the tarball contains the /usr/src files as well if you plan to build any port containing modules.

url=PATH

Fetch from given PATH. Any URL supported by fetch(1) can be used. For example:

url=file:///mirror/10.0

Build from source options:

git git+http git+https git+ssh

Will use git, the -v flag to set the branch name and the GIT_BASEURL variable in poudriere.conf.

src=PATH

With the -b flag, the src tree will be copied into the jail and built.

svn svn+file svn+http svn+https

Will use SVN and the SVN_HOST variable in poudriere.conf.

-f filesystem

Specifies the filesystem name (${ZPOOL}/jails/filesystem).

-K kernelname

Install the jail with a kernel. If the kernelname is an empty string GENERIC will be used. If installing from ftp then the default kernel will be installed what ever the kernelname value is.

-M mountpoint

Gives an alternative mountpoint when creating jail.

-p name

This specifies which port tree to start/stop the jail with.

-P patch

Apply the specified patch to the source tree before building the jail.

-S srcpath

Use the specified srcpath as the FreeBSD source tree mounted inside the jail or from the host for -m null.

-t version

instead of upgrading to the latest security fix of the jail version, you can jump to the new specified version.

-z set

This specifies which SET to start/stop the jail with.

-x

Build the native-xtools target using the host's /usr/src tree and copy this into the jail. The use of /usr/src is due to a bug in the native-xtools build which does not allow it to be built from the jail's own source. Used exclusively for cross building a ports set, typically via qemu-user tools.

-C data

Clean poudriere data folders when deleting a jail. Only used for -d option.

data options are the following:

all

 

cache

 

logs

 

packages

 

wkrdirs

 

-D

When creating the jail from a git checkout, clone it with the full history instead of a --depth=1.

CAVEATS

Jailname

-j, -z and -p are all used in the name of the jail.

Be careful to respect the names supported by jail(8):

    "This is an arbitrary string that identifies a jail (except it 
     may not contain a '.')"

SEE ALSO

jail(8), poudriere(8), poudriere-bulk(8), poudriere-distclean(8), poudriere-image(8), poudriere-logclean(8), poudriere-options(8), poudriere-pkgclean(8), poudriere-ports(8), poudriere-queue(8), poudriere-status(8), poudriere-testport(8), poudriere-version(8)

AUTHORS

Baptiste Daroussin ⟨[email protected]⟩
Bryan Drewery ⟨[email protected]⟩

October 22, 2018

FreeBSD 13.0-CURRENT