From: Sebastian Harl Date: Mon, 12 May 2014 10:25:56 +0000 (+0200) Subject: Unified project description across all documentation. X-Git-Tag: sysdb-0.1.0~29 X-Git-Url: https://git.tokkee.org/?p=sysdb.git;a=commitdiff_plain;h=70a3f7daeac51f82b5d81dedc5ad8ca267d72173 Unified project description across all documentation. --- diff --git a/README b/README index d3d4d62..7371c46 100644 --- a/README +++ b/README @@ -2,12 +2,22 @@ =============================================================== “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. diff --git a/ReleaseNotes b/ReleaseNotes index 341f58f..f7a5101 100644 --- a/ReleaseNotes +++ b/ReleaseNotes @@ -9,10 +9,13 @@ 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. diff --git a/doc/sysdb-description.txt b/doc/sysdb-description.txt index 64cecf3..ea9df32 100644 --- a/doc/sysdb-description.txt +++ b/doc/sysdb-description.txt @@ -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. diff --git a/doc/sysdbd.1.txt b/doc/sysdbd.1.txt index c7d68ce..53e936b 100644 --- a/doc/sysdbd.1.txt +++ b/doc/sysdbd.1.txt @@ -15,9 +15,9 @@ SYNOPSIS 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