Rework release-notes for Oxygen 48/69048/1
authorScott Melton <smelton2@uccs.edu>
Sun, 4 Mar 2018 03:36:23 +0000 (19:36 -0800)
committerScott Melton <smelton2@uccs.edu>
Sun, 4 Mar 2018 03:36:23 +0000 (19:36 -0800)
Change-Id: If005b8b3c205710c46353aee20bb614c53a383aa
Signed-off-by: Scott Melton <smelton2@uccs.edu>
docs/getting-started-guide/installing_opendaylight.rst
docs/release-notes/projects/tsdr.rst
docs/release-process/milestone-readouts/m0/tsdr.rst
docs/release-process/milestone-readouts/m1/tsdr.rst
docs/release-process/milestone-readouts/m3/tsdr.rst

index 1b62392ef67001cc0de7a3bc6af13b5f29c722f7..1f127dd8acd6c9b76635315dbb162da0e73cbc8a 100644 (file)
@@ -352,8 +352,7 @@ Karaf OpenDaylight Features
 
     * - 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
@@ -361,53 +360,28 @@ Karaf OpenDaylight Features
         * 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
index 47a6fa881f46b03df347c5e48aefdb50895cdc7c..029dee7481f59baa91c8b69e63c5e244f851547d 100644 (file)
 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.
index 4280f129da99c0cde3d39deb6ad038444a6e87f0..9c78b761e5780abd39c3462f650d46b3b98c25de 100644 (file)
@@ -4,7 +4,7 @@ TSDR
 
 1. The TSDR project formally joins the OpenDaylight Oxygen
    Simultaneous Release and agrees to the activities and timeline documented on
-   the Oxygen  Release Plan Page:
+   the Oxygen Release Plan Page:
    https://wiki.opendaylight.org/view/Simultaneous_Release:Oxygen_Release_Plan
 
 2. Project Offset: Offset 2
index 63ff05fb82d9e69f8bdd215e3bb553d130e253c1..185f3029a60acfc091d16039252cf99ff407efc9 100644 (file)
@@ -6,11 +6,11 @@ TSDR
 
    - Yes, I have reviewed the PTL Requirements [1]_.
 
-2. Project Contact: YuLing Chen, yulingchen54@gmail.com, yuling_c
+2. Project Contact: Scott Melton, smelton2@uccs.edu
 
 3. Test Contact: YuLing Chen, yulingchen54@gmail.com, yuling_c
 
-4. Documentation Contact: YuLing Chen, yulingchen54@gmail.com, yuling_c
+4. Documentation Contact: Scott Melton, smelton2@uccs.edu
 
 5. Does your project have any updates on any previously-incomplete items from
    prior milestone readouts? No
@@ -40,7 +40,7 @@ TSDR
     - mdsal, Implicit acknowledgement
     - odlparent, Implicit acknowledgement
     - yangtools, Implicit acknowledgement
-
+    - openflowplugin, Implicit acknowledgement
 
 11. Will your project have top-level features not requiring system test? No
 
index 80128f4ec74cc55b8d51014243ac6428d9193f51..f992511ed1e0746060f8fdde6d79e60d851002c6 100644 (file)
@@ -23,7 +23,7 @@ TSDR
 
 7. Does your project use any ports, including for testing? Yes
 
-   - (If yes, list of ports used)  Yes, 514,1514, 2055,6343.
+   - (If yes, list of ports used)  Yes, 514, 1514, 2055,6343.
    - (If yes, have you updated the wiki [3]_ with all ports used? Yes
 
 8. Does your project build successfully in Autorelease? Yes