1 SysDB -- a system management and inventory collection service
2 ===============================================================
4 “System DataBase” (SysDB) is a multi-backend system management and inventory
5 collection service. It stores system and inventory information about
6 hardware and software systems. This information is (continuously) collected
7 from various configurable backends (inventory services, monitoring services,
8 etc.) and stored in a graph-like hierarchy of generic objects. The store may
9 be queried through a generic interface independent of the active backends.
10 Object names are canonicalized before they are added to the store to ensure
11 a consistent view of your infrastructure.
13 The central object type is a host, which generally represents a physical or
14 virtual machine or any other type of physical resource. Hosts, in turn, may
15 reference a list of services which represent any kind of logical resource
16 like a software system. Both, hosts and services, may reference a list of
17 attributes which represent further information about the respective host or
18 service object. For example, attributes may specify static information like
19 a host's architecture or the software version or reference performance data
20 like the current memory utilization or much more.
22 SysDB is free and open source software, licensed under the 2-clause BSD
23 license. See COPYING for details. Changes between all SysDB releases can be
24 found in the file ReleaseNotes.
26 <http://sysdb.io/>
28 Configure and install SysDB
29 ---------------------------
31 To configure, build and install SysDB with the default settings, run
32 ‘./configure && make && make install’. For detailed, generic instructions
33 see INSTALL. For a complete list of configure options and their description,
34 run ‘./configure --help’.
36 Various third-party packages are required for a full installation of SysDB.
37 See the section ‘Prerequisites’ below for details. A summary of
38 user-supplied and auto-detected build settings is displayed at the end of
39 each ‘configure’ run. Consult this first for trouble-shooting.
41 By default, SysDB will be installed into ‘/opt/sysdb’. You can adjust this
42 setting by specifying the ‘--prefix’ configure option - see INSTALL for
43 details. If you pass DESTDIR=<path> to ‘make install’, <path> will be
44 prefixed to all installation directories. This might be useful when creating
45 packages for SysDB.
47 Prerequisites
48 -------------
50 To compile the SysDB package from source you need:
52 * A build environment: autotools, libtool, C compiler, ...
54 <http://www.gnu.org/software/automake/>
55 <http://www.gnu.org/software/autoconf/>
56 <http://www.gnu.org/software/libtool/>
57 <http://www.freedesktop.org/wiki/Software/pkg-config/>
58 <http://gcc.gnu.org/>
60 * When building from Git, you also need the flex lexical analyzer generator
61 and bison parser generator (other lex and yacc compatible tools might work
62 as well if you are lucky).
64 <http://www.gnu.org/software/bison/>
65 <http://flex.sourceforge.net/>
67 * A POSIX + Single UNIX Specification compatible C library.
69 <http://pubs.opengroup.org/onlinepubs/9699919799/>
71 * asciidoc, xmlto:
72 The AsciiDoc text document format is used to write the manpages.
74 <http://www.methods.co.nz/asciidoc/>
75 <https://fedorahosted.org/xmlto/>
77 * libedit or libreadline:
78 A readline compatible command line editor and history library is used for
79 handling input in the sysdb client program.
81 <http://thrysoee.dk/editline/>
82 <http://tiswww.case.edu/php/chet/readline/rltop.html>
84 The following optional libraries may be used by various plugins:
86 * libdbi:
87 The database independent abstraction layer is used for database access by
88 the puppet::store-configs plugin.
90 <http://libdbi.sourceforge.net/>
92 Testing
93 -------
95 Unit and integration tests for SysDB are shipped along with the source code
96 in the ‘t’ subdirectory. Run ‘make test’ to run all available tests.
98 Some tests require the ‘fopencookie’ function as provided by the GNU libc
99 library. It used used to mock I/O related functions. In case this function
100 is not available, the respective tests will be disabled automatically.
102 The integration tests require valgrind. If it is not available, integration
103 tests will be disabled automatically.
105 For the latest build status, see:
106 <https://travis-ci.org/sysdb/sysdb>
108 Code coverage testing using Gcov may be enabled when using the
109 ‘--enable-gcov’ configure option.
111 For the latest coverage report, see:
112 <https://coveralls.io/r/sysdb/sysdb>
114 Documentation
115 -------------
117 All documentation for SysDB is available as manual pages (in roff and HTML
118 formats) and shipped alongside the source code in the doc/ subdirectory.
119 Also, it is available online at <http://sysdb.io/documentation/>.
121 Getting Help
122 ------------
124 Various channels for asynchronous and real-time communication with
125 developers and users are available. See <http://sysdb.io/contact/> for
126 details about the mailing list, IRC channel, and social media.
128 Author
129 ------
131 Sebastian “tokkee” Harl <sh@tokkee.org>
133 See the file THANKS for credits and inspiration.
135 Want to contribute? Check out the website <http://sysdb.io> for details.