Merge "Release Notes for the SFC Nitrogen project."
authorThanh Ha <thanh.ha@linuxfoundation.org>
Mon, 18 Sep 2017 15:19:24 +0000 (15:19 +0000)
committerGerrit Code Review <gerrit@opendaylight.org>
Mon, 18 Sep 2017 15:19:24 +0000 (15:19 +0000)
37 files changed:
docs/developer-guide/daexim-developer-guide.rst [new file with mode: 0644]
docs/developer-guide/index.rst
docs/getting-started-guide/project-release-notes/alto.rst
docs/getting-started-guide/project-release-notes/bgp-ls-pcep.rst
docs/getting-started-guide/project-release-notes/bier.rst
docs/getting-started-guide/project-release-notes/controller.rst
docs/getting-started-guide/project-release-notes/eman.rst
docs/getting-started-guide/project-release-notes/faas-release-notes.rst
docs/getting-started-guide/project-release-notes/genius.rst
docs/getting-started-guide/project-release-notes/iotdm.rst
docs/getting-started-guide/project-release-notes/lispflowmapping.rst
docs/getting-started-guide/project-release-notes/netconf.rst
docs/getting-started-guide/project-release-notes/netide.rst
docs/getting-started-guide/project-release-notes/neutron-northbound.rst
docs/getting-started-guide/project-release-notes/nic.rst
docs/getting-started-guide/project-release-notes/ocpplugin-release-notes.rst
docs/getting-started-guide/project-release-notes/odl-sdni-release-notes.rst
docs/getting-started-guide/project-release-notes/odlparent.rst
docs/getting-started-guide/project-release-notes/of-config-release-notes.rst
docs/getting-started-guide/project-release-notes/openflowplugin.rst
docs/getting-started-guide/project-release-notes/packetcable.rst
docs/getting-started-guide/project-release-notes/sample-release-notes.rst
docs/getting-started-guide/project-release-notes/snmp.rst
docs/getting-started-guide/project-release-notes/snmp4sdn.rst
docs/getting-started-guide/project-release-notes/sxp.rst
docs/getting-started-guide/project-release-notes/tsdr.rst
docs/getting-started-guide/project-release-notes/ttp.rst
docs/getting-started-guide/project-release-notes/unimgr.rst
docs/getting-started-guide/project-release-notes/vbd.rst
docs/getting-started-guide/project-release-notes/vtn.rst
docs/submodules/aaa
docs/submodules/coe
docs/submodules/integration/test
docs/submodules/netvirt
docs/submodules/releng/builder
docs/user-guide/daexim-user-guide.rst [new file with mode: 0644]
docs/user-guide/index.rst

diff --git a/docs/developer-guide/daexim-developer-guide.rst b/docs/developer-guide/daexim-developer-guide.rst
new file mode 100644 (file)
index 0000000..ca3b3f2
--- /dev/null
@@ -0,0 +1,30 @@
+##################################
+Data Export/Import Developer Guide
+##################################
+
+Overview
+========
+
+This feature is used to export the system data tree state, or part of,
+to the system's file system. It may also be used to import the system
+data tree state, or part of, from the system's file system.
+
+
+Data Export/Import Architecture
+===============================
+
+The daexim feature consists of a single feature, which interacts with
+MD-SAL to export and import the system data.
+
+
+Key APIs and Interfaces
+=======================
+
+The APIs are available via REST. The details are provided are in user-guide.
+
+
+API Reference Documentation
+===========================
+
+The details of the API are also available in the YANG model for this
+feature. This model is accessiable via the APIDOC explorer interface.
index 67e9fa6ca1e1327c9b6e7125777a15808cd32f08..1ef4b7543136bdbe0c1e062bd77f759bf3de437f 100644 (file)
@@ -24,6 +24,7 @@ Project-specific Developer Guides
    capwap-developer-guide
    cardinal_-opendaylight-monitoring-as-a-service
    controller
+   daexim-developer-guide
    didm-developer-guide
    distribution-version
    dlux
index 0479edc9c8950f6b2dc251a8a73b5223dacbcd88..f664a0ea0ee531f414a3caba957f7b0126bcd830 100644 (file)
@@ -5,13 +5,13 @@ Application-Layer Traffic Optimization (ALTO)
 odl-alto-release
 ----------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=alto.git;a=blob;f=alto-release-features/features-alto/src/main/features/features.xml
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=alto.git;a=blob;f=alto-release-features/features-alto/pom.xml;hb=refs/heads/stable/nitrogen
 * **Feature Description:**  This is a summary feature containing the default
   functionalities provided by ALTO project.
 * **Top Level:** Yes
 * **User Facing:** Yes
 * **Experimental:** Yes
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/alto/job/alto-csit-1node-setup-all-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/alto/job/alto-csit-1node-setup-all-nitrogen/
 
 Documentation
 =============
@@ -36,8 +36,8 @@ project. All resources exposed by customized interfaces are read-only.
 Quality Assurance
 =================
 
-* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=50636>`_ 22.0%
-* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/alto/job/alto-csit-1node-setup-all-carbon/>`_
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=50636>`_ 31.7%
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/alto/job/alto-csit-1node-setup-all-nitrogen/>`_
 * The tests are using the OpenDaylight CSIT infrastructure.
 
   * How extensive was it? Not very extensive since the tests are customized to
@@ -50,7 +50,7 @@ Quality Assurance
 Migration
 ---------
 
-Migration with data from Boron to Carbon isn't supported.
+Migration with data from Boron isn't supported.
 
 Compatibility
 -------------
@@ -72,29 +72,19 @@ also need to migrate to Blueprint instead of using CONFIG subsystem.
 Bugs Fixed
 ----------
 
-No bug is fixed in this release.
+* `Fixed Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=RESOLVED&chfield=%5BBug%20creation%5D&chfieldfrom=2017-05-25&chfieldto=2017-08-14&list_id=84715&product=alto&query_format=advanced&resolution=FIXED>`_
 
 Known Issues
 ------------
 
-* `Bug 5753 <https://bugs.opendaylight.org/show_bug.cgi?id=5753>`_
+Parallel query for simple-ecs service can conduct failure.
 
