docs/release-notes/projects/tsdr.rst

   1 ====
   2 TSDR
   3 ====
   4
   5 Major Features
   6 ==============
   7 The Time Series Data Repository (TSDR) project in OpenDaylight (ODL)
   8 creates a framework for collecting, storing, querying, and maintaining
   9 time series data from multiple similar and disparate data sources.
  10
  11 * **TSDR Features URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/features-tsdr/pom.xml
  12
  13 odl-tsdr-core
  14 -------------
  15 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-core/pom.xml
  16 * **Feature Description:**  Core features of TSDR enables collector SPI and external interfaces.
  17 * **Top Level:** Yes
  18 * **User Facing:** Yes
  19 * **Experimental:** No
  20 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/
  21
  22
  23 odl-tsdr-openflow-statistics-collector
  24 --------------------------------------
  25 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-openflow-statistics-collector/pom.xml
  26 * **Feature Description:**  Collect OpenFlow data from the network.
  27 * **Top Level:** Yes
  28 * **User Facing:** Yes
  29 * **Experimental:** No
  30 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/
  31
  32 odl-tsdr-netflow-collector
  33 --------------------------
  34 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-netflow-statistics-collector/pom.xml
  35 * **Feature Description:**  Collect netflow data from the network.
  36 * **Top Level:** Yes
  37 * **User Facing:** Yes
  38 * **Experimental:** No
  39 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/
  40
  41 odl-tsdr-restconf-collector
  42 ---------------------------
  43 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-restconf-collector/pom.xml
  44 * **Feature Description:**  Collect restconf web activities from the network.
  45 * **Top Level:** Yes
  46 * **User Facing:** Yes
  47 * **Experimental:** No
  48 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/
  49
  50 odl-tsdr-controller-metrics-collector
  51 -------------------------------------
  52 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-controller-metrics-collector/pom.xml
  53 * **Feature Description:**  Collect ODL controller metrics.
  54 * **Top Level:** Yes
  55 * **User Facing:** Yes
  56 * **Experimental:** No
  57 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/
  58
  59 odl-tsdr-syslog-collector
  60 -------------------------
  61 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-syslog-collector/pom.xml
  62 * **Feature Description:**  Collect syslog data from the network.
  63 * **Top Level:** Yes
  64 * **User Facing:** Yes
  65 * **Experimental:** No
  66 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/
  67
  68 odl-tsdr-hsqldb
  69 ---------------
  70 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-hsqldb/pom.xml
  71 * **Feature Description:**  Store the collected data into hsqldb that is embedded in ODL controller.
  72 * **Top Level:** Yes
  73 * **User Facing:** Yes
  74 * **Experimental:** No
  75 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-verify-1node-hsqldb-datastore/
  76
  77 odl-tsdr-hbase
  78 --------------
  79 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-hbase/pom.xml
  80 * **Feature Description:** Store the collected data into hbase data store.
  81 * **Top Level:** Yes
  82 * **User Facing:** Yes
  83 * **Experimental:** No
  84 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-verify-1node-hbase-datastore/
  85
  86 odl-tsdr-hbase-client
  87 ---------------------
  88 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-hbaseclient/pom.xml
  89 * **Feature Description:** External facing client to store the collected data into hbase data store.
  90 * **Top Level:** Yes
  91 * **User Facing:** Yes
  92 * **Experimental:** No
  93 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-verify-1node-hbase-datastore/
  94
  95 odl-tsdr-cassandra
  96 ------------------
  97 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-cassandra/pom.xml
  98 * **Feature Description:**  Store the collected data into cassandra data store.
  99 * **Top Level:** Yes
 100 * **User Facing:** Yes
 101 * **Experimental:** No
 102 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-verify-1node-cassandra-datastore/
 103
 104 odl-tsdr-elasticsearch
 105 ----------------------
 106 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-elasticsearch/pom.xml
 107 * **Feature Description:**  Store the collected data into ElasticSearch data store.
 108 * **Top Level:** Yes
 109 * **User Facing:** Yes
 110 * **Experimental:** No
 111 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-verify-1node-elasticsearch-datastore/
 112
 113 Documentation
 114 =============
 115
 116 Please provide the URL to each document at docs.opendaylight.org. If the document is under review, provide a link to the change in Gerrit.
 117
 118 * **Installation Guide(s):**
 119
 120   * :ref:`TSDR Installation Guide <tsdr-install-guide>`
 121
 122 * **User Guide(s):**
 123
 124   * :ref:`TSDR User Guide <tsdr-user-guide>`
 125
 126 * **HSQLDB TSDR User Guide:** https://github.com/opendaylight/docs/blob/stable/lithium/manuals/user-guide/src/main/asciidoc/tsdr/tsdr-hsqldb-user.adoc
 127 * **HBase TSDR User Guide:** https://github.com/opendaylight/docs/blob/stable/lithium/manuals/user-guide/src/main/asciidoc/tsdr/tsdr-hbase-user.adoc
 128
 129 Security Considerations
 130 =======================
 131
 132 * TSDR northbound query supports authentication and authorization using AAA features.
 133 * Since ODL OpenFlow Plugin supports TLS, the OpenFlow Stats data transported from OpenFlow enabled appliances to ODL will be encrypted when TLS is enabled.
 134 * Syslog, NetFlow, and RestConf collectors do not support encryption at this time.
 135
 136 Quality Assurance
 137 =================
 138
 139 * `Link to Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.tsdr%3Atsdr>`_ 73.1%
 140 * `Link to Test Procedures <https://wiki.opendaylight.org/view/TSDR:TSDR_Oxygen_Testing_with_Results#Test_Cases_.26_Results/>`_
 141 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/tsdr/>`_
 142 * `Other manual testing and QA information <https://wiki.opendaylight.org/view/TSDR_Carbon_:TSDR_Integration_System_Test/>`_
 143 * Testing methodology. How extensive was it? What should be expected to work? What hasn't been tested as much?
 144
 145   * Relying on automation for regression on features carried over from previous releases. Manual testing on new features with test report.
 146
 147 Migration
 148 ---------
 149
 150 * Is it possible to migrate from the previous release? If so, how?
 151
 152   * Yes, since there's no change of features from the previous releases.
 153
 154 Compatibility
 155 -------------
 156
 157 * Is this release compatible with the previous release?
 158   Yes.
 159
 160 * Any API changes?
 161   No.
 162
 163 * Any configuration changes?
 164   No.
 165
 166 Bugs Fixed
 167 ----------
 168
 169 * List of bugs fixed since the previous release
 170
 171 Known Issues
 172 ------------
 173
 174 * List key known issues with workarounds
 175
 176 End-of-life
 177 ===========
 178
 179 * List of features/APIs which are EOLed, deprecated, and/or removed in this release
 180
 181   * SNMP data collector was temporarily removed.
 182
 183 Standards
 184 =========
 185
 186 * List of standards implemented and to what extent
 187
 188 Release Mechanics
 189 =================
 190
 191 * `Link to release plan <https://wiki.opendaylight.org/view/TSDR:TSDR_Oxygen_Release_Plan>`_
 192 * Describe any major shifts in release schedule from the release plan
 193   * N/A.