Update cdist beta docs
This commit is contained in:
Darko Poljak
parent
da78c8f28c
commit
486d2f153f
220 changed files with 12895 additions and 10680 deletions
|
|
@ -263,6 +263,7 @@ The following types are available:
|
|||
- __postfix_postconf (`cdist-type__postfix_postconf(7) <man7/cdist-type__postfix_postconf.html>`_)
|
||||
- __postfix_postmap (`cdist-type__postfix_postmap(7) <man7/cdist-type__postfix_postmap.html>`_)
|
||||
- __postfix_reload (`cdist-type__postfix_reload(7) <man7/cdist-type__postfix_reload.html>`_)
|
||||
- __postgres_conf (`cdist-type__postgres_conf(7) <man7/cdist-type__postgres_conf.html>`_)
|
||||
- __postgres_database (`cdist-type__postgres_database(7) <man7/cdist-type__postgres_database.html>`_)
|
||||
- __postgres_extension (`cdist-type__postgres_extension(7) <man7/cdist-type__postgres_extension.html>`_)
|
||||
- __postgres_role (`cdist-type__postgres_role(7) <man7/cdist-type__postgres_role.html>`_)
|
||||
|
|
@ -280,6 +281,7 @@ The following types are available:
|
|||
- __rvm_ruby (`cdist-type__rvm_ruby(7) <man7/cdist-type__rvm_ruby.html>`_)
|
||||
- __sensible_editor (`cdist-type__sensible_editor(7) <man7/cdist-type__sensible_editor.html>`_)
|
||||
- __service (`cdist-type__service(7) <man7/cdist-type__service.html>`_)
|
||||
- __snakeoil_cert (`cdist-type__snakeoil_cert(7) <man7/cdist-type__snakeoil_cert.html>`_)
|
||||
- __ssh_authorized_key (`cdist-type__ssh_authorized_key(7) <man7/cdist-type__ssh_authorized_key.html>`_)
|
||||
- __ssh_authorized_keys (`cdist-type__ssh_authorized_keys(7) <man7/cdist-type__ssh_authorized_keys.html>`_)
|
||||
- __ssh_dot_ssh (`cdist-type__ssh_dot_ssh(7) <man7/cdist-type__ssh_dot_ssh.html>`_)
|
||||
|
|
|
|||
82
src/extra/manual/beta/_sources/cdist-scan.rst.txt
Normal file
82
src/extra/manual/beta/_sources/cdist-scan.rst.txt
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
Scan
|
||||
=====
|
||||
|
||||
Description
|
||||
-----------
|
||||
Runs cdist as a daemon that discover/watch on hosts and reconfigure them
|
||||
periodically. It is especially useful in netboot-based environment where hosts
|
||||
boot unconfigured, and to ensure your infrastructure stays in sync with your
|
||||
configuration.
|
||||
|
||||
This feature is still consider to be in **beta** stage, and only operate on
|
||||
IPv6 (including link-local).
|
||||
|
||||
Usage (Examples)
|
||||
----------------
|
||||
|
||||
Discover hosts on local network and configure those whose name is resolved by
|
||||
the name mapper script.
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ cdist scan --beta --interface eth0 \
|
||||
--mode scan --name-mapper path/to/script \
|
||||
--mode trigger --mode config
|
||||
|
||||
List known hosts and exit.
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
$ cdist scan --beta --list --name-mapper path/to/script
|
||||
|
||||
Please refer to `cdist(1)` for a detailed list of parameters.
|
||||
|
||||
Modes
|
||||
-----
|
||||
|
||||
The scanner has 3 modes that can be independently toggled. If the `--mode`
|
||||
parameter is not specified, only `tigger` and `scan` are enabled (= hosts are
|
||||
not configured).
|
||||
|
||||
trigger
|
||||
Send ICMPv6 requests to specific hosts or broadcast over IPv6 link-local to
|
||||
trigger detection by the `scan` module.
|
||||
|
||||
scan
|
||||
Watch for incoming ICMPv6 replies and optionally configure detected hosts.
|
||||
|
||||
config
|
||||
Enable configuration of hosts detected by `scan`.
|
||||
|
||||
Name Mapper Script
|
||||
------------------
|
||||
|
||||
The name mapper script takes an IPv6 address as first argument and writes the
|
||||
resolved name to stdout - if any. The script must be executable.
|
||||
|
||||
Simplest script:
|
||||
|
||||
.. code-block:: sh
|
||||
#!/bin/sh
|
||||
|
||||
case "$1" in
|
||||
"fe80::20d:b9ff:fe57:3524")
|
||||
printf "my-host-01"
|
||||
;;
|
||||
"fe80::7603:bdff:fe05:89bb")
|
||||
printf "my-host-02"
|
||||
;;
|
||||
esac
|
||||
|
||||
Resolving name from `PTR` DNS record:
|
||||
|
||||
.. code-block:: sh
|
||||
#!/bin/sh
|
||||
|
||||
for cmd in dig sed; do
|
||||
if ! command -v $cmd > /dev/null; then
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
|
||||
dig +short -x "$1" | sed -e 's/.$//'
|
||||
|
|
@ -131,6 +131,7 @@ cdist types
|
|||
__postfix_postconf <man7/cdist-type__postfix_postconf>
|
||||
__postfix_postmap <man7/cdist-type__postfix_postmap>
|
||||
__postfix_reload <man7/cdist-type__postfix_reload>
|
||||
__postgres_conf <man7/cdist-type__postgres_conf>
|
||||
__postgres_database <man7/cdist-type__postgres_database>
|
||||
__postgres_extension <man7/cdist-type__postgres_extension>
|
||||
__postgres_role <man7/cdist-type__postgres_role>
|
||||
|
|
@ -148,6 +149,7 @@ cdist types
|
|||
__rvm_ruby <man7/cdist-type__rvm_ruby>
|
||||
__sensible_editor <man7/cdist-type__sensible_editor>
|
||||
__service <man7/cdist-type__service>
|
||||
__snakeoil_cert <man7/cdist-type__snakeoil_cert>
|
||||
__ssh_authorized_key <man7/cdist-type__ssh_authorized_key>
|
||||
__ssh_authorized_keys <man7/cdist-type__ssh_authorized_keys>
|
||||
__ssh_dot_ssh <man7/cdist-type__ssh_dot_ssh>
|
||||
|
|
|
|||
|
|
@ -35,6 +35,7 @@ It natively supports IPv6 since the first release.
|
|||
cdist-inventory
|
||||
cdist-trigger
|
||||
cdist-preos
|
||||
cdist-scan
|
||||
cdist-integration
|
||||
cdist-reference
|
||||
cdist-best-practice
|
||||
|
|
|
|||
|
|
@ -97,6 +97,8 @@ SYNOPSIS
|
|||
[-R [{tar,tgz,tbz2,txz}]] [-r REMOTE_OUT_PATH]
|
||||
[--remote-copy REMOTE_COPY] [--remote-exec REMOTE_EXEC]
|
||||
[-S] [-D DIRECTORY] [-H HTTP_PORT] [--ipv6] [-O SOURCE]
|
||||
cdist scan -I INTERFACE [--m MODE] [--name-mapper PATH_TO_SCRIPT] [--list]
|
||||
[-d CONFIG_DELAY] [-t TRIGGER_DELAY]
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
|
|
@ -748,6 +750,31 @@ This command returns the following response codes to client requests:
|
|||
**-S, --disable-saving-output-streams**
|
||||
Disable saving output streams.
|
||||
|
||||
SCAN
|
||||
----
|
||||
|
||||
Runs cdist as a daemon that discover/watch on hosts and reconfigure them
|
||||
periodically.
|
||||
|
||||
**-I INTERFACE, --interfaces INTERFACE**
|
||||
Interface to listen on. Can be specified multiple times.
|
||||
|
||||
**-m MODE, --mode MODE**
|
||||
Scanner components to enable. Can be specified multiple time to enable more
|
||||
than one component. Supported modes are: scan, trigger and config. Defaults
|
||||
to tiggger and scan.
|
||||
|
||||
**--name-mapper PATH_TO_SCRIPT**
|
||||
Path to script used to resolve a remote host name from an IPv6 address.
|
||||
|
||||
**--list**
|
||||
List known hosts and exit.
|
||||
|
||||
**-d CONFIG_DELAY, --config-delay CONFIG_DELAY**
|
||||
How long (seconds) to wait before reconfiguring after last try (config mode only).
|
||||
|
||||
**-t TRIGGER_DELAY, --tigger-delay TRIGGER_DELAY**
|
||||
How long (seconds) to wait between ICMPv6 echo requests (trigger mode only).
|
||||
|
||||
CONFIGURATION
|
||||
-------------
|
||||
|
|
|
|||
|
|
@ -10,6 +10,14 @@ DESCRIPTION
|
|||
-----------
|
||||
Manages the list of keys used by apt to authenticate packages.
|
||||
|
||||
This is done by placing the requested key in a file named
|
||||
``$__object_id.gpg`` in the ``keydir`` directory.
|
||||
|
||||
This is supported by modern releases of Debian-based distributions.
|
||||
|
||||
In order of preference, exactly one of: ``source``, ``uri`` or ``keyid``
|
||||
must be specified.
|
||||
|
||||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
|
|
@ -18,21 +26,49 @@ None.
|
|||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
keydir
|
||||
keyring directory, defaults to ``/etc/apt/trusted.pgp.d``, which is
|
||||
enabled system-wide by default.
|
||||
|
||||
source
|
||||
path to a file containing the GPG key of the repository.
|
||||
Using this is recommended as it ensures that the manifest/type manintainer
|
||||
has validated the key.
|
||||
If ``-``, the GPG key is read from the type's stdin.
|
||||
|
||||
state
|
||||
'present' or 'absent'. Defaults to 'present'
|
||||
|
||||
uri
|
||||
the URI from which to download the key.
|
||||
It is highly recommended that you only use protocols with TLS like HTTPS.
|
||||
This uses ``__download`` but does not use checksums, if you want to ensure
|
||||
that the key doesn't change, you are better off downloading it and using
|
||||
``--source``.
|
||||
|
||||
|
||||
DEPRECATED OPTIONAL PARAMETERS
|
||||
------------------------------
|
||||
keyid
|
||||
the id of the key to add. Defaults to __object_id
|
||||
the id of the key to download from the ``keyserver``.
|
||||
This is to be used in absence of ``--source`` and ``--uri`` or together
|
||||
with ``--use-deprecated-apt-key`` for key removal.
|
||||
Defaults to ``$__object_id``.
|
||||
|
||||
keyserver
|
||||
the keyserver from which to fetch the key. If omitted the default set
|
||||
in ./parameter/default/keyserver is used.
|
||||
the keyserver from which to fetch the key.
|
||||
Defaults to ``pool.sks-keyservers.net``.
|
||||
|
||||
keydir
|
||||
key save location, defaults to ``/etc/apt/trusted.pgp.d``
|
||||
|
||||
uri
|
||||
the URI from which to download the key
|
||||
DEPRECATED BOOLEAN PARAMETERS
|
||||
-----------------------------
|
||||
use-deprecated-apt-key
|
||||
``apt-key(8)`` will last be available in Debian 11 and Ubuntu 22.04.
|
||||
You can use this parameter to force usage of ``apt-key(8)``.
|
||||
Please only use this parameter to *remove* keys from the keyring,
|
||||
in order to prepare for removal of ``apt-key``.
|
||||
Adding keys should be done without this parameter.
|
||||
This parameter will be removed when Debian 11 stops being supported.
|
||||
|
||||
|
||||
EXAMPLES
|
||||
|
|
@ -40,33 +76,39 @@ EXAMPLES
|
|||
|
||||
.. code-block:: sh
|
||||
|
||||
# Add Ubuntu Archive Automatic Signing Key
|
||||
__apt_key 437D05B5
|
||||
# Same thing
|
||||
__apt_key 437D05B5 --state present
|
||||
# Get rid of it
|
||||
__apt_key 437D05B5 --state absent
|
||||
# add a key that has been verified by a type maintainer
|
||||
__apt_key jitsi_meet_2021 \
|
||||
--source cdist-contrib/type/__jitsi_meet/files/apt_2021.gpg
|
||||
|
||||
# same thing with human readable name and explicit keyid
|
||||
__apt_key UbuntuArchiveKey --keyid 437D05B5
|
||||
# remove an old, deprecated or expired key
|
||||
__apt_key jitsi_meet_2016 --state absent
|
||||
|
||||
# same thing with other keyserver
|
||||
__apt_key UbuntuArchiveKey --keyid 437D05B5 --keyserver keyserver.ubuntu.com
|
||||
# Get rid of a key that might have been added to
|
||||
# /etc/apt/trusted.gpg with apt-key
|
||||
__apt_key 0x40976EAF437D05B5 --use-deprecated-apt-key --state absent
|
||||
|
||||
# download key from the internet
|
||||
__apt_key rabbitmq \
|
||||
--uri http://www.rabbitmq.com/rabbitmq-signing-key-public.asc
|
||||
# add a key that we define in-line
|
||||
__apt_key jitsi_meet_2021 --source '-' <<EOF
|
||||
-----BEGIN PGP PUBLIC KEY BLOCK-----
|
||||
[...]
|
||||
-----END PGP PUBLIC KEY BLOCK-----
|
||||
EOF
|
||||
|
||||
# download or update key from the internet
|
||||
__apt_key rabbitmq_2007 \
|
||||
--uri https://www.rabbitmq.com/rabbitmq-signing-key-public.asc
|
||||
|
||||
|
||||
AUTHORS
|
||||
-------
|
||||
Steven Armstrong <steven-cdist--@--armstrong.cc>
|
||||
Ander Punnar <ander-at-kvlt-dot-ee>
|
||||
Evilham <contact~~@~~evilham.com>
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011-2019 Steven Armstrong and Ander Punnar. You can
|
||||
Copyright \(C) 2011-2021 Steven Armstrong, Ander Punnar and Evilham. 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.
|
||||
|
|
|
|||
|
|
@ -8,15 +8,33 @@ cdist-type__debconf_set_selections - Setup debconf selections
|
|||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
On Debian and alike systems debconf-set-selections(1) can be used
|
||||
On Debian and alike systems :strong:`debconf-set-selections`\ (1) can be used
|
||||
to setup configuration parameters.
|
||||
|
||||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
cf. ``--line``.
|
||||
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
file
|
||||
Use the given filename as input for debconf-set-selections(1)
|
||||
If filename is "-", read from stdin.
|
||||
Use the given filename as input for :strong:`debconf-set-selections`\ (1)
|
||||
If filename is ``-``, read from stdin.
|
||||
|
||||
**This parameter is deprecated, because it doesn't work with state detection.**
|
||||
line
|
||||
A line in :strong:`debconf-set-selections`\ (1) compatible format.
|
||||
This parameter can be used multiple times to set multiple options.
|
||||
|
||||
(This parameter is actually required, but marked optional because the
|
||||
deprecated ``--file`` is still accepted.)
|
||||
|
||||
|
||||
BOOLEAN PARAMETERS
|
||||
------------------
|
||||
None.
|
||||
|
||||
|
||||
EXAMPLES
|
||||
|
|
@ -24,30 +42,29 @@ EXAMPLES
|
|||
|
||||
.. code-block:: sh
|
||||
|
||||
# Setup configuration for nslcd
|
||||
__debconf_set_selections nslcd --file /path/to/file
|
||||
# Setup gitolite's gituser
|
||||
__debconf_set_selections nslcd --line 'gitolite gitolite/gituser string git'
|
||||
|
||||
# Setup configuration for nslcd from another type
|
||||
__debconf_set_selections nslcd --file "$__type/files/preseed/nslcd"
|
||||
|
||||
__debconf_set_selections nslcd --file - << eof
|
||||
gitolite gitolite/gituser string git
|
||||
eof
|
||||
# Setup configuration for nslcd from a file.
|
||||
# NB: Multiple lines can be passed to --line, although this can be considered a hack.
|
||||
__debconf_set_selections nslcd --line "$(cat "${__files:?}/preseed/nslcd.debconf")"
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
:strong:`debconf-set-selections`\ (1), :strong:`cdist-type__update_alternatives`\ (7)
|
||||
- :strong:`cdist-type__update_alternatives`\ (7)
|
||||
- :strong:`debconf-set-selections`\ (1)
|
||||
|
||||
|
||||
AUTHORS
|
||||
-------
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
| Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
| Dennis Camera <dennis.camera--@--ssrq-sds-fds.ch>
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2011-2014 Nico Schottelius. 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.
|
||||
Copyright \(C) 2011-2014 Nico Schottelius, 2021 Dennis Camera.
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ cdist-type__download - Download a file
|
|||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
By default type will try to use ``wget``, ``curl`` or ``fetch``.
|
||||
By default type will try to use ``curl``, ``fetch`` or ``wget``.
|
||||
If download happens in target (see ``--download``) then type will
|
||||
fallback to (and install) ``wget``.
|
||||
|
||||
|
|
@ -16,6 +16,8 @@ If download happens in local machine, then environment variables like
|
|||
``{http,https,ftp}_proxy`` etc can be used on cdist execution
|
||||
(``http_proxy=foo cdist config ...``).
|
||||
|
||||
To change downloaded file's owner, group or permissions, use ``require='__download/path/to/file' __file ...``.
|
||||
|
||||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
|
|
@ -25,14 +27,29 @@ url
|
|||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
destination
|
||||
Downloaded file's destination in target. If unset, ``$__object_id`` is used.
|
||||
|
||||
sum
|
||||
Checksum is used to decide if existing destination file must be redownloaded.
|
||||
By default output of ``cksum`` without filename is expected.
|
||||
Other hash formats supported with prefixes: ``md5:``, ``sha1:`` and ``sha256:``.
|
||||
Supported formats: ``cksum`` output without file name, MD5, SHA1 and SHA256.
|
||||
|
||||
Type tries to detect hash format with regexes, but prefixes
|
||||
``cksum:``, ``md5:``, ``sha1:`` and ``sha256:`` are also supported.
|
||||
|
||||
Checksum have two purposes - state check and post-download verification.
|
||||
In state check, if destination checksum mismatches, then content of URL
|
||||
will be downloaded to temporary file. If downloaded temporary file's
|
||||
checksum matches, then it will be moved to destination (overwritten).
|
||||
|
||||
For local downloads it is expected that usable utilities for checksum
|
||||
calculation exist in the system.
|
||||
|
||||
download
|
||||
If ``local`` (default), then download file to local storage and copy
|
||||
it to target host. If ``remote``, then download happens in target.
|
||||
If ``local`` (default), then file is downloaded to local storage and copied
|
||||
to target host. If ``remote``, then download happens in target.
|
||||
|
||||
For local downloads it is expected that usable utilities for downloading
|
||||
exist in the system. Type will try to use ``curl``, ``fetch`` or ``wget``.
|
||||
|
||||
cmd-get
|
||||
Command used for downloading.
|
||||
|
|
@ -62,7 +79,7 @@ EXAMPLES
|
|||
require='__directory/opt/cpma' \
|
||||
__download /opt/cpma/cnq3.zip \
|
||||
--url https://cdn.playmorepromode.com/files/cnq3/cnq3-1.51.zip \
|
||||
--sum md5:46da3021ca9eace277115ec9106c5b46
|
||||
--sum 46da3021ca9eace277115ec9106c5b46
|
||||
|
||||
require='__download/opt/cpma/cnq3.zip' \
|
||||
__unpack /opt/cpma/cnq3.zip \
|
||||
|
|
|
|||
|
|
@ -0,0 +1,60 @@
|
|||
cdist-type__postgres_conf(7)
|
||||
============================
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__postgres_conf - Alter PostgreSQL configuration
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Configure a running PostgreSQL server using ``ALTER SYSTEM``.
|
||||
|
||||
|
||||
REQUIRED PARAMETERS
|
||||
-------------------
|
||||
value
|
||||
The value to set (can be omitted if ``--state`` is set to ``absent``).
|
||||
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
state
|
||||
``present`` or ``absent``.
|
||||
Defaults to ``present``.
|
||||
|
||||
|
||||
BOOLEAN PARAMETERS
|
||||
------------------
|
||||
None.
|
||||
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
# set timezone
|
||||
__postgres_conf timezone --value Europe/Zurich
|
||||
|
||||
# reset maximum number of concurrent connections to default (normally 100)
|
||||
__postgres_conf max_connections --state absent
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
None.
|
||||
|
||||
|
||||
AUTHORS
|
||||
-------
|
||||
Beni Ruef (bernhard.ruef--@--ssrq-sds-fds.ch)
|
||||
Dennis Camera (dennis.camera--@--ssrq-sds-fds.ch)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2019-2021 SSRQ (www.ssrq-sds-fds.ch).
|
||||
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.
|
||||
|
|
@ -3,32 +3,36 @@ cdist-type__postgres_extension(7)
|
|||
|
||||
NAME
|
||||
----
|
||||
cdist-type__postgres_extension - manage postgres extensions
|
||||
cdist-type__postgres_extension - Manage PostgreSQL extensions
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
This cdist type allows you to create or drop postgres extensions.
|
||||
This cdist type allows you to manage PostgreSQL extensions.
|
||||
|
||||
The object you need to pass to __postgres_extension consists of
|
||||
the database name and the extension name joined by a colon in the
|
||||
following form:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
dbname:extension
|
||||
|
||||
f.ex.
|
||||
The ``__object_id`` to pass to ``__postgres_extension`` is of the form
|
||||
``dbname:extension``, e.g.:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
rails_test:unaccent
|
||||
|
||||
|
||||
**CAUTION!** Be careful when installing extensions from (untrusted) third-party
|
||||
sources:
|
||||
|
||||
| Installing an extension as superuser requires trusting that the extension's
|
||||
author wrote the extension installation script in a secure fashion. It is
|
||||
not terribly difficult for a malicious user to create trojan-horse objects
|
||||
that will compromise later execution of a carelessly-written extension
|
||||
script, allowing that user to acquire superuser privileges.
|
||||
| – `<https://www.postgresql.org/docs/13/sql-createextension.html#id-1.9.3.64.7>`_
|
||||
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
state
|
||||
either "present" or "absent", defaults to "present"
|
||||
either ``present`` or ``absent``, defaults to ``present``.
|
||||
|
||||
|
||||
EXAMPLES
|
||||
|
|
@ -36,24 +40,29 @@ EXAMPLES
|
|||
|
||||
.. code-block:: sh
|
||||
|
||||
__postgres_extension rails_test:unaccent
|
||||
__postgres_extension --present rails_test:unaccent
|
||||
__postgres_extension --absent rails_test:unaccent
|
||||
# Install extension unaccent into database rails_test
|
||||
__postgres_extension rails_test:unaccent
|
||||
|
||||
# Drop extension unaccent from database fails_test
|
||||
__postgres_extension rails_test:unaccent --state absent
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
:strong:`cdist-type__postgre_database`\ (7)
|
||||
- :strong:`cdist-type__postgres_database`\ (7)
|
||||
- PostgreSQL "CREATE EXTENSION" documentation at:
|
||||
`<http://www.postgresql.org/docs/current/static/sql-createextension.html>`_.
|
||||
|
||||
Postgres "Create Extension" documentation at: <http://www.postgresql.org/docs/current/static/sql-createextension.html>.
|
||||
|
||||
AUTHOR
|
||||
AUTHORS
|
||||
-------
|
||||
Tomas Pospisek <tpo_deb--@--sourcepole.ch>
|
||||
| Tomas Pospisek <tpo_deb--@--sourcepole.ch>
|
||||
| Dennis Camera <dennis.camera--@--ssrq-sds-fds.ch>
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2014 Tomas Pospisek. 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.
|
||||
Copyright \(C) 2014 Tomas Pospisek, 2021 Dennis Camera.
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,60 @@
|
|||
cdist-type__snakeoil_cert(7)
|
||||
============================
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-type__snakeoil_cert - Generate self-signed certificate
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
The purpose of this type is to generate **self-signed** certificate and private key
|
||||
for **testing purposes**. Certificate will expire in 3650 days.
|
||||
|
||||
Certificate's and key's access bits will be ``644`` and ``640`` respectively.
|
||||
If target system has ``ssl-cert`` group, then it will be used as key's group.
|
||||
Use ``require='__snakeoil_cert/...' __file ...`` to override.
|
||||
|
||||
|
||||
OPTIONAL PARAMETERS
|
||||
-------------------
|
||||
common-name
|
||||
Defaults to ``$__object_id``.
|
||||
|
||||
key-path
|
||||
``%s`` in path will be replaced with ``$__object_id``.
|
||||
Defaults to ``/etc/ssl/private/%s.pem``.
|
||||
|
||||
key-type
|
||||
Possible values are ``rsa:$bits`` and ``ec:$name``.
|
||||
For possible EC names see ``openssl ecparam -list_curves``.
|
||||
Defaults to ``rsa:2048``.
|
||||
|
||||
cert-path
|
||||
``%s`` in path will be replaced with ``$__object_id``.
|
||||
Defaults to ``/etc/ssl/certs/%s.pem``.
|
||||
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
.. code-block:: sh
|
||||
__snakeoil_cert localhost-rsa \
|
||||
--common-name localhost \
|
||||
--key-type rsa:4096
|
||||
|
||||
__snakeoil_cert localhost-ec \
|
||||
--common-name localhost \
|
||||
--key-type ec:prime256v1
|
||||
|
||||
|
||||
AUTHORS
|
||||
-------
|
||||
Ander Punnar <ander-at-kvlt-dot-ee>
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2021 Ander Punnar. 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,6 +1,6 @@
|
|||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||
VERSION: '6.9.6',
|
||||
VERSION: '6.9.7',
|
||||
LANGUAGE: 'None',
|
||||
COLLAPSE_INDEX: false,
|
||||
BUILDER: 'html',
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>25. Best practice — cdist 6.9.6 documentation</title>
|
||||
<title>26. Best practice — cdist 6.9.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
|
@ -35,8 +35,8 @@
|
|||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="26. Execution stages" href="cdist-stages.html" />
|
||||
<link rel="prev" title="24. Reference" href="cdist-reference.html" />
|
||||
<link rel="next" title="27. Execution stages" href="cdist-stages.html" />
|
||||
<link rel="prev" title="25. Reference" href="cdist-reference.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
|
@ -63,7 +63,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
6.9.6
|
||||
6.9.7
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -110,31 +110,32 @@
|
|||
<li class="toctree-l1"><a class="reference internal" href="cdist-inventory.html">20. Inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-trigger.html">21. Trigger</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-preos.html">22. PreOS</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">23. cdist integration / using cdist as library</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">24. Reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">25. Best practice</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#passwordless-connections">25.1. Passwordless connections</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#speeding-up-ssh-connections">25.2. Speeding up ssh connections</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#speeding-up-shell-execution">25.3. Speeding up shell execution</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#multi-master-or-environment-setups">25.4. Multi master or environment setups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#separating-work-by-groups">25.5. Separating work by groups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#maintaining-multiple-configurations">25.6. Maintaining multiple configurations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#multiple-developers-with-different-trust">25.7. Multiple developers with different trust</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#templating">25.8. Templating</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#testing-a-new-type">25.9. Testing a new type</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#other-content-in-cdist-repository">25.10. Other content in cdist repository</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#notes-on-cdist-order-dependency">25.11. Notes on CDIST_ORDER_DEPENDENCY</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#cdist-order-dependency-kills-parallelization">25.11.1. CDIST_ORDER_DEPENDENCY kills parallelization</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-scan.html">23. Scan</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">24. cdist integration / using cdist as library</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">25. Reference</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">26. Best practice</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#passwordless-connections">26.1. Passwordless connections</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#speeding-up-ssh-connections">26.2. Speeding up ssh connections</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#speeding-up-shell-execution">26.3. Speeding up shell execution</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#multi-master-or-environment-setups">26.4. Multi master or environment setups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#separating-work-by-groups">26.5. Separating work by groups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#maintaining-multiple-configurations">26.6. Maintaining multiple configurations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#multiple-developers-with-different-trust">26.7. Multiple developers with different trust</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#templating">26.8. Templating</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#testing-a-new-type">26.9. Testing a new type</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#other-content-in-cdist-repository">26.10. Other content in cdist repository</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#notes-on-cdist-order-dependency">26.11. Notes on CDIST_ORDER_DEPENDENCY</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#cdist-order-dependency-kills-parallelization">26.11.1. CDIST_ORDER_DEPENDENCY kills parallelization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">26. Execution stages</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-cache.html">27. Local cache overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-saving-output-streams.html">28. Saving output streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">29. Remote exec and copy commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">30. Hacking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">31. Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">27. Execution stages</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-cache.html">28. Local cache overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-saving-output-streams.html">29. Saving output streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">30. Remote exec and copy commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">31. Hacking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">32. Troubleshooting</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
|
@ -180,7 +181,7 @@
|
|||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><span class="section-number">25. </span>Best practice</li>
|
||||
<li><span class="section-number">26. </span>Best practice</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
|
@ -200,17 +201,17 @@
|
|||
<div itemprop="articleBody">
|
||||
|
||||
<section id="best-practice">
|
||||
<h1><span class="section-number">25. </span>Best practice<a class="headerlink" href="#best-practice" title="Permalink to this headline">¶</a></h1>
|
||||
<h1><span class="section-number">26. </span>Best practice<a class="headerlink" href="#best-practice" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Practices used in real environments</p>
|
||||
<section id="passwordless-connections">
|
||||
<h2><span class="section-number">25.1. </span>Passwordless connections<a class="headerlink" href="#passwordless-connections" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><span class="section-number">26.1. </span>Passwordless connections<a class="headerlink" href="#passwordless-connections" title="Permalink to this headline">¶</a></h2>
|
||||
<p>It is recommended to run cdist with public key authentication.
|
||||
This requires a private/public key pair and the entry
|
||||
"PermitRootLogin without-password" in the sshd server.
|
||||
See sshd_config(5) and ssh-keygen(1).</p>
|
||||
</section>
|
||||
<section id="speeding-up-ssh-connections">
|
||||
<h2><span class="section-number">25.2. </span>Speeding up ssh connections<a class="headerlink" href="#speeding-up-ssh-connections" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><span class="section-number">26.2. </span>Speeding up ssh connections<a class="headerlink" href="#speeding-up-ssh-connections" title="Permalink to this headline">¶</a></h2>
|
||||
<p>When connecting to a new host, the initial delay with ssh connections
|
||||
is pretty big. As cdist makes many connections to each host successive
|
||||
connections can be sped up by "sharing of multiple sessions over a single
|
||||
|
|
@ -224,7 +225,7 @@ parallel multiplexed connections this with <cite>MaxSessions N</cite> (N default
|
|||
for OpenSSH v7.4).</p>
|
||||
</section>
|
||||
<section id="speeding-up-shell-execution">
|
||||
<h2><span class="section-number">25.3. </span>Speeding up shell execution<a class="headerlink" href="#speeding-up-shell-execution" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><span class="section-number">26.3. </span>Speeding up shell execution<a class="headerlink" href="#speeding-up-shell-execution" title="Permalink to this headline">¶</a></h2>
|
||||
<p>On the source host, ensure that /bin/sh is <em>not</em> bash: bash is quite slow for
|
||||
script execution. Instead, you could use dash after installing it:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ln</span> <span class="o">-</span><span class="n">sf</span> <span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">dash</span> <span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">sh</span>
|
||||
|
|
@ -232,7 +233,7 @@ script execution. Instead, you could use dash after installing it:</p>
|
|||
</div>
|
||||
</section>
|
||||
<section id="multi-master-or-environment-setups">
|
||||
<h2><span class="section-number">25.4. </span>Multi master or environment setups<a class="headerlink" href="#multi-master-or-environment-setups" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><span class="section-number">26.4. </span>Multi master or environment setups<a class="headerlink" href="#multi-master-or-environment-setups" title="Permalink to this headline">¶</a></h2>
|
||||
<p>If you plan to distribute cdist among servers or use different
|
||||
environments, you can do so easily with the included version
|
||||
control git. For instance if you plan to use the typical three
|
||||
|
|
@ -258,7 +259,7 @@ you can clone it multiple times:</p>
|
|||
</div>
|
||||
</section>
|
||||
<section id="separating-work-by-groups">
|
||||
<h2><span class="section-number">25.5. </span>Separating work by groups<a class="headerlink" href="#separating-work-by-groups" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><span class="section-number">26.5. </span>Separating work by groups<a class="headerlink" href="#separating-work-by-groups" title="Permalink to this headline">¶</a></h2>
|
||||
<p>If you are working with different groups on one cdist-configuration,
|
||||
you can delegate to other manifests and have the groups edit only
|
||||
their manifests. You can use the following snippet in
|
||||
|
|
@ -271,7 +272,7 @@ their manifests. You can use the following snippet in
|
|||
</div>
|
||||
</section>
|
||||
<section id="maintaining-multiple-configurations">
|
||||
<h2><span class="section-number">25.6. </span>Maintaining multiple configurations<a class="headerlink" href="#maintaining-multiple-configurations" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><span class="section-number">26.6. </span>Maintaining multiple configurations<a class="headerlink" href="#maintaining-multiple-configurations" title="Permalink to this headline">¶</a></h2>
|
||||
<p>When you need to manage multiple sites with cdist, like company_a, company_b
|
||||
and private for instance, you can easily use git for this purpose.
|
||||
Including a possible common base that is reused across the different sites:</p>
|
||||
|
|
@ -330,7 +331,7 @@ Including a possible common base that is reused across the different sites:</p>
|
|||
<p>Have a look at git-remote(1) to adjust the remote configuration, which allows</p>
|
||||
</section>
|
||||
<section id="multiple-developers-with-different-trust">
|
||||
<h2><span class="section-number">25.7. </span>Multiple developers with different trust<a class="headerlink" href="#multiple-developers-with-different-trust" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><span class="section-number">26.7. </span>Multiple developers with different trust<a class="headerlink" href="#multiple-developers-with-different-trust" title="Permalink to this headline">¶</a></h2>
|
||||
<p>If you are working in an environment that requires different people to
|
||||
work on the same configuration, but having different privileges, you can
|
||||
implement this scenario with a gateway host and sudo:</p>
|
||||
|
|
@ -350,7 +351,7 @@ implement this scenario with a gateway host and sudo:</p>
|
|||
<p>For more details consult sudoers(5)</p>
|
||||
</section>
|
||||
<section id="templating">
|
||||
<h2><span class="section-number">25.8. </span>Templating<a class="headerlink" href="#templating" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><span class="section-number">26.8. </span>Templating<a class="headerlink" href="#templating" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>create directory files/ in your type (convention)</p></li>
|
||||
<li><p>create the template as an executable file like files/basic.conf.sh, it will output text using shell variables for the values</p></li>
|
||||
|
|
@ -388,7 +389,7 @@ cat <span class="s"><< EOF</span>
|
|||
</div>
|
||||
</section>
|
||||
<section id="testing-a-new-type">
|
||||
<h2><span class="section-number">25.9. </span>Testing a new type<a class="headerlink" href="#testing-a-new-type" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><span class="section-number">26.9. </span>Testing a new type<a class="headerlink" href="#testing-a-new-type" title="Permalink to this headline">¶</a></h2>
|
||||
<p>If you want to test a new type on a node, you can tell cdist to only use an
|
||||
object of this type: Use the '--initial-manifest' parameter
|
||||
with - (stdin) as argument and feed object into stdin
|
||||
|
|
@ -407,7 +408,7 @@ of cdist:</p>
|
|||
</div>
|
||||
</section>
|
||||
<section id="other-content-in-cdist-repository">
|
||||
<h2><span class="section-number">25.10. </span>Other content in cdist repository<a class="headerlink" href="#other-content-in-cdist-repository" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><span class="section-number">26.10. </span>Other content in cdist repository<a class="headerlink" href="#other-content-in-cdist-repository" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Usually the cdist repository contains all configuration
|
||||
items. Sometimes you may have additional resources that
|
||||
you would like to store in your central configuration
|
||||
|
|
@ -420,7 +421,7 @@ and also to store all important files in one
|
|||
repository.</p>
|
||||
</section>
|
||||
<section id="notes-on-cdist-order-dependency">
|
||||
<h2><span class="section-number">25.11. </span>Notes on CDIST_ORDER_DEPENDENCY<a class="headerlink" href="#notes-on-cdist-order-dependency" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><span class="section-number">26.11. </span>Notes on CDIST_ORDER_DEPENDENCY<a class="headerlink" href="#notes-on-cdist-order-dependency" title="Permalink to this headline">¶</a></h2>
|
||||
<p>With CDIST_ORDER_DEPENDENCY all types are executed in the order in which they
|
||||
are created in the manifest. The current created object automatically depends
|
||||
on the previously created object.</p>
|
||||
|
|
@ -428,7 +429,7 @@ on the previously created object.</p>
|
|||
(like first creating the directory xyz than the file below the directory).</p>
|
||||
<p>This can be helpful, but one must be aware of its side effects.</p>
|
||||
<section id="cdist-order-dependency-kills-parallelization">
|
||||
<h3><span class="section-number">25.11.1. </span>CDIST_ORDER_DEPENDENCY kills parallelization<a class="headerlink" href="#cdist-order-dependency-kills-parallelization" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><span class="section-number">26.11.1. </span>CDIST_ORDER_DEPENDENCY kills parallelization<a class="headerlink" href="#cdist-order-dependency-kills-parallelization" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Suppose you have defined CDIST_ORDER_DEPENDENCY and then, among other things,
|
||||
you specify creation of three, by nature independent, files.</p>
|
||||
<p><strong>init</strong></p>
|
||||
|
|
@ -472,10 +473,10 @@ __file /tmp/file3
|
|||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="cdist-stages.html" class="btn btn-neutral float-right" title="26. Execution stages" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
<a href="cdist-stages.html" class="btn btn-neutral float-right" title="27. Execution stages" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="cdist-reference.html" class="btn btn-neutral float-left" title="24. Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="cdist-reference.html" class="btn btn-neutral float-left" title="25. Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>12. Bootstrap — cdist 6.9.6 documentation</title>
|
||||
<title>12. Bootstrap — cdist 6.9.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
|
@ -63,7 +63,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
6.9.6
|
||||
6.9.7
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -116,15 +116,16 @@
|
|||
<li class="toctree-l1"><a class="reference internal" href="cdist-inventory.html">20. Inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-trigger.html">21. Trigger</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-preos.html">22. PreOS</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">23. cdist integration / using cdist as library</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">24. Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">25. Best practice</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">26. Execution stages</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-cache.html">27. Local cache overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-saving-output-streams.html">28. Saving output streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">29. Remote exec and copy commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">30. Hacking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">31. Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-scan.html">23. Scan</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">24. cdist integration / using cdist as library</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">25. Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">26. Best practice</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">27. Execution stages</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-cache.html">28. Local cache overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-saving-output-streams.html">29. Saving output streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">30. Remote exec and copy commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">31. Hacking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">32. Troubleshooting</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>27. Local cache overview — cdist 6.9.6 documentation</title>
|
||||
<title>28. Local cache overview — cdist 6.9.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
|
@ -35,8 +35,8 @@
|
|||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="28. Saving output streams" href="cdist-saving-output-streams.html" />
|
||||
<link rel="prev" title="26. Execution stages" href="cdist-stages.html" />
|
||||
<link rel="next" title="29. Saving output streams" href="cdist-saving-output-streams.html" />
|
||||
<link rel="prev" title="27. Execution stages" href="cdist-stages.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
|
@ -63,7 +63,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
6.9.6
|
||||
6.9.7
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -110,22 +110,23 @@
|
|||
<li class="toctree-l1"><a class="reference internal" href="cdist-inventory.html">20. Inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-trigger.html">21. Trigger</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-preos.html">22. PreOS</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">23. cdist integration / using cdist as library</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">24. Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">25. Best practice</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">26. Execution stages</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">27. Local cache overview</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#description">27.1. Description</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#cache-overview">27.2. Cache overview</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#object-cache-overview">27.2.1. Object cache overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-scan.html">23. Scan</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">24. cdist integration / using cdist as library</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">25. Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">26. Best practice</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">27. Execution stages</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">28. Local cache overview</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#description">28.1. Description</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#cache-overview">28.2. Cache overview</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#object-cache-overview">28.2.1. Object cache overview</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-saving-output-streams.html">28. Saving output streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">29. Remote exec and copy commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">30. Hacking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">31. Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-saving-output-streams.html">29. Saving output streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">30. Remote exec and copy commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">31. Hacking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">32. Troubleshooting</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
|
@ -171,7 +172,7 @@
|
|||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li><span class="section-number">27. </span>Local cache overview</li>
|
||||
<li><span class="section-number">28. </span>Local cache overview</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
|
@ -191,9 +192,9 @@
|
|||
<div itemprop="articleBody">
|
||||
|
||||
<section id="local-cache-overview">
|
||||
<h1><span class="section-number">27. </span>Local cache overview<a class="headerlink" href="#local-cache-overview" title="Permalink to this headline">¶</a></h1>
|
||||
<h1><span class="section-number">28. </span>Local cache overview<a class="headerlink" href="#local-cache-overview" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="description">
|
||||
<h2><span class="section-number">27.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><span class="section-number">28.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
||||
<p>While executing, cdist stores data to local cache. Currently this feature is
|
||||
one way only. That means that cdist does not use stored data for future runs.
|
||||
Anyway, those data can be used for debugging cdist, debugging types and
|
||||
|
|
@ -207,7 +208,7 @@ environment variable.</p>
|
|||
section in cdist man page.</p>
|
||||
</section>
|
||||
<section id="cache-overview">
|
||||
<h2><span class="section-number">27.2. </span>Cache overview<a class="headerlink" href="#cache-overview" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><span class="section-number">28.2. </span>Cache overview<a class="headerlink" href="#cache-overview" title="Permalink to this headline">¶</a></h2>
|
||||
<p>As noted above each configured host has got its subdirectory in local cache.
|
||||
Entries in host's cache directory are as follows.</p>
|
||||
<dl class="simple">
|
||||
|
|
@ -236,7 +237,7 @@ cdist</p>
|
|||
</dd>
|
||||
</dl>
|
||||
<section id="object-cache-overview">
|
||||
<h3><span class="section-number">27.2.1. </span>Object cache overview<a class="headerlink" href="#object-cache-overview" title="Permalink to this headline">¶</a></h3>
|
||||
<h3><span class="section-number">28.2.1. </span>Object cache overview<a class="headerlink" href="#object-cache-overview" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Each object under <strong>object</strong> directory has its own structure.</p>
|
||||
<dl class="simple">
|
||||
<dt>autorequire</dt><dd><p>file containing a list of object auto requirements</p>
|
||||
|
|
@ -291,10 +292,10 @@ outputs.</p>
|
|||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="cdist-saving-output-streams.html" class="btn btn-neutral float-right" title="28. Saving output streams" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
<a href="cdist-saving-output-streams.html" class="btn btn-neutral float-right" title="29. Saving output streams" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="cdist-stages.html" class="btn btn-neutral float-left" title="26. Execution stages" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="cdist-stages.html" class="btn btn-neutral float-left" title="27. Execution stages" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>13. Configuration — cdist 6.9.6 documentation</title>
|
||||
<title>13. Configuration — cdist 6.9.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
|
@ -63,7 +63,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
6.9.6
|
||||
6.9.7
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -114,15 +114,16 @@
|
|||
<li class="toctree-l1"><a class="reference internal" href="cdist-inventory.html">20. Inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-trigger.html">21. Trigger</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-preos.html">22. PreOS</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">23. cdist integration / using cdist as library</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">24. Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">25. Best practice</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">26. Execution stages</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-cache.html">27. Local cache overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-saving-output-streams.html">28. Saving output streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">29. Remote exec and copy commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">30. Hacking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">31. Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-scan.html">23. Scan</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">24. cdist integration / using cdist as library</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">25. Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">26. Best practice</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">27. Execution stages</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-cache.html">28. Local cache overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-saving-output-streams.html">29. Saving output streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">30. Remote exec and copy commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">31. Hacking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">32. Troubleshooting</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>17. Explorer — cdist 6.9.6 documentation</title>
|
||||
<title>17. Explorer — cdist 6.9.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
|
@ -36,7 +36,7 @@
|
|||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="18. Messaging" href="cdist-messaging.html" />
|
||||
<link rel="prev" title="16.169. cdist-type__zypper_service(7)" href="man7/cdist-type__zypper_service.html" />
|
||||
<link rel="prev" title="16.171. cdist-type__zypper_service(7)" href="man7/cdist-type__zypper_service.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
|
@ -63,7 +63,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
6.9.6
|
||||
6.9.7
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -114,15 +114,16 @@
|
|||
<li class="toctree-l1"><a class="reference internal" href="cdist-inventory.html">20. Inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-trigger.html">21. Trigger</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-preos.html">22. PreOS</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">23. cdist integration / using cdist as library</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">24. Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">25. Best practice</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">26. Execution stages</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-cache.html">27. Local cache overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-saving-output-streams.html">28. Saving output streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">29. Remote exec and copy commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">30. Hacking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">31. Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-scan.html">23. Scan</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">24. cdist integration / using cdist as library</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">25. Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">26. Best practice</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">27. Execution stages</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-cache.html">28. Local cache overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-saving-output-streams.html">29. Saving output streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">30. Remote exec and copy commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">31. Hacking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-troubleshooting.html">32. Troubleshooting</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
|
@ -245,7 +246,7 @@ dpkg -s <span class="s2">"</span><span class="nv">$name</span><span class="
|
|||
<a href="cdist-messaging.html" class="btn btn-neutral float-right" title="18. Messaging" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="man7/cdist-type__zypper_service.html" class="btn btn-neutral float-left" title="16.169. cdist-type__zypper_service(7)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
<a href="man7/cdist-type__zypper_service.html" class="btn btn-neutral float-left" title="16.171. cdist-type__zypper_service(7)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>2. Features — cdist 6.9.6 documentation</title>
|
||||
<title>2. Features — cdist 6.9.7 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
|
@ -63,7 +63,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
6.9.6
|
||||
6.9.7
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -110,15 +110,16 @@
|
|||
<li class="toctree-l1"><a class="reference internal" href="cdist-inventory.html">20. Inventory</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-trigger.html">21. Trigger</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-preos.html">22. PreOS</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">23. cdist integration / using cdist as library</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-reference.html">24. Reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-best-practice.html">25. Best practice</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-stages.html">26. Execution stages</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-cache.html">27. Local cache overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-saving-output-streams.html">28. Saving output streams</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-remote-exec-copy.html">29. Remote exec and copy commands</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cdist-hacker.html">30. Hacking</a></li>
|
||||