-Both Jersey 1.0 and 2.0 are imported in karaf.
-
-This seems like a general bug which resides in several projects.
+* `Bug 8826 <https://bugs.opendaylight.org/show_bug.cgi?id=8826>`_
 
 End-of-life
 ===========
 
-* Namespaces:
-
-  * urn:opendaylight:alto:core
-  * urn:opendaylight:alto:basic
-
-* Packages:
-
-  * org.opendaylight.yang.gen.v1.urn.opendaylight.alto.core.*
-  * org.opendaylight.yang.gen.v1.urn.opendaylight.alto.basic.*
+* Nothing deprecated, EOL.
 
 Standards
 =========
@@ -102,14 +92,13 @@ Standards
 * ALTO protocols are not compatible with YANG model
 * Message types for RFC 7285 have been implemented
 * ALTO project provides several basic services in RFC 7285
-* Work-in-progress Internet drafts for multi-cost, incremental updates and RSA
-  service are also scheduled but not fully implemented.
+* Work-in-progress Internet drafts for path-vector, multi-cost, incremental
+  updates and RSA service are also scheduled but not fully implemented.
 
 Release Mechanics
 =================
 
-* `Link to release plan <https://wiki.opendaylight.org/view/ALTO:Carbon_Release_Plan>`_
+* `Link to release plan <https://wiki.opendaylight.org/view/ALTO:Nitrogen_Release_Plan>`_
 * Major shifts:
 
-  * Unable to finish the extensions (multi-cost, incremental update and RSA service)
-  * Unable to reach the goal of improving code quality
+  * Unable to finish the extensions (path-vector and RSA service)
index 6f4aa57405e77e395044582fea87c9cd486e2139..a3c6e1b3cc8bcfed35ba34759816e1a7148ffb74 100644 (file)
@@ -8,32 +8,32 @@ Major Features
 odl-bgpcep-bgp
 --------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/bgp/features-bgp/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/bgp/features-bgp/src/main/features/features.xml;hb=refs/heads/stable/nitrogen
 * **Feature Description:**  OpenDaylight Border Gateway Protocol (BGP) plugin.
 * **Top Level:** Yes
 * **User Facing:** Yes
 * **Experimental:** No
-* **CSIT Test:** https://logs.opendaylight.org/releng/jenkins092/bgpcep-csit-1node-userfeatures-all-carbon
+* **CSIT Test:** https://logs.opendaylight.org/releng/jenkins092/bgpcep-csit-1node-userfeatures-all-nitrogen
 
 odl-bgpcep-bmp
 --------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/bmp/features-bmp/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/bmp/features-bmp/src/main/features/features.xml;hb=refs/heads/stable/nitrogen
 * **Feature Description:**  OpenDaylight BGP Monitoring Protocol (BMP) plugin.
 * **Top Level:** Yes
 * **User Facing:** Yes
 * **Experimental:** No
-* **CSIT Test:** https://logs.opendaylight.org/releng/jenkins092/bgpcep-csit-1node-userfeatures-all-carbon
+* **CSIT Test:** https://logs.opendaylight.org/releng/jenkins092/bgpcep-csit-1node-userfeatures-all-nitrogen
 
 odl-bgpcep-pcep
 ---------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/pcep/features-pcep/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/pcep/features-pcep/src/main/features/features.xml;hb=refs/heads/stable/nitrogen
 * **Feature Description:**  OpenDaylight Path Computation Element Configuration Protocol (PCEP) plugin.
 * **Top Level:** Yes
 * **User Facing:** Yes
 * **Experimental:** No
-* **CSIT Test:** https://logs.opendaylight.org/releng/jenkins092/bgpcep-csit-1node-userfeatures-all-carbon
+* **CSIT Test:** https://logs.opendaylight.org/releng/jenkins092/bgpcep-csit-1node-userfeatures-all-nitrogen
 
 
 Documentation
@@ -59,14 +59,14 @@ None Known - all protocol implements the TCP Authentication Option (TCP MD5)
 Quality Assurance
 =================
 
-* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=10075>`_ (80,8%)
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=10075>`_ (80%)
 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/bgpcep/>`_
 
-* `User features test <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-userfeatures-only-carbon/>`_
-* `PCEP performance and scale tests <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-throughpcep-only-carbon/>`_
-* `BGP Application peer performance and scale tests <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-bgp-ingest-only-carbon/>`_
-* `BGP performance and scale test <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-bgp-ingest-mixed-only-carbon/>`_
-* `BGP clustering <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-3node-periodic-bgpclustering-only-carbon/>`_
+* `User features test <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-userfeatures-only-nitrogen/>`_
+* `PCEP performance and scale tests <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-throughpcep-only-nitrogen/>`_
+* `BGP Application peer performance and scale tests <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-bgp-ingest-only-nitrogen/>`_
+* `BGP performance and scale test <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-bgp-ingest-mixed-only-nitrogen/>`_
+* `BGP clustering <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-3node-periodic-bgpclustering-only-nitrogen/>`_
 
   The BGP extensions were tested manually with vendor's BGP router implementation or other software implementations (exaBGP, bagpipeBGP). Also, they are covered by the unit tests and automated system tests.
 
@@ -144,7 +144,7 @@ Compatibility
 Bugs Fixed
 ----------
 
-* `List of bugs fixed since the previous release <https://bugs.opendaylight.org/buglist.cgi?columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_severity%2Ccf_issue_type%2Cshort_desc%2Cbug_status%2Cpriority%2Cdeadline%2Ccf_target_milestone&f1=cf_target_milestone&f2=cf_issue_type&known_name=Lithium%3A%20bgpcep&o1=substring&o2=equals&product=bgpcep&query_based_on=Lithium%3A%20bgpcep&query_format=advanced&resolution=FIXED&v1=Carbon&v2=Bug>`_
+* `List of bugs fixed since the previous release <https://bugs.opendaylight.org/buglist.cgi?columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_severity%2Ccf_issue_type%2Cshort_desc%2Cbug_status%2Cpriority%2Cdeadline%2Ccf_target_milestone&f1=cf_target_milestone&f2=cf_issue_type&known_name=Carbon%3A%20bgpcep&list_id=84608&o1=substring&o2=equals&product=bgpcep&query_based_on=Carbon%3A%20bgpcep&query_format=advanced&resolution=FIXED&v1=nitrogen&v2=Bug>`_
 
 Known Issues
 ------------
