summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2011-08-03 15:42:28 -0400
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2011-08-03 15:43:31 -0400
commitae44f106be38fe5d073260e2edaa3126861d9e6f (patch)
treee57f357489cf4e786bed4614c0f558f147065e1b /doc
parent95b5cb0fe306b13ec9788f0e36f5ca02b31b5a79 (diff)
downloadbcfg2-ae44f106be38fe5d073260e2edaa3126861d9e6f.tar.gz
bcfg2-ae44f106be38fe5d073260e2edaa3126861d9e6f.tar.bz2
bcfg2-ae44f106be38fe5d073260e2edaa3126861d9e6f.zip
added buildbundle command to bcfg2-info to render a bundle template
Diffstat (limited to 'doc')
-rw-r--r--doc/help/troubleshooting.txt1
-rw-r--r--doc/server/bcfg2-info.txt6
-rw-r--r--doc/server/plugins/structures/bundler/index.txt20
3 files changed, 12 insertions, 15 deletions
diff --git a/doc/help/troubleshooting.txt b/doc/help/troubleshooting.txt
index cb68a02c5..b0eeca33e 100644
--- a/doc/help/troubleshooting.txt
+++ b/doc/help/troubleshooting.txt
@@ -71,6 +71,7 @@ operations
* groups - Current group metadata values
* mappings - Configuration entries provided by plugins
* buildfile <filename> <hostname> - Build a config file for a client
+* buildbundle <bundle> <hostname> - Render a templated bundle for a client
* showentries <client> <type> - Build the abstract configuration (list
of entries) for a client
* build <hostname> <output-file> - Build the complete configuration
diff --git a/doc/server/bcfg2-info.txt b/doc/server/bcfg2-info.txt
index 201900ba9..912cb73ab 100644
--- a/doc/server/bcfg2-info.txt
+++ b/doc/server/bcfg2-info.txt
@@ -92,6 +92,12 @@ commands.
displays a list of entries (optionally filtered by type) that
appear in a client's configuration specification
+**buildbundle**
+ Render a single bundle template. This only performs the template
+ rendering step; it does not fully bind all entries in the
+ bundle. This command is very useful when developing bundle
+ templates.
+
**buildfile**
Perform the entry binding process on a single entry, displaying
its results. This command is very useful when developing
diff --git a/doc/server/plugins/structures/bundler/index.txt b/doc/server/plugins/structures/bundler/index.txt
index ad0c0c7f1..0cc2a0e55 100644
--- a/doc/server/plugins/structures/bundler/index.txt
+++ b/doc/server/plugins/structures/bundler/index.txt
@@ -169,24 +169,14 @@ has an additional `xmlns:py` attribute. See the examples.
Troubleshooting
---------------
-There is no :ref:`bcfg2-info <server-bcfg2-info>` command like
-``buildfile`` for Bundler templates, so if you want to generate a
-Bundler template for a given client, you have to do so manually by
-first invoking ``bcfg2-info debug``, then run::
+To render a bundle for a given client, you can run::
- metadata = self.build_metadata("<hostname>")
- path = "<full path to template file>"
- from genshi.template import TemplateLoader, MarkupTemplate
- template = TemplateLoader().load(path, cls=MarkupTemplate)
- print template.generate(metadata=metadata).render('xml')
+ bcfg2-info buildbundle <bundle name> <hostname>
-``path`` needs to be the full path to the template file on the
-filesystem, not just within the Bcfg2 repo.
+This will render the template; it will not fully bind all of the
+entries in the bundle.
-If you are making changes to your template and you want to tell your
-filemonitor to process any pending changes, you can do the following::
-
- self.fam.handle_events_in_interval(0.1)
+See :ref:`bcfg2-info <server-bcfg2-info>` for more details.
Altsrc
======