Commit f0c54b83 authored by Darko Poljak's avatar Darko Poljak

Update cdist beta docs

parent 3b069095
......@@ -144,6 +144,7 @@ The following types are available:
- __apt_norecommends (`cdist-type__apt_norecommends(7) <man7/cdist-type__apt_norecommends.html>`_)
- __apt_ppa (`cdist-type__apt_ppa(7) <man7/cdist-type__apt_ppa.html>`_)
- __apt_source (`cdist-type__apt_source(7) <man7/cdist-type__apt_source.html>`_)
- __apt_unattended_upgrades (`cdist-type__apt_unattended_upgrades(7) <man7/cdist-type__apt_unattended_upgrades.html>`_)
- __apt_update_index (`cdist-type__apt_update_index(7) <man7/cdist-type__apt_update_index.html>`_)
- __block (`cdist-type__block(7) <man7/cdist-type__block.html>`_)
- __ccollect_source (`cdist-type__ccollect_source(7) <man7/cdist-type__ccollect_source.html>`_)
......
......@@ -12,6 +12,7 @@ cdist types
__apt_norecommends <man7/cdist-type__apt_norecommends>
__apt_ppa <man7/cdist-type__apt_ppa>
__apt_source <man7/cdist-type__apt_source>
__apt_unattended_upgrades <man7/cdist-type__apt_unattended_upgrades>
__apt_update_index <man7/cdist-type__apt_update_index>
__block <man7/cdist-type__block>
__ccollect_source <man7/cdist-type__ccollect_source>
......
......@@ -59,7 +59,9 @@ SYNOPSIS
[-I INVENTORY_DIR] [-a] [-f HOSTFILE] [-H] [-t]
[host [host ...]]
cdist preos [-h] [-l LOGLEVEL] [-q] [-v] [-c CONF_DIR] [-L] [preos] ...
cdist preos [-h] [-l LOGLEVEL] [-q] [-v] [-c CONF_DIR] [-g CONFIG_FILE]
[-L]
[preos] ...
cdist preos [preos-options] debian [-h] [-l LOGLEVEL] [-q] [-v] [-b] [-a ARCH] [-B]
[-C] [-c CDIST_PARAMS] [-D DRIVE] [-e REMOTE_EXEC]
......@@ -474,6 +476,9 @@ Create PreOS.
**-c CONF_DIR, --conf-dir CONF_DIR**
Add configuration directory (one that contains "preos" subdirectory).
**-g CONFIG_FILE, --config-file CONFIG_FILE**
Use specified custom configuration file.
**-L, --list-preoses**
List available PreOS-es.
......
......@@ -15,10 +15,24 @@ See ``setfacl`` and ``acl`` manpages for more details.
REQUIRED MULTIPLE PARAMETERS
----------------------------
acl
entry
Set ACL entry following ``getfacl`` output syntax.
OPTIONAL PARAMETERS
-------------------
source
Read ACL entries from stdin or file.
Ordering of entries is not important.
When reading from file, comments and empty lines are ignored.
file
Create/change file with ``__file`` using ``user:group:mode`` pattern.
directory
Create/change directory with ``__directory`` using ``user:group:mode`` pattern.
BOOLEAN PARAMETERS
------------------
default
......@@ -36,8 +50,8 @@ remove
DEPRECATED PARAMETERS
---------------------
Parameters ``user``, ``group``, ``mask`` and ``other`` are deprecated and they
will be removed in future versions. Please use ``acl`` parameter instead.
Parameters ``acl``, ``user``, ``group``, ``mask`` and ``other`` are deprecated and they
will be removed in future versions. Please use ``entry`` parameter instead.
EXAMPLES
......@@ -49,27 +63,38 @@ EXAMPLES
--default \
--recursive \
--remove \
--acl user:alice:rwx \
--acl user:bob:r-x \
--acl group:project-group:rwx \
--acl group:some-other-group:r-x \
--acl mask::r-x \
--acl other::r-x
--entry user:alice:rwx \
--entry user:bob:r-x \
--entry group:project-group:rwx \
--entry group:some-other-group:r-x \
--entry mask::r-x \
--entry other::r-x
# give Alice read-only access to subdir,
# but don't allow her to see parent content.
__acl /srv/project2 \
--remove \
--acl default:group:secret-project:rwx \
--acl group:secret-project:rwx \
--acl user:alice:--x
--entry default:group:secret-project:rwx \
--entry group:secret-project:rwx \
--entry user:alice:--x
__acl /srv/project2/subdir \
--default \
--remove \
--acl group:secret-project:rwx \
--acl user:alice:r-x
--entry group:secret-project:rwx \
--entry user:alice:r-x
# read acl from stdin
echo 'user:alice:rwx' \
| __acl /path/to/directory --source -
# create/change directory too
__acl /path/to/directory \
--default \
--remove \
--directory root:root:770 \
--entry user:nobody:rwx
AUTHORS
......
cdist-type__apt_unattended_upgrades(7)
======================================
NAME
----
cdist-type__apt_unattended_upgrades - automatic installation of updates
DESCRIPTION
-----------
Install and configure unattended-upgrades package.
For more information see https://wiki.debian.org/UnattendedUpgrades.
OPTIONAL MULTIPLE PARAMETERS
----------------------------
option
Set options for unattended-upgrades. See examples.
Supported options with default values (as of 2020-01-17) are:
- AutoFixInterruptedDpkg, default is "true"
- MinimalSteps, default is "true"
- InstallOnShutdown, default is "false"
- Mail, default is "" (empty)
- MailOnlyOnError, default is "false"
- Remove-Unused-Kernel-Packages, default is "true"
- Remove-New-Unused-Dependencies, default is "true"
- Remove-Unused-Dependencies, default is "false"
- Automatic-Reboot, default is "false"
- Automatic-Reboot-WithUsers, default is "true"
- Automatic-Reboot-Time, default is "02:00"
- SyslogEnable, default is "false"
- SyslogFacility, default is "daemon"
- OnlyOnACPower, default is "true"
- Skip-Updates-On-Metered-Connections, default is "true"
- Verbose, default is "false"
- Debug, default is "false"
blacklist
Python regular expressions, matching packages to exclude from upgrading.
EXAMPLES
--------
.. code-block:: sh
__apt_unattended_upgrades \
--option Mail=root \
--option MailOnlyOnError=true \
--blacklist multipath-tools \
--blacklist open-iscsi
AUTHORS
-------
Ander Punnar <ander-at-kvlt-dot-ee>
COPYING
-------
Copyright \(C) 2020 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.
......@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>25. Best practice &mdash; cdist 6.4.0 documentation</title>
<title>25. Best practice &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.0
</div>
......
......@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>12. Bootstrap &mdash; cdist 6.4.0 documentation</title>
<title>12. Bootstrap &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.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.4.0 documentation</title>
<title>27. Local cache overview &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.0
</div>
......
......@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>13. Configuration &mdash; cdist 6.4.0 documentation</title>
<title>13. Configuration &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.0
</div>
......
......@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>17. Explorer &mdash; cdist 6.4.0 documentation</title>
<title>17. Explorer &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -45,7 +45,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.157. cdist-type__zypper_service(7)" href="man7/cdist-type__zypper_service.html" />
<link rel="prev" title="16.158. cdist-type__zypper_service(7)" href="man7/cdist-type__zypper_service.html" />
</head>
<body class="wy-body-for-nav">
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.0
</div>
......@@ -254,7 +254,7 @@ dpkg -s <span class="s2">&quot;</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.157. 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.158. cdist-type__zypper_service(7)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
......
......@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>2. Features &mdash; cdist 6.4.0 documentation</title>
<title>2. Features &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.0
</div>
......
......@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>30. Hacking &mdash; cdist 6.4.0 documentation</title>
<title>30. Hacking &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.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.4.0 documentation</title>
<title>4. How to install cdist &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.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.4.0 documentation</title>
<title>23. cdist integration / using cdist as library &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.0
</div>
......
......@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>20. Inventory &mdash; cdist 6.4.0 documentation</title>
<title>20. Inventory &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.0
</div>
......
......@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>14. Manifest &mdash; cdist 6.4.0 documentation</title>
<title>14. Manifest &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.0
</div>
......
......@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>18. Messaging &mdash; cdist 6.4.0 documentation</title>
<title>18. Messaging &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.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.4.0 documentation</title>
<title>3. Supported operating systems &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.0
</div>
......
......@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>19. Parallelization &mdash; cdist 6.4.0 documentation</title>
<title>19. Parallelization &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.0
</div>
......
......@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>22. PreOS &mdash; cdist 6.4.0 documentation</title>
<title>22. PreOS &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.0
</div>
......
......@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>7. Quickstart &mdash; cdist 6.4.0 documentation</title>
<title>7. Quickstart &mdash; cdist 6.5.0 documentation</title>
......@@ -23,7 +23,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'6.4.0',
VERSION:'6.5.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
......@@ -72,7 +72,7 @@
<div class="version">
6.4.0
6.5.0
</div>
......