@@ -207,11 +207,4 @@ Standards
 Release Mechanics
 =================
 
-* `Link to release plan <https://wiki.opendaylight.org/view/BGP_LS_PCEP:Carbon_Release_Plan>`_
-
-* Release plan not achieved
-
-  * `BUG-6966 <https://bugs.opendaylight.org/show_bug.cgi?id=6966>`_ Introduce infrastructure for inbound/outbound routing policies
-  * `BUG-6973 <https://bugs.opendaylight.org/show_bug.cgi?id=6973>`_ Migrate PCEP topology provider to use BP wiring
-  * `BUG-6976 <https://bugs.opendaylight.org/show_bug.cgi?id=6976>`_ Migrate BMP collector to use BP wiring
-  * `BUG-6978 <https://bugs.opendaylight.org/show_bug.cgi?id=6978>`_ Integrate BMP collector with Cluster Singleton Service
+* `Link to release plan <https://wiki.opendaylight.org/view/BGP_LS_PCEP:Nitrogen_Release_Plan>`_
index 568957eca4a6a3f0aad23e8ffdba305e30fc932b..e0fe573ef0eb8fb7ef3fcb7b6958282b94a8ed26 100644 (file)
@@ -47,7 +47,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
 * Not applicable as there is no previous release.
 
index d3b7bf9e7b6381352dffe4a1d37c30f16abb3de6..0620db2d2e0f5d75de9e83d5712712ea86a04f9c 100644 (file)
@@ -46,7 +46,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   Yes, no specific steps needed unless prior updates to config subsystem modules
   were made via the controller-config yang-ext mount in which case the
index fe6bb2d8c047af7e7c7ac261d9beced924d881ce..ce9293450f12d610e0880c43f96daa8cf24a4fbf 100644 (file)
@@ -51,7 +51,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   N/A as this is first release
 
index 41a217bcd9e4a567ef079271a1c6e36446ea2a72..cfa4fc53b23b77708e34f2b9d21abce360ccc46d 100644 (file)
@@ -48,7 +48,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   * No
 
index a6edbb33848aadfc830730c6cd6c04b47db0298f..b6a53c9d631ba1c6cb6c07f62e119e6239fc1299 100644 (file)
@@ -133,7 +133,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   * No. OpenDaylight doesn't support migration natively for applications that use datastore.
 
index fd057bb80fcff3d1f8f7473db4697cb07e32e230..502305e8866b0ed788918858190ac99cae394704 100644 (file)
@@ -123,7 +123,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
   No, current release is backward incompatible.
 
 Compatibility
index 662c809f7807c2e38d098a023769bd39a62108ba..ec6a0ee27f6b32df09436e0af9d83d6a98f6cb40 100644 (file)
@@ -66,9 +66,9 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
-  * LISP Flow Mapping service will auto-populate the datastructures from existing MD-SAL data upon service start if the data has already been migrated separately.
+  * LISP Flow Mapping service will auto-populate the datastructures from existing MD-SAL data upon service start if the data has already been migrated separately. No automated way for transfering the data is provided in this release.
 
 Compatibility
 -------------
@@ -90,25 +90,18 @@ Bugs Fixed
 
 * List of bugs fixed since the previous release:
 
