2011-09-12 08:58:10 +00:00
|
|
|
cdist(1)
|
|
|
|
========
|
2016-06-23 14:08:59 +00:00
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
|
|
|
cdist - Usable Configuration Management
|
2011-09-12 08:58:10 +00:00
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
2011-09-13 20:48:14 +00:00
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
::
|
|
|
|
|
2019-09-20 05:15:37 +00:00
|
|
|
cdist [-h] [-V] {banner,config,install,inventory,preos,shell} ...
|
2016-05-20 06:50:56 +00:00
|
|
|
|
2017-09-09 19:17:29 +00:00
|
|
|
cdist banner [-h] [-l LOGLEVEL] [-q] [-v]
|
2011-09-13 20:48:14 +00:00
|
|
|
|
2019-01-28 18:09:36 +00:00
|
|
|
cdist config [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-g CONFIG_FILE] [-4]
|
|
|
|
[-6] [-C CACHE_PATH_PATTERN] [-c CONF_DIR] [-i MANIFEST]
|
|
|
|
[-j [JOBS]] [-n] [-o OUT_PATH] [-P]
|
|
|
|
[-R [{tar,tgz,tbz2,txz}]] [-r REMOTE_OUT_PATH]
|
|
|
|
[--remote-copy REMOTE_COPY] [--remote-exec REMOTE_EXEC]
|
|
|
|
[-S] [-I INVENTORY_DIR] [-A] [-a] [-f HOSTFILE]
|
|
|
|
[-p [HOST_MAX]] [-s] [-t]
|
|
|
|
[host [host ...]]
|
|
|
|
|
|
|
|
cdist install [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-g CONFIG_FILE] [-4]
|
|
|
|
[-6] [-C CACHE_PATH_PATTERN] [-c CONF_DIR] [-i MANIFEST]
|
|
|
|
[-j [JOBS]] [-n] [-o OUT_PATH] [-P]
|
|
|
|
[-R [{tar,tgz,tbz2,txz}]] [-r REMOTE_OUT_PATH]
|
|
|
|
[--remote-copy REMOTE_COPY] [--remote-exec REMOTE_EXEC]
|
|
|
|
[-S] [-I INVENTORY_DIR] [-A] [-a] [-f HOSTFILE]
|
|
|
|
[-p [HOST_MAX]] [-s] [-t]
|
|
|
|
[host [host ...]]
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-02-28 22:29:45 +00:00
|
|
|
cdist inventory [-h] {add-host,add-tag,del-host,del-tag,list} ...
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2017-09-09 19:17:29 +00:00
|
|
|
cdist inventory add-host [-h] [-l LOGLEVEL] [-q] [-v] [-b]
|
|
|
|
[-g CONFIG_FILE] [-I INVENTORY_DIR]
|
|
|
|
[-f HOSTFILE]
|
2017-07-20 20:04:44 +00:00
|
|
|
[host [host ...]]
|
|
|
|
|
2017-09-09 19:17:29 +00:00
|
|
|
cdist inventory add-tag [-h] [-l LOGLEVEL] [-q] [-v] [-b]
|
|
|
|
[-g CONFIG_FILE] [-I INVENTORY_DIR]
|
|
|
|
[-f HOSTFILE] [-T TAGFILE] [-t TAGLIST]
|
2017-07-20 20:04:44 +00:00
|
|
|
[host [host ...]]
|
|
|
|
|
2017-09-09 19:17:29 +00:00
|
|
|
cdist inventory del-host [-h] [-l LOGLEVEL] [-q] [-v] [-b]
|
|
|
|
[-g CONFIG_FILE] [-I INVENTORY_DIR] [-a]
|
|
|
|
[-f HOSTFILE]
|
2017-07-20 20:04:44 +00:00
|
|
|
[host [host ...]]
|
|
|
|
|
2017-09-09 19:17:29 +00:00
|
|
|
cdist inventory del-tag [-h] [-l LOGLEVEL] [-q] [-v] [-b]
|
|
|
|
[-g CONFIG_FILE] [-I INVENTORY_DIR] [-a]
|
|
|
|
[-f HOSTFILE] [-T TAGFILE] [-t TAGLIST]
|
2017-07-20 20:04:44 +00:00
|
|
|
[host [host ...]]
|
|
|
|
|
2017-09-09 19:17:29 +00:00
|
|
|
cdist inventory list [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-g CONFIG_FILE]
|
2017-08-30 21:02:17 +00:00
|
|
|
[-I INVENTORY_DIR] [-a] [-f HOSTFILE] [-H] [-t]
|
2017-07-20 20:04:44 +00:00
|
|
|
[host [host ...]]
|
2016-10-13 19:38:34 +00:00
|
|
|
|
2019-09-20 05:15:37 +00:00
|
|
|
cdist preos [-h] preos
|
|
|
|
|
|
|
|
cdist preos debian [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-a ARCH] [-B]
|
|
|
|
[-C] [-c CDIST_PARAMS] [-D DRIVE] [-e REMOTE_EXEC]
|
|
|
|
[-i MANIFEST] [-k KEYFILE ] [-m MIRROR]
|
|
|
|
[-P ROOT_PASSWORD] [-p PXE_BOOT_DIR] [-r]
|
|
|
|
[-S SCRIPT] [-s SUITE] [-y REMOTE_COPY]
|
|
|
|
target_dir
|
|
|
|
|
|
|
|
cdist preos devuan [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-a ARCH] [-B]
|
|
|
|
[-C] [-c CDIST_PARAMS] [-D DRIVE] [-e REMOTE_EXEC]
|
|
|
|
[-i MANIFEST] [-k KEYFILE ] [-m MIRROR]
|
|
|
|
[-P ROOT_PASSWORD] [-p PXE_BOOT_DIR] [-r]
|
|
|
|
[-S SCRIPT] [-s SUITE] [-y REMOTE_COPY]
|
|
|
|
target_dir
|
|
|
|
|
|
|
|
cdist preos ubuntu [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-a ARCH] [-B]
|
|
|
|
[-C] [-c CDIST_PARAMS] [-D DRIVE] [-e REMOTE_EXEC]
|
|
|
|
[-i MANIFEST] [-k KEYFILE ] [-m MIRROR]
|
|
|
|
[-P ROOT_PASSWORD] [-p PXE_BOOT_DIR] [-r]
|
|
|
|
[-S SCRIPT] [-s SUITE] [-y REMOTE_COPY]
|
|
|
|
target_dir
|
|
|
|
|
2017-09-09 19:17:29 +00:00
|
|
|
cdist shell [-h] [-l LOGLEVEL] [-q] [-v] [-s SHELL]
|
2011-09-12 08:58:10 +00:00
|
|
|
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
|
|
|
cdist is the frontend executable to the cdist configuration management.
|
2016-07-20 06:16:58 +00:00
|
|
|
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.
|
2013-08-12 09:42:00 +00:00
|
|
|
|
|
|
|
GENERAL
|
|
|
|
-------
|
2014-04-29 19:33:18 +00:00
|
|
|
All commands accept the following options:
|
2013-08-12 09:42:00 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-h, --help**
|
2017-08-17 06:24:58 +00:00
|
|
|
Show the help screen.
|
2011-09-13 19:35:57 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-l LOGLEVEL, --log-level LOGLEVEL**
|
2017-09-09 19:17:29 +00:00
|
|
|
Set the specified verbosity level. The levels, in
|
|
|
|
order from the lowest to the highest, are: ERROR (-1),
|
|
|
|
WARNING (0), INFO (1), VERBOSE (2), DEBUG (3) TRACE (4
|
|
|
|
or higher). If used along with -v then -v increases
|
|
|
|
last set value and -l overwrites last set value.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-q, --quiet**
|
2017-08-17 06:24:58 +00:00
|
|
|
Quiet mode: disables logging, including WARNING and ERROR.
|
2017-06-28 08:18:53 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-v, --verbose**
|
2017-09-09 19:17:29 +00:00
|
|
|
Increase the verbosity level. Every instance of -v
|
|
|
|
increments the verbosity level by one. Its default
|
|
|
|
value is 0 which includes ERROR and WARNING levels.
|
|
|
|
The levels, in order from the lowest to the highest,
|
|
|
|
are: ERROR (-1), WARNING (0), INFO (1), VERBOSE (2),
|
|
|
|
DEBUG (3) TRACE (4 or higher). If used along with -l
|
|
|
|
then -l overwrites last set value and -v increases
|
|
|
|
last set value.
|
2013-08-12 09:42:00 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-V, --version**
|
2017-08-17 06:24:58 +00:00
|
|
|
Show version and exit.
|
2011-09-12 08:58:10 +00:00
|
|
|
|
|
|
|
|
2011-09-13 19:35:57 +00:00
|
|
|
BANNER
|
2013-08-12 09:42:00 +00:00
|
|
|
------
|
|
|
|
Displays the cdist banner. Useful for printing
|
|
|
|
cdist posters - a must have for every office.
|
2011-09-13 19:35:57 +00:00
|
|
|
|
|
|
|
|
2016-10-13 19:38:34 +00:00
|
|
|
CONFIG/INSTALL
|
|
|
|
--------------
|
|
|
|
Configure/install one or more hosts.
|
2017-08-17 06:24:58 +00:00
|
|
|
Install command is currently in beta.
|
2011-09-13 19:35:57 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-4, --force-ipv4**
|
2018-02-15 19:33:36 +00:00
|
|
|
Force to use IPv4 addresses only. No influence for
|
|
|
|
custom remote commands.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-6, --force-ipv6**
|
2018-02-15 19:33:36 +00:00
|
|
|
Force to use IPv6 addresses only. No influence for
|
|
|
|
custom remote commands.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-A, --all-tagged**
|
2017-08-17 06:24:58 +00:00
|
|
|
Use all hosts present in tags db. Currently in beta.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-a, --all**
|
2017-08-17 06:24:58 +00:00
|
|
|
List hosts that have all specified tags, if -t/--tag
|
|
|
|
is specified.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-b, --beta**
|
2017-06-30 15:01:07 +00:00
|
|
|
Enable beta functionality.
|
2017-08-30 21:02:17 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-C CACHE_PATH_PATTERN, --cache-path-pattern CACHE_PATH_PATTERN**
|
2018-03-18 17:38:44 +00:00
|
|
|
Specify custom cache path pattern. If it is not set then
|
2017-07-01 21:59:51 +00:00
|
|
|
default hostdir is used. For more info on format see
|
|
|
|
:strong:`CACHE PATH PATTERN FORMAT` below.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-c CONF_DIR, --conf-dir CONF_DIR**
|
2012-11-30 12:48:34 +00:00
|
|
|
Add a configuration directory. Can be specified multiple times.
|
|
|
|
If configuration directories contain conflicting types, explorers or
|
2017-08-17 06:24:58 +00:00
|
|
|
manifests, then the last one found is used.
|
2011-09-12 09:18:18 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-f HOSTFILE, --file HOSTFILE**
|
2017-06-30 15:45:14 +00:00
|
|
|
Read specified file for a list of additional hosts to operate on
|
|
|
|
or if '-' is given, read stdin (one host per line).
|
2016-05-22 07:45:08 +00:00
|
|
|
If no host or host file is specified then, by default,
|
2017-07-01 21:59:51 +00:00
|
|
|
read hosts from stdin. For the file format see
|
|
|
|
:strong:`HOSTFILE FORMAT` below.
|
2016-05-22 07:22:39 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-g CONFIG_FILE, --config-file CONFIG_FILE**
|
2017-08-30 21:02:17 +00:00
|
|
|
Use specified custom configuration file.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-I INVENTORY_DIR, --inventory INVENTORY_DIR**
|
2017-07-20 20:04:44 +00:00
|
|
|
Use specified custom inventory directory. Inventory
|
2017-08-30 21:02:17 +00:00
|
|
|
directory is set up by the following rules: if cdist
|
|
|
|
configuration resolves this value then specified
|
|
|
|
directory is used, if HOME env var is set then
|
|
|
|
~/.cdit/inventory is used, otherwise distribution
|
|
|
|
inventory directory is used.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-i MANIFEST, --initial-manifest MANIFEST**
|
2017-08-17 06:24:58 +00:00
|
|
|
Path to a cdist manifest or - to read from stdin.
|
2011-09-12 09:18:18 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-j [JOBS], --jobs [JOBS]**
|
2017-07-25 09:12:18 +00:00
|
|
|
Operate in parallel in specified maximum number of
|
|
|
|
jobs. Global explorers, object prepare and object run
|
|
|
|
are supported. Without argument CPU count is used by
|
2019-04-13 19:18:27 +00:00
|
|
|
default.
|
2016-08-15 14:37:38 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-n, --dry-run**
|
2017-08-17 06:24:58 +00:00
|
|
|
Do not execute code.
|
2016-08-14 18:11:45 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-o OUT_PATH, --out-dir OUT_PATH**
|
2017-08-17 06:24:58 +00:00
|
|
|
Directory to save cdist output in.
|
2016-08-14 18:11:45 +00:00
|
|
|
|
2018-09-23 18:34:42 +00:00
|
|
|
**-P, --timestamp**
|
|
|
|
Timestamp log messages with the current local date and time
|
|
|
|
in the format: YYYYMMDDHHMMSS.us.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-p [HOST_MAX], --parallel [HOST_MAX]**
|
2017-07-25 09:12:18 +00:00
|
|
|
Operate on multiple hosts in parallel for specified
|
|
|
|
maximum hosts at a time. Without argument CPU count is
|
|
|
|
used by default.
|
2011-09-12 09:18:18 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-R [{tar,tgz,tbz2,txz}], --use-archiving [{tar,tgz,tbz2,txz}]**
|
2017-08-11 12:10:29 +00:00
|
|
|
Operate by using archiving with compression where
|
2017-08-25 08:50:11 +00:00
|
|
|
appropriate. Supported values are: tar - tar archive,
|
2017-08-11 12:10:29 +00:00
|
|
|
tgz - gzip tar archive (the default), tbz2 - bzip2 tar
|
2017-08-17 06:24:58 +00:00
|
|
|
archive and txz - lzma tar archive. Currently in beta.
|
2017-08-11 12:10:29 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-r REMOTE_OUT_PATH, --remote-out-dir REMOTE_OUT_PATH**
|
2017-08-17 06:24:58 +00:00
|
|
|
Directory to save cdist output in on the target host.
|
2017-06-27 15:49:58 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-S, --disable-saving-output-streams**
|
2018-02-07 17:12:15 +00:00
|
|
|
Disable saving output streams.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-s, --sequential**
|
2017-08-17 06:24:58 +00:00
|
|
|
Operate on multiple hosts sequentially (default).
|
2012-05-22 13:06:04 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**--remote-copy REMOTE_COPY**
|
2017-08-17 06:24:58 +00:00
|
|
|
Command to use for remote copy (should behave like scp).
|
2012-05-22 13:06:04 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**--remote-exec REMOTE_EXEC**
|
2017-08-17 06:24:58 +00:00
|
|
|
Command to use for remote execution (should behave like ssh).
|
2011-09-12 08:58:10 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-t, --tag**
|
2017-08-17 06:24:58 +00:00
|
|
|
Host is specified by tag, not hostname/address; list
|
|
|
|
all hosts that contain any of specified tags.
|
|
|
|
Currently in beta.
|
2016-08-19 12:33:41 +00:00
|
|
|
|
|
|
|
HOSTFILE FORMAT
|
|
|
|
~~~~~~~~~~~~~~~
|
2017-06-30 15:45:14 +00:00
|
|
|
The HOSTFILE contains one host per line.
|
|
|
|
A comment is started with '#' and continues to the end of the line.
|
|
|
|
Any leading and trailing whitespace on a line is ignored.
|
2016-08-20 05:49:52 +00:00
|
|
|
Empty lines are ignored/skipped.
|
|
|
|
|
2017-06-30 15:45:14 +00:00
|
|
|
|
|
|
|
The Hostfile lines are processed as follows. First, all comments are
|
2016-08-20 05:49:52 +00:00
|
|
|
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
|
|
|
|
2017-07-01 21:59:51 +00:00
|
|
|
CACHE PATH PATTERN FORMAT
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Cache path pattern specifies path for a cache directory subdirectory.
|
|
|
|
In the path, '%N' will be substituted by the target host, '%h' will
|
|
|
|
be substituted by the calculated host directory, '%P' will be substituted
|
|
|
|
by the current process id. All format codes that
|
|
|
|
:strong:`python` :strong:`datetime.strftime()` function supports, except
|
|
|
|
'%h', are supported. These date/time directives format cdist config/install
|
|
|
|
start time.
|
|
|
|
|
|
|
|
If empty pattern is specified then default calculated host directory
|
|
|
|
is used.
|
|
|
|
|
|
|
|
Calculated host directory is a hash of a host cdist operates on.
|
|
|
|
|
|
|
|
Resulting path is used to specify cache path subdirectory under which
|
|
|
|
current host cache data are saved.
|
|
|
|
|
2016-08-19 12:33:41 +00:00
|
|
|
|
2017-07-20 20:04:44 +00:00
|
|
|
INVENTORY
|
|
|
|
---------
|
|
|
|
Manage inventory database.
|
|
|
|
Currently in beta with all sub-commands.
|
|
|
|
|
|
|
|
|
|
|
|
INVENTORY ADD-HOST
|
|
|
|
------------------
|
|
|
|
Add host(s) to inventory database.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**host**
|
2017-08-17 06:24:58 +00:00
|
|
|
Host(s) to add.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-b, --beta**
|
2017-08-17 06:24:58 +00:00
|
|
|
Enable beta functionality.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-f HOSTFILE, --file HOSTFILE**
|
2017-07-20 20:04:44 +00:00
|
|
|
Read additional hosts to add from specified file or
|
|
|
|
from stdin if '-' (each host on separate line). If no
|
|
|
|
host or host file is specified then, by default, read
|
|
|
|
from stdin. Hostfile format is the same as config hostfile format.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-g CONFIG_FILE, --config-file CONFIG_FILE**
|
2017-08-30 21:02:17 +00:00
|
|
|
Use specified custom configuration file.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-I INVENTORY_DIR, --inventory INVENTORY_DIR**
|
2017-07-20 20:04:44 +00:00
|
|
|
Use specified custom inventory directory. Inventory
|
2017-08-30 21:02:17 +00:00
|
|
|
directory is set up by the following rules: if cdist
|
|
|
|
configuration resolves this value then specified
|
|
|
|
directory is used, if HOME env var is set then
|
|
|
|
~/.cdit/inventory is used, otherwise distribution
|
|
|
|
inventory directory is used.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
|
|
|
|
|
|
|
INVENTORY ADD-TAG
|
|
|
|
-----------------
|
|
|
|
Add tag(s) to inventory database.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**host**
|
2017-08-17 06:24:58 +00:00
|
|
|
List of host(s) for which tags are added.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-b, --beta**
|
2017-08-17 06:24:58 +00:00
|
|
|
Enable beta functionality.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-f HOSTFILE, --file HOSTFILE**
|
2017-07-20 20:04:44 +00:00
|
|
|
Read additional hosts to add tags from specified file
|
|
|
|
or from stdin if '-' (each host on separate line). If
|
|
|
|
no host or host file is specified then, by default,
|
|
|
|
read from stdin. If no tags/tagfile nor hosts/hostfile
|
|
|
|
are specified then tags are read from stdin and are
|
|
|
|
added to all hosts. Hostfile format is the same as config hostfile format.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-g CONFIG_FILE, --config-file CONFIG_FILE**
|
2017-08-30 21:02:17 +00:00
|
|
|
Use specified custom configuration file.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-I INVENTORY_DIR, --inventory INVENTORY_DIR**
|
2017-07-20 20:04:44 +00:00
|
|
|
Use specified custom inventory directory. Inventory
|
2017-08-30 21:02:17 +00:00
|
|
|
directory is set up by the following rules: if cdist
|
|
|
|
configuration resolves this value then specified
|
|
|
|
directory is used, if HOME env var is set then
|
|
|
|
~/.cdit/inventory is used, otherwise distribution
|
|
|
|
inventory directory is used.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-T TAGFILE, --tag-file TAGFILE**
|
2017-07-20 20:04:44 +00:00
|
|
|
Read additional tags to add from specified file or
|
|
|
|
from stdin if '-' (each tag on separate line). If no
|
|
|
|
tag or tag file is specified then, by default, read
|
|
|
|
from stdin. If no tags/tagfile nor hosts/hostfile are
|
|
|
|
specified then tags are read from stdin and are added
|
|
|
|
to all hosts. Tagfile format is the same as config hostfile format.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-t TAGLIST, --taglist TAGLIST**
|
2017-07-20 20:04:44 +00:00
|
|
|
Tag list to be added for specified host(s), comma
|
2017-08-17 06:24:58 +00:00
|
|
|
separated values.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
|
|
|
|
|
|
|
INVENTORY DEL-HOST
|
|
|
|
------------------
|
|
|
|
Delete host(s) from inventory database.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**host**
|
2017-08-17 06:24:58 +00:00
|
|
|
Host(s) to delete.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-a, --all**
|
2017-08-17 06:24:58 +00:00
|
|
|
Delete all hosts.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-b, --beta**
|
2017-08-17 06:24:58 +00:00
|
|
|
Enable beta functionality.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-f HOSTFILE, --file HOSTFILE**
|
2017-07-20 20:04:44 +00:00
|
|
|
Read additional hosts to delete from specified file or
|
|
|
|
from stdin if '-' (each host on separate line). If no
|
|
|
|
host or host file is specified then, by default, read
|
|
|
|
from stdin. Hostfile format is the same as config hostfile format.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-g CONFIG_FILE, --config-file CONFIG_FILE**
|
2017-08-30 21:02:17 +00:00
|
|
|
Use specified custom configuration file.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-I INVENTORY_DIR, --inventory INVENTORY_DIR**
|
2017-07-20 20:04:44 +00:00
|
|
|
Use specified custom inventory directory. Inventory
|
2017-08-30 21:02:17 +00:00
|
|
|
directory is set up by the following rules: if cdist
|
|
|
|
configuration resolves this value then specified
|
|
|
|
directory is used, if HOME env var is set then
|
|
|
|
~/.cdit/inventory is used, otherwise distribution
|
|
|
|
inventory directory is used.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
|
|
|
|
|
|
|
INVENTORY DEL-TAG
|
|
|
|
-----------------
|
|
|
|
Delete tag(s) from inventory database.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**host**
|
2017-08-17 06:24:58 +00:00
|
|
|
List of host(s) for which tags are deleted.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-a, --all**
|
2017-08-17 06:24:58 +00:00
|
|
|
Delete all tags for specified host(s).
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-b, --beta**
|
2017-08-17 06:24:58 +00:00
|
|
|
Enable beta functionality.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-f HOSTFILE, --file HOSTFILE**
|
2017-07-20 20:04:44 +00:00
|
|
|
Read additional hosts to delete tags for from
|
|
|
|
specified file or from stdin if '-' (each host on
|
|
|
|
separate line). If no host or host file is specified
|
|
|
|
then, by default, read from stdin. If no tags/tagfile
|
|
|
|
nor hosts/hostfile are specified then tags are read
|
|
|
|
from stdin and are deleted from all hosts. Hostfile
|
|
|
|
format is the same as config hostfile format.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-g CONFIG_FILE, --config-file CONFIG_FILE**
|
2017-08-30 21:02:17 +00:00
|
|
|
Use specified custom configuration file.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-I INVENTORY_DIR, --inventory INVENTORY_DIR**
|
2017-07-20 20:04:44 +00:00
|
|
|
Use specified custom inventory directory. Inventory
|
2017-08-30 21:02:17 +00:00
|
|
|
directory is set up by the following rules: if cdist
|
|
|
|
configuration resolves this value then specified
|
|
|
|
directory is used, if HOME env var is set then
|
|
|
|
~/.cdit/inventory is used, otherwise distribution
|
|
|
|
inventory directory is used.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-T TAGFILE, --tag-file TAGFILE**
|
2017-07-20 20:04:44 +00:00
|
|
|
Read additional tags from specified file or from stdin
|
|
|
|
if '-' (each tag on separate line). If no tag or tag
|
|
|
|
file is specified then, by default, read from stdin.
|
|
|
|
If no tags/tagfile nor hosts/hostfile are specified
|
|
|
|
then tags are read from stdin and are added to all
|
|
|
|
hosts. Tagfile format is the same as config hostfile format.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-t TAGLIST, --taglist TAGLIST**
|
2017-07-20 20:04:44 +00:00
|
|
|
Tag list to be deleted for specified host(s), comma
|
2017-08-17 06:24:58 +00:00
|
|
|
separated values.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
|
|
|
|
|
|
|
INVENTORY LIST
|
|
|
|
--------------
|
|
|
|
List inventory database.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**host**
|
2017-08-17 06:24:58 +00:00
|
|
|
Host(s) to list.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-a, --all**
|
2017-08-17 06:24:58 +00:00
|
|
|
List hosts that have all specified tags, if -t/--tag
|
|
|
|
is specified.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-b, --beta**
|
2017-08-17 06:24:58 +00:00
|
|
|
Enable beta functionality.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-f HOSTFILE, --file HOSTFILE**
|
2017-07-20 20:04:44 +00:00
|
|
|
Read additional hosts to list from specified file or
|
|
|
|
from stdin if '-' (each host on separate line). If no
|
|
|
|
host or host file is specified then, by default, list
|
|
|
|
all. Hostfile format is the same as config hostfile format.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-g CONFIG_FILE, --config-file CONFIG_FILE**
|
2017-08-30 21:02:17 +00:00
|
|
|
Use specified custom configuration file.
|
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-H, --host-only**
|
2017-08-17 06:24:58 +00:00
|
|
|
Suppress tags listing.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-I INVENTORY_DIR, --inventory INVENTORY_DIR**
|
2017-07-20 20:04:44 +00:00
|
|
|
Use specified custom inventory directory. Inventory
|
2017-08-30 21:02:17 +00:00
|
|
|
directory is set up by the following rules: if cdist
|
|
|
|
configuration resolves this value then specified
|
|
|
|
directory is used, if HOME env var is set then
|
|
|
|
~/.cdit/inventory is used, otherwise distribution
|
|
|
|
inventory directory is used.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-t, --tag**
|
2017-08-17 06:24:58 +00:00
|
|
|
Host is specified by tag, not hostname/address; list
|
|
|
|
all hosts that contain any of specified tags.
|
2017-07-20 20:04:44 +00:00
|
|
|
|
|
|
|
|
2019-09-20 05:15:37 +00:00
|
|
|
PREOS
|
|
|
|
-----
|
|
|
|
Create PreOS. Currently, the following PreOS-es are supported:
|
|
|
|
|
|
|
|
* debian
|
|
|
|
* ubuntu
|
|
|
|
* devuan
|
|
|
|
|
|
|
|
|
|
|
|
PREOS DEBIAN/DEVUAN
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
**target_dir**
|
|
|
|
target directory where PreOS will be bootstrapped
|
|
|
|
|
|
|
|
**-a ARCH, --arch ARCH**
|
|
|
|
target debootstrap architecture, by default 'amd64'
|
|
|
|
|
|
|
|
**-B, --bootstrap**
|
|
|
|
do bootstrap step
|
|
|
|
|
|
|
|
**-b, --beta**
|
|
|
|
Enable beta functionality.
|
|
|
|
|
|
|
|
**-C, --configure**
|
|
|
|
do configure step
|
|
|
|
|
|
|
|
**-c CDIST_PARAMS, --cdist-params CDIST_PARAMS**
|
|
|
|
parameters that will be passed to cdist config, by
|
|
|
|
default '-v' is used
|
|
|
|
|
|
|
|
**-D DRIVE, --drive-boot DRIVE**
|
|
|
|
create bootable PreOS on specified drive
|
|
|
|
|
|
|
|
**-e REMOTE_EXEC, --remote-exec REMOTE_EXEC**
|
|
|
|
remote exec that cdist config will use, by default
|
|
|
|
internal script is used
|
|
|
|
|
|
|
|
**-i MANIFEST, --init-manifest MANIFEST**
|
|
|
|
init manifest that cdist config will use, by default
|
|
|
|
internal init manifest is used
|
|
|
|
|
|
|
|
**-k KEYFILE, --keyfile KEYFILE**
|
|
|
|
ssh key files that will be added to cdist config;
|
|
|
|
'``__ssh_authorized_keys root ...``' type is appended to initial manifest
|
|
|
|
|
|
|
|
**-m MIRROR, --mirror MIRROR**
|
|
|
|
use specified mirror for debootstrap
|
|
|
|
|
|
|
|
**-P ROOT_PASSWORD, --root-password ROOT_PASSWORD**
|
|
|
|
Set specified password for root, generated by default
|
|
|
|
|
|
|
|
**-p PXE_BOOT_DIR, --pxe-boot-dir PXE_BOOT_DIR**
|
|
|
|
PXE boot directory
|
|
|
|
|
|
|
|
**-r, --rm-bootstrap-dir**
|
|
|
|
remove target directory after finishing
|
|
|
|
|
|
|
|
**-S SCRIPT, --script SCRIPT**
|
|
|
|
use specified script for debootstrap
|
|
|
|
|
|
|
|
**-s SUITE, --suite SUITE**
|
|
|
|
suite used for debootstrap, by default 'stable'
|
|
|
|
|
|
|
|
**-y REMOTE_COPY, --remote-copy REMOTE_COPY**
|
|
|
|
remote copy that cdist config will use, by default
|
|
|
|
internal script is used
|
|
|
|
|
|
|
|
|
|
|
|
PREOS UBUNTU
|
|
|
|
------------
|
|
|
|
|
|
|
|
**target_dir**
|
|
|
|
target directory where PreOS will be bootstrapped
|
|
|
|
|
|
|
|
**-a ARCH, --arch ARCH**
|
|
|
|
target debootstrap architecture, by default 'amd64'
|
|
|
|
|
|
|
|
**-B, --bootstrap**
|
|
|
|
do bootstrap step
|
|
|
|
|
|
|
|
**-b, --beta**
|
|
|
|
Enable beta functionality.
|
|
|
|
|
|
|
|
**-C, --configure**
|
|
|
|
do configure step
|
|
|
|
|
|
|
|
**-c CDIST_PARAMS, --cdist-params CDIST_PARAMS**
|
|
|
|
parameters that will be passed to cdist config, by
|
|
|
|
default '-v' is used
|
|
|
|
|
|
|
|
**-D DRIVE, --drive-boot DRIVE**
|
|
|
|
create bootable PreOS on specified drive
|
|
|
|
|
|
|
|
**-e REMOTE_EXEC, --remote-exec REMOTE_EXEC**
|
|
|
|
remote exec that cdist config will use, by default
|
|
|
|
internal script is used
|
|
|
|
|
|
|
|
**-i MANIFEST, --init-manifest MANIFEST**
|
|
|
|
init manifest that cdist config will use, by default
|
|
|
|
internal init manifest is used
|
|
|
|
|
|
|
|
**-k KEYFILE, --keyfile KEYFILE**
|
|
|
|
ssh key files that will be added to cdist config;
|
|
|
|
'``__ssh_authorized_keys root ...``' type is appended to initial manifest
|
|
|
|
|
|
|
|
**-m MIRROR, --mirror MIRROR**
|
|
|
|
use specified mirror for debootstrap
|
|
|
|
|
|
|
|
**-P ROOT_PASSWORD, --root-password ROOT_PASSWORD**
|
|
|
|
Set specified password for root, generated by default
|
|
|
|
|
|
|
|
**-p PXE_BOOT_DIR, --pxe-boot-dir PXE_BOOT_DIR**
|
|
|
|
PXE boot directory
|
|
|
|
|
|
|
|
**-r, --rm-bootstrap-dir**
|
|
|
|
remove target directory after finishing
|
|
|
|
|
|
|
|
**-S SCRIPT, --script SCRIPT**
|
|
|
|
use specified script for debootstrap
|
|
|
|
|
|
|
|
**-s SUITE, --suite SUITE**
|
|
|
|
suite used for debootstrap, by default 'xenial'
|
|
|
|
|
|
|
|
**-y REMOTE_COPY, --remote-copy REMOTE_COPY**
|
|
|
|
remote copy that cdist config will use, by default
|
|
|
|
internal script is used
|
|
|
|
|
|
|
|
|
2013-08-12 09:42:00 +00:00
|
|
|
SHELL
|
|
|
|
-----
|
2013-08-12 10:32:58 +00:00
|
|
|
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.
|
2013-08-12 09:42:00 +00:00
|
|
|
|
2018-03-15 17:01:23 +00:00
|
|
|
**-s SHELL, --shell SHELL**
|
2016-07-19 11:00:14 +00:00
|
|
|
Select shell to use, defaults to current shell. Used shell should
|
|
|
|
be POSIX compatible shell.
|
2013-08-12 09:42:00 +00:00
|
|
|
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2017-09-01 08:40:01 +00:00
|
|
|
CONFIGURATION
|
|
|
|
-------------
|
2017-08-30 21:02:17 +00:00
|
|
|
cdist obtains configuration data from the following sources in the following
|
2017-09-01 08:40:01 +00:00
|
|
|
order (from higher to lower precedence):
|
2017-08-30 21:02:17 +00:00
|
|
|
|
|
|
|
#. command-line options
|
|
|
|
#. configuration file specified at command-line
|
|
|
|
#. configuration file specified in CDIST_CONFIG_FILE environment variable
|
|
|
|
#. environment variables
|
2017-09-01 08:40:01 +00:00
|
|
|
#. user's configuration file (first one found of ~/.cdist.cfg, $XDG_CONFIG_HOME/cdist/cdist.cfg, in specified order)
|
|
|
|
#. system-wide configuration file (/etc/cdist.cfg).
|
2017-08-30 21:02:17 +00:00
|
|
|
|
2017-09-01 08:40:01 +00:00
|
|
|
CONFIGURATION FILE FORMAT
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
2017-08-30 21:02:17 +00:00
|
|
|
cdist configuration file is in the INI file format. Currently it supports
|
|
|
|
only [GLOBAL] section.
|
|
|
|
The possible keywords and their meanings are as follows:
|
|
|
|
|
|
|
|
:strong:`archiving`
|
|
|
|
Use specified archiving. Valid values include:
|
|
|
|
'none', 'tar', 'tgz', 'tbz2' and 'txz'.
|
|
|
|
|
|
|
|
:strong:`beta`
|
|
|
|
Enable beta functionality. It recognizes boolean values from
|
2017-09-19 10:07:15 +00:00
|
|
|
'yes'/'no', 'on'/'off', 'true'/'false' and '1'/'0'.
|
2017-08-30 21:02:17 +00:00
|
|
|
|
|
|
|
:strong:`cache_path_pattern`
|
|
|
|
Specify cache path pattern.
|
|
|
|
|
|
|
|
:strong:`conf_dir`
|
2017-09-19 11:52:49 +00:00
|
|
|
List of configuration directories separated with the character conventionally
|
|
|
|
used by the operating system to separate search path components (as in PATH),
|
|
|
|
such as ':' for POSIX or ';' for Windows.
|
2017-08-30 21:02:17 +00:00
|
|
|
If also specified at command line then values from command line are
|
|
|
|
appended to this value.
|
|
|
|
|
|
|
|
:strong:`init_manifest`
|
|
|
|
Specify default initial manifest.
|
|
|
|
|
|
|
|
:strong:`inventory_dir`
|
|
|
|
Specify inventory directory.
|
|
|
|
|
|
|
|
:strong:`jobs`
|
|
|
|
Specify number of jobs for parallel processing. If -1 then the default,
|
|
|
|
number of CPU's in the system is used. If 0 then parallel processing in
|
|
|
|
jobs is disabled. If set to positive number then specified maximum
|
|
|
|
number of processes will be used.
|
|
|
|
|
|
|
|
:strong:`local_shell`
|
|
|
|
Shell command used for local execution.
|
|
|
|
|
|
|
|
:strong:`out_path`
|
|
|
|
Directory to save cdist output in.
|
|
|
|
|
|
|
|
:strong:`parallel`
|
|
|
|
Process hosts in parallel. If -1 then the default, number of CPU's in
|
|
|
|
the system is used. If 0 then parallel processing of hosts is disabled.
|
|
|
|
If set to positive number then specified maximum number of processes
|
|
|
|
will be used.
|
|
|
|
|
|
|
|
:strong:`remote_copy`
|
|
|
|
Command to use for remote copy (should behave like scp).
|
|
|
|
|
|
|
|
:strong:`remote_exec`
|
|
|
|
Command to use for remote execution (should behave like ssh).
|
|
|
|
|
|
|
|
:strong:`remote_out_path`
|
|
|
|
Directory to save cdist output in on the target host.
|
|
|
|
|
|
|
|
:strong:`remote_shell`
|
|
|
|
Shell command at remote host used for remote execution.
|
|
|
|
|
2018-02-07 17:12:15 +00:00
|
|
|
:strong:`save_output_streams`
|
|
|
|
Enable/disable saving output streams (enabled by default).
|
|
|
|
It recognizes boolean values from 'yes'/'no', 'on'/'off', 'true'/'false'
|
|
|
|
and '1'/'0'.
|
|
|
|
|
2018-09-27 16:55:33 +00:00
|
|
|
:strong:`timestamp`
|
|
|
|
Timestamp log messages with the current local date and time
|
|
|
|
in the format: YYYYMMDDHHMMSS.us.
|
|
|
|
|
2017-08-30 21:02:17 +00:00
|
|
|
:strong:`verbosity`
|
|
|
|
Set verbosity level. Valid values are:
|
|
|
|
'ERROR', 'WARNING', 'INFO', 'VERBOSE', 'DEBUG', 'TRACE' and 'OFF'.
|
|
|
|
|
|
|
|
|
2016-07-19 11:00:14 +00:00
|
|
|
FILES
|
|
|
|
-----
|
|
|
|
~/.cdist
|
|
|
|
Your personal cdist config directory. If exists it will be
|
|
|
|
automatically used.
|
2018-01-14 09:03:57 +00:00
|
|
|
~/.cdist/cache
|
|
|
|
Local cache directory.
|
2017-07-20 20:04:44 +00:00
|
|
|
~/.cdist/inventory
|
|
|
|
The home inventory directory. If ~/.cdist exists it will be used as
|
|
|
|
default inventory directory.
|
2019-09-20 05:15:37 +00:00
|
|
|
~/.cdist/preos
|
|
|
|
PreOS plugins directory, if existing.
|
2016-07-20 06:16:58 +00:00
|
|
|
cdist/conf
|
|
|
|
The distribution configuration directory. It contains official types and
|
|
|
|
explorers. This path is relative to cdist installation directory.
|
2017-07-20 20:04:44 +00:00
|
|
|
cdist/inventory
|
|
|
|
The distribution inventory directory.
|
|
|
|
This path is relative to cdist installation directory.
|
2019-09-20 05:15:37 +00:00
|
|
|
cdist/preos
|
|
|
|
The distribution PreOS plugins directory.
|
2017-08-30 21:02:17 +00:00
|
|
|
/etc/cdist.cfg
|
|
|
|
Global cdist configuration file, if exists.
|
2017-08-30 21:11:10 +00:00
|
|
|
~/.cdist.cfg or $XDG_CONFIG_HOME/cdist/cdist.cfg
|
2017-08-30 21:02:17 +00:00
|
|
|
Local cdist configuration file, if exists.
|
2011-09-12 08:58:10 +00:00
|
|
|
|
2016-11-27 16:02:51 +00:00
|
|
|
NOTES
|
|
|
|
-----
|
|
|
|
cdist detects if host is specified by IPv6 address. If so then remote_copy
|
|
|
|
command is executed with host address enclosed in square brackets
|
|
|
|
(see :strong:`scp`\ (1)).
|
|
|
|
|
2011-09-12 08:58:10 +00:00
|
|
|
EXAMPLES
|
|
|
|
--------
|
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
.. code-block:: sh
|
2012-05-22 13:06:04 +00:00
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
# Configure ikq05.ethz.ch with debug enabled
|
2017-06-30 07:08:22 +00:00
|
|
|
% cdist config -vvv ikq05.ethz.ch
|
2011-09-13 19:35:57 +00:00
|
|
|
|
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
|
2011-09-12 08:58:10 +00:00
|
|
|
|
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
|
2011-09-13 19:35:57 +00:00
|
|
|
|
2016-05-25 05:39:53 +00:00
|
|
|
# Configure hosts read from file loadbalancers
|
|
|
|
% cdist config -f loadbalancers
|
2011-09-13 19:35:57 +00:00
|
|
|
|
2016-08-17 06:07:57 +00:00
|
|
|
# Configure hosts read from file web.hosts using 16 parallel jobs
|
2019-09-20 17:56:17 +00:00
|
|
|
% cdist config -j 16 -f web.hosts
|
2016-08-17 06:07:57 +00:00
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
# Display banner
|
|
|
|
cdist banner
|
2013-08-12 09:42:00 +00:00
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
# Show help
|
|
|
|
% cdist --help
|
2013-08-12 09:42:00 +00:00
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
# Show Version
|
|
|
|
% cdist --version
|
2013-08-12 09:42:00 +00:00
|
|
|
|
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
|
2011-09-12 08:58:10 +00:00
|
|
|
|
2016-10-13 19:38:34 +00:00
|
|
|
# Install ikq05.ethz.ch with debug enabled
|
2017-06-30 07:08:22 +00:00
|
|
|
% cdist install -vvv ikq05.ethz.ch
|
2011-09-12 08:58:10 +00:00
|
|
|
|
2017-07-20 20:04:44 +00:00
|
|
|
# List inventory content
|
|
|
|
% cdist inventory list -b
|
|
|
|
|
|
|
|
# List inventory for specified host localhost
|
|
|
|
% cdist inventory list -b localhost
|
|
|
|
|
|
|
|
# List inventory for specified tag loadbalancer
|
|
|
|
% cdist inventory list -b -t loadbalancer
|
|
|
|
|
|
|
|
# Add hosts to inventory
|
|
|
|
% cdist inventory add-host -b web1 web2 web3
|
|
|
|
|
|
|
|
# Delete hosts from file old-hosts from inventory
|
|
|
|
% cdist inventory del-host -b -f old-hosts
|
|
|
|
|
2018-03-18 17:38:44 +00:00
|
|
|
# Add tags to specified hosts
|
2017-07-20 20:04:44 +00:00
|
|
|
% cdist inventory add-tag -b -t europe,croatia,web,static web1 web2
|
|
|
|
|
|
|
|
# Add tag to all hosts in inventory
|
|
|
|
% cdist inventory add-tag -b -t vm
|
|
|
|
|
|
|
|
# Delete all tags from specified host
|
|
|
|
% cdist inventory del-tag -b -a localhost
|
|
|
|
|
|
|
|
# Delete tags read from stdin from hosts specified by file hosts
|
|
|
|
% cdist inventory del-tag -b -T - -f hosts
|
|
|
|
|
|
|
|
# Configure hosts from inventory with any of specified tags
|
|
|
|
% cdist config -b -t web dynamic
|
|
|
|
|
|
|
|
# Configure hosts from inventory with all specified tags
|
|
|
|
% cdist config -b -t -a web dynamic
|
|
|
|
|
|
|
|
# Configure all hosts from inventory db
|
|
|
|
$ cdist config -b -A
|
|
|
|
|
2019-09-20 05:15:37 +00:00
|
|
|
# Create default debian PreOS in debug mode
|
2019-09-20 17:56:17 +00:00
|
|
|
$ cdist preos debian /preos/preos-debian -vvvv -C \
|
2019-09-20 05:15:37 +00:00
|
|
|
-k ~/.ssh/id_rsa.pub -p /preos/pxe-debian
|
|
|
|
|
|
|
|
# Create ubuntu PreOS
|
2019-09-20 17:56:17 +00:00
|
|
|
$ cdist preos ubuntu /preos/preos-ubuntu -C \
|
2019-09-20 05:15:37 +00:00
|
|
|
-k ~/.ssh/id_rsa.pub -p /preos/pxe-ubuntu
|
|
|
|
|
|
|
|
# Create ubuntu PreOS on drive /dev/sdb
|
|
|
|
# and set root password to 'password'.
|
2019-09-20 17:56:17 +00:00
|
|
|
$ cdist preos ubuntu /mnt -B -C \
|
2019-09-20 05:15:37 +00:00
|
|
|
-k ~/.ssh/id_rsa.pub -D /dev/sdb \
|
|
|
|
-P password
|
|
|
|
|
2017-07-20 20:04:44 +00:00
|
|
|
|
2011-09-18 19:04:23 +00:00
|
|
|
ENVIRONMENT
|
|
|
|
-----------
|
2016-05-20 06:50:56 +00:00
|
|
|
TMPDIR, TEMP, TMP
|
2014-01-20 19:30:37 +00:00
|
|
|
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.
|
|
|
|
|
2016-07-20 06:16:58 +00:00
|
|
|
CDIST_PATH
|
|
|
|
Colon delimited list of config directories.
|
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
CDIST_LOCAL_SHELL
|
2016-07-20 06:16:58 +00:00
|
|
|
Selects shell for local script execution, defaults to /bin/sh.
|
2014-01-20 19:30:37 +00:00
|
|
|
|
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.
|
2016-07-20 06:16:58 +00:00
|
|
|
|
|
|
|
CDIST_OVERRIDE
|
|
|
|
Allow overwriting type parameters.
|
|
|
|
|
|
|
|
CDIST_ORDER_DEPENDENCY
|
|
|
|
Create dependencies based on the execution order.
|
2019-11-22 23:25:51 +00:00
|
|
|
Note that in version 6.2.0 semantic of this processing mode is
|
|
|
|
finally fixed and well defined.
|
2011-09-18 19:04:23 +00:00
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
CDIST_REMOTE_EXEC
|
2016-07-20 06:16:58 +00:00
|
|
|
Use this command for remote execution (should behave like ssh).
|
2016-03-18 22:34:02 +00:00
|
|
|
|
2016-05-20 06:50:56 +00:00
|
|
|
CDIST_REMOTE_COPY
|
2016-07-20 06:16:58 +00:00
|
|
|
Use this command for remote copy (should behave like scp).
|
2012-03-12 19:20:18 +00:00
|
|
|
|
2017-07-20 20:04:44 +00:00
|
|
|
CDIST_INVENTORY_DIR
|
|
|
|
Use this directory as inventory directory.
|
|
|
|
|
2016-12-04 19:27:42 +00:00
|
|
|
CDIST_BETA
|
2017-06-30 15:01:07 +00:00
|
|
|
Enable beta functionality.
|
2016-12-04 19:27:42 +00:00
|
|
|
|
2017-07-01 21:59:51 +00:00
|
|
|
CDIST_CACHE_PATH_PATTERN
|
|
|
|
Custom cache path pattern.
|
|
|
|
|
2017-08-30 21:02:17 +00:00
|
|
|
CDIST_CONFIG_FILE
|
|
|
|
Custom configuration file.
|
|
|
|
|
|
|
|
|
2012-03-12 19:20:18 +00:00
|
|
|
EXIT STATUS
|
|
|
|
-----------
|
|
|
|
The following exit values shall be returned:
|
|
|
|
|
2016-07-20 06:16:58 +00:00
|
|
|
0 Successful completion.
|
|
|
|
|
|
|
|
1 One or more host configurations failed.
|
2012-03-12 19:20:18 +00:00
|
|
|
|
|
|
|
|
2016-06-17 19:28:16 +00:00
|
|
|
AUTHORS
|
|
|
|
-------
|
2016-11-29 06:43:53 +00:00
|
|
|
Originally written by Nico Schottelius <nico-cdist--@--schottelius.org>
|
|
|
|
and Steven Armstrong <steven-cdist--@--armstrong.cc>.
|
2011-09-12 08:58:10 +00:00
|
|
|
|
2017-07-01 21:59:51 +00:00
|
|
|
|
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).
|
|
|
|
|
2016-10-08 09:40:32 +00:00
|
|
|
When requirements for the same object are defined in different manifests (see
|
2017-06-11 11:58:47 +00:00
|
|
|
example below), for example, in init manifest and in some other type manifest
|
|
|
|
and those requirements differ then dependency resolver cannot detect
|
2017-06-30 15:45:14 +00:00
|
|
|
dependencies correctly. This happens because cdist cannot prepare all objects first
|
2017-06-11 11:58:47 +00:00
|
|
|
and run all objects afterwards. Some object can depend on the result of type
|
|
|
|
explorer(s) and explorers are executed during object run. cdist will detect
|
2017-06-30 15:45:14 +00:00
|
|
|
such case and display a warning message. An example of such a case:
|
2016-10-08 09:40:32 +00:00
|
|
|
|
|
|
|
.. code-block:: sh
|
|
|
|
|
|
|
|
init manifest:
|
|
|
|
__a a
|
|
|
|
require="__e/e" __b b
|
|
|
|
require="__f/f" __c c
|
|
|
|
__e e
|
|
|
|
__f f
|
|
|
|
require="__c/c" __d d
|
|
|
|
__g g
|
|
|
|
__h h
|
|
|
|
|
|
|
|
type __g manifest:
|
|
|
|
require="__c/c __d/d" __a a
|
|
|
|
|
|
|
|
Warning message:
|
2016-10-08 09:45:50 +00:00
|
|
|
WARNING: cdisttesthost: Object __a/a already exists with requirements:
|
2016-10-08 09:40:32 +00:00
|
|
|
/usr/home/darko/ungleich/cdist/cdist/test/config/fixtures/manifest/init-deps-resolver /tmp/tmp.cdist.test.ozagkg54/local/759547ff4356de6e3d9e08522b0d0807/data/conf/type/__g/manifest: set()
|
|
|
|
/tmp/tmp.cdist.test.ozagkg54/local/759547ff4356de6e3d9e08522b0d0807/data/conf/type/__g/manifest: {'__c/c', '__d/d'}
|
|
|
|
Dependency resolver could not handle dependencies as expected.
|
|
|
|
|
2011-09-12 08:58:10 +00:00
|
|
|
COPYING
|
|
|
|
-------
|
2017-06-11 12:01:16 +00:00
|
|
|
Copyright \(C) 2011-2017 Nico Schottelius. Free use of this software is
|
2016-07-20 05:55:48 +00:00
|
|
|
granted under the terms of the GNU General Public License v3 or later (GPLv3+).
|