cdist/docs/src/man1/cdist.rst

253 lines
6.8 KiB
ReStructuredText
Raw Normal View History

cdist(1)
========
NAME
----
cdist - Usable Configuration Management
SYNOPSIS
--------
2016-05-20 06:50:56 +00:00
::
cdist [-h] [-d] [-v] [-V] {banner,config,shell} ...
cdist banner [-h] [-d] [-v]
2016-08-15 14:37:38 +00:00
cdist config [-h] [-d] [-v] [-b] [-c CONF_DIR] [-f HOSTFILE]
[-i MANIFEST] [-j [JOBS]] [-n] [-o OUT_PATH] [-p] [-s]
[--remote-copy REMOTE_COPY] [--remote-exec REMOTE_EXEC]
[host [host ...]]
2016-05-20 06:50:56 +00:00
cdist shell [-h] [-d] [-v] [-s SHELL]
DESCRIPTION
-----------
cdist is the frontend executable to the cdist configuration management.
It supports different subcommands as explained below.
It is written in Python so it requires :strong:`python`\ (1) to be installed.
It requires a minimal Python version 3.2.
GENERAL
-------
2014-04-29 19:33:18 +00:00
All commands accept the following options:
.. option:: -h, --help
2016-05-20 06:50:56 +00:00
Show the help screen
.. option:: -d, --debug
2016-05-20 06:50:56 +00:00
Set log level to debug
2016-05-20 06:50:56 +00:00
.. option:: -v, --verbose
Set log level to info, be more verbose
2016-05-20 06:50:56 +00:00
.. option:: -V, --version
Show version and exit
BANNER
------
Displays the cdist banner. Useful for printing
cdist posters - a must have for every office.
CONFIG
------
Configure one or more hosts.
2016-08-15 14:37:38 +00:00
.. option:: -b, --enable-beta
Enable beta functionalities. Beta functionalities include the
following options: -j/--jobs.
2016-05-20 06:50:56 +00:00
.. option:: -c CONF_DIR, --conf-dir CONF_DIR
Add a configuration directory. Can be specified multiple times.
If configuration directories contain conflicting types, explorers or
manifests, then the last one found is used. Additionally this can also
be configured by setting the CDIST_PATH environment variable to a colon
delimited list of config directories. Directories given with the
--conf-dir argument have higher precedence over those set through the
environment variable.
.. option:: -f HOSTFILE, --file HOSTFILE
Read additional hosts to operate on from specified file
or from stdin if '-' (each host on separate line).
If no host or host file is specified then, by default,
2016-08-19 12:33:41 +00:00
read hosts from stdin. For the file format see below.
2016-05-20 06:50:56 +00:00
.. option:: -i MANIFEST, --initial-manifest MANIFEST
Path to a cdist manifest or - to read from stdin
2016-08-15 14:37:38 +00:00
.. option:: -j [JOBS], --jobs [JOBS]
Specify the maximum number of parallel jobs; currently only
global explorers are supported (currently in beta)
.. option:: -n, --dry-run
Do not execute code
.. option:: -o OUT_PATH, --out-dir OUT_PATH
Directory to save cdist output in
2016-05-20 06:50:56 +00:00
.. option:: -p, --parallel
Operate on multiple hosts in parallel
2016-05-20 06:50:56 +00:00
.. option:: -s, --sequential
Operate on multiple hosts sequentially (default)
2016-05-20 06:50:56 +00:00
.. option:: --remote-copy REMOTE_COPY
Command to use for remote copy (should behave like scp)
2016-05-20 06:50:56 +00:00
.. option:: --remote-exec REMOTE_EXEC
Command to use for remote execution (should behave like ssh)
2016-08-19 12:33:41 +00:00
HOSTFILE FORMAT
~~~~~~~~~~~~~~~
2016-08-20 05:49:52 +00:00
HOSTFILE contains hosts per line.
All characters after and including '#' until the end of line is a comment.
In a line, all leading and trailing whitespace characters are ignored.
Empty lines are ignored/skipped.
Hostfile line is processed like the following. First, all comments are
removed. Then all leading and trailing whitespace characters are stripped.
If such a line results in empty line it is ignored/skipped. Otherwise,
host string is used.
2016-08-19 12:33:41 +00:00
SHELL
-----
This command allows you to spawn a shell that enables access
to the types as commands. It can be thought as an
"interactive manifest" environment. See below for example
usage. Its primary use is for debugging type parameters.
.. option:: -s SHELL, --shell SHELL
2016-05-20 06:50:56 +00:00
Select shell to use, defaults to current shell. Used shell should
be POSIX compatible shell.
FILES
-----
~/.cdist
Your personal cdist config directory. If exists it will be
automatically used.
cdist/conf
The distribution configuration directory. It contains official types and
explorers. This path is relative to cdist installation directory.
EXAMPLES
--------
2016-05-20 06:50:56 +00:00
.. code-block:: sh
2016-05-20 06:50:56 +00:00
# Configure ikq05.ethz.ch with debug enabled
% cdist config -d ikq05.ethz.ch
2016-05-20 06:50:56 +00:00
# Configure hosts in parallel and use a different configuration directory
% cdist config -c ~/p/cdist-nutzung \
-p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch
2016-05-20 06:50:56 +00:00
# Use custom remote exec / copy commands
% cdist config --remote-exec /path/to/my/remote/exec \
--remote-copy /path/to/my/remote/copy \
-p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch
# Configure hosts read from file loadbalancers
% cdist config -f loadbalancers
# Configure hosts read from file web.hosts using 16 parallel jobs
# (beta functionality)
% cdist config -b -j 16 -f web.hosts
2016-05-20 06:50:56 +00:00
# Display banner
cdist banner
2016-05-20 06:50:56 +00:00
# Show help
% cdist --help
2016-05-20 06:50:56 +00:00
# Show Version
% cdist --version
2016-05-20 06:50:56 +00:00
# Enter a shell that has access to emulated types
% cdist shell
% __git
usage: __git --source SOURCE [--state STATE] [--branch BRANCH]
[--group GROUP] [--owner OWNER] [--mode MODE] object_id
ENVIRONMENT
-----------
2016-05-20 06:50:56 +00:00
TMPDIR, TEMP, TMP
Setup the base directory for the temporary directory.
See http://docs.python.org/py3k/library/tempfile.html for
more information. This is rather useful, if the standard
directory used does not allow executables.
CDIST_PATH
Colon delimited list of config directories.
2016-05-20 06:50:56 +00:00
CDIST_LOCAL_SHELL
Selects shell for local script execution, defaults to /bin/sh.
2016-05-20 06:50:56 +00:00
CDIST_REMOTE_SHELL
2016-08-22 07:24:48 +00:00
Selects shell for remote script execution, defaults to /bin/sh.
CDIST_OVERRIDE
Allow overwriting type parameters.
CDIST_ORDER_DEPENDENCY
Create dependencies based on the execution order.
2016-05-20 06:50:56 +00:00
CDIST_REMOTE_EXEC
Use this command for remote execution (should behave like ssh).
2016-05-20 06:50:56 +00:00
CDIST_REMOTE_COPY
Use this command for remote copy (should behave like scp).
EXIT STATUS
-----------
The following exit values shall be returned:
0 Successful completion.
1 One or more host configurations failed.
AUTHORS
-------
Nico Schottelius <nico-cdist--@--schottelius.org>
2016-08-17 17:32:43 +00:00
CAVEATS
-------
When operating in parallel, either by operating in parallel for each host
(-p/--parallel) or by parallel jobs within a host (-j/--jobs), and depending
on target SSH server and its configuration you may encounter connection drops.
This is controlled with sshd :strong:`MaxStartups` configuration options.
You may also encounter session open refusal. This happens with ssh multiplexing
when you reach maximum number of open sessions permitted per network
connection. In this case ssh will disable multiplexing.
This limit is controlled with sshd :strong:`MaxSessions` configuration
options. For more details refer to :strong:`sshd_config`\ (5).
COPYING
-------
Copyright \(C) 2011-2013 Nico Schottelius. Free use of this software is
granted under the terms of the GNU General Public License v3 or later (GPLv3+).