docs/getting-started-guide/project-release-notes/tsdr.rst

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