docs/getting-started-guide/project-specific-guides/tsdr-hsqldb-install.rst

   1 .. _tsdr-hsqldb-install-guide:
   2
   3 TSDR HSQLDB Default Datastore Installation Guide
   4 ================================================
   5
   6 This document is for the user to install the artifacts that are needed
   7 for using Time Series Data Repository (TSDR) functionality in the ODL
   8 Controller by enabling the default HSQLDB Datastore. TSDR is new functionality
   9 added in OpenDaylight in Lithium Release.
  10
  11 Overview
  12 --------
  13
  14 In Lithium Release the time series data records of OpenFlow statistics are
  15 collected periodically and stored in a persistent store. For non-production
  16 usage, the bundled default datastore (HSQLDB) is utilized based on odl-tsdr-all
  17 feature installation. The TSDR records get persisted in HSQLDB store in
  18 <install folder>/tsdr/ folder by default.
  19
  20 Installing TSDR with default HSQLDB datastore
  21 ---------------------------------------------
  22
  23 Once OpenDaylight distribution is up, from karaf console install the TSDR
  24 feature with default datastore (HSQLDB store used) can be installed by::
  25
  26     feature:install odl-tsdr-all
  27
  28
  29 This will install all dependency features (and can take sometime) before
  30 returning control to the console.
  31
  32 Verifying your Installation
  33 ---------------------------
  34
  35 If the feature install was successful you should be able to see the following
  36 tsdr commands added::
  37
  38     tsdr:list
  39
  40
  41 Troubleshooting
  42 ---------------
  43
  44 Check the ../data/log/karaf.log for any exception related to TSDR or HSQLDB
  45 related features.
  46
  47 Post Installation Configuration
  48 -------------------------------
  49
  50 The feature installation takes care of automated configuration of the
  51 datasource by installing a file in
  52 <install folder>/etc named org.ops4j.datasource-metric.cfg.
  53 This contains the default location of <install folder>/tsdr where the HSQLDB
  54 datastore files are stored. If you want to change the default location of the
  55 datastore files to some other location update the last portion of the url
  56 property in the org.ops4j.datasource-metric.cfg and then restart the karaf
  57 container
  58
  59 Upgrading From a Previous Release
  60 ---------------------------------
  61
  62 Lithium being the first release supporting TSDR functionality, only fresh
  63 installation is possible. However if you want to move to production usage by
  64 enabling the store HBase for TSDR usage, you can do it by uninstalling the TSDR
  65 with default HSQLDB datastore, restarting the Karaf container and then enabling
  66 the TSDR with HBase store as documented in tsdr-hbase-install.doc
  67
  68 Uninstalling TSDR with default HSQLDB datastore
  69 -----------------------------------------------
  70
  71 To uninstall the TSDR functionality with the default store, you need to do the
  72 following from karaf console
  73
  74 .. code-block:: bash
  75
  76    feature:uninstall odl-tsdr-all
  77    feature:uninstall odl-tsdr-core
  78    feature:uninstall odl-tsdr-HSQLDB-persistence
  79
  80
  81 It's recommended to restart the Karaf container after uninstallation of the TSDR
  82 functionality with the default store