-* `6536 <https://bugs.opendaylight.org/show_bug.cgi?id=6536>`_ Clustering: operational data is not showing up in the in-memory map-cache on the replicas 2016-09-08
-* `6754 <https://bugs.opendaylight.org/show_bug.cgi?id=6754>`_ No serializer defined for IPv6 prefix SimpleAddress 2016-09-20
-* `6759 <https://bugs.opendaylight.org/show_bug.cgi?id=6759>`_ Expired mappings are not returned from SimpleMapCache before deletion.  2016-09-21
-* `6634 <https://bugs.opendaylight.org/show_bug.cgi?id=6634>`_ LispNeutronService give exception: java.lang.NullPointerException 2016-10-13
-* `6782 <https://bugs.opendaylight.org/show_bug.cgi?id=6782>`_ RadixTrie parent insertion not done correctly for non-empty children  2016-10-13
-* `6925 <https://bugs.opendaylight.org/show_bug.cgi?id=6925>`_ Error during Map-Register performance test  2016-10-13
-* `7018 <https://bugs.opendaylight.org/show_bug.cgi?id=7018>`_ Null pointer exception when SMR map request is received 2016-10-25
-* `7035 <https://bugs.opendaylight.org/show_bug.cgi?id=7035>`_ Boron autorelease failing on lispflowmapping tests  2016-11-01
-* `6361 <https://bugs.opendaylight.org/show_bug.cgi?id=6361>`_ LispSouthboundHandler is marked @ChannelHandler.Sharable but is not stateless 2016-11-23
-* `7293 <https://bugs.opendaylight.org/show_bug.cgi?id=7293>`_ Radix trie node removals that update the root don't work  2016-12-05
-* `7586 <https://bugs.opendaylight.org/show_bug.cgi?id=7586>`_ Fix broken lispflowmapping features failing the new extended SingleFeatureTest incl. TestBundleDiag 2017-01-23
-* `7789 <https://bugs.opendaylight.org/show_bug.cgi?id=7789>`_ Odl-lispflowmapping-ui breaks DLUX  2017-02-15
-* `7628 <https://bugs.opendaylight.org/show_bug.cgi?id=7628>`_ Karaf 4 migration: provide Karaf 4 lispflowmapping features 2017-03-24
-* `7818 <https://bugs.opendaylight.org/show_bug.cgi?id=7818>`_ Map-Register fast path not working correctly  2017-03-27
-* `6071 <https://bugs.opendaylight.org/show_bug.cgi?id=6071>`_ Map Notify Authentication Data is not computed correctly  2017-03-27
-* `6381 <https://bugs.opendaylight.org/show_bug.cgi?id=6381>`_ Expired xTR-ID mappings are not removed 2017-03-27
-* `8248 <https://bugs.opendaylight.org/show_bug.cgi?id=8248>`_ Intermittent SingleFeatureTest failures in autorelease  2017-04-26
-* `8429 <https://bugs.opendaylight.org/show_bug.cgi?id=8429>`_ Integration tests fail intermittently with unexpected SMR (a.k.a. the Heisenbug)  04:21:56
-* `7272 <https://bugs.opendaylight.org/show_bug.cgi?id=7272>`_ Map-resolver replies with wrong mapping record and TTL  05:04:17
+* `6536 <https://bugs.opendaylight.org/show_bug.cgi?id=8679>`_ MappingSystem#getWidestNegativePrefix(Eid) returns incorrect results
+* `6754 <https://bugs.opendaylight.org/show_bug.cgi?id=9023>`_ Merging of negative prefixes is incorrect
+* `6759 <https://bugs.opendaylight.org/show_bug.cgi?id=7947>`_ Subscribers from both Northbound and Southbound origin are stored in SimpleMapCache
+* `6634 <https://bugs.opendaylight.org/show_bug.cgi?id=8469>`_ SMR scheduler task tracking unreliable
+* `6782 <https://bugs.opendaylight.org/show_bug.cgi?id=8506>`_ RNegative mapping subscriptions on SB take into account NB mappings too
+* `6925 <https://bugs.opendaylight.org/show_bug.cgi?id=8764>`_ Newly added mapping is removed when it has the same EID prefix as the old one
+* `7018 <https://bugs.opendaylight.org/show_bug.cgi?id=9037>`_ Negative mapping in SB masking overlapping more specific positive added later to NB
+* `7035 <https://bugs.opendaylight.org/show_bug.cgi?id=6537>`_ Expired mapping removed from map-cache, not removed from MD-SAL
+* `6361 <https://bugs.opendaylight.org/show_bug.cgi?id=8503>`_ DAO: Empty sub-tables are not removed
+* `7293 <https://bugs.opendaylight.org/show_bug.cgi?id=8112>`_ Integration tests: multi-site doesn't send SMR-invoked Map-Request on SMR
+* `7586 <https://bugs.opendaylight.org/show_bug.cgi?id=8591>`_ Authentication cannot be properly disabled
+* `7789 <https://bugs.opendaylight.org/show_bug.cgi?id=8775>`_ Upon negative mapping removal, subscribers should be notified to delete the negative
 
 
 Known Issues
@@ -135,6 +128,6 @@ Standards
 Release Mechanics
 =================
 
-* `Link to release plan <https://wiki.opendaylight.org/view/OpenDaylight_Lisp_Flow_Mapping:Carbon_Release_Plan>`_
+* `Link to release plan <https://wiki.opendaylight.org/view/OpenDaylight_Lisp_Flow_Mapping:Nitrogen_Release_Plan>`_
 
-  * No major shifts from the release plan.
\ No newline at end of file
+  * No major shifts from the release plan.
index 3bcc5d553084c9bab21e5edb359526deedb3f2e1..1332cb3dfdac565242c222c59c5f2a7711a68a76 100644 (file)
@@ -128,7 +128,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   Yes.
 
index 6a261ef9558088571d0eef4cd9d2469bc4355366..e3a8f9aaee8e762c895f038271da79ce284a74cf 100644 (file)
@@ -72,7 +72,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   Yes. No state data kept in datastore. User facing features and interfaces have not changed between releases, only
   enhancements/bugfixes were added.
index 63590b30243830ffa01ee195d4b4a69e13a9e905..785f9a4695ac1780f708106122762d440e7583a1 100644 (file)
@@ -14,8 +14,9 @@ Major Features
 odl-neutron-service
 -------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/features-neutron/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:**  This is a top level feature to load Neutron northbound functionality.
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/odl-neutron-service/pom.xml;hb=refs/heads/stable/nitrogen
+* **Feature Description:** This is a top level feature to load Neutron
+  northbound functionality.
 * **Top Level:** Yes
 * **User Facing:** Yes
 * **Experimental:** No
@@ -26,8 +27,9 @@ odl-neutron-service
 odl-neutron-northbound-api
 --------------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/features-neutron/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:**  This feature provides REST API for OpenStack Neutron
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/odl-neutron-northbound-api/pom.xml;hhb=refs/heads/stable/nitrogen
+* **Feature Description:** This feature provides REST API for
+  OpenStack Neutron
 * **Top Level:** No
 * **User Facing:** No
 * **Experimental:** No
@@ -39,7 +41,7 @@ odl-neutron-northbound-api
 odl-neutron-spi
 ---------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/features-neutron/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/odl-neutron-spi/pom.xml;hb=stable/nitrogen
 * **Feature Description:**  SPI for Neutron northbound feature
 * **Top Level:** No
 * **User Facing:** No
@@ -51,8 +53,9 @@ odl-neutron-spi
 odl-neutron-transcriber
 -----------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/features-neutron/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:**  Data converter from/to REST API to/from MD-SAL YANG model
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/odl-neutron-transcriber/pom.xml;hb=stable/nitrogen
+* **Feature Description:** Data converter from/to REST API to/from
+  MD-SAL YANG model
 * **Top Level:** No
 * **User Facing:** No
 * **Experimental:** No
@@ -63,7 +66,7 @@ odl-neutron-transcriber
 odl-neutron-logger
 ------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/features-neutron/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/odl-neutron-logger/pom.xml;hb=stable/nitrogen
 * **Feature Description:**  Logger on activity on Neutron YANG models
 * **Top Level:** No
 * **User Facing:** No
@@ -75,8 +78,9 @@ odl-neutron-logger
 odl-neutron-hostconfig-ovs
 --------------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/features-neutron/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:**  Helper library to support hostconfig for OpenStack service provider with Open vSwitch
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/odl-neutron-hostconfig-ovs/pom.xml;hb=stable/nitrogen
+* **Feature Description:** Helper library to support hostconfig for
+  OpenStack service provider with Open vSwitch
 * **Top Level:** No
 * **User Facing:** No
 * **Experimental:** No
