summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoe Digilio <jdigilio@imca.aps.anl.gov>2011-09-26 13:26:02 -0500
committerSol Jerome <sol.jerome@gmail.com>2011-10-12 10:39:10 -0500
commitbeed44ac11bbf70449c080262f98fb3ecb951c62 (patch)
tree471655db5dec83aa10fcfd886e9477d6e7673c66 /doc
parent86452547586c80eb8f6c433c9acc14f4de451e15 (diff)
downloadbcfg2-beed44ac11bbf70449c080262f98fb3ecb951c62.tar.gz
bcfg2-beed44ac11bbf70449c080262f98fb3ecb951c62.tar.bz2
bcfg2-beed44ac11bbf70449c080262f98fb3ecb951c62.zip
Cfg: Add support for .cheetah files
Diffstat (limited to 'doc')
-rw-r--r--doc/server/plugins/generators/cfg.txt45
1 files changed, 36 insertions, 9 deletions
diff --git a/doc/server/plugins/generators/cfg.txt b/doc/server/plugins/generators/cfg.txt
index 1039ff556..1c8f6f11a 100644
--- a/doc/server/plugins/generators/cfg.txt
+++ b/doc/server/plugins/generators/cfg.txt
@@ -29,8 +29,8 @@ in ``Cfg/etc/passwd/passwd``, while the ssh pam module config file,
``/etc/pam.d/sshd``, goes in ``Cfg/etc/pam.d/sshd/sshd``. The reason for
the like-name directory is to allow multiple versions of each file to
exist, as described below. Note that these files are exact copies of what
-will appear on the client machine (except when using genshi templating --
-see below).
+will appear on the client machine (except when using genshi or cheetah
+templating -- see below).
Group-Specific Files
====================
@@ -150,25 +150,52 @@ file. The reason the other deltas aren't applied to *foo.example.com*
is because a **.H_** delta is more specific than a **.G##_** delta. Bcfg2
applies all the deltas at the most specific level.
+Templates
+=========
+
Genshi Templates
-================
+----------------
Genshi templates maybe used for entries as well. Any file ending in .genshi
will be processed using the new template style (like .newtxt in the TGenshi
-plugin). Templates can be host and group specific as well. Deltas will not
-be processed for any genshi base file.
+plugin).
+
+Cheetah Templates
+-----------------
+
+Cheetah templates maybe used for entries as well. Simply name your file
+with a .cheetah extenstion and it will be processed like the TCheetah
+plugin.
+
+Notes on Using Templates
+------------------------
+
+Templates can be host and group specific as well. Deltas will not be
+processed for any genshi or cheetah base file.
.. note::
- If you are using genshi templating in combination with host-specific
+ If you are using templating in combination with host-specific
or group-specific files, you will need to ensure that the ``.genshi``
- extensions is at the **end** of the filename. Using the examples
- from above for *host.example.com* and group *server* you would have
- the following::
+ or ``.cheetah`` extension is at the **end** of the filename. Using the
+ examples from above for *host.example.com* and group *server* you would
+ have the following (using genshi only)::
Cfg/etc/fstab/fstab.H_host.example.com.genshi
Cfg/etc/fstab/fstab.G50_server.genshi
+Genshi templates take precence over cheetah templates. For example, if
+two files exist named
+
+ Cfg/etc/fstab/fstab.genshi
+ Cfg/etc/fstab/fstab.cheetah
+
+the cheetah template is ignored. But you can mix genshi and cheetah when
+using different host-specific or group-specific files. For example:
+
+ Cfg/etc/fstab/fstab.H_host.example.com.genshi
+ Cfg/etc/fstab/fstab.G50_server.cheetah
+
File permissions
================