* - Time Series Data Repository (TSDR)
- Enables support for collecting, storing and querying time series data.
- TSDR supports the following collection data:
-
+ TSDR collects and supports the following collection data:
* OpenFlow statistics
* NETFLOW statistics
* sFlow statistics
* SNMP data
* SysLog data
* RestConf data
-
- TSDR supports the following data stores:
-
+ TSDR supports the following Data Stores:
* HSQLDB
* HBase
* Cassandra
-
- TSDR supports the default OpenDaylight RESTCONF and API interfaces and an
- ElasticSearch interface for all data stores.
- - odl-tsdr-core, odl-tsdr-hsqldb
- - all
-
- * - TSDR Data Collectors
- - TSDR collector features include support for collecting the following
- data:
-
- * OpenFlow statistics
- * NETFLOW statistics
- * sFlow statistics
- * OpenFlow Controller metrics
- * SNMP data
- * SysLog data
- * RESTCONF data.
-
- - * odl-tsdr-openflow-statistics-collector
- * odl-tsdr-netflow-statistics-collector
- * odl-tsdr-sflow-statistics-collector
- * odl-tsdr-controller-metrics-collector
- * odl-tsdr-snmp-data-collector
- * odl-tsdr-syslog-collector
- * odl-tsdr-restconf-collector
- - all
-
- * - TSDR Data Stores
- - TSDR enables support for the following data stores:
- * HSQLDB
- * HBase
- * Cassandra
- - * odl-tsdr-hsqldb
- * odl-tsdr-hbase
- * odl-tsdr-cassandra
- - all
-
- * - TSDR Data Query
- - TSDR supports the default OpenDaylight RESTCONF and ODL API interfaces
- for queries to all data stores. It also supports an integrated ElasticSearch query.
- - odl-tsdr-elasticsearch
+ TSDR Data Query REST API
+ TSDR supports OpenDaylight RESTCONF and API interfaces
+ for queries to all data stores.
+ TSDR supports an integrated ElasticSearch query.
+ TSDR supports a Grafana interface.
+
+ - odl-tsdr-openflow-statistics-collector
+ odl-tsdr-netflow-statistics-collector
+ odl-tsdr-sflow-statistics-collector
+ odl-tsdr-controller-metrics-collector
+ odl-tsdr-snmp-data-collector
+ odl-tsdr-syslog-collector
+ odl-tsdr-restconf-collector
+
+ odl-tsdr-core
+ odl-tsdr-hsqldb
+ odl-tsdr-hbase
+ odl-tsdr-cassandra
- all
* - Topology Processing Framework
TSDR
====
-
Major Features
==============
The Time Series Data Repository (TSDR) project in OpenDaylight (ODL)
creates a framework for collecting, storing, querying, and maintaining
-time series data.
+time series data from multiple similar and disparate data sources.
+* **TSDR Features URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/features-tsdr/pom.xml
-odl-tsdr-syslog-collector
--------------------------
-* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.xml
-* **Feature Description:** Collect syslog data from the network.
+odl-tsdr-core
+-------------
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-core/pom.xml
+* **Feature Description:** Core features of TSDR enables collector SPI and external interfaces.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/
+
+
+odl-tsdr-openflow-statistics-collector
+--------------------------------------
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-openflow-statistics-collector/pom.xml
+* **Feature Description:** Collect OpenFlow data from the network.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-1node-hsqldb-datastore-all-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/
odl-tsdr-netflow-collector
--------------------------
-* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.xml
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-netflow-statistics-collector/pom.xml
* **Feature Description:** Collect netflow data from the network.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-1node-hsqldb-datastore-all-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/
odl-tsdr-restconf-collector
---------------------------
-* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.xml
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-restconf-collector/pom.xml
* **Feature Description:** Collect restconf web activities from the network.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-1node-hsqldb-datastore-all-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/
odl-tsdr-controller-metrics-collector
-------------------------------------
-* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.xml
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-controller-metrics-collector/pom.xml
* **Feature Description:** Collect ODL controller metrics.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-1node-hsqldb-datastore-all-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/
+
+odl-tsdr-syslog-collector
+-------------------------
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-syslog-collector/pom.xml
+* **Feature Description:** Collect syslog data from the network.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/
odl-tsdr-hsqldb
-----------------
-* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.xml
+---------------
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-hsqldb/pom.xml
* **Feature Description:** Store the collected data into hsqldb that is embedded in ODL controller.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-1node-hsqldb-datastore-all-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-verify-1node-hsqldb-datastore/
odl-tsdr-hbase
--------------
-* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.xml
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-hbase/pom.xml
* **Feature Description:** Store the collected data into hbase data store.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-1node-hbase-datastore-all-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-verify-1node-hbase-datastore/
+
+odl-tsdr-hbase-client
+---------------------
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-hbaseclient/pom.xml
+* **Feature Description:** External facing client to store the collected data into hbase data store.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-verify-1node-hbase-datastore/
odl-tsdr-cassandra
------------------
-* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.xml
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-cassandra/pom.xml
* **Feature Description:** Store the collected data into cassandra data store.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-1node-cassandra-datastore-only-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-verify-1node-cassandra-datastore/
odl-tsdr-elasticsearch
----------------------
-* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.xml
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=tsdr.git;a=blob;f=features/odl-tsdr-elasticsearch/pom.xml
* **Feature Description:** Store the collected data into ElasticSearch data store.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-1node-elasticsearch-datastore-only-carbon/
-
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-verify-1node-elasticsearch-datastore/
Documentation
=============
* :ref:`TSDR User Guide <tsdr-user-guide>`
+* **HSQLDB TSDR User Guide:** https://github.com/opendaylight/docs/blob/stable/lithium/manuals/user-guide/src/main/asciidoc/tsdr/tsdr-hsqldb-user.adoc
+* **HBase TSDR User Guide:** https://github.com/opendaylight/docs/blob/stable/lithium/manuals/user-guide/src/main/asciidoc/tsdr/tsdr-hbase-user.adoc
+
Security Considerations
=======================
* TSDR northbound query supports authentication and authorization using AAA features.
* Since ODL OpenFlow Plugin supports TLS, the OpenFlow Stats data transported from OpenFlow enabled appliances to ODL will be encrypted when TLS is enabled.
-* Syslog, NetFlow, and RestConf collectors do not support encryption at this moment.
+* Syslog, NetFlow, and RestConf collectors do not support encryption at this time.
Quality Assurance
=================
-* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=31699>`_ 76.9%
-* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/tsdr/job/tsdr-csit-1node-hbase-datastore-all-carbon/>`_
+* `Link to Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.tsdr%3Atsdr>`_ 73.1%
+* `Link to Test Procedures <https://wiki.opendaylight.org/view/TSDR:TSDR_Oxygen_Testing_with_Results#Test_Cases_.26_Results/>`_
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/tsdr/>`_
* `Other manual testing and QA information <https://wiki.opendaylight.org/view/TSDR_Carbon_:TSDR_Integration_System_Test/>`_
* Testing methodology. How extensive was it? What should be expected to work? What hasn't been tested as much?
* List of features/APIs which are EOLed, deprecated, and/or removed in this release
- * SNMP data collector was removed.
+ * SNMP data collector was temporarily removed.
Standards
=========
Release Mechanics
=================
-* `Link to release plan <https://wiki.opendaylight.org/view/TSDR:TSDR_Carbon_Release_Plan>`_
+* `Link to release plan <https://wiki.opendaylight.org/view/TSDR:TSDR_Oxygen_Release_Plan>`_
* Describe any major shifts in release schedule from the release plan
* N/A.