xanderio/cdist
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fix man pages

Browse source 
Migrate (re-migrate) from text -> rst and update docs to reflect new developments
This commit is contained in:
Jake Guffey 2016-06-05 22:16:42 -04:00
commit bcd5e9827b
3 changed files with 81 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

6
cdist/conf/type/__jail/man.rst
View file

@ -2,12 +2,12 @@ cdist-type__jail(7)
=================== ===================
Manage FreeBSD jails Manage FreeBSD jails
Jake Guffey <jake.guffey--@--eprotex.com> Jake Guffey <jake.guffey--@--jointheirstm.org>
DESCRIPTION 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 REQUIRED PARAMETERS
@ -112,5 +112,5 @@ SEE ALSO
COPYING 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). granted under the terms of the GNU General Public License version 3 (GPLv3).

70
cdist/conf/type/__jail_freebsd10/man.text → cdist/conf/type/__jail_freebsd10/man.rst
View file

@ -1,61 +1,58 @@
cdist-type__jail_freebsd_10(7) cdist-type__jail_freebsd10(7)
============================== =============================
Manage FreeBSD jails
Jake Guffey <jake.guffey--@--jointheirstm.org> Jake Guffey <jake.guffey--@--jointheirstm.org>
NAME
----
cdist-type__jail_freebsd_10 - Manage FreeBSD jails
DESCRIPTION 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 REQUIRED PARAMETERS
------------------- -------------------
state:: state
Either "present" or "absent", defaults to "present". Either "present" or "absent", defaults to "present".
jailbase:: jailbase
The location of the .tgz archive containing the base fs for your jails. The location of the .tgz archive containing the base fs for your jails.
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
------------------- -------------------
name:: name
The name of the jail. Default is to use the object_id as the jail 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 ifconfig style IP/netmask combination to use for the jail guest. If
the state parameter is "present," this parameter is required. the state parameter is "present," this parameter is required.
hostname:: hostname
The FQDN to use for the jail guest. Defaults to the name parameter. 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. 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. 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 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. "jailrules." This ruleset must be copied to the server via another type.
To use this option, devfs-enable must be "true." To use this option, devfs-enable must be "true."
jaildir:: jaildir
The location on the remote server to use for hosting jail filesystems. The location on the remote server to use for hosting jail filesystems.
Defaults to /usr/jail. Defaults to /usr/jail.
BOOLEAN PARAMETERS BOOLEAN PARAMETERS
------------------ ------------------
stopped:: stopped
Do not start the jail Do not start the jail
devfs-disable:: devfs-disable
Whether to disallow devfs mounting within the jail Whether to disallow devfs mounting within the jail
onboot:: onboot
Whether to add the jail to rc.conf's jail_list variable. 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 MESSAGES
-------- --------
start:: start
The jail was started The jail was started
stop:: stop
The jail was stopped The jail was stopped
create: create:
The jail was created The jail was created
delete:: delete
The jail was deleted The jail was deleted
onboot:: onboot
The jail was configured to start on boot The jail was configured to start on boot
EXAMPLES 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
# Remove the jail called www # Create a jail called www
__jail_freebsd_10 www --state absent --jailbase /my/jail/base.tgz __jail_freebsd10 www --state present --ip "192.168.1.2" --jailbase /my/jail/base.tgz
# The jail www should not be started # Remove the jail called www
__jail_freebsd_10 www --state present --stopped \ __jail_freebsd10 www --state absent --jailbase /my/jail/base.tgz
# The jail www should not be started
__jail_freebsd10 www --state present --stopped \
--ip "192.168.1.2 netmask 255.255.255.0" \ --ip "192.168.1.2 netmask 255.255.255.0" \
--jailbase /my/jail/base.tgz --jailbase /my/jail/base.tgz
# Use the name variable explicitly # 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" \ --ip "192.168.1.2" \
--jailbase /my/jail/base.tgz --jailbase /my/jail/base.tgz
# Go nuts # 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" \ --ip "192.168.1.100 netmask 255.255.255.0" \
--hostname "testjail.example.com" --interface "em0" \ --hostname "testjail.example.com" --interface "em0" \
--onboot --jailbase /my/jail/base.tgz --jaildir /jails --onboot --jailbase /my/jail/base.tgz --jaildir /jails
--------------------------------------------------------------------------------
SEE ALSO SEE ALSO
-------- --------
- cdist-type(7) - `cdist-type(7) <cdist-type.html>`_
- cdist-type__jail(7)
COPYING COPYING

