Fix man pages
Migrate (re-migrate) from text -> rst and update docs to reflect new developments
This commit is contained in:
Jake Guffey
parent
bcd4e5f29b
commit
bcd5e9827b
3 changed files with 81 additions and 89 deletions
|
|
@ -2,12 +2,12 @@ cdist-type__jail(7)
|
|||
===================
|
||||
Manage FreeBSD jails
|
||||
|
||||
Jake Guffey <jake.guffey--@--eprotex.com>
|
||||
Jake Guffey <jake.guffey--@--jointheirstm.org>
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This type is used on FreeBSD to manage jails.
|
||||
This type is used on FreeBSD to manage jails by calling the appropriate per-version subtype.
|
||||
|
||||
|
||||
REQUIRED PARAMETERS
|
||||
|
|
@ -112,5 +112,5 @@ SEE ALSO
|
|||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2012 Jake Guffey. Free use of this software is
|
||||
Copyright \(C) 2012,2016 Jake Guffey. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
|
|||
|
|
@ -1,61 +1,58 @@
|
|||
cdist-type__jail_freebsd_10(7)
|
||||
==============================
|
||||
cdist-type__jail_freebsd10(7)
|
||||
=============================
|
||||
Manage FreeBSD jails
|
||||
|
||||
Jake Guffey <jake.guffey--@--jointheirstm.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__jail_freebsd_10 - Manage FreeBSD jails
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This type is used on FreeBSD 10.x to manage jails.
|
||||
This type is used on FreeBSD >= 10.0 to manage jails.
|
||||
|
||||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
state::
|
||||
state
|
||||
Either "present" or "absent", defaults to "present".
|
||||
|
||||
jailbase::
|
||||
jailbase
|
||||
The location of the .tgz archive containing the base fs for your jails.
|
||||
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
name::
|
||||
name
|
||||
The name of the jail. Default is to use the object_id as the jail name.
|
||||
|
||||
ip::
|
||||
ip
|
||||
The ifconfig style IP/netmask combination to use for the jail guest. If
|
||||
the state parameter is "present," this parameter is required.
|
||||
|
||||
hostname::
|
||||
hostname
|
||||
The FQDN to use for the jail guest. Defaults to the name parameter.
|
||||
|
||||
interface::
|
||||
interface
|
||||
The name of the physical interface on the jail server to bind the jail to.
|
||||
Defaults to the first interface found in the output of ifconfig -l.
|
||||
|
||||
devfs-ruleset::
|
||||
devfs-ruleset
|
||||
The name of the devfs ruleset to associate with the jail. Defaults to
|
||||
"jailrules." This ruleset must be copied to the server via another type.
|
||||
To use this option, devfs-enable must be "true."
|
||||
|
||||
jaildir::
|
||||
jaildir
|
||||
The location on the remote server to use for hosting jail filesystems.
|
||||
Defaults to /usr/jail.
|
||||
|
||||
BOOLEAN PARAMETERS
|
||||
------------------
|
||||
stopped::
|
||||
stopped
|
||||
Do not start the jail
|
||||
|
||||
devfs-disable::
|
||||
devfs-disable
|
||||
Whether to disallow devfs mounting within the jail
|
||||
|
||||
onboot::
|
||||
onboot
|
||||
Whether to add the jail to rc.conf's jail_list variable.
|
||||
|
||||
|
||||
|
|
@ -68,49 +65,48 @@ modifications to jail.conf need to be made through alternate means.
|
|||
|
||||
MESSAGES
|
||||
--------
|
||||
start::
|
||||
start
|
||||
The jail was started
|
||||
stop::
|
||||
stop
|
||||
The jail was stopped
|
||||
create:
|
||||
The jail was created
|
||||
delete::
|
||||
delete
|
||||
The jail was deleted
|
||||
onboot::
|
||||
onboot
|
||||
The jail was configured to start on boot
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
.. code-block:: sh
|
||||
|
||||
# Create a jail called www
|
||||
__jail_freebsd_10 www --state present --ip "192.168.1.2" --jailbase /my/jail/base.tgz
|
||||
__jail_freebsd10 www --state present --ip "192.168.1.2" --jailbase /my/jail/base.tgz
|
||||
|
||||
# Remove the jail called www
|
||||
__jail_freebsd_10 www --state absent --jailbase /my/jail/base.tgz
|
||||
__jail_freebsd10 www --state absent --jailbase /my/jail/base.tgz
|
||||
|
||||
# The jail www should not be started
|
||||
__jail_freebsd_10 www --state present --stopped \
|
||||
__jail_freebsd10 www --state present --stopped \
|
||||
--ip "192.168.1.2 netmask 255.255.255.0" \
|
||||
--jailbase /my/jail/base.tgz
|
||||
|
||||
# Use the name variable explicitly
|
||||
__jail_freebsd_10 thisjail --state present --name www \
|
||||
__jail_freebsd10 thisjail --state present --name www \
|
||||
--ip "192.168.1.2" \
|
||||
--jailbase /my/jail/base.tgz
|
||||
|
||||
# Go nuts
|
||||
__jail_freebsd_10 lotsofoptions --state present --name testjail \
|
||||
__jail_freebsd10 lotsofoptions --state present --name testjail \
|
||||
--ip "192.168.1.100 netmask 255.255.255.0" \
|
||||
--hostname "testjail.example.com" --interface "em0" \
|
||||
--onboot --jailbase /my/jail/base.tgz --jaildir /jails
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist-type(7)
|
||||
- cdist-type__jail(7)
|
||||
- `cdist-type(7) <cdist-type.html>`_
|
||||
|
||||
|
||||
COPYING
|
||||
|
|
@ -1,61 +1,58 @@
|
|||
cdist-type__jail_freebsd9(7)
|
||||
============================
|
||||
Jake Guffey <jake.guffey--@--jointheirstm.org>
|
||||
Manage FreeBSD jails
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__jail_freebsd9 - Manage FreeBSD jails
|
||||
Jake Guffey <jake.guffey--@--eprotex.com>
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This type is used on FreeBSD 9.x and before to manage jails.
|
||||
This type is used on FreeBSD <= 9.x to manage jails.
|
||||
|
||||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
state::
|
||||
state
|
||||
Either "present" or "absent", defaults to "present".
|
||||
|
||||
jailbase::
|
||||
jailbase
|
||||
The location of the .tgz archive containing the base fs for your jails.
|
||||
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
name::
|
||||
name
|
||||
The name of the jail. Default is to use the object_id as the jail name.
|
||||
|
||||
ip::
|
||||
ip
|
||||
The ifconfig style IP/netmask combination to use for the jail guest. If
|
||||
the state parameter is "present," this parameter is required.
|
||||
|
||||
hostname::
|
||||
hostname
|
||||
The FQDN to use for the jail guest. Defaults to the name parameter.
|
||||
|
||||
interface::
|
||||
interface
|
||||
The name of the physical interface on the jail server to bind the jail to.
|
||||
Defaults to the first interface found in the output of ifconfig -l.
|
||||
|
||||
devfs-ruleset::
|
||||
devfs-ruleset
|
||||
The name of the devfs ruleset to associate with the jail. Defaults to
|
||||
"jailrules." This ruleset must be copied to the server via another type.
|
||||
To use this option, devfs-enable must be "true."
|
||||
|
||||
jaildir::
|
||||
jaildir
|
||||
The location on the remote server to use for hosting jail filesystems.
|
||||
Defaults to /usr/jail.
|
||||
|
||||
BOOLEAN PARAMETERS
|
||||
------------------
|
||||
stopped::
|
||||
stopped
|
||||
Do not start the jail
|
||||
|
||||
devfs-disable::
|
||||
devfs-disable
|
||||
Whether to disallow devfs mounting within the jail
|
||||
|
||||
onboot::
|
||||
onboot
|
||||
Whether to add the jail to rc.conf's jail_list variable.
|
||||
|
||||
|
||||
|
|
@ -69,21 +66,22 @@ means.
|
|||
|
||||
MESSAGES
|
||||
--------
|
||||
start::
|
||||
start
|
||||
The jail was started
|
||||
stop::
|
||||
stop
|
||||
The jail was stopped
|
||||
create:
|
||||
The jail was created
|
||||
delete::
|
||||
delete
|
||||
The jail was deleted
|
||||
onboot::
|
||||
onboot
|
||||
The jail was configured to start on boot
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
.. code-block:: sh
|
||||
|
||||
# Create a jail called www
|
||||
__jail_freebsd9 www --state present --ip "192.168.1.2" --jailbase /my/jail/base.tgz
|
||||
|
||||
|
|
@ -105,13 +103,11 @@ __jail_freebsd9 lotsofoptions --state present --name testjail \
|
|||
--ip "192.168.1.100 netmask 255.255.255.0" \
|
||||
--hostname "testjail.example.com" --interface "em0" \
|
||||
--onboot --jailbase /my/jail/base.tgz --jaildir /jails
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist-type(7)
|
||||
- cdist-type__jail
|
||||
- `cdist-type(7) <cdist-type.html>`_
|
||||
|
||||
|
||||
COPYING
|
||||
Loading…
Reference in a new issue