TSDR Release Note for Release Review

Change-Id: I3a269cfa0375d7fc8d48692608f6d216e4b52fb6
Signed-off-by: YuLing Chen <yulingchen54@gmail.com>

diff --git a/docs/getting-started-guide/project-release-notes/tsdr.rst b/docs/getting-started-guide/project-release-notes/tsdr.rst
new file mode 100644 (file)
index 0000000..5594820
--- /dev/null
+++ b/docs/getting-started-guide/project-release-notes/tsdr.rst
@@ -0,0 +1,166 @@
+====
+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.
+
+
+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.
+* **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/
+
+odl-tsdr-netflow-collector
+--------------------------
+* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.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/
+
+odl-tsdr-restconf-collector
+---------------------------
+* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.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/
+
+odl-tsdr-controller-metrics-collector
+-------------------------------------
+* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.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/
+
+odl-tsdr-hsqldb
+----------------
+* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.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/
+
+odl-tsdr-hbase
+--------------
+* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.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/
+
+odl-tsdr-cassandra
+------------------
+* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.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/
+
+odl-tsdr-elasticsearch
+----------------------
+* **Feature URL:** https://github.com/opendaylight/tsdr/blob/stable/carbon/features/features-tsdr/src/main/features/features.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/
+
+
+Documentation
+=============
+
+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.
+
+* **Installation Guide(s):**
+
+  * :ref:`TSDR Installation Guide <tsdr-install-guide>`
+
+* **User Guide(s):**
+
+  * :ref:`TSDR User Guide <tsdr-user-guide>`
+
+* **Developer Guide(s):**
+  * N/A
+
+
+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.
+
+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/>`_
+* `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?
+
+  * Relying on automation for regression on features carried over from previous releases. Manual testing on new features with test report.
+
+Migration
+---------
+
+* Is it possible migrate from the previous release? If so, how?
+
+  * Yes, since there's no change of features from the previous releases.
+
+Compatiblity
+------------
+
+* Is this release compatible with the previous release?
+  Yes.
+
+* Any API changes?
+  No.
+
+* Any configuration changes?
+  No.
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this release
+
+  * SNMP data collector was removed.
+
+Standards
+=========
+
+* List of standards implemented and to what extent
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/TSDR:TSDR_Carbon_Release_Plan>`_
+* Describe any major shifts in release schedule from the release plan
+  * N/A.

diff --git a/docs/getting-started-guide/project-specific-guides/tsdr.rst b/docs/getting-started-guide/project-specific-guides/tsdr.rst
index dcb9f7c69cf0b4af32339935578046816c893466..3c0d04dcc71133f61b6ee55a953267d0af2453c9 100644 (file)
--- a/docs/getting-started-guide/project-specific-guides/tsdr.rst
+++ b/docs/getting-started-guide/project-specific-guides/tsdr.rst
@@ -1,3 +1,5 @@
+.. _tsdr-install-guide:
+
 TSDR Installation Guide
 =======================
 

diff --git a/docs/user-guide/tsdr-user-guide.rst b/docs/user-guide/tsdr-user-guide.rst
index 5fe3345aabfee134781ce8decf1d21935a011adc..2d06d3f6a72be6c067300fc695ed09883306d452 100644 (file)
--- a/docs/user-guide/tsdr-user-guide.rst
+++ b/docs/user-guide/tsdr-user-guide.rst
@@ -1,3 +1,5 @@
+.. _tsdr-user-guide:
+
 TSDR User Guide
 ===============