forked from ungleich-public/cdist
man.text -> man.rst
This commit is contained in:
parent
ac94d182b6
commit
a05ae761a4
24 changed files with 367 additions and 329 deletions
|
@ -1,7 +1,5 @@
|
||||||
cdist-type__cdist_preos(7)
|
cdist-type__cdist_preos(7)
|
||||||
==========================
|
==========================
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
|
@ -13,26 +11,38 @@ DESCRIPTION
|
||||||
This cdist type creates a directory containing an operating
|
This cdist type creates a directory containing an operating
|
||||||
suitable for installation using cdist.
|
suitable for installation using cdist.
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
|
None
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
|
None
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__cdist_preos /tmp/random_name_for_packaging
|
|
||||||
--------------------------------------------------------------------------------
|
__cdist_preos /tmp/random_name_for_packaging
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
:strong:`cdist-type__cdist`\ (7)
|
||||||
- cdist-type__cdist(7)
|
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
-------
|
||||||
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
-------
|
-------
|
||||||
Copyright \(C) 2015 Nico Schottelius. Free use of this software is
|
Copyright \(C) 2015 Nico Schottelius. You can redistribute it
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
|
@ -1,7 +1,5 @@
|
||||||
cdist-type__install_chroot_mount(7)
|
cdist-type__install_chroot_mount(7)
|
||||||
===================================
|
===================================
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
|
@ -15,28 +13,30 @@ Mount and prepare a chroot for running commands within it.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
None
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
None
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__install_chroot_mount /path/to/chroot
|
|
||||||
--------------------------------------------------------------------------------
|
__install_chroot_mount /path/to/chroot
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
AUTHORS
|
||||||
--------
|
-------
|
||||||
- cdist-type(7)
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
-------
|
-------
|
||||||
Copyright \(C) 2012 Steven Armstrong. Free use of this software is
|
Copyright \(C) 2012 Steven Armstrong. You can redistribute it
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
|
@ -1,7 +1,5 @@
|
||||||
cdist-type__install_chroot_umount(7)
|
cdist-type__install_chroot_umount(7)
|
||||||
====================================
|
====================================
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
|
@ -15,28 +13,35 @@ Undo what __chroot_mount did.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
None
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
None
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__install_chroot_umount /path/to/chroot
|
|
||||||
--------------------------------------------------------------------------------
|
__install_chroot_umount /path/to/chroot
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
:strong:`cdist-type__chroot_mount`\ (7)
|
||||||
|
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
-------
|
||||||
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
-------
|
-------
|
||||||
Copyright \(C) 2012 Steven Armstrong. Free use of this software is
|
Copyright \(C) 2012 Steven Armstrong. You can redistribute it
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
|
@ -1,7 +1,5 @@
|
||||||
cdist-type__install_bootloader_grub(7)
|
cdist-type__install_bootloader_grub(7)
|
||||||
======================================
|
======================================
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
|
@ -15,33 +13,36 @@ This cdist type allows you to install grub2 bootloader on given disk.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
None
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
device::
|
device
|
||||||
The device to install grub to. Defaults to object_id
|
The device to install grub to. Defaults to object_id
|
||||||
|
|
||||||
chroot::
|
chroot
|
||||||
where to chroot before running grub-install. Defaults to /target.
|
where to chroot before running grub-install. Defaults to /target.
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__install_bootloader_grub /dev/sda
|
|
||||||
__install_bootloader_grub /dev/sda --chroot /mnt/foobar
|
__install_bootloader_grub /dev/sda
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
__install_bootloader_grub /dev/sda --chroot /mnt/foobar
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
AUTHORS
|
||||||
--------
|
-------
|
||||||
- cdist-type(7)
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
-------
|
-------
|
||||||
Copyright \(C) 2011 Steven Armstrong. Free use of this software is
|
Copyright \(C) 2011 Steven Armstrong. You can redistribute it
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
1
cdist/conf/type/__install_chroot_mount/man.rst
Symbolic link
1
cdist/conf/type/__install_chroot_mount/man.rst
Symbolic link
|
@ -0,0 +1 @@
|
||||||
|
../__chroot_mount/man.rst
|
|
@ -1 +0,0 @@
|
||||||
../__chroot_mount/man.text
|
|
1
cdist/conf/type/__install_chroot_umount/man.rst
Symbolic link
1
cdist/conf/type/__install_chroot_umount/man.rst
Symbolic link
|
@ -0,0 +1 @@
|
||||||
|
../__chroot_umount/man.rst
|
|
@ -1 +0,0 @@
|
||||||
../__chroot_umount/man.text
|
|
|
@ -1,7 +1,5 @@
|
||||||
cdist-type__install_config(7)
|
cdist-type__install_config(7)
|
||||||
=============================
|
=============================
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
|
@ -17,31 +15,33 @@ cdist config against the /target chroot on the remote host.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
None
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
chroot::
|
chroot
|
||||||
where to chroot before running grub-install. Defaults to /target.
|
where to chroot before running grub-install. Defaults to /target.
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__install_config
|
|
||||||
|
|
||||||
__install_config --chroot /mnt/somewhere
|
__install_config
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
__install_config --chroot /mnt/somewhere
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
AUTHORS
|
||||||
--------
|
-------
|
||||||
- cdist-type(7)
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
-------
|
-------
|
||||||
Copyright \(C) 2011 Steven Armstrong. Free use of this software is
|
Copyright \(C) 2011 Steven Armstrong. You can redistribute it
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
1
cdist/conf/type/__install_file/man.rst
Symbolic link
1
cdist/conf/type/__install_file/man.rst
Symbolic link
|
@ -0,0 +1 @@
|
||||||
|
../__file/man.rst
|
|
@ -1 +0,0 @@
|
||||||
../__file/man.text
|
|
|
@ -1,7 +1,5 @@
|
||||||
cdist-type__install_fstab(7)
|
cdist-type__install_fstab(7)
|
||||||
============================
|
============================
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
|
@ -16,12 +14,12 @@ to the target machine at ${prefix}/etc/fstab.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
None
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
prefix::
|
prefix
|
||||||
The prefix under which to generate the /etc/fstab file.
|
The prefix under which to generate the /etc/fstab file.
|
||||||
Defaults to /target.
|
Defaults to /target.
|
||||||
|
|
||||||
|
@ -29,20 +27,27 @@ prefix::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__install_fstab
|
|
||||||
__install_fstab --prefix /mnt/target
|
__install_fstab
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
__install_fstab --prefix /mnt/target
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
:strong:`cdist-type__install_generate_fstab`\ (7),
|
||||||
- cdist-type__install_mount(7)
|
:strong:`cdist-type__install_mount`\ (7)
|
||||||
- cdist-type__install_generate_fstab(7)
|
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
-------
|
||||||
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
-------
|
-------
|
||||||
Copyright \(C) 2011 Steven Armstrong. Free use of this software is
|
Copyright \(C) 2011 Steven Armstrong. You can redistribute it
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
|
@ -1,7 +1,5 @@
|
||||||
cdist-type__install_generate_fstab(7)
|
cdist-type__install_generate_fstab(7)
|
||||||
=====================================
|
=====================================
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
|
@ -16,37 +14,40 @@ __install_mount definitions.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
destination::
|
destination
|
||||||
The path where to store the generated fstab file.
|
The path where to store the generated fstab file.
|
||||||
Note that this is a path on the server, where cdist is running, not the target host.
|
Note that this is a path on the server, where cdist is running, not the target host.
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
None
|
||||||
|
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
BOOLEAN PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
uuid::
|
uuid
|
||||||
use UUID instead of device in fstab
|
use UUID instead of device in fstab
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__install_generate_fstab --destination /path/where/you/want/fstab
|
|
||||||
__install_generate_fstab --uuid --destination /path/where/you/want/fstab
|
__install_generate_fstab --destination /path/where/you/want/fstab
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
__install_generate_fstab --uuid --destination /path/where/you/want/fstab
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
AUTHORS
|
||||||
--------
|
-------
|
||||||
- cdist-type(7)
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
-------
|
-------
|
||||||
Copyright \(C) 2012 Steven Armstrong. Free use of this software is
|
Copyright \(C) 2012 Steven Armstrong. You can redistribute it
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
62
cdist/conf/type/__install_mkfs/man.rst
Normal file
62
cdist/conf/type/__install_mkfs/man.rst
Normal file
|
@ -0,0 +1,62 @@
|
||||||
|
cdist-type__install_mkfs(7)
|
||||||
|
===========================
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
cdist-type__install_mkfs - build a linux file system
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
This cdist type is a wrapper for the mkfs command.
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
type
|
||||||
|
The filesystem type to use. Same as used with mkfs -t.
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
device
|
||||||
|
defaults to object_id
|
||||||
|
|
||||||
|
options
|
||||||
|
file system-specific options to be passed to the mkfs command
|
||||||
|
|
||||||
|
blocks
|
||||||
|
the number of blocks to be used for the file system
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# reiserfs /dev/sda5
|
||||||
|
__install_mkfs /dev/sda5 --type reiserfs
|
||||||
|
|
||||||
|
# same thing with explicit device
|
||||||
|
__install_mkfs whatever --device /dev/sda5 --type reiserfs
|
||||||
|
|
||||||
|
# jfs with journal on /dev/sda2
|
||||||
|
__install_mkfs /dev/sda1 --type jfs --options "-j /dev/sda2"
|
||||||
|
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
:strong:`mkfs`\ (8)
|
||||||
|
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
-------
|
||||||
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2011 Steven Armstrong. You can redistribute it
|
||||||
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
|
@ -1,57 +0,0 @@
|
||||||
cdist-type__install_mkfs(7)
|
|
||||||
===========================
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__install_mkfs - build a linux file system
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
This cdist type is a wrapper for the mkfs command.
|
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
|
||||||
-------------------
|
|
||||||
type::
|
|
||||||
The filesystem type to use. Same as used with mkfs -t.
|
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
|
||||||
-------------------
|
|
||||||
device::
|
|
||||||
defaults to object_id
|
|
||||||
|
|
||||||
options::
|
|
||||||
file system-specific options to be passed to the mkfs command
|
|
||||||
|
|
||||||
blocks::
|
|
||||||
the number of blocks to be used for the file system
|
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
|
||||||
--------
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
# reiserfs /dev/sda5
|
|
||||||
__install_mkfs /dev/sda5 --type reiserfs
|
|
||||||
# same thing with explicit device
|
|
||||||
__install_mkfs whatever --device /dev/sda5 --type reiserfs
|
|
||||||
|
|
||||||
# jfs with journal on /dev/sda2
|
|
||||||
__install_mkfs /dev/sda1 --type jfs --options "-j /dev/sda2"
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
--------
|
|
||||||
- cdist-type(7)
|
|
||||||
- mkfs(8)
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2011 Steven Armstrong. Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
|
|
@ -1,7 +1,5 @@
|
||||||
cdist-type__install_mount(7)
|
cdist-type__install_mount(7)
|
||||||
============================
|
============================
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
|
@ -15,24 +13,24 @@ Mounts filesystems in the installer. Collects data to generate /etc/fstab.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
device::
|
device
|
||||||
the device to mount
|
the device to mount
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
dir::
|
dir
|
||||||
where to mount device. Defaults to object_id.
|
where to mount device. Defaults to object_id.
|
||||||
|
|
||||||
options::
|
options
|
||||||
mount options passed to mount(8) and used in /etc/fstab
|
mount options passed to mount(8) and used in /etc/fstab
|
||||||
|
|
||||||
type::
|
type
|
||||||
filesystem type passed to mount(8) and used in /etc/fstab.
|
filesystem type passed to mount(8) and used in /etc/fstab.
|
||||||
If type is swap, 'dir' is ignored.
|
If type is swap, 'dir' is ignored.
|
||||||
Defaults to the filesystem used in __install_mkfs for the same 'device'.
|
Defaults to the filesystem used in __install_mkfs for the same 'device'.
|
||||||
|
|
||||||
prefix::
|
prefix
|
||||||
the prefix to prepend to 'dir' when mounting in the installer.
|
the prefix to prepend to 'dir' when mounting in the installer.
|
||||||
Defaults to /target.
|
Defaults to /target.
|
||||||
|
|
||||||
|
@ -40,22 +38,28 @@ prefix::
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__install_mount slash --dir / --device /dev/sda5 --options noatime
|
|
||||||
require="__install_mount/slash" __install_mount /boot --device /dev/sda1
|
__install_mount slash --dir / --device /dev/sda5 --options noatime
|
||||||
__install_mount swap --device /dev/sda2 --type swap
|
require="__install_mount/slash" __install_mount /boot --device /dev/sda1
|
||||||
require="__install_mount/slash" __install_mount /tmp --device tmpfs --type tmpfs
|
__install_mount swap --device /dev/sda2 --type swap
|
||||||
--------------------------------------------------------------------------------
|
require="__install_mount/slash" __install_mount /tmp --device tmpfs --type tmpfs
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
:strong:`cdist-type__install_mkfs`\ (7),
|
||||||
- cdist-type__install_mount_apply(7)
|
:strong:`cdist-type__install_mount_apply` (7)
|
||||||
- cdist-type__install_mkfs(7)
|
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
-------
|
||||||
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
-------
|
-------
|
||||||
Copyright \(C) 2011 Steven Armstrong. Free use of this software is
|
Copyright \(C) 2011 Steven Armstrong. You can redistribute it
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
64
cdist/conf/type/__install_partition_msdos/man.rst
Normal file
64
cdist/conf/type/__install_partition_msdos/man.rst
Normal file
|
@ -0,0 +1,64 @@
|
||||||
|
cdist-type__install_partition_msdos(7)
|
||||||
|
======================================
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
cdist-type__install_partition_msdos - creates msdos partitions
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
This cdist type allows you to create msdos paritions.
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
type
|
||||||
|
the partition type used in fdisk (such as 82 or 83) or "extended"
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
partition
|
||||||
|
defaults to object_id
|
||||||
|
|
||||||
|
bootable
|
||||||
|
mark partition as bootable, true or false, defaults to false
|
||||||
|
|
||||||
|
size
|
||||||
|
the size of the partition (such as 32M or 15G, whole numbers
|
||||||
|
only), '+' for remaining space, or 'n%' for percentage of remaining
|
||||||
|
(these should only be used after all specific partition sizes are
|
||||||
|
specified). Defaults to +.
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
# 128MB, linux, bootable
|
||||||
|
__install_partition_msdos /dev/sda1 --type 83 --size 128M --bootable true
|
||||||
|
# 512MB, swap
|
||||||
|
__install_partition_msdos /dev/sda2 --type 82 --size 512M
|
||||||
|
# 100GB, extended
|
||||||
|
__install_partition_msdos /dev/sda3 --type extended --size 100G
|
||||||
|
# 10GB, linux
|
||||||
|
__install_partition_msdos /dev/sda5 --type 83 --size 10G
|
||||||
|
# 50% of the free space of the extended partition, linux
|
||||||
|
__install_partition_msdos /dev/sda6 --type 83 --size 50%
|
||||||
|
# rest of the extended partition, linux
|
||||||
|
__install_partition_msdos /dev/sda7 --type 83 --size +
|
||||||
|
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
-------
|
||||||
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2011 Steven Armstrong. You can redistribute it
|
||||||
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
|
@ -1,62 +0,0 @@
|
||||||
cdist-type__install_partition_msdos(7)
|
|
||||||
======================================
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__install_partition_msdos - creates msdos partitions
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
This cdist type allows you to create msdos paritions.
|
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
|
||||||
-------------------
|
|
||||||
type::
|
|
||||||
the partition type used in fdisk (such as 82 or 83) or "extended"
|
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
|
||||||
-------------------
|
|
||||||
partition::
|
|
||||||
defaults to object_id
|
|
||||||
bootable::
|
|
||||||
mark partition as bootable, true or false, defaults to false
|
|
||||||
size::
|
|
||||||
the size of the partition (such as 32M or 15G, whole numbers
|
|
||||||
only), '+' for remaining space, or 'n%' for percentage of remaining
|
|
||||||
(these should only be used after all specific partition sizes are
|
|
||||||
specified). Defaults to +.
|
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
|
||||||
--------
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
# 128MB, linux, bootable
|
|
||||||
__install_partition_msdos /dev/sda1 --type 83 --size 128M --bootable true
|
|
||||||
# 512MB, swap
|
|
||||||
__install_partition_msdos /dev/sda2 --type 82 --size 512M
|
|
||||||
# 100GB, extended
|
|
||||||
__install_partition_msdos /dev/sda3 --type extended --size 100G
|
|
||||||
# 10GB, linux
|
|
||||||
__install_partition_msdos /dev/sda5 --type 83 --size 10G
|
|
||||||
# 50% of the free space of the extended partition, linux
|
|
||||||
__install_partition_msdos /dev/sda6 --type 83 --size 50%
|
|
||||||
# rest of the extended partition, linux
|
|
||||||
__install_partition_msdos /dev/sda7 --type 83 --size +
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
--------
|
|
||||||
- cdist-type(7)
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2011 Steven Armstrong. Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
|
|
@ -1,7 +1,5 @@
|
||||||
cdist-type__install_partition_msdos_apply(7)
|
cdist-type__install_partition_msdos_apply(7)
|
||||||
============================================
|
============================================
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
|
@ -20,23 +18,30 @@ None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
None
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__install_partition_msdos_apply
|
|
||||||
--------------------------------------------------------------------------------
|
__install_partition_msdos_apply
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
- cdist-type(7)
|
:strong:`cdist-type__install_partition_msdos_apply`\ (7)
|
||||||
- cdist-type__install_partition_msdos_apply(7)
|
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
-------
|
||||||
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
-------
|
-------
|
||||||
Copyright \(C) 2011 Steven Armstrong. Free use of this software is
|
Copyright \(C) 2011 Steven Armstrong. You can redistribute it
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
|
@ -1,7 +1,5 @@
|
||||||
cdist-type__install_reboot(7)
|
cdist-type__install_reboot(7)
|
||||||
=============================
|
=============================
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
|
@ -15,29 +13,31 @@ This cdist type allows you to reboot a machine.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
None
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
options::
|
options
|
||||||
options to pass to the reboot command. e.g. -f
|
options to pass to the reboot command. e.g. -f
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__install_reboot
|
|
||||||
--------------------------------------------------------------------------------
|
__install_reboot
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
AUTHORS
|
||||||
--------
|
-------
|
||||||
- cdist-type(7)
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
-------
|
-------
|
||||||
Copyright \(C) 2011 Steven Armstrong. Free use of this software is
|
Copyright \(C) 2011 Steven Armstrong. You can redistribute it
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
|
@ -1,7 +1,5 @@
|
||||||
cdist-type__install_reset_disk(7)
|
cdist-type__install_reset_disk(7)
|
||||||
=================================
|
=================================
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
|
@ -17,27 +15,29 @@ Remove mdadm superblock.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
None
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
None
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__install_reset_disk /dev/sdb
|
|
||||||
--------------------------------------------------------------------------------
|
__install_reset_disk /dev/sdb
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
AUTHORS
|
||||||
--------
|
-------
|
||||||
- cdist-type(7)
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
-------
|
-------
|
||||||
Copyright \(C) 2012 Steven Armstrong. Free use of this software is
|
Copyright \(C) 2012 Steven Armstrong. You can redistribute it
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
58
cdist/conf/type/__install_stage/man.rst
Normal file
58
cdist/conf/type/__install_stage/man.rst
Normal file
|
@ -0,0 +1,58 @@
|
||||||
|
cdist-type__install_stage(7)
|
||||||
|
============================
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
cdist-type__install_stage - download and unpack a stage file
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
Downloads a operating system stage using curl and unpacks it to /target
|
||||||
|
using tar. The stage tarball is expected to be gzip compressed.
|
||||||
|
|
||||||
|
|
||||||
|
REQUIRED PARAMETERS
|
||||||
|
-------------------
|
||||||
|
uri
|
||||||
|
The uri from which to fetch the tarball.
|
||||||
|
Can be anything understood by curl, e.g:
|
||||||
|
| http://path/to/stage.tgz
|
||||||
|
| tftp:///path/to/stage.tgz
|
||||||
|
| file:///local/path/stage.tgz
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONAL PARAMETERS
|
||||||
|
-------------------
|
||||||
|
target
|
||||||
|
where to unpack the tarball to. Defaults to /target.
|
||||||
|
|
||||||
|
|
||||||
|
BOOLEAN PARAMETERS
|
||||||
|
------------------
|
||||||
|
insecure
|
||||||
|
run curl in insecure mode so it does not check the servers ssl certificate
|
||||||
|
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
__install_stage --uri tftp:///path/to/stage.tgz
|
||||||
|
__install_stage --uri http://path/to/stage.tgz --target /mnt/foobar
|
||||||
|
__install_stage --uri file:///path/to/stage.tgz --target /target
|
||||||
|
__install_stage --uri https://path/to/stage.tgz --target /mnt/foobar --insecure
|
||||||
|
|
||||||
|
|
||||||
|
AUTHORS
|
||||||
|
-------
|
||||||
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2011 - 2013 Steven Armstrong. You can redistribute it
|
||||||
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
|
@ -1,58 +0,0 @@
|
||||||
cdist-type__install_stage(7)
|
|
||||||
============================
|
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-type__install_stage - download and unpack a stage file
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
Downloads a operating system stage using curl and unpacks it to /target
|
|
||||||
using tar. The stage tarball is expected to be gzip compressed.
|
|
||||||
|
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
|
||||||
-------------------
|
|
||||||
uri::
|
|
||||||
The uri from which to fetch the tarball.
|
|
||||||
Can be anything understood by curl, e.g:
|
|
||||||
http://path/to/stage.tgz
|
|
||||||
tftp:///path/to/stage.tgz
|
|
||||||
file:///local/path/stage.tgz
|
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
|
||||||
-------------------
|
|
||||||
target::
|
|
||||||
where to unpack the tarball to. Defaults to /target.
|
|
||||||
|
|
||||||
|
|
||||||
BOOLEAN PARAMETERS
|
|
||||||
------------------
|
|
||||||
insecure::
|
|
||||||
run curl in insecure mode so it does not check the servers ssl certificate
|
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
|
||||||
--------
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
__install_stage --uri tftp:///path/to/stage.tgz
|
|
||||||
__install_stage --uri http://path/to/stage.tgz --target /mnt/foobar
|
|
||||||
__install_stage --uri file:///path/to/stage.tgz --target /target
|
|
||||||
__install_stage --uri https://path/to/stage.tgz --target /mnt/foobar --insecure
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
--------
|
|
||||||
- cdist-type(7)
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2011 - 2013 Steven Armstrong. Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
|
|
@ -1,7 +1,5 @@
|
||||||
cdist-type__install_umount(7)
|
cdist-type__install_umount(7)
|
||||||
=============================
|
=============================
|
||||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
|
@ -15,29 +13,31 @@ This cdist type allows you to recursively umount the given target directory.
|
||||||
|
|
||||||
REQUIRED PARAMETERS
|
REQUIRED PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
None.
|
None
|
||||||
|
|
||||||
|
|
||||||
OPTIONAL PARAMETERS
|
OPTIONAL PARAMETERS
|
||||||
-------------------
|
-------------------
|
||||||
target::
|
target
|
||||||
the mount point to umount. Defaults to object_id
|
the mount point to umount. Defaults to object_id
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
--------
|
--------
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
.. code-block:: sh
|
||||||
__install_umount /target
|
|
||||||
--------------------------------------------------------------------------------
|
__install_umount /target
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
AUTHORS
|
||||||
--------
|
-------
|
||||||
- cdist-type(7)
|
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
COPYING
|
||||||
-------
|
-------
|
||||||
Copyright \(C) 2011 Steven Armstrong. Free use of this software is
|
Copyright \(C) 2011 Steven Armstrong. You can redistribute it
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
and/or modify it under the terms of the GNU General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
Loading…
Reference in a new issue