@@ -87,8 +91,9 @@ odl-neutron-hostconfig-ovs
 odl-neutron-hostconfig-vpp
 --------------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/features-neutron/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:**  Helper library to support hostconfig for OpenStack service provider with VPP
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/odl-neutron-hostconfig-vpp/pom.xml;hb=stable/nitrogen
+* **Feature Description:** Helper library to support hostconfig for
+  OpenStack service provider with VPP
 * **Top Level:** No
 * **User Facing:** No
 * **Experimental:** No
@@ -145,19 +150,17 @@ Quality Assurance
     tests which also exercise Neutron Norhtbound. Which give coverage.
 
 
-* Testing methodology. How extensive was it? What should be expected to work? What hasn't been tested as much?
+* Testing methodology. How extensive was it? What should be expected
+  to work? What hasn't been tested as much?
 
-  * Unit test: coverage 26.5%
-  * Integration test(Karaf 3): coverage 75.9%
-  * Integration test(karaf 4): doens't work reliably.
-    https://git.opendaylight.org/gerrit/#/c/55128/ is pending to migrate
-    integration test to karaf4
+  * Unit test: coverage 24.9%
+  * Integration test: coverage 75.8%
   * OpenStack CI
 
 Migration
 ---------
 
-* Is it possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   No as incompatble change was introduced.
 
@@ -170,16 +173,7 @@ Compatibility
 
 * Any API changes?
 
-  Yes. adding new YANG models/nodes and REST API.
-
-  * `TRUNK API
-    <https://git.opendaylight.org/gerrit/#/c/50615/>`_
-  * `add configuration string
-    <https://git.opendaylight.org/gerrit/#/c/51817/>`_
-  * `add service provider feature model
-    <https://git.opendaylight.org/gerrit/#/c/52081/>`_
-  * `Neutron YANG model update
-    <https://git.opendaylight.org/gerrit/#/c/51534/>`_
+  No.
 
 * Any configuration changes?
 
@@ -191,7 +185,7 @@ Bugs Fixed
 * List of bugs fixed since the previous release
 
   * `Link to Bugs fixed
-    <https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2016-08-09&chfieldto=2017-05-25&list_id=78675&product=neutron&query_format=advanced&resolution=FIXED>`_
+    <https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2017-05-25&chfieldto=2017-09-08&list_id=78675&product=neutron&query_format=advanced&resolution=FIXED>`_
 
 
 Known Issues
@@ -232,7 +226,10 @@ Release Mechanics
 =================
 
 * `Link to release plan
-  <https://wiki.opendaylight.org/view/NeutronNorthbound:Carbon_Release_Plan>`_
+  <https://wiki.opendaylight.org/view/NeutronNorthbound:Nitrogen_Release_Plan>`_
 * Describe any major shifts in release schedule from the release plan
 
-  * Postponed YANG model change to drop tenant-id, make status operational to Nitrogen cycle
+  * Postponed YANG model change to drop tenant-id, make status
+    operational to Nitrogen cycle
+  * update supported QoS rules
+  * TAPaaS
index 7bc42e3b3ac971f2dc20e10b11a625a901e2b18b..c9c8d9f7930e332ec33f68514c424ef12ab7e456 100644 (file)
@@ -106,7 +106,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   Migration with user configuration and state is not supported.
 
index 6a065a72d03cf71783d5d281d30a178df7a10638..0799d273a0b28f4aac6a4fc265b6b5dc905e4412 100644 (file)
@@ -60,7 +60,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   * Yes, there is no change in config and no need to migrate data in the datastore.
 
index afc0afe29999eb7cd04ab284b799c26116cb0e15..2ee0059d3157025aeb33a7a1b6e4870ef09bb37f 100644 (file)
@@ -64,7 +64,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
   No, current release is backward incompatible.
 
 
index d226d4492edaa053329288269156a998c043f28e..8d327facf6054452ae92643e751a533a99aa13f6 100644 (file)
@@ -43,7 +43,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   Yes. There are no specific migration aspects related to ODL Parent.
 
index ae373feff733841684464e63710e1e41fdf8ed9b..73b0d70fb51a73eba13d6e59c3f7418548722485 100644 (file)
@@ -51,7 +51,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   There is no additional support for migration in OF-CONFIG than there is in
   general. User configuration and state will need to be manually migrated when
index 2e407bc7f3f155b8297d50a9fd6407d7f52cb189..896ec68fecc85cfc3cb4d4c4933f8ab2b0829ec4 100644 (file)
@@ -228,7 +228,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   Yes. `single-layer-serialization needs to be disabled <https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:OF13%2B_Single_Layer_Serialization#Enabling.2FDisabling_Single_Layer_Serialization>`_
   in order to achieve same functionality as in previous release.
index 5e33078477f6f04d2ffdb22e28627575dbc154b4..eb7e44e402d41883d67727c35a372a40b8dbd294 100644 (file)
@@ -59,7 +59,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release?  Yes
+* Is it possible to migrate from the previous release?  Yes
 * Migration from PacketCable Boron version to Carbon version can be
   accomplished by replacement of the PacketCable plugin components.
 
index 815fa7a78b40399e6f84e1cc4fc1b30d48e4ce2a..3bc7d6266a73f97c0d4840438b687015fef49d89 100644 (file)
@@ -105,7 +105,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
 .. note:: This is asking if somebody can move from an installation of the
           previous release while keeping data. This isn't currently, natively
index c67f6546bc6bdf528338314ffd8ce104b0553ab9..48b9358cb34b18a9d909323bc3aea27e5eaed491 100644 (file)
@@ -60,7 +60,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   It is possible to seamlessly migrate consumers to this iteration of the plug-in as there has been no functional
   change to features. Migration of state data is not defined.
index 180e8db4ac2e19ac75522765a64fd2194af7ba32..44a8b55203f9f821e8698f1a6b31dfd84a861124 100644 (file)
@@ -50,7 +50,7 @@ Quality Assurance
 Migration\r
 ---------\r
 \r
