Update beta docs

pull/1/head
Darko Poljak 3 years ago
parent 12076b981a
commit 45d62c806c

@ -95,7 +95,8 @@ Dependencies
------------
If you want to describe that something requires something else, just
setup the variable "require" to contain the requirements. Multiple
requirements can be added white space separated.
requirements can be added separated with (optionally consecutive)
delimiters including space, tab and newline.
::

@ -30,9 +30,6 @@ sum
By default output of ``cksum`` without filename is expected.
Other hash formats supported with prefixes: ``md5:``, ``sha1:`` and ``sha256:``.
onchange
Execute this command after download.
OPTIONAL PARAMETERS
-------------------
@ -54,6 +51,9 @@ cmd-sum
format specification ``%s`` which will become destination.
For example: ``md5sum '%s' | awk '{print $1}'``.
onchange
Execute this command after download.
EXAMPLES
--------

@ -31,8 +31,8 @@ manager-password-hash
Generate e.g. with: `slappasswd -s weneedgoodsecurity`.
See `slappasswd(8C)`, `slapd.conf(5)`.
TODO: implement this: http://blog.adamsbros.org/2015/06/09/openldap-ssha-salted-hashes-by-hand/
to derive from the manager-password parameter and ensure idempotency (care with salts).
At that point, manager-password-hash should be deprecated and ignored.
to derive from the manager-password parameter and ensure idempotency (care with salts).
At that point, manager-password-hash should be deprecated and ignored.
serverid
The server for the directory.

@ -1,9 +1,10 @@
cdist-type__systemd-service(7)
cdist-type__systemd_service(7)
==============================
NAME
----
cdist-type__systemd-service - Controls a systemd service state
cdist-type__systemd_service - Controls a systemd service state
DESCRIPTION
-----------
@ -14,11 +15,12 @@ service after configuration applied or shutdown one service.
The activation or deactivation is out of scope. Look for the
:strong:`cdist-type__systemd_util`\ (7) type instead.
REQUIRED PARAMETERS
-------------------
None.
OPTIONAL PARAMETERS
-------------------
@ -31,12 +33,12 @@ state
running
Service should run (default)
stoppend
Service should stopped
stopped
Service should be stopped
action
Executes an action on on the service. It will only execute it if the
service keeps the state **running**. There are following actions, where:
service keeps the state ``running``. There are following actions, where:
reload
Reloads the service
@ -48,11 +50,12 @@ BOOLEAN PARAMETERS
------------------
if-required
Only execute the action if minimum one required type outputs a message to
**$__messages_out**. Through this, the action should only executed if a
Only execute the action if at minimum one required type outputs a message
to ``$__messages_out``. Through this, the action should only executed if a
dependency did something. The action will not executed if no dependencies
given.
MESSAGES
--------
@ -68,12 +71,14 @@ restart
reload
Reloaded the service
ABORTS
------
Aborts in following cases:
systemd or the service does not exist
EXAMPLES
--------
.. code-block:: sh
@ -95,13 +100,15 @@ EXAMPLES
# reload the service for a modified configuration file
# only reloads the service if the file really changed
require="__config_file/etc/foo.conf" __systemd_service foo \
require="__file/etc/foo.conf" __systemd_service foo \
--action reload --if-required
AUTHORS
-------
Matthias Stecher <matthiasstecher at gmx.de>
COPYRIGHT
---------
Copyright \(C) 2020 Matthias Stecher. You can redistribute it

@ -14,7 +14,8 @@ This type creates a symlink (/etc/localtime) to the selected timezone
REQUIRED PARAMETERS
-------------------
None.
tz
The name of timezone to set.
OPTIONAL PARAMETERS
@ -27,19 +28,24 @@ EXAMPLES
.. code-block:: sh
#Set up Europe/Andorra as our timezone.
__timezone Europe/Andorra
# Set up Europe/Andorra as our timezone.
__timezone --tz Europe/Andorra
#Set up US/Central as our timezone.
__timezone US/Central
# Set up US/Central as our timezone.
__timezone --tz US/Central
AUTHORS
-------
Ramon Salvadó <rsalvado--@--gnuine--dot--com>
| Steven Armstrong <steven-cdist--@--armstrong.cc>
| Nico Schottelius <nico-cdist--@--schottelius.org>
| Ramon Salvadó <rsalvado--@--gnuine--dot--com>
| Dennis Camera <dennis.camera--@--ssrq-sds-fds.ch>
COPYING
-------
Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).
Copyright \(C) 2012-2020 the `AUTHORS`_. 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.

