From cfa4ce0a6fe82ed8578fe4668998012ad3833e05 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Tue, 5 Feb 2013 11:36:49 -0500 Subject: added support for wildcard XInclude in XMLFileBacked --- doc/server/plugins/grouping/metadata.txt | 42 +++++++++++++++++++++++++++++--- 1 file changed, 39 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/server/plugins/grouping/metadata.txt b/doc/server/plugins/grouping/metadata.txt index a6ed37f8e..11b3d5496 100644 --- a/doc/server/plugins/grouping/metadata.txt +++ b/doc/server/plugins/grouping/metadata.txt @@ -197,9 +197,9 @@ useful results: .. code-block:: xml - - - + + + Each of the included groups files has the same format. These files are @@ -207,6 +207,42 @@ properly validated by ``bcfg2-lint``. This mechanism is useful for composing group definitions from multiple sources, or setting different permissions in an svn repository. +You can also optionally include a file that may or may not exist with +the ``fallback`` tag: + +.. code-block:: xml + + + + + + +In this case, if ``their-groups.xml`` does not exist, no error will be +raised and everything will work fine. (You can also use ``fallback`` +to include a different file, or explicit content in the case that the +parent include does not exist.) + +Wildcard XInclude +~~~~~~~~~~~~~~~~~ + +.. versionadded:: 1.3.1 + +Bcfg2 supports an extension to XInclude that allows you to use shell +globbing in the hrefs. (Stock XInclude doesn't support this, since +the href is supposed to be a URL.) + +For instance: + + + + + +This would include all ``*.xml`` files in the ``groups`` subdirectory. + +Note that if a glob finds no files, that is treated the same as if a +single included file does not exist. You should use the ``fallback`` +tag, described above, if a glob may potentially find no files. + Probes ====== -- cgit v1.2.3-1-g7c22 From b8ebd636ac3a5e2919b3e62041019f26acb1e2c0 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Thu, 7 Feb 2013 10:01:16 -0500 Subject: Metadata: allowed setting global default authentication type --- doc/appendix/guides/authentication.txt | 33 ++++++++++++++++++++++---------- doc/server/plugins/grouping/metadata.txt | 4 ++-- 2 files changed, 25 insertions(+), 12 deletions(-) (limited to 'doc') diff --git a/doc/appendix/guides/authentication.txt b/doc/appendix/guides/authentication.txt index 3fd0e1e2d..b8ec82590 100644 --- a/doc/appendix/guides/authentication.txt +++ b/doc/appendix/guides/authentication.txt @@ -132,13 +132,26 @@ controlled through the use of the auth attribute in Allowed values are: - +---------------+------------------------------------------+ - | **Auth Type** | **Meaning** | - +===============+==========================================+ - | cert | Certificates must be used | - +---------------+------------------------------------------+ - | cert+password | Certificate or password may be used | - +---------------+------------------------------------------+ - | bootstrap | Password can be used for one client run, | - | | after that certificate is required | - +---------------+------------------------------------------+ ++-------------------+------------------------------------------+ +| Auth Type | Meaning | ++===================+==========================================+ +| ``cert`` | Certificates must be used | ++-------------------+------------------------------------------+ +| ``cert+password`` | Certificate or password may be used. If | +| | a certificate is used, the password must | +| | also be used. | ++-------------------+------------------------------------------+ +| ``bootstrap`` | Password can be used for one client run, | +| | after that only certificate is allowed | ++-------------------+------------------------------------------+ + +``cert+password`` is the default. This can be changed by setting the +``authentication`` parameter in the ``[communcation]`` section of +``bcfg2.conf``. For instance, to set ``bootstrap`` mode as the global +default, you would add the following to ``bcfg2.conf``:: + + [communication] + authentication = bootstrap + +``bootstrap`` mode is currently incompatible with the +:ref:`server-plugins-grouping-metadata-clients-database`. diff --git a/doc/server/plugins/grouping/metadata.txt b/doc/server/plugins/grouping/metadata.txt index 11b3d5496..f4c5cbcb3 100644 --- a/doc/server/plugins/grouping/metadata.txt +++ b/doc/server/plugins/grouping/metadata.txt @@ -32,7 +32,7 @@ clients.xml =========== The ``clients.xml`` file contains the mappings of Profile Groups -to clients. The file is just a series of ** tags, each of which +to clients. The file is just a series of ```` tags, each of which describe one host. A sample file is below: .. code-block:: xml @@ -43,7 +43,7 @@ describe one host. A sample file is below: - + -- cgit v1.2.3-1-g7c22 From d526c8745b61c1977b775cfe750a86c51dd6a9f3 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Wed, 13 Feb 2013 16:07:30 -0500 Subject: added docs for Bcfg2.Utils --- doc/development/client-driver.txt | 9 +++++++-- doc/development/plugins.txt | 8 +++++++- doc/development/utils.txt | 15 +++++++++++++++ 3 files changed, 29 insertions(+), 3 deletions(-) create mode 100644 doc/development/utils.txt (limited to 'doc') diff --git a/doc/development/client-driver.txt b/doc/development/client-driver.txt index 29216acd5..5977f2a91 100644 --- a/doc/development/client-driver.txt +++ b/doc/development/client-driver.txt @@ -65,6 +65,11 @@ Base Classes Helper Classes -------------- -.. autoclass:: Bcfg2.Client.Tools.ClassName -.. autoclass:: Bcfg2.Client.Tools.Executor .. autoclass:: Bcfg2.Client.Tools.ToolInstantiationError + +See Also +-------- + +* :ref:`development-compat` +* :ref:`development-utils` + diff --git a/doc/development/plugins.txt b/doc/development/plugins.txt index 91a4e6868..593c2f83e 100644 --- a/doc/development/plugins.txt +++ b/doc/development/plugins.txt @@ -175,7 +175,7 @@ decorate functions that you would like to track execution times for: .. code-block:: python from Bcfg2.Server.Plugin import track_statistics - + @track_statistics() def do_something(self, ...): ... @@ -208,3 +208,9 @@ Plugin Exceptions ----------------- .. automodule:: Bcfg2.Server.Plugin.exceptions + +See Also +-------- + +* :ref:`development-compat` +* :ref:`development-utils diff --git a/doc/development/utils.txt b/doc/development/utils.txt new file mode 100644 index 000000000..a4c158bf0 --- /dev/null +++ b/doc/development/utils.txt @@ -0,0 +1,15 @@ +.. -*- mode: rst -*- + +.. _development-utils: + +================ +Common Utilities +================ + +Some helper functions, classes, etc., are useful to both the client +and server. Some of these are used to maintain +:ref:`development-compat`, and should go in ``Bcfg2.Compat``. Those +that aren't strictly for Python compatibility go in ``Bcfg2.Utils``, +which is documented below. + +.. automodule:: Bcfg2.Utils -- cgit v1.2.3-1-g7c22 From 689c1519ced43315a4d8c78128c517743d772dce Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Thu, 21 Mar 2013 13:37:23 -0400 Subject: more consistent XML-RPC debug calls for FAM --- doc/help/troubleshooting.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/help/troubleshooting.txt b/doc/help/troubleshooting.txt index 35c1e93a2..aac831ae0 100644 --- a/doc/help/troubleshooting.txt +++ b/doc/help/troubleshooting.txt @@ -56,8 +56,8 @@ the debug level individually on a given plugin, e.g.:: Finally, the File Activity Monitor has its own analogue to these two methods, for setting the debug level of the FAM: - bcfg2-admin xcmd toggle_fam_debug - bcfg2-admin xcmd set_fam_debug false + bcfg2-admin xcmd Inotify.toggle_debug + bcfg2-admin xcmd Inotify.set_debug false Check if all repository XML files conform to schemas ==================================================== -- cgit v1.2.3-1-g7c22