index fa18d6c227b19a4108e1858b09245cc9b27e89e6..43f6f29aeab6e23bef9fb282f8d9e626a51abb16 100644 (file)
--- a/README
+++ b/README
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
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.
+ a host's architecture or the software version. A host may also reference a
+ list of metrics which are references to performance data stored about the
+ host. SysDB supports querying the respective time-series from a backend's
+ data store.
SysDB is free and open source software, licensed under the 2-clause BSD
license. See COPYING for details. Changes between all SysDB releases can be
found in the file ReleaseNotes.
SysDB is free and open source software, licensed under the 2-clause BSD
license. See COPYING for details. Changes between all SysDB releases can be
found in the file ReleaseNotes.
- <http://sysdb.io/>
+ <https://sysdb.io/>
Configure and install SysDB
---------------------------
Configure and install SysDB
---------------------------
To compile the SysDB package from source you need:
To compile the SysDB package from source you need:
- * A build environment: autotools, libtool, C compiler, ...
+ * A build environment: autotools, libtool, C and C++ compilers, ...
<http://www.gnu.org/software/automake/>
<http://www.gnu.org/software/autoconf/>
<http://www.gnu.org/software/automake/>
<http://www.gnu.org/software/autoconf/>
* libdbi:
The database independent abstraction layer is used for database access by
* libdbi:
The database independent abstraction layer is used for database access by
- the puppet::store-configs plugin.
+ the backend::puppet::store-configs plugin.
<http://libdbi.sourceforge.net/>
<http://libdbi.sourceforge.net/>
+ * libfacter:
+ The cfacter library for gathering facts about a system is used by the
+ backend::facter plugin to retrieve attributes about the local system.
+
+ <https://github.com/puppetlabs/cfacter>
+
+ * librrd:
+ The RRDtool library is used by the timeseries::rrdtool plugin to retrieve
+ time-series from RRD files.
+
+ <https://oss.oetiker.ch/rrdtool/>
+
+ * libssl:
+ The Secure Sockets Layer toolkit library is used to encrypt and
+ authenticate TCP connections.
+
+ <http://openssl.org/>
+
Testing
-------
Unit and integration tests for SysDB are shipped along with the source code
Testing
-------
Unit and integration tests for SysDB are shipped along with the source code
- in the ‘t’ subdirectory. Run ‘make test’ to run all available tests.
+ in the ‘t’ subdirectory. Run ‘make test’ to run all available tests or use
+ the following commands to run unit and integration tests separately:
+
+ make test TESTS='$(UNIT_TESTS)'
+ make test TESTS='$(INTEGRATION_TESTS)'
Some tests require the ‘fopencookie’ function as provided by the GNU libc
library. It used used to mock I/O related functions. In case this function
Some tests require the ‘fopencookie’ function as provided by the GNU libc
library. It used used to mock I/O related functions. In case this function
All documentation for SysDB is available as manual pages (in roff and HTML
formats) and shipped alongside the source code in the doc/ subdirectory.
All documentation for SysDB is available as manual pages (in roff and HTML
formats) and shipped alongside the source code in the doc/ subdirectory.
- Also, it is available online at <http://sysdb.io/documentation/>.
+ Also, it is available online at <https://sysdb.io/documentation/>.
Getting Help
------------
Various channels for asynchronous and real-time communication with
Getting Help
------------
Various channels for asynchronous and real-time communication with
- developers and users are available. See <http://sysdb.io/contact/> for
+ developers and users are available. See <https://sysdb.io/contact/> for
details about the mailing list, IRC channel, and social media.
Author
details about the mailing list, IRC channel, and social media.
Author
See the file THANKS for credits and inspiration.
See the file THANKS for credits and inspiration.
- Want to contribute? Check out the website <http://sysdb.io> for details.
+ Want to contribute? Check out the website <https://sysdb.io> for details.