summaryrefslogtreecommitdiffstats
path: root/doc/server/configurationentries.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/server/configurationentries.txt')
-rw-r--r--doc/server/configurationentries.txt62
1 files changed, 62 insertions, 0 deletions
diff --git a/doc/server/configurationentries.txt b/doc/server/configurationentries.txt
new file mode 100644
index 000000000..d4a1407d2
--- /dev/null
+++ b/doc/server/configurationentries.txt
@@ -0,0 +1,62 @@
+.. -*- mode: rst -*-
+
+.. _server-configurationentries:
+
+Configuration Entries
+---------------------
+
+This page describes the names and semantics of each of the configuration
+entries used by Bcfg2.
+
+Common non-POSIX entries
+^^^^^^^^^^^^^^^^^^^^^^^^
+
++-------------+---------------------+-----------------------------+
+| TagName | Description | Attributes |
++=============+=====================+=============================+
+| Action | Command | name, command, when, timing |
++-------------+---------------------+-----------------------------+
+| Package | Software Packages | name, type, version, url |
++-------------+---------------------+-----------------------------+
+| PostInstall | PostInstall command | name |
++-------------+---------------------+-----------------------------+
+| Service | System Services | name, type, status, reload |
++-------------+---------------------+-----------------------------+
+
+POSIX entries
+^^^^^^^^^^^^^
+
+In 1.0.0, there are new unified POSIX Path entries which prevent
+inconsistent configuration specifications of multiple entries for a given
+path. The following table describes the various types available for new
+**Path** entries.
+
++-------------+----------------------+-----------------+--------------------------+
+| Type | Replacement/New | Description | Attributes |
++=============+======================+=================+==========================+
+| device | New | Create block, | name, owner, group, |
+| | | character, and | dev_type |
+| | | fifo devices | (block, char, fifo), |
+| | | | major/minor |
+| | | | (for block/char devices) |
++-------------+----------------------+-----------------+--------------------------+
+| directory | Replaces Directory | Directories | name, owner, group, |
+| | entries | | perms, prune |
++-------------+----------------------+-----------------+--------------------------+
+| file | Replaces ConfigFile | Configuration | name, owner, group, |
+| | entries | File | perms, encoding, empty |
++-------------+----------------------+-----------------+--------------------------+
+| hardlink | New | Create | name, to |
+| | | hardlinks | |
++-------------+----------------------+-----------------+--------------------------+
+| nonexistent | New | Specify a path | name |
+| | | that should not | |
+| | | exist | |
++-------------+----------------------+-----------------+--------------------------+
+| permissions | Replaces Permissions | Permissions of | name, owner, |
+| | entries | POSIX entities | group, perms |
+| | | | |
++-------------+----------------------+-----------------+--------------------------+
+| symlink | Replaces SymLink | SymLinks | name, to |
+| | entries | | |
++-------------+----------------------+-----------------+--------------------------+