@ -33,6 +33,10 @@ sum-file
tar-strip
Tarball specific. See ``man tar`` for ``--strip-components``.
tar-extra-args
Tarball sepcific. Append additional arguments to ``tar`` command.
See ``man tar`` for possible arguments.
OPTIONAL BOOLEAN PARAMETERS
---------------------------
@ -46,6 +50,9 @@ backup-destination
preserve-archive
Don't delete archive after unpacking.
onchange
Execute this command after unpack.
EXAMPLES
--------
@ -65,6 +72,13 @@ EXAMPLES
--preserve-archive \
--destination /opt/cpma/server
# example usecase for --tar-* args
__unpack /root/strelaysrv.tar.gz \
--preserve-archive \
--destination /usr/local/bin \
--tar-strip 1 \
--tar-extra-args '--wildcards "*/strelaysrv"'
AUTHORS
-------

@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '6.7.0',
VERSION: '6.8.0',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>25. Best practice &mdash; cdist 6.7.0 documentation</title>
<title>25. Best practice &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>12. Bootstrap &mdash; cdist 6.7.0 documentation</title>
<title>12. Bootstrap &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>27. Local cache overview &mdash; cdist 6.7.0 documentation</title>
<title>27. Local cache overview &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>13. Configuration &mdash; cdist 6.7.0 documentation</title>
<title>13. Configuration &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>17. Explorer &mdash; cdist 6.7.0 documentation</title>
<title>17. Explorer &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>2. Features &mdash; cdist 6.7.0 documentation</title>
<title>2. Features &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>30. Hacking &mdash; cdist 6.7.0 documentation</title>
<title>30. Hacking &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>4. How to install cdist &mdash; cdist 6.7.0 documentation</title>
<title>4. How to install cdist &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>23. cdist integration / using cdist as library &mdash; cdist 6.7.0 documentation</title>
<title>23. cdist integration / using cdist as library &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>20. Inventory &mdash; cdist 6.7.0 documentation</title>
<title>20. Inventory &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>14. Manifest &mdash; cdist 6.7.0 documentation</title>
<title>14. Manifest &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>
@ -277,7 +277,8 @@ done
<h2><span class="section-number">14.5. </span>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline"></a></h2>
<p>If you want to describe that something requires something else, just
setup the variable &quot;require&quot; to contain the requirements. Multiple
requirements can be added white space separated.</p>
requirements can be added separated with (optionally consecutive)
delimiters including space, tab and newline.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="mi">1</span> <span class="c1"># No dependency</span>
<span class="mi">2</span> <span class="n">__file</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">cdist</span><span class="o">-</span><span class="n">configured</span>
<span class="mi">3</span>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>18. Messaging &mdash; cdist 6.7.0 documentation</title>
<title>18. Messaging &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>3. Supported operating systems &mdash; cdist 6.7.0 documentation</title>
<title>3. Supported operating systems &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>19. Parallelization &mdash; cdist 6.7.0 documentation</title>
<title>19. Parallelization &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>22. PreOS &mdash; cdist 6.7.0 documentation</title>
<title>22. PreOS &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>7. Quickstart &mdash; cdist 6.7.0 documentation</title>
<title>7. Quickstart &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>8. Dive into real world cdist &mdash; cdist 6.7.0 documentation</title>
<title>8. Dive into real world cdist &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>24. Reference &mdash; cdist 6.7.0 documentation</title>
<title>24. Reference &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>29. Remote exec and copy commands &mdash; cdist 6.7.0 documentation</title>
<title>29. Remote exec and copy commands &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>28. Saving output streams &mdash; cdist 6.7.0 documentation</title>
<title>28. Saving output streams &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>26. Execution stages &mdash; cdist 6.7.0 documentation</title>
<title>26. Execution stages &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>6. Support &mdash; cdist 6.7.0 documentation</title>
<title>6. Support &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>21. Trigger &mdash; cdist 6.7.0 documentation</title>
<title>21. Trigger &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>31. Troubleshooting &mdash; cdist 6.7.0 documentation</title>
<title>31. Troubleshooting &mdash; cdist 6.8.0 documentation</title>
@ -62,7 +62,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>15. cdist type &mdash; cdist 6.7.0 documentation</title>
<title>15. cdist type &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16. cdist types &mdash; cdist 6.7.0 documentation</title>
<title>16. cdist types &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>5. How to upgrade cdist &mdash; cdist 6.7.0 documentation</title>
<title>5. How to upgrade cdist &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>1. Why should I use cdist? &mdash; cdist 6.7.0 documentation</title>
<title>1. Why should I use cdist? &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Index &mdash; cdist 6.7.0 documentation</title>
<title>Index &mdash; cdist 6.8.0 documentation</title>
@ -62,7 +62,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>cdist - usable configuration management &mdash; cdist 6.7.0 documentation</title>
<title>cdist - usable configuration management &mdash; cdist 6.8.0 documentation</title>
@ -62,7 +62,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>10. cdist-dump(1) &mdash; cdist 6.7.0 documentation</title>
<title>10. cdist-dump(1) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>11. cdist-new-type(1) &mdash; cdist 6.7.0 documentation</title>
<title>11. cdist-new-type(1) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>9. cdist(1) &mdash; cdist 6.7.0 documentation</title>
<title>9. cdist(1) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.1. cdist-type__acl(7) &mdash; cdist 6.7.0 documentation</title>
<title>16.1. cdist-type__acl(7) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.2. cdist-type__apt_default_release(7) &mdash; cdist 6.7.0 documentation</title>
<title>16.2. cdist-type__apt_default_release(7) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.3. cdist-type__apt_key(7) &mdash; cdist 6.7.0 documentation</title>
<title>16.3. cdist-type__apt_key(7) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.4. cdist-type__apt_key_uri(7) &mdash; cdist 6.7.0 documentation</title>
<title>16.4. cdist-type__apt_key_uri(7) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.5. cdist-type__apt_mark(7) &mdash; cdist 6.7.0 documentation</title>
<title>16.5. cdist-type__apt_mark(7) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.6. cdist-type__apt_norecommends(7) &mdash; cdist 6.7.0 documentation</title>
<title>16.6. cdist-type__apt_norecommends(7) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.7. cdist-type__apt_ppa(7) &mdash; cdist 6.7.0 documentation</title>
<title>16.7. cdist-type__apt_ppa(7) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.8. cdist-type__apt_source(7) &mdash; cdist 6.7.0 documentation</title>
<title>16.8. cdist-type__apt_source(7) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.9. cdist-type__apt_unattended_upgrades(7) &mdash; cdist 6.7.0 documentation</title>
<title>16.9. cdist-type__apt_unattended_upgrades(7) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.10. cdist-type__apt_update_index(7) &mdash; cdist 6.7.0 documentation</title>
<title>16.10. cdist-type__apt_update_index(7) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.11. cdist-type__block(7) &mdash; cdist 6.7.0 documentation</title>
<title>16.11. cdist-type__block(7) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.12. cdist-type__ccollect_source(7) &mdash; cdist 6.7.0 documentation</title>
<title>16.12. cdist-type__ccollect_source(7) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.13. cdist-type__cdist(7) &mdash; cdist 6.7.0 documentation</title>
<title>16.13. cdist-type__cdist(7) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>16.14. cdist-type__cdist_preos_trigger(7) &mdash; cdist 6.7.0 documentation</title>
<title>16.14. cdist-type__cdist_preos_trigger(7) &mdash; cdist 6.8.0 documentation</title>
@ -63,7 +63,7 @@
<div class="version">
6.7.0
6.8.0
</div>