-* Is is possible migrate from the previous release? If so, how?\r
+* Is it possible to migrate from the previous release? If so, how?\r
 \r
   Yes. Features as well as interfaces are not changed.\r
 \r
index 319131c455af5b254c9ee3bce435fd2c32792930..e3683a91e3fe9bfcc2f0243855a29bc76413654a 100644 (file)
@@ -112,7 +112,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   * Yes, no data models were changed that would break the migration.
 
index 87ac021d43e494da988e4e4f2ec3fc76f3a634e8..47a6fa881f46b03df347c5e48aefdb50895cdc7c 100644 (file)
@@ -116,7 +116,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is it possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   * Yes, since there's no change of features from the previous releases.
 
index b5498c6fa59046a320f3421707cb1d0ca82d2e0c..485f456a09892f90303fa3b8ff0e35d234e3826b 100644 (file)
@@ -67,7 +67,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
   While it should be possible to export all TTP-related information by doing
   RESTCONF GETs and then import it by doing RESTCONF PUTs after the fact, this
index 06cac862e5a218537a11bf89e237f46c6ae74082..76c166df11791fbcb90289299c84f76a0b64b8b6 100644 (file)
@@ -51,7 +51,7 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release?
+* Is it possible to migrate from the previous release?
   No, Current release is backward incompatible.
 
 Compatibility
index 344fa9f7ae8fd440a8dafe173b9dfb08e7e3877c..c24b20ec7ae71a89a407fcf66a07deb2e140fcf3 100644 (file)
@@ -8,7 +8,7 @@ Major Features
 odl-vbd
 -------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=honeycomb/vbd.git;a=blob;f=features/vbd-features/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=honeycomb/vbd.git;a=blob;f=features/odl-vbd/src/main/feature/feature.xml;h=37a666153982e4efa38a37ca0b971be5d5cbdcd6;hb=refs/heads/stable/nitrogen
 * **Feature Description:**  This feature provides models to configure Virtual Bridge Domains on VPP.
 * **Top Level:** Yes
 * **User Facing:** Yes
@@ -18,7 +18,7 @@ odl-vbd
 odl-vbd-ui
 ----------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=honeycomb/vbd.git;a=blob;f=features/vbd-features/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=honeycomb/vbd.git;a=tree;f=features/odl-vbd-ui;h=a6172d7fb3d2c1930b0a87213b7043f58a711f60;hb=refs/heads/stable/nitrogen
 * **Feature Description:**  This feature provides the GUI for VBD.
 * **Top Level:** Yes
 * **User Facing:** Yes
@@ -44,14 +44,14 @@ Quality Assurance
 * VBD project is tested within `FastDataStacks (FDS) <https://wiki.opnfv.org/display/fds/FastDataStacks+Home>`_ testing suite, where severeal automated
   tests are performed. More information about FDS testing can be found here:
   `FDS testing <https://wiki.opnfv.org/display/fds/FDS+Testing>`_ and test
-  results are available here: `FDS test results <http://testresults.opnfv.org/reporting/functest/release/danube/index-status-apex.html>`_
+  results are available here: `FDS test results <http://testresults.opnfv.org/reporting/master/functest/status-apex.html>`_
 * FDS automated tests perform series of functests where the whole stack is
   beeing tested (Openstack/ODL (GBP,VBD)/HC/VPP).
 
 Migration
 ---------
 
-* Please upgrade to VPP 17.04 stable.
+* Please use VPP 17.04 stable.
 
 Compatibility
 -------------
@@ -61,23 +61,7 @@ Compatibility
 Bugs Fixed
 ----------
 
-* `Bug 6077 <https://bugs.opendaylight.org/show_bug.cgi?id=6077>`_     RESOLVED        Bridge domain is not created when topology and node are created at the same time
-* `Bug 6078 <https://bugs.opendaylight.org/show_bug.cgi?id=6078>`_     RESOLVED        BVI is set to true and should be false when creating VXLAN tunnel
-* `Bug 6101 <https://bugs.opendaylight.org/show_bug.cgi?id=6101>`_     RESOLVED        Error when creating VLAN flood domain
-* `Bug 6104 <https://bugs.opendaylight.org/show_bug.cgi?id=6104>`_     RESOLVED        Ip addresses nullPointerException
-* `Bug 6105 <https://bugs.opendaylight.org/show_bug.cgi?id=6105>`_     RESOLVED        Error when removing nodes from bridge domain
-* `Bug 6241 <https://bugs.opendaylight.org/show_bug.cgi?id=6241>`_     RESOLVED        Split horizon group is not set for VXLAN tunnel interfaces
-* `Bug 6285 <https://bugs.opendaylight.org/show_bug.cgi?id=6285>`_     RESOLVED        HONEYCOMB/VBD Missing from Distribution Feature Index
-* `Bug 6591 <https://bugs.opendaylight.org/show_bug.cgi?id=6591>`_     RESOLVED        VXLAN tunnels are not created correctly
-* `Bug 7117 <https://bugs.opendaylight.org/show_bug.cgi?id=7117>`_     RESOLVED        Cannot add Virtual Bridge Domains in DLUX
-* `Bug 7118 <https://bugs.opendaylight.org/show_bug.cgi?id=7118>`_     RESOLVED        Cannot remove VPP from inventory in DLUX
-* `Bug 7148 <https://bugs.opendaylight.org/show_bug.cgi?id=7148>`_     RESOLVED        VBD Carbon Autorelease Build Failure
-* `Bug 7655 <https://bugs.opendaylight.org/show_bug.cgi?id=7655>`_     RESOLVED        Karaf 4 migration: provide Karaf 4 honeycomb-vbd features
-* `Bug 8009 <https://bugs.opendaylight.org/show_bug.cgi?id=8009>`_     RESOLVED        Mismatched VXLAN tunnel endpoint addresses
-* `Bug 8167 <https://bugs.opendaylight.org/show_bug.cgi?id=8167>`_     RESOLVED        Default startup configuration file not created
-* `Bug 8172 <https://bugs.opendaylight.org/show_bug.cgi?id=8172>`_     RESOLVED        VBD missing yangs for configuring LISP in VPP
-* `Bug 8173 <https://bugs.opendaylight.org/show_bug.cgi?id=8173>`_     RESOLVED        Mismatch of v3po yangs between vbd and hc2vpp
-* `Bug 8354 <https://bugs.opendaylight.org/show_bug.cgi?id=8354>`_     RESOLVED        Feature installs fails if installed in a particular order
+* N/A
 
 
 Known Issues
