README

   1                       Core Go language bindings for SysDB
   2                      =====================================
   3
   4   The core Go language bindings for SysDB are a set of packages for the Go
   5   programming language providing core functionality to interact with SysDB.
   6
   7 What is SysDB?
   8 --------------
   9
  10   “System DataBase” (SysDB) is a multi-backend system management and inventory
  11   collection service. It stores system and inventory information about
  12   hardware and software systems. This information is (continuously) collected
  13   from various configurable backends (inventory services, monitoring services,
  14   etc.) and stored in a graph-like hierarchy of generic objects. The store may
  15   be queried through a generic interface independent of the active backends.
  16   Object names are canonicalized before they are added to the store to ensure
  17   a consistent view of your infrastructure.
  18
  19   The central object type is a host, which generally represents a physical or
  20   virtual machine or any other type of physical resource. Hosts, in turn, may
  21   reference a list of services which represent any kind of logical resource
  22   like a software system. Both, hosts and services, may reference a list of
  23   attributes which represent further information about the respective host or
  24   service object. For example, attributes may specify static information like
  25   a host's architecture or the software version. A host may also reference a
  26   list of metrics which are references to performance data stored about the
  27   host. SysDB supports querying the respective time-series from a backend's
  28   data store.
  29
  30   SysDB is free and open source software, licensed under the 2-clause BSD
  31   license. See COPYING for details. Changes between all SysDB releases can be
  32   found in the file ReleaseNotes.
  33
  34   <https://sysdb.io/>
  35
  36 Install the Go bindings
  37 -----------------------
  38
  39   Installing all of the packages provided by this project is as easy as
  40   running the following command:
  41
  42     go get github.com/sysdb/go/...
  43
  44   This will download and install the packages and all of their dependencies
  45   into GOPATH. See ‘go help get’ for more details. See below for a list of all
  46   packages and their descriptions.
  47
  48 Packages
  49 --------
  50
  51   * github.com/sysdb/go/client: A SysDB client implementation.
  52
  53   * github.com/sysdb/go/proto: Helper functions for using the SysDB front-end
  54     protocol. That's the protocol used for communication between a client and
  55     a SysDB server instance.
  56
  57   * github.com/sysdb/go/sysdb: Core constants and types used by SysDB
  58     packages.
  59
  60 Documentation
  61 -------------
  62
  63   The documentation for all Go packages is included with the source code in a
  64   way compatible with the godoc tool. As such, it can be viewed and browsed
  65   online at <https://godoc.org/github.com/sysdb/go>.
  66
  67 Getting Help
  68 ------------
  69
  70   Various channels for asynchronous and real-time communication with
  71   developers and users are available. See <https://sysdb.io/contact/> for
  72   details about the mailing list, IRC channel, and social media.
  73
  74 Author
  75 ------
  76
  77   Sebastian “tokkee” Harl <sh@tokkee.org>
  78
  79   Want to contribute? Check out the website <https://sysdb.io> for details.
  80