66
cdist/conf/type/__jail_freebsd9/man.text → cdist/conf/type/__jail_freebsd9/man.rst
View file

@ -1,61 +1,58 @@
cdist-type__jail_freebsd9(7) cdist-type__jail_freebsd9(7)
============================ ============================
Jake Guffey <jake.guffey--@--jointheirstm.org> Manage FreeBSD jails
Jake Guffey <jake.guffey--@--eprotex.com>
NAME
----
cdist-type__jail_freebsd9 - Manage FreeBSD jails
DESCRIPTION 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 REQUIRED PARAMETERS
------------------- -------------------
state:: state
Either "present" or "absent", defaults to "present". Either "present" or "absent", defaults to "present".
jailbase:: jailbase
The location of the .tgz archive containing the base fs for your jails. The location of the .tgz archive containing the base fs for your jails.
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
------------------- -------------------
name:: name
The name of the jail. Default is to use the object_id as the jail 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 ifconfig style IP/netmask combination to use for the jail guest. If
the state parameter is "present," this parameter is required. the state parameter is "present," this parameter is required.
hostname:: hostname
The FQDN to use for the jail guest. Defaults to the name parameter. 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. 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. 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 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. "jailrules." This ruleset must be copied to the server via another type.
To use this option, devfs-enable must be "true." To use this option, devfs-enable must be "true."
jaildir:: jaildir
The location on the remote server to use for hosting jail filesystems. The location on the remote server to use for hosting jail filesystems.
Defaults to /usr/jail. Defaults to /usr/jail.
BOOLEAN PARAMETERS BOOLEAN PARAMETERS
------------------ ------------------
stopped:: stopped
Do not start the jail Do not start the jail
devfs-disable:: devfs-disable
Whether to disallow devfs mounting within the jail Whether to disallow devfs mounting within the jail
onboot:: onboot
Whether to add the jail to rc.conf's jail_list variable. Whether to add the jail to rc.conf's jail_list variable.
@ -69,49 +66,48 @@ means.
MESSAGES MESSAGES
-------- --------
start:: start
The jail was started The jail was started
stop:: stop
The jail was stopped The jail was stopped
create: create:
The jail was created The jail was created
delete:: delete
The jail was deleted The jail was deleted
onboot:: onboot
The jail was configured to start on boot The jail was configured to start on boot
EXAMPLES EXAMPLES
-------- --------
-------------------------------------------------------------------------------- .. code-block:: sh
# Create a jail called www
__jail_freebsd9 www --state present --ip "192.168.1.2" --jailbase /my/jail/base.tgz
# Remove the jail called www # Create a jail called www
__jail_freebsd9 www --state absent --jailbase /my/jail/base.tgz __jail_freebsd9 www --state present --ip "192.168.1.2" --jailbase /my/jail/base.tgz
# The jail www should not be started # Remove the jail called www
__jail_freebsd9 www --state present --stopped \ __jail_freebsd9 www --state absent --jailbase /my/jail/base.tgz
# The jail www should not be started
__jail_freebsd9 www --state present --stopped \
--ip "192.168.1.2 netmask 255.255.255.0" \ --ip "192.168.1.2 netmask 255.255.255.0" \
--jailbase /my/jail/base.tgz --jailbase /my/jail/base.tgz
# Use the name variable explicitly # Use the name variable explicitly
__jail_freebsd9 thisjail --state present --name www \ __jail_freebsd9 thisjail --state present --name www \
--ip "192.168.1.2" \ --ip "192.168.1.2" \
--jailbase /my/jail/base.tgz --jailbase /my/jail/base.tgz
# Go nuts # Go nuts
__jail_freebsd9 lotsofoptions --state present --name testjail \ __jail_freebsd9 lotsofoptions --state present --name testjail \
--ip "192.168.1.100 netmask 255.255.255.0" \ --ip "192.168.1.100 netmask 255.255.255.0" \
--hostname "testjail.example.com" --interface "em0" \ --hostname "testjail.example.com" --interface "em0" \
--onboot --jailbase /my/jail/base.tgz --jaildir /jails --onboot --jailbase /my/jail/base.tgz --jaildir /jails
--------------------------------------------------------------------------------
SEE ALSO SEE ALSO
-------- --------
- cdist-type(7) - `cdist-type(7) <cdist-type.html>`_
- cdist-type__jail
COPYING COPYING