c/mirror_zfs
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_zfs.git synced 2026-01-14 01:02:04 +03:00
Code Issues Packages Projects Releases Wiki Activity

zfs-jail.8: Add introductory sentence, refactor

Browse Source 
Add an introductory sentance explaining why the reader may want to use
this command, and establishing the requirement that the jail must be
running. Move other requirements from the description of the subcommands
to follow this for flow and structure. Move the caveat that this is for
FreeBSD down to a cannonical CAVEATS section, and crossreference Linux's
equivelant functionality. Mention that this utility can not be used to
delegate the root directory of the jail to that section also.

Reported by: Jan Brankamp <crest@rlwinm.de>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Allan Jude <allan@klarasystems.com>
Signed-off-by: Alexander Ziaee <ziaee@FreeBSD.org>
Closes #17883
This commit is contained in:
Alexander Ziaee 2025-11-06 16:53:24 -05:00 committed by Brian Behlendorf
parent a2a34d9212
commit 055e908d47
1 changed files with 49 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
man/man8/zfs-jail.8
View File

@ -37,7 +37,7 @@
.\" Copyright 2018 Nexenta Systems, Inc.
.\" Copyright 2019 Joyent, Inc.
.\"
.Dd July 11, 2022
.Dd November 4, 2025
.Dt ZFS-JAIL 8
.Os
.
@ -53,9 +53,42 @@
.Ar filesystem
.
.Sh DESCRIPTION
.Bl -tag -width ""
The
.Nm
functionality can be used to assign a dataset onto a running
.Fx
system
.Xr jail 4 ,
allowing
.Xr zfs 8
management utilities to be run inside of the
.Xr jail 4 .
.Pp
To allow management of the dataset from within a jail, the
.Sy jailed
property should be set and the required
.Xr devfs.conf 5
entries to expose
.Pa /dev/zfs
device within the jail must be present.
The
.Sy quota
property cannot be changed from within a jail.
.Pp
To use this functionality, the jail needs the
.Sy allow.mount
and
.Sy allow.mount.zfs
parameters set to
.Sy 1
and the
.Sy enforce_statfs
parameter set to a value lower than
.Sy 2 .
.Pp
The subcommands are as follows:
.Bl -tag -width indent
.It Xo
.Nm zfs
.Cm jail
.Ar jailid Ns | Ns Ar jailname
.Ar filesystem
@ -69,16 +102,6 @@ or name
From now on this file system tree can be managed from within a jail if the
.Sy jailed
property has been set.
To use this functionality, the jail needs the
.Sy allow.mount
and
.Sy allow.mount.zfs
parameters set to
.Sy 1
and the
.Sy enforce_statfs
parameter set to a value lower than
.Sy 2 .
.Pp
You cannot attach a jailed dataset's children to another jail.
You can also not attach the root file system
@ -86,29 +109,12 @@ of the jail or any dataset which needs to be mounted before the zfs rc script
is run inside the jail, as it would be attached unmounted until it is
mounted from the rc script inside the jail.
.Pp
To allow management of the dataset from within a jail, the
.Sy jailed
property has to be set and the jail needs access to the
.Pa /dev/zfs
device.
The
.Sy quota
property cannot be changed from within a jail.
.Pp
After a dataset is attached to a jail and the
.Sy jailed
property is set, a jailed file system cannot be mounted outside the jail,
since the jail administrator might have set the mount point to an unacceptable
value.
.Pp
See
.Xr jail 8
for more information on managing jails.
Jails are a
.Fx
feature and are not relevant on other platforms.
.It Xo
.Nm zfs
.Cm unjail
.Ar jailid Ns | Ns Ar jailname
.Ar filesystem
@ -121,5 +127,18 @@ or name
.Ar jailname .
.El
.Sh SEE ALSO
.Xr devfs.conf 5 ,
.Xr zfsprops 7 ,
.Xr jail 8
.Sh CAVEATS
The root directory of jail can not be delegated to the jail with this
utility because the jail must be running with a valid root directory.
.Pp
Jails are a
.Fx
feature and are not relevant on other platforms.
See
.Xr jail 8
for more information on managing jails, or
.Xr zfs-zone 8
for the equivelant functionality on Linux.