Code

Unified project description across all documentation.
authorSebastian Harl <sh@tokkee.org>
Mon, 12 May 2014 10:25:56 +0000 (12:25 +0200)
committerSebastian Harl <sh@tokkee.org>
Mon, 12 May 2014 10:25:56 +0000 (12:25 +0200)
README
ReleaseNotes
doc/sysdb-description.txt
doc/sysdbd.1.txt

diff --git a/README b/README
index d3d4d6200e127d6826b61d24fbd4d68d4db25f4c..7371c46e3fcd6f86a64b4e13086bed313bc143ae 100644 (file)
--- a/README
+++ b/README
@@ -2,12 +2,22 @@
        ===============================================================
 
   “System DataBase” (SysDB) is a multi-backend system management and inventory
        ===============================================================
 
   “System DataBase” (SysDB) is a multi-backend system management and inventory
-  collection service. It may be used to (continuously) collect information
-  about your systems from various backends (inventory services, monitoring
-  services, etc.) and provides a unique interface to access the information
-  independent of the active backends. This is done by storing and mapping the
-  backend objects to generic objects and correlating the attributes to create
-  a single hierarchical view of your infrastructure.
+  collection service. It stores system and inventory information about
+  hardware and software systems. This information is (continuously) collected
+  from various configurable backends (inventory services, monitoring services,
+  etc.) and stored in a graph-like hierarchy of generic objects. The store may
+  be queried through a generic interface independent of the active backends.
+  Object names are canonicalized before they are added to the store to ensure
+  a consistent view of your infrastructure.
+
+  The central object type is a host, which generally represents a physical or
+  virtual machine or any other type of physical resource. Hosts, in turn, may
+  reference a list of services which represent any kind of logical resource
+  like a software system. Both, hosts and services, may reference a list of
+  attributes which represent further information about the respective host or
+  service object. For example, attributes may specify static information like
+  a host's architecture or the software version or reference performance data
+  like the current memory utilization or much more.
 
   SysDB is free and open source software, licensed under the 2-clause BSD
   license. See COPYING for details.
 
   SysDB is free and open source software, licensed under the 2-clause BSD
   license. See COPYING for details.
index 341f58f1af0bd5db6327f5dd01c2dc8d5df05fa8..f7a510193e74a8e931912a720df86676c5d3d94d 100644 (file)
@@ -9,10 +9,13 @@
  About SysDB:
  ~~~~~~~~~~~~
   “System DataBase” (SysDB) is a multi-backend system management and inventory
  About SysDB:
  ~~~~~~~~~~~~
   “System DataBase” (SysDB) is a multi-backend system management and inventory
-  collection service. It may be used to (continuously) collect information
-  about your systems from various backends (inventory services, monitoring
-  services, etc.) and provides a unique interface to access the information
-  independent of the active backends.
+  collection service. It stores system and inventory information about
+  hardware and software systems. This information is (continuously) collected
+  from various configurable backends (inventory services, monitoring services,
+  etc.) and stored in a graph-like hierarchy of generic objects. The store may
+  be queried through a generic interface independent of the active backends.
+  Object names are canonicalized before they are added to the store to ensure
+  a consistent view of your infrastructure.
 
   <https://github.com/tokkee/sysdb>
 
 
   <https://github.com/tokkee/sysdb>
 
index 64cecf38dfdd069586fd03be676c457d37d203c3..ea9df3233ff097307528b35713734219e237626e 100644 (file)
@@ -1,11 +1,18 @@
-SysDB stores system and inventory information about hardware and software
-systems. This information is stored in a graph-like hierarchy of generic
-objects. The central object type is a host, which generally represents a
-physical or virtual machine or any other type of physical resource. Hosts, in
-turn, may reference a list of services which represent any kind of logical
-resource like a software system. Both, hosts and services, may reference a
-list of attributes which represent further information about the respective
-host or service object. For example, attributes may specify static information
-like a host's architecture or the software version or snapshots of performance
-data like the current memory utilization or much more.
+“System DataBase” (SysDB) is a multi-backend system management and inventory
+collection service. It stores system and inventory information about hardware
+and software systems. This information is (continuously) collected from
+various configurable backends (inventory services, monitoring services, etc.)
+and stored in a graph-like hierarchy of generic objects. The store may be
+queried through a generic interface independent of the active backends. Object
+names are canonicalized before they are added to the store to ensure a
+consistent view of your infrastructure.
+
+The central object type is a host, which generally represents a physical or
+virtual machine or any other type of physical resource. Hosts, in turn, may
+reference a list of services which represent any kind of logical resource like
+a software system. Both, hosts and services, may reference a list of
+attributes which represent further information about the respective host or
+service object. For example, attributes may specify static information like a
+host's architecture or the software version or reference performance data like
+the current memory utilization or much more.
 
 
index c7d68ce9361bb16d8ab567f4bf28e1a6f2185ca9..53e936b6fc421251957f85688292c5938b48398a 100644 (file)
@@ -15,9 +15,9 @@ SYNOPSIS
 DESCRIPTION
 -----------
 *sysdbd* is a multi-backend system management and inventory collection daemon.
 DESCRIPTION
 -----------
 *sysdbd* is a multi-backend system management and inventory collection daemon.
-It may be used to (continuously) collect information from various backends
-(e.g., inventory services, monitoring services, configuration services) and
-provides a uniform combined view of all data.
+It stores system and inventory information about hardware and software
+systems. This information is (continuously) collected from various
+configurable backends.
 
 The main daemon itself is the central instance managing all collected
 information and doing the correlation of objects provided by different
 
 The main daemon itself is the central instance managing all collected
 information and doing the correlation of objects provided by different