diff options
| author | Michal Minar <miminar@redhat.com> | 2013-10-11 10:12:51 +0200 |
|---|---|---|
| committer | Michal Minar <miminar@redhat.com> | 2013-10-15 15:31:26 +0200 |
| commit | 17c74a7ecb2d241f6f0aa01b97b552c2855847e4 (patch) | |
| tree | 8ac9a55cebfbb381e73648e28c53ea981772b41d | |
| parent | e8ba6662501696e596e206ea691d7c7a8dd92849 (diff) | |
| download | openlmi-providers-17c74a7ecb2d241f6f0aa01b97b552c2855847e4.tar.gz openlmi-providers-17c74a7ecb2d241f6f0aa01b97b552c2855847e4.tar.xz openlmi-providers-17c74a7ecb2d241f6f0aa01b97b552c2855847e4.zip | |
documentation: extended configuration section
| -rw-r--r-- | src/software/doc/admin/configuration.rst | 4 | ||||
| -rw-r--r-- | tools/gendoc/doc/config.rst | 85 |
2 files changed, 70 insertions, 19 deletions
diff --git a/src/software/doc/admin/configuration.rst b/src/software/doc/admin/configuration.rst index 10f9c98..028f399 100644 --- a/src/software/doc/admin/configuration.rst +++ b/src/software/doc/admin/configuration.rst @@ -17,6 +17,10 @@ specify options common to all in the global configuration file, while the values specific for particular provider can be overriden in its main one (``/etc/openlmi/${provider}/${provider}.conf``). +.. + TODO: once we have a stable hosting for all OpenLMI documetation, let's + just point to top-level Configuration page. + Treating boolean values ----------------------- Options expecting boolean values treat following strings as valid ``True`` diff --git a/tools/gendoc/doc/config.rst b/tools/gendoc/doc/config.rst index 0c28609..398df3d 100644 --- a/tools/gendoc/doc/config.rst +++ b/tools/gendoc/doc/config.rst @@ -30,25 +30,62 @@ Default configuration:: Level=ERROR Stderr=false -======= =================== ==================== =========== -Section Option name Default value Desciption -======= =================== ==================== =========== -``CIM`` ``Namespace`` root/cimv2 Namespace where OpenLMI providers are registered. -``CIM`` ``SystemClassName`` PG_ComputerSystem Name of CIM_ComputerSystem class, which is used to represent the computer system. It will be used as ``SystemClassName`` property value of various classes. -``Log`` ``Level`` ERROR Chooses which messages are logged, either to CIMOM and (if configured) to standard error output. Available levels (sorted by severity) are: - - * CRITICAL - * ERROR - * WARNING - * INFO - * DEBUG - * TRACE_WARNING - * TRACE_INFO - * TRACE_VERBOSE - - Levels below INFO (= TRACE_WARNING, TRACE_INFO and DEBUG) are useful mainly for debugging and bug reporting. -``Log`` ``Stderr`` false Toggles sending of log messages to standard error output of the CIMOM. -======= =================== ==================== =========== ++---------+---------------------+-----------------------+-------------------------------------------------------------------+ +| Section | Option name | Default value | Description | ++=========+=====================+=======================+===================================================================+ +| ``CIM`` | ``Namespace`` | ``root/cimv2`` | Namespace where OpenLMI providers are registered. | ++---------+---------------------+-----------------------+-------------------------------------------------------------------+ +| ``CIM`` | ``SystemClassName`` | ``PG_ComputerSystem`` | Name of ``CIM_ComputerSystem`` class, which is used to represent | +| | | | the computer system. It will be used as ``SystemClassName`` | +| | | | property value of various classes. Different cimmoms can | +| | | | instrument variously named computer systems and some may not | +| | | | instrument any at all. `Sfcb`_ is an example of the later, it | +| | | | needs the ``sblim-cmpi-base`` package installed providing the | +| | | | basic set of providers containing ``Linux_ComputerSystem``. So in | +| | | | case you run a ``Sfcb`` or you preferr to use providers from | +| | | | ``sblim-cmpi-base`` package, you need to change this to | +| | | | ``Linux_ComputerSystem``. | ++---------+---------------------+-----------------------+-------------------------------------------------------------------+ +| ``Log`` | ``Level`` | ``ERROR`` | Chooses which messages are logged, either to CIMOM and (if | +| | | | configured) to standard error output. Available levels | +| | | | (sorted by severity) are: | +| | | | | +| | | | * ``CRITICAL`` | +| | | | * ``ERROR`` | +| | | | * ``WARNING`` | +| | | | * ``INFO`` | +| | | | * ``DEBUG`` | +| | | | * ``TRACE_WARNING`` | +| | | | * ``TRACE_INFO`` | +| | | | * ``TRACE_VERBOSE`` | +| | | | | +| | | | Levels below ``INFO`` (= ``TRACE_WARNING``, ``TRACE_INFO`` | +| | | | and ``DEBUG``) are useful mainly for debugging and bug | +| | | | reporting. | ++---------+---------------------+-----------------------+-------------------------------------------------------------------+ +| ``Log`` | ``Stderr`` | ``False`` | Toggles sending of log messages to standard error output of the | +| | | | CIMOM. Accepts boolean value (see the next section). | ++---------+---------------------+-----------------------+-------------------------------------------------------------------+ + +Treating boolean values +----------------------- +Options expecting boolean values treat following strings as valid ``True`` +values: + + * ``true`` + * ``1`` + * ``yes`` + * ``on`` + +While the following are considered ``False``: + + * ``false`` + * ``0`` + * ``no`` + * ``off`` + +These words are checked in a case-insensitive way. Any other value isn't +considered valid [1]_. Logging ======= @@ -63,3 +100,13 @@ documentation how to enable tracing logs. With ``Stderr`` configuration option enabled, all logs are sent both to CIMOM and to the standard error output of the CIMOM. + +------------------------------------------------------------------------------- + +.. [1] Default value will be used as a fallback. This applies also to other + non-boolean options in case of invalid value. + +.. **************************************************************************** + +.. _Sfcb: http://sourceforge.net/apps/mediawiki/sblim/index.php?title=Sfcb + |