@@ -100,5 +84,5 @@ Standards
 Release Mechanics
 =================
 
-* `Release plan <https://wiki.opendaylight.org/view/Honeycomb/VBD/Carbon/Release_Plan>`_
+* `Release plan <https://wiki.opendaylight.org/view/Honeycomb/VBD/Nitrogen/Release_Plan>`_
 * no major shifts from official release plan
index d742987cf3889135aa150cc5b9b57ae2efc7e7f0..2533053aa7b2bd5fe0d425f25cf29a67f2671006 100644 (file)
@@ -8,23 +8,23 @@ Major Features
 odl-vtn-manager-rest
 --------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=vtn.git;a=blob;f=manager/features/features-vtn-manager/src/main/features/features.xml;hb=refs/heads/stable/carbon#l41
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=vtn.git;a=blob;f=manager/features/odl-vtn-manager-rest/pom.xml;h=c130771e9dbc0d77dddf9b81a65d1a0c9aab936c;hb=refs/heads/stable/nitrogen#l24
 * **Feature Description:**  This is the feature that allows users to use the VTN virtualization, by creating the various components as needed for the network.
 * **Top Level:** Yes
 * **User Facing:** Yes
 * **Experimental:** No
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/vtn/job/vtn-csit-1node-manager-only-carbon/,https://jenkins.opendaylight.org/releng/view/vtn/job/vtn-csit-1node-manager-all-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/vtn/job/vtn-csit-1node-manager-all-nitrogen/
 
 
 odl-vtn-manager-neutron
 ----------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=vtn.git;a=blob;f=manager/features/features-vtn-manager/src/main/features/features.xml;hb=refs/heads/stable/carbon#l49
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=vtn.git;a=blob;f=manager/features/odl-vtn-manager-neutron/pom.xml;h=600411e41a52ddc8ac90e9a3c5c58b73ed774b8c;hb=refs/heads/stable/nitrogen#l24
 * **Feature Description:**  This feature provides support for integration with Openstack (L2 API)
 * **Top Level:** Yes
 * **User Facing:** Yes
 * **Experimental:** No
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/vtn/job/vtn-csit-1node-openstack-newton-neutron-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/vtn/job/vtn-csit-1node-openstack-newton-neutron-nitrogen/
 
 Documentation
 =============
@@ -69,16 +69,8 @@ Compatibility
 Bugs Fixed
 ----------
 
-* 6632 - VTN Coordinator Build Issues with Fedora 24
-* 7360 - VTN Coordinator Build Issues in Fedora 25
-* 7402 - VTN Coordinator Tomcat Upgrade to 7.0.73
-* 6859 - Clean up package names across ODL for yangtools
-* 7969 - VTN Coordinator Issues with recent Postgres Versions
-* 7652 - VTN Manager Support for Karaf 4
-* 8191 - VTN Manager Addressed some Checkstyle/findbugs warnings
-* 8184 - VTN Manager Removed some log messages when handling send-barrier RPC
-* 8211 - VTN Manager Addressed Problems in mapping VTN Flow and MD-SAL Flow
-* 8212 - VTN Manager Fixed Failure in retrieving dataflow
+* 8761 - VTN coordinator Portmapping fails due to unnecessary hex conversion.
+* 9024 - VTN Manager Set null to bundle version qualifier if it is empty.
 
 Known Issues
 ------------
@@ -98,5 +90,5 @@ Standards
 Release Mechanics
 =================
 
-* `Link to release plan <https://wiki.opendaylight.org/view/VTN:Carbon_Release_Plan>`_
+* `Link to release plan <https://wiki.opendaylight.org/view/VTN:Nitrogen_Release_Plan>`_
 * There was no deviation from the plan.
