document definition of directories

This commit is contained in:
2023-04-12 11:40:10 +02:00
parent 2a71be6953
commit f77ca1164e

View File

@@ -11,6 +11,7 @@ Parameters
**Name** **Type** **Default**
------------------------------- -------- ------------------------------------------------
symlinks hash hiera('files::symlinks')
directories hash hiera_hash('files::directories')
=============================== ======== ================================================
@@ -25,3 +26,20 @@ Example::
files::symlinks:
'/opt/foo': '/var/lib/foo'
``directories``
~~~~~~~~~~~~~~~
A hash specifying directories to be created. The keys of the hash are the absolute
pathnames of the directory, the optional values can be ``owner``, ``group`` (default is ``root`` for both) and the ``mode`` (default ``755``). Parent directories are automatically created with default settings. If that is not desired, do a custom definition for each parent directory too.
Example::
files::directories:
/etc/test1:
/etc/test2/foo/bar:
owner: 'buchel_k'
group: 'unx-nogroup'
mode: '775'