forked from ungleich-public/cdist
Write sphinx rst docs.
This commit is contained in:
Darko Poljak
parent
091ddac384
commit
cf32b669ff
232 changed files with 4439 additions and 3705 deletions
|
|
@ -1,13 +1,10 @@
|
|||
cdist-type__autofs(7)
|
||||
=====================
|
||||
Install and start autofs
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__autofs - install and start autofs
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This space intentionally left blank.
|
||||
|
|
@ -26,14 +23,14 @@ None.
|
|||
EXAMPLES
|
||||
--------
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
__autofs
|
||||
--------------------------------------------------------------------------------
|
||||
.. code-block:: sh
|
||||
|
||||
__autofs
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist-type(7)
|
||||
- `cdist-type(7) <cdist-type.html>`_
|
||||
|
||||
|
||||
COPYING
|
||||
|
|
@ -1,13 +1,10 @@
|
|||
cdist-type__autofs_map(7)
|
||||
=========================
|
||||
Manage autofs maps
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__autofs_map - Manage autofs maps
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This cdist type allows you to define maps for autofs.
|
||||
|
|
@ -20,48 +17,50 @@ The object_id is used as the mount-point as described in auto.master(5).
|
|||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
map::
|
||||
map
|
||||
Name of the map to use. See auto.master(5).
|
||||
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
type::
|
||||
type
|
||||
Type of map used for this mount point. Defaults to 'file'.
|
||||
See map-type in auto.master(5) for possible values.
|
||||
options::
|
||||
|
||||
options
|
||||
See auto.master(5).
|
||||
comment::
|
||||
|
||||
comment
|
||||
A comment describing this map. Is added to the generated entry in
|
||||
auto.master.
|
||||
|
||||
|
||||
BOOLEAN PARAMETERS
|
||||
------------------
|
||||
noreload::
|
||||
noreload
|
||||
don't reload autofs after the entry has been changed
|
||||
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
# Add auto mounter at /net and reload
|
||||
__autofs_map /net --map /etc/auto.net --type program
|
||||
.. code-block:: sh
|
||||
|
||||
# Add auto mounter at /pub and don't reload
|
||||
__autofs_map /pub \
|
||||
--map /etc/auto.pub \
|
||||
--type file \
|
||||
--options "nosuid,rw,bg,hard,intr --ghost" \
|
||||
--noreload
|
||||
--------------------------------------------------------------------------------
|
||||
# Add auto mounter at /net and reload
|
||||
__autofs_map /net --map /etc/auto.net --type program
|
||||
|
||||
# Add auto mounter at /pub and don't reload
|
||||
__autofs_map /pub \
|
||||
--map /etc/auto.pub \
|
||||
--type file \
|
||||
--options "nosuid,rw,bg,hard,intr --ghost" \
|
||||
--noreload
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist-type(7)
|
||||
- cdist-type__autofs_reload(7)
|
||||
- `cdist-type(7) <cdist-type.html>`_
|
||||
- `cdist-type__autofs_reload(7) <cdist-type__autofs_reload.html>`_
|
||||
|
||||
|
||||
COPYING
|
||||
|
|
@ -1,13 +1,10 @@
|
|||
cdist-type__autofs_reload(7)
|
||||
============================
|
||||
Tell automounter to reload config file
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__autofs_reload - tell automounter to reload config file
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This space intentionally left blank.
|
||||
|
|
@ -26,14 +23,14 @@ None.
|
|||
EXAMPLES
|
||||
--------
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
__autofs_reload
|
||||
--------------------------------------------------------------------------------
|
||||
.. code-block:: sh
|
||||
|
||||
__autofs_reload
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist-type(7)
|
||||
- `cdist-type(7) <cdist-type.html>`_
|
||||
|
||||
|
||||
COPYING
|
||||
|
|
@ -1,13 +1,10 @@
|
|||
cdist-type__init_script(7)
|
||||
==========================
|
||||
Use the init scripts
|
||||
|
||||
Daniel Roth <dani-cdist--@--d-roth.li>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__init_script - Use the init scripts
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This type can be used to control your init scripts.
|
||||
|
|
@ -15,34 +12,35 @@ This type can be used to control your init scripts.
|
|||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
mode::
|
||||
mode
|
||||
Specifies what shall be done with the init script (usually one of 'start'|'stop'|'restart'|'reload' or 'force-reload')
|
||||
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
script::
|
||||
script
|
||||
If supplied, use this as the init-script.
|
||||
Otherwise the object_id is used.
|
||||
|
||||
base_dir::
|
||||
base_dir
|
||||
If supplied, this type uses this directory instead of '/etc/init.d'. The parameter will not need an ending slash.
|
||||
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
# Reloads the configuration for lighttpd
|
||||
__init_script lighttpd --mode force-reload
|
||||
.. code-block:: sh
|
||||
|
||||
# Reloads the configuration for lighttpd
|
||||
__init_script lighty --script lighttpd --mode force-reload
|
||||
--------------------------------------------------------------------------------
|
||||
# Reloads the configuration for lighttpd
|
||||
__init_script lighttpd --mode force-reload
|
||||
|
||||
# Reloads the configuration for lighttpd
|
||||
__init_script lighty --script lighttpd --mode force-reload
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist-type(7)
|
||||
- `cdist-type(7) <cdist-type.html>`_
|
||||
|
||||
|
||||
COPYING
|
||||
|
|
@ -1,13 +1,10 @@
|
|||
cdist-type__mysql_server(7)
|
||||
===========================
|
||||
Manage a MySQL server
|
||||
|
||||
Benedikt Koeppel <code@benediktkoeppel.ch>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__mysql_server - Manage a MySQL server
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This cdist type allows you to install a MySQL database server. The
|
||||
|
|
@ -18,13 +15,13 @@ with MySQL.
|
|||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
password::
|
||||
password
|
||||
The root password to set.
|
||||
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
no_my_cnf::
|
||||
no_my_cnf
|
||||
The /root/.my.cnf file is used to temporary store the root password when doing
|
||||
the mysql_secure_installation. If you want to have your own .my.cnf file, then
|
||||
specify --no_my_cnf "true".
|
||||
|
|
@ -34,24 +31,24 @@ no_my_cnf::
|
|||
EXAMPLES
|
||||
--------
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
# to install a MySQL server
|
||||
__mysql_server
|
||||
.. code-block:: sh
|
||||
|
||||
# to install a MySQL server, remove remote access, remove test databases
|
||||
# similar to mysql_secure_installation, specify the root password
|
||||
__mysql_server --password "Uu9jooKe"
|
||||
# this will also write a /root/.my.cnf file
|
||||
# to install a MySQL server
|
||||
__mysql_server
|
||||
|
||||
# if you don't want cdist to write a /root/.my.cnf file permanently, specify
|
||||
# the --no_my_cnf option
|
||||
__mysql_server --password "Uu9jooKe" --no_my_cnf
|
||||
--------------------------------------------------------------------------------
|
||||
# to install a MySQL server, remove remote access, remove test databases
|
||||
# similar to mysql_secure_installation, specify the root password
|
||||
__mysql_server --password "Uu9jooKe"
|
||||
# this will also write a /root/.my.cnf file
|
||||
|
||||
# if you don't want cdist to write a /root/.my.cnf file permanently, specify
|
||||
# the --no_my_cnf option
|
||||
__mysql_server --password "Uu9jooKe" --no_my_cnf
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist-type(7)
|
||||
- `cdist-type(7) <cdist-type.html>`_
|
||||
|
||||
|
||||
COPYING
|
||||
|
|
@ -1,13 +1,10 @@
|
|||
cdist-type__nfs_client(7)
|
||||
=========================
|
||||
nfs client
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__nfs_client - nfs client
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Install, start, do whatever is necessary to have a working nfs client.
|
||||
|
|
@ -26,14 +23,14 @@ None.
|
|||
EXAMPLES
|
||||
--------
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
__nfs_client
|
||||
--------------------------------------------------------------------------------
|
||||
.. code-block:: sh
|
||||
|
||||
__nfs_client
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist-type(7)
|
||||
- `cdist-type(7) <cdist-type.html>`_
|
||||
|
||||
|
||||
COPYING
|
||||
|
|
@ -1,13 +1,10 @@
|
|||
cdist-type__nfs_export(7)
|
||||
=========================
|
||||
Manage nfs exports
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__nfs_export - manage nfs exports
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This cdist type allows you to manage entries in /etc/exports.d.
|
||||
|
|
@ -17,35 +14,35 @@ For older distributions (currently ubuntu lucid) that don't support
|
|||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
client::
|
||||
client
|
||||
space delimited list of client ip/networks for use in /etc/exports. See exports(5)
|
||||
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
options::
|
||||
options
|
||||
export options for use in /etc/exports. See exports(5)
|
||||
|
||||
export::
|
||||
export
|
||||
the directory to export. Defaults to object_id
|
||||
|
||||
state::
|
||||
state
|
||||
Either present or absent. Defaults to present.
|
||||
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
__nfs_export /local/chroot/lucid-amd64 \
|
||||
--client "192.168.0.1/24 10.0.0.1/16" \
|
||||
--options "ro,async,no_all_squash,no_root_squash,subtree_check"
|
||||
--------------------------------------------------------------------------------
|
||||
.. code-block:: sh
|
||||
|
||||
__nfs_export /local/chroot/lucid-amd64 \
|
||||
--client "192.168.0.1/24 10.0.0.1/16" \
|
||||
--options "ro,async,no_all_squash,no_root_squash,subtree_check"
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist-type(7)
|
||||
- `cdist-type(7) <cdist-type.html>`_
|
||||
- exports(5)
|
||||
|
||||
|
||||
|
|
@ -1,13 +1,10 @@
|
|||
cdist-type__nfs_server(7)
|
||||
=========================
|
||||
nfs server
|
||||
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__nfs_server - nfs server
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Install, start, do whatever is necessary to have a working nfs server.
|
||||
|
|
@ -26,14 +23,14 @@ None.
|
|||
EXAMPLES
|
||||
--------
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
__nfs_server
|
||||
--------------------------------------------------------------------------------
|
||||
.. code-block:: sh
|
||||
|
||||
__nfs_server
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist-type(7)
|
||||
- `cdist-type(7) <cdist-type.html>`_
|
||||
|
||||
|
||||
COPYING
|
||||
|
|
@ -1,13 +1,10 @@
|
|||
cdist-type__rsyncer(7)
|
||||
======================
|
||||
Use rsync to copy files.
|
||||
|
||||
Daniel Maher <phrawzty+cdist at gmail.com>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__rsyncer - Use rsync to copy files.
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This type is used to trigger rsync to copy files from the machine running cdist
|
||||
|
|
@ -19,41 +16,41 @@ from the destination which are not present on the source.
|
|||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
source::
|
||||
source
|
||||
The full path of the source from which to copy. This is passed directly
|
||||
to rsync.
|
||||
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
destination::
|
||||
destination
|
||||
The full path of the destination. This is passed directly to rsync.
|
||||
Default: object_id
|
||||
|
||||
delete::
|
||||
delete
|
||||
If true, remove files from destination which are not in source. This is
|
||||
effectively the --delete argument of rsync.
|
||||
Default: false
|
||||
|
||||
rsyncbin::
|
||||
rsyncbin
|
||||
Specify the full path to the rsync binary.
|
||||
Default: `which rsync`
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
# Basic example
|
||||
__rsyncer '/home/foo' --source '/opt/dist/foo'
|
||||
.. code-block:: sh
|
||||
|
||||
# Fancier example
|
||||
__rsyncer FOO --source '/opt/dist/foo' --destination '/home/foo/' --delete true
|
||||
--------------------------------------------------------------------------------
|
||||
# Basic example
|
||||
__rsyncer '/home/foo' --source '/opt/dist/foo'
|
||||
|
||||
# Fancier example
|
||||
__rsyncer FOO --source '/opt/dist/foo' --destination '/home/foo/' --delete true
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist-type(7)
|
||||
- `cdist-type(7) <cdist-type.html>`_
|
||||
|
||||
|
||||
COPYING
|
||||
66
other/types_submitted_for_inclusion/__run_command/man.rst
Normal file
66
other/types_submitted_for_inclusion/__run_command/man.rst
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
cdist-type__run_command(7)
|
||||
==========================
|
||||
Run a command
|
||||
|
||||
Benedikt Koeppel <code--@--benediktkoeppel.ch>
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This cdist type allows you to run a specific command once at installation time.
|
||||
|
||||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
command
|
||||
Command (with arguments) to run.
|
||||
|
||||
If no command is give, then the object_id is executed.
|
||||
|
||||
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
# Run a command
|
||||
__run_command "/etc/init.d/mysql restart"
|
||||
# runs `/etc/init.d/mysql restart` (the "object_id")
|
||||
|
||||
# Run the same command:
|
||||
__run_command restart-mysql --command "/etc/init.d/mysql restart"
|
||||
# runs `/etc/init.d/mysql restart` (the --command argument)
|
||||
# additionally, it can easily be referenced (for example in a require="..."
|
||||
#as __run_command/restart-mysql
|
||||
|
||||
# Run a script:
|
||||
__run_command install-pear --command "$(cat <<-EOF
|
||||
/usr/bin/pear install --force Auth
|
||||
/usr/bin/pear install --force HTML_Template_IT-1.2.1
|
||||
/usr/bin/pear install --force MDB2
|
||||
/usr/bin/pear install --force MDB2#mysql
|
||||
/usr/bin/pear config-set preferred_state beta;
|
||||
/usr/bin/pear install --force --alldeps Spreadsheet_Excel_Writer;
|
||||
/usr/bin/pear config-set preferred_state stable
|
||||
/usr/bin/pear install --force HTTP_Request
|
||||
/usr/bin/pear install --force Mail
|
||||
/usr/bin/pear install --force Auth_HTTP
|
||||
/usr/bin/pear install --force XML_RPC
|
||||
EOF
|
||||
)"
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- `cdist-type(7) <cdist-type.html>`_
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2012 Benedikt Koeppel. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
|
|
@ -1,70 +0,0 @@
|
|||
cdist-type__run_command(7)
|
||||
==========================
|
||||
Benedikt Koeppel <code--@--benediktkoeppel.ch>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__run_command - Run a command
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This cdist type allows you to run a specific command once at installation time.
|
||||
|
||||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
command::
|
||||
Command (with arguments) to run.
|
||||
|
||||
If no command is give, then the object_id is executed.
|
||||
|
||||
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
# Run a command
|
||||
__run_command "/etc/init.d/mysql restart"
|
||||
# runs `/etc/init.d/mysql restart` (the "object_id")
|
||||
|
||||
# Run the same command:
|
||||
__run_command restart-mysql --command "/etc/init.d/mysql restart"
|
||||
# runs `/etc/init.d/mysql restart` (the --command argument)
|
||||
# additionally, it can easily be referenced (for example in a require="..."
|
||||
#as __run_command/restart-mysql
|
||||
|
||||
# Run a script:
|
||||
__run_command install-pear --command "$(cat <<-EOF
|
||||
/usr/bin/pear install --force Auth
|
||||
/usr/bin/pear install --force HTML_Template_IT-1.2.1
|
||||
/usr/bin/pear install --force MDB2
|
||||
/usr/bin/pear install --force MDB2#mysql
|
||||
/usr/bin/pear config-set preferred_state beta;
|
||||
/usr/bin/pear install --force --alldeps Spreadsheet_Excel_Writer;
|
||||
/usr/bin/pear config-set preferred_state stable
|
||||
/usr/bin/pear install --force HTTP_Request
|
||||
/usr/bin/pear install --force Mail
|
||||
/usr/bin/pear install --force Auth_HTTP
|
||||
/usr/bin/pear install --force XML_RPC
|
||||
EOF
|
||||
)"
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist-type(7)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2012 Benedikt Koeppel. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
Loading…
Add table
Add a link
Reference in a new issue