index 7e6781e513100ffb3fc3a1ae5959f0426f6058a1..71ffcd312c8b5d2664f0c54e1567ff7afeae3b98 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 7e6781e513100ffb3fc3a1ae5959f0426f6058a1
+Subproject commit 71ffcd312c8b5d2664f0c54e1567ff7afeae3b98
index 1790f100558e49a15e2e5f9925a179bf815779f2..d22a1e6bb1e0e4aca88ac4d8b0f987b2961935fd 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 1790f100558e49a15e2e5f9925a179bf815779f2
+Subproject commit d22a1e6bb1e0e4aca88ac4d8b0f987b2961935fd
index d4037c7ded52c7af9806f1e83b69a350f6ff3bf0..a1b6d1136f3cdafd468160b450071fa59e7f7b63 160000 (submodule)
@@ -1 +1 @@
-Subproject commit d4037c7ded52c7af9806f1e83b69a350f6ff3bf0
+Subproject commit a1b6d1136f3cdafd468160b450071fa59e7f7b63
index 72bef67d06d2793aee07979d6ef0df7d715115f0..07baece077510d6015fcc3da8784e2360bf57bc3 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 72bef67d06d2793aee07979d6ef0df7d715115f0
+Subproject commit 07baece077510d6015fcc3da8784e2360bf57bc3
index bc9d308eeb07c398f9ba8c37661a8b224aa147b7..c9912dd1d528b91c7b5f67f1b3156b586f92d15f 160000 (submodule)
@@ -1 +1 @@
-Subproject commit bc9d308eeb07c398f9ba8c37661a8b224aa147b7
+Subproject commit c9912dd1d528b91c7b5f67f1b3156b586f92d15f
diff --git a/docs/user-guide/daexim-user-guide.rst b/docs/user-guide/daexim-user-guide.rst
new file mode 100644 (file)
index 0000000..647ba9f
--- /dev/null
@@ -0,0 +1,190 @@
+Data Export/Import User Guide
+=============================
+
+
+Overview
+--------
+
+The Data Export/Import is known as "daexim" (pronounced 'deck-sim') for
+short. The intended audience are administrators responsible for
+operations of OpenDaylight.
+
+Data Export/Import provides an API (via RPCs) to request the bulk
+transfer of OpenDaylight system data between its internal data stores
+and the local file system. This can be used for scheduling data exports,
+checking the status of data being exported, canceling data export jobs,
+importing data from files in the file systems, and checking the import
+status.
+
+Such export and import of data can be used during system upgrade,
+enabling the development of administrative procedures that make
+reconfigurations of the base system without concern of internal data
+loss.
+
+Data Export produces a models declaration file and one or more data
+files. The models declaration file records exactly which YANG models
+were loaded (by module name, revision date and namespace). The data
+file(s) contain data store data as per the draft-ietf-netmod-yang-json
+RFC.
+
+Data Import takes a models declaration file and zero or more data
+files. The models declaration file is used to check that the listed
+models are loaded before importing any data. Data is imported into each
+data store in turn with one transaction executed for each data store,
+irrespective of the number of files for that data store, as inter-module
+data dependencies may exist. Existing data store data may be cleared
+before importing.
+
+
+Data Export Import Architecture
+-------------------------------
+
+The daexim feature is a single feature. This feature leverages the
+existing infrastructure provided by MD-SAL and yangtools.
+
+
+Installing the Feature
+----------------------
+
+To install the feature perform the following steps.
+
+.. code:: bash
+
+    karaf > feature:install odl-daexim-all
+
+
+The interactions with this feature are via Restconf RPCs. The details
+are provided in the `Tutorials`.
+
+
+Tutorials
+---------
+
+The following tutorials provide examples of REST API that are supported
+by the Data Export/Import feature.  As for all ODL RESTCONF calls, the
+following are the common setting for REST calls:
+
+* Headers:
+  * Content-Type: application/json
+  * Accept: application/json
+  * Authentication: admin:admin
+* Method: HTTP POST
+* <controller-ip> : Host (or IP) where OpenDaylight controller is
+  running, e.g. localhost
+* <restconf-port> : TCP port where RESTCONF has been configured to
+  listen, e.g. 8181 by default
+
+The files created by export are placed in a subdirectory called
+*daexim/* in the installation directory of OpenDaylight. Similarly files
+to import must be placed in this *daexim/* subdirectory.
+
+
+
+Scheduling Export
+^^^^^^^^^^^^^^^^^
+
+The **schedule-export** RPC exports the data at a specific time in the
+future. The *run-at* time may be specified as an absolute UTC time or a
+relative offset from the server clock. Attempts to schedule an export in
+the past times are rejected. Each file has a JSON-encoded object that
+contains module data from the corresponding data store.  Module data is
+not included in the object for any module identified in the exclusion
+list. Each file contains at least one empty JSON object.
+
+URL:
+  http://<controller-ip>:<restconf-port>/restconf/operations/data-export-import:schedule-export
+
+Payload:
+
+.. code:: json
+
+  {
+     "input": {
+       "data-export-import:run-at": 500
+     }
+  }
+
+
+
+Checking Export Status
+^^^^^^^^^^^^^^^^^^^^^^
+
+The **status-export** RPC checks the status of the exported data. If the
+status has the value of *initial*, an export has not been scheduled. If
+the status has the value of *scheduled*, *run-at* indicates the time at
+which the next export runs. If the status has the value of
+*in-progress*, *run-at* indicates the time at which the running export
+was scheduled to start. A status of *tasks* indicates activities that
+are scheduled and currently being performed. The *tasks* status serves
+as an indicator of progress and success of the activity. If the status
+has any other value, *run-at* indicates the time at which the last
+export was scheduled to start; and *tasks* indicates the activities that
+were undertaken. If the status for any node has failed, the
+corresponding reason for failure is listed.
+
+URL:
+  http://<controller-ip>:<restconf-port>/restconf/operations/data-export-import:status-export
+
+Payload:
+  No payload
+
+
+
+Canceling Scheduled Export
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The **cancel-export** RPC cancels an already scheduled data export
+job. To cancel the export, the server stops the tasks that are running
+(where possible, immediately), clears any scheduled export time value,
+and releases the associated resources. This RPC may be called at any
+time, whether an export is in progress, scheduled or not yet
+scheduled. The returned result is *True* when the server has
+successfully cleared tasks, the state, and resources. The status is
+*False* on failure to do so. Note that if no export is scheduled or
+running, there is no tasks for the server to clear. Therefore, the
+return result is *True* because the server cannot fail.
+
+URL:
+  http://<controller-ip>:<restconf-port>/restconf/operations/data-export-import:cancel-export
+
+Payload:
+  No payload
+
+
+Import from a file
+^^^^^^^^^^^^^^^^^^
+
+The **immediate-import** RPC imports data from files already present in
+the file system.
+
+URL:
+  http://<controller-ip>:<restconf-port>/restconf/operations/data-export-import:immediate-import
+
+Payload:
+
+.. code:: json
+
+  {
+     "input" : {
+       "check-models" : true,
+       "clear-stores" : "all"
+     }
+  }
+
+
+
+
+Status of Import
+^^^^^^^^^^^^^^^^
+
+The **status-import** RPC checks the last import status. If the status
+has the value of *initial*, an import has not taken place. For all other
+values of status, *imported-at* indicates the time at which the
+restoration has taken place. List nodes hold status about the
+restoration for each node.
+
+URL:
+  http://<controller-ip>:<restconf-port>/restconf/operations/data-export-import:status-import
+
+Payload:
+  No payload
index c1caaa5bd21ea0787780201ef99f597dfc84899b..54a3b98030c88694884b94f24a16f0c4280182f6 100644 (file)
@@ -32,6 +32,7 @@ Project-specific User Guides
    capwap-user-guide
    cardinal_-opendaylight-monitoring-as-a-service
    centinel-user-guide
+   daexim-user-guide
    didm-user-guide
    eman-user-guide
    fabric-as-a-service