Code Review / docs.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Merge "USC Oxygen Release Review"
[docs.git] / docs / release-notes / projects / tsdr.rst
diff --git a/docs/release-notes/projects/tsdr.rst b/docs/release-notes/projects/tsdr.rst
index 47a6fa881f46b03df347c5e48aefdb50895cdc7c..029dee7481f59baa91c8b69e63c5e244f851547d 100644 (file)
--- a/docs/release-notes/projects/tsdr.rst
+++ b/docs/release-notes/projects/tsdr.rst
@@ -2,86 +2,113 @@
 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
 =============
@@ -96,18 +123,22 @@ Please provide the URL to each document at docs.opendaylight.org. If the documen
 
   * :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?
 
@@ -147,7 +178,7 @@ End-of-life
 
 * 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
 =========
@@ -157,6 +188,6 @@ 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.
OpenDaylight Documentation