From a44304d3fcb3fa4ec186e7ebbeb4d4e72f25e9de Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Thu, 28 Oct 2010 17:09:10 -0500 Subject: doc: Move Properties plugin documentation under connectors Signed-off-by: Sol Jerome --- doc/server/plugins/connectors/properties.txt | 46 ++++++++++++++++++++++++++++ doc/server/plugins/index.txt | 10 +++++- doc/server/plugins/properties.txt | 46 ---------------------------- 3 files changed, 55 insertions(+), 47 deletions(-) create mode 100644 doc/server/plugins/connectors/properties.txt delete mode 100644 doc/server/plugins/properties.txt diff --git a/doc/server/plugins/connectors/properties.txt b/doc/server/plugins/connectors/properties.txt new file mode 100644 index 000000000..fa8bfd884 --- /dev/null +++ b/doc/server/plugins/connectors/properties.txt @@ -0,0 +1,46 @@ +.. -*- mode: rst -*- + +.. _server-plugins-properties: + +========== +Properties +========== + +The Properties plugin is a connector plugin that adds information from +properties files into client metadata instances. + +Enabling Properties +=================== + +First, ``mkdir /var/lib/bcfg2/Properties``. Each property XML file goes +in this directory. Each will automatically be cached by the server, +and reread/reparsed upon changes. Add **Properties** to your ``plugins`` +line in ``/etc/bcfg2.conf``. + +Data Structures +=============== + +Properties adds a new dictionary to client metadata instances that maps +property file names to PropertyFile instances. PropertyFile instances +contain parsed XML data as the "data" attribute. + +Usage +===== + +Specific property files can be referred to in +templates as metadata.Properties[]. The +data attribute is an LXML element object. (Documented +`here `_) + +Currently, no access methods are defined for this data, but as we +formulate common use cases, we will add them to the !PropertyFile class +as methods. This will simplify templates. + +Accessing Properties contest from TGenshi +========================================= + +Access contents of ``Properties/auth.xml`` + +:: + + ${metadata.Properties['auth.xml'].data.find('file').find('bcfg2.key').text} diff --git a/doc/server/plugins/index.txt b/doc/server/plugins/index.txt index 126331325..61f91da86 100644 --- a/doc/server/plugins/index.txt +++ b/doc/server/plugins/index.txt @@ -68,6 +68,15 @@ Literal Configuration (Generators) Each of these plugins has a corresponding subdirectory with the same name in the Bcfg2 repository. +Connector Plugins +----------------- + +.. toctree:: + :maxdepth: 2 + :glob: + + connectors/* + Statistics Plugins ------------------ @@ -103,5 +112,4 @@ More details can be found in :ref:`server-plugins-plugin-roles` plugin-roles probes/index - properties trigger diff --git a/doc/server/plugins/properties.txt b/doc/server/plugins/properties.txt deleted file mode 100644 index fa8bfd884..000000000 --- a/doc/server/plugins/properties.txt +++ /dev/null @@ -1,46 +0,0 @@ -.. -*- mode: rst -*- - -.. _server-plugins-properties: - -========== -Properties -========== - -The Properties plugin is a connector plugin that adds information from -properties files into client metadata instances. - -Enabling Properties -=================== - -First, ``mkdir /var/lib/bcfg2/Properties``. Each property XML file goes -in this directory. Each will automatically be cached by the server, -and reread/reparsed upon changes. Add **Properties** to your ``plugins`` -line in ``/etc/bcfg2.conf``. - -Data Structures -=============== - -Properties adds a new dictionary to client metadata instances that maps -property file names to PropertyFile instances. PropertyFile instances -contain parsed XML data as the "data" attribute. - -Usage -===== - -Specific property files can be referred to in -templates as metadata.Properties[]. The -data attribute is an LXML element object. (Documented -`here `_) - -Currently, no access methods are defined for this data, but as we -formulate common use cases, we will add them to the !PropertyFile class -as methods. This will simplify templates. - -Accessing Properties contest from TGenshi -========================================= - -Access contents of ``Properties/auth.xml`` - -:: - - ${metadata.Properties['auth.xml'].data.find('file').find('bcfg2.key').text} -- cgit v1.2.3-1-g7c22