Merge "Add infrautils release note"
authorColin Dixon <colin@colindixon.com>
Thu, 8 Jun 2017 01:26:21 +0000 (01:26 +0000)
committerGerrit Code Review <gerrit@opendaylight.org>
Thu, 8 Jun 2017 01:26:21 +0000 (01:26 +0000)
106 files changed:
docs/developer-guide/alto-developer-guide.rst
docs/developer-guide/authentication-and-authorization-services.rst
docs/developer-guide/bgp-developer-guide.rst
docs/developer-guide/bgp-monitoring-protocol-developer-guide.rst
docs/developer-guide/controller.rst
docs/developer-guide/eman-developer-guide.rst [new file with mode: 0644]
docs/developer-guide/fabric-as-a-service.rst
docs/developer-guide/index.rst
docs/developer-guide/iotdm-developer-guide.rst
docs/developer-guide/l2switch-developer-guide.rst
docs/developer-guide/network-intent-composition-(nic)-developer-guide.rst
docs/developer-guide/neutron-northbound.rst
docs/developer-guide/neutron-service-developer-guide.rst
docs/developer-guide/ocp-plugin-developer-guide.rst
docs/developer-guide/odl-parent-developer-guide.rst
docs/developer-guide/openflow-protocol-library-developer-guide.rst
docs/developer-guide/opflex-agent-ovs-developer-guide.rst
docs/developer-guide/opflex-genie-developer-guide.rst
docs/developer-guide/opflex-libopflex-developer-guide.rst
docs/developer-guide/pcep-developer-guide.rst
docs/developer-guide/service-function-chaining.rst
docs/developer-guide/snmp4sdn-developer-guide.rst
docs/developer-guide/ttp-cli-tools-developer-guide.rst
docs/developer-guide/ttp-model-developer-guide.rst
docs/developer-guide/virtual-tenant-network-(vtn).rst
docs/developer-guide/yang-tools.rst
docs/getting-started-guide/index.rst
docs/getting-started-guide/installing_opendaylight.rst
docs/getting-started-guide/project-release-notes/aaa.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/alto.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/bgp-ls-pcep.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/bier.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/controller.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/dluxapps.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/docs.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/eman.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/faas-release-notes.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/federation.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/gbp-release-notes.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/iotdm.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/l2switch.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/lispflowmapping.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/mdsal.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/netconf.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/netide.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/netvirt.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/neutron-northbound.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/nic.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/ocpplugin-release-notes.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/odlparent.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/openflowjava.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/openflowplugin.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/opflex.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/ovsdb.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/sample-release-notes.rst
docs/getting-started-guide/project-release-notes/sfc.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/snmp4sdn.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/sxp.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/topology-processing-framework.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/tsdr.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/ttp.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/usc.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/vbd.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/vtn.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/yangtools.rst [new file with mode: 0644]
docs/getting-started-guide/project-specific-guides/nemo.rst [new file with mode: 0644]
docs/getting-started-guide/project-specific-guides/opflex.rst
docs/getting-started-guide/project-specific-guides/tsdr.rst
docs/getting-started-guide/project-specific-guides/vtn.rst
docs/getting-started-guide/security_considerations.rst
docs/opendaylight-with-openstack/openstack-with-vtn.rst
docs/release-process/simultaneous-release.rst
docs/submodules/aaa
docs/submodules/coe
docs/submodules/genius
docs/submodules/infrautils
docs/submodules/integration/packaging
docs/submodules/integration/test
docs/submodules/netconf
docs/submodules/netvirt
docs/submodules/odlparent
docs/submodules/ovsdb
docs/submodules/releng/builder
docs/user-guide/alto-user-guide.rst
docs/user-guide/authentication-and-authorization-services.rst
docs/user-guide/bgp-monitoring-protocol-user-guide.rst
docs/user-guide/bgp-user-guide.rst
docs/user-guide/bier-user-guide.rst
docs/user-guide/eman-user-guide.rst [new file with mode: 0644]
docs/user-guide/fabric-as-a-service.rst
docs/user-guide/group-based-policy-user-guide.rst
docs/user-guide/index.rst
docs/user-guide/l2switch-user-guide.rst
docs/user-guide/lisp-flow-mapping-user-guide.rst
docs/user-guide/network-intent-composition-(nic)-user-guide.rst
docs/user-guide/neutron-service-user-guide.rst
docs/user-guide/ocp-plugin-user-guide.rst
docs/user-guide/opflex-agent-ovs-user-guide.rst
docs/user-guide/pcep-user-guide.rst
docs/user-guide/service-function-chaining.rst
docs/user-guide/snmp4sdn-user-guide.rst
docs/user-guide/tsdr-user-guide.rst
docs/user-guide/ttp-cli-tools-user-guide.rst
docs/user-guide/virtual-tenant-network-(vtn).rst
tox.ini
web/tsc-meetings.sh [changed mode: 0644->0755]

index 8b16f532421ba9c8e6c7cea08fdea369904b6940..baf6b46a4090da2e6c4e6840e903bde77acdfd3a 100644 (file)
@@ -1,3 +1,5 @@
+.. _alto-developer-guide
+
 ALTO Developer Guide
 ====================
 
@@ -191,4 +193,3 @@ Register northbound route
 
 If necessary, you can add a northbound route module in
 ``alto-core/standard-northbound-routes``.
-
index c9775cf02cd5b6ebf5e7e22a1e4e388f305daf25..bb05ad86d0944df65189b64c740054335c1f7760 100644 (file)
@@ -1,3 +1,5 @@
+.. _aaa-dev-guide:
+
 Authentication, Authorization and Accounting (AAA) Services
 ===========================================================
 
index 5910d0ab0565ea7ddfae72e98d266650b53d8995..5f3a1567191e169f7b2f4011a76b0a2feef74374 100644 (file)
@@ -1,3 +1,4 @@
+.. _bgp-developer-guide:
 BGP Developer Guide
 ===================
 
index a6e84a7bf2e5c6c18ce6316c6eb75938a77cbc1b..d83bbc7dce561e9ac6319cadba0a1460003d9641 100644 (file)
@@ -1,3 +1,4 @@
+.. _bgp-monitoring-protocol-developer-guide:
 BGP Monitoring Protocol Developer Guide
 =======================================
 
index 99000069c1b649a32f01f049f7c7cb66928e01be..ade88739f08716ef1e7efc96882808573a2b67f3 100644 (file)
@@ -52,6 +52,8 @@ data using following model-driven protocols:
    manipulate YANG modeled data and invoke YANG modeled RPCs, using XML
    or JSON as payload format.
 
+.. _mdsal_dev_guide:
+
 MD-SAL Overview
 ---------------
 
diff --git a/docs/developer-guide/eman-developer-guide.rst b/docs/developer-guide/eman-developer-guide.rst
new file mode 100644 (file)
index 0000000..1119877
--- /dev/null
@@ -0,0 +1,120 @@
+.. _eman-dev-guide:
+
+eman Developer Guide
+====================
+
+Overview
+--------
+
+The OpenDaylight Energy Management (eman) plugin implements an abstract
+Information Model that describes energy measurement and control features
+that may be supported by a variety of device types. The eman plugin may
+support a number of southbound interfaces to accommodate a set of
+protocols, including but not limited to SNMP, NETCONF, IPDR. The plugin
+presents a northbound REST API. This framework enables any number of
+applications to interoperate with any number of devices in order to
+measure and optimize energy usage. The Information Model will be
+inherited from the `SCTE 216 standard – Adaptive Power Systems Interface
+Specification (APSIS)
+<http://www.scte.org/SCTEDocs/Standards/ANSI_SCTE%20216%202015.pdf>`_,
+which in turn inherits definitions within the `IETF eman document set
+<https://datatracker.ietf.org/wg/eman/documents/>`_.
+
+This documentation is directed to developers who may use the eman features
+to build other OpenDaylight features or applications.
+
+eman is composed of 3 Karaf features:
+    * ``eman`` incudes the YANG model and its implementation
+    * ``eman-api`` adds support for REST
+    * ``eman-ui`` adds support for DLUX.
+
+Developers will typically interface with ``eman-api``.
+
+
+eman Architecture
+-----------------
+
+``eman`` defines a YANG model that represents the IETF energy management
+Information Model, and includes RPCs. The implementation of the model
+currently supports an SNMP 'binding' via interfacing with the
+OpenDaylight SNMP module. In the future, other Southbound protocols may
+be supported.
+
+Developers my use the ``eman-api`` feature to read and write energy
+related data and commands to devices that support the IETF eman MIBS.
+
+Key APIs and Interfaces
+-----------------------
+
+The eman API currently supports a subset of the IETF eman Information Model,
+including the EnergyObjectPowerMeasurement table. Users of the API may
+get individual attributes or the entire table. When querying the table, the
+results are written into the MD-SAL, for subsequent access. For example,
+a developer may periodically poll a device for its powerMeasurements,
+and fetch a collection of measurements to discover a history of measurements.
+
+
+Operational API
+---------------
+
+Via MD-SAL, the following endpoint provides access to previously
+captured power measurements.
+
+.. note::
+  "eo" indicates "energy object" as per the IETF Information Model
+
+operational::
+
+  eman:eoDevices/eoDevice{id}/eoPowerMeasurement{id}
+
+    id indicates an index into a collection
+
+EoDevices may contain a collection of individual eoDevice objects, which
+in turn may contain a collection of eoPowerMeasurement objects
+
+Operations API
+--------------
+
+A set of RPCs enable interactions with devices.
+
+get-eoAttribute enables query on an individual attribute of a energy object::
+
+  get-eoAttribute
+
+    deviceIP indicates IP address of target device
+    attribute indicates name of requested attribute
+
+.. note:: Future releases will provide a enumeration of allowed names.
+
+The supported name are:
+
+* eoPower
+* eoPowerNameplate
+* eoPowerUnitMultiplier
+* eoPowerAccuracy
+* eoPowerMeasurementCaliber
+* eoPowerCurrentType
+* eoPowerMeasurementLocal
+* eoPowerAdminState
+* eoPowerOperState
+* eoPowerStateEnterReason
+
+set-eoAttribute enables sending a command to an energy object::
+
+  set-eoAttribute
+
+    deviceIP. IP address of target device
+    attribute. string indicating name of attribute. Currently, no attributes
+
+get-eoDevicePowerMeasures reads an eoPowerMEasurements table from a device
+and stores the result in MD-SAL, making it available vie the operational API::
+
+  get-eoDevicePowerMeasures
+
+    deviceIP. IP address of target device
+
+API Reference Documentation
+---------------------------
+
+See eman project page for additional information:
+https://wiki.opendaylight.org/view/eman:Main
index 77f9acf7d33f93a717ea807f671014d876f827b1..1720aaff60ff80542ca6f06d27e0e04e1caeaac4 100644 (file)
@@ -1,3 +1,5 @@
+.. _faas_dev_guide:
+
 Fabric As A Service
 ===================
 
index ff397bb5a7bf81ae502b108bd504a6d4631ff44d..d1d89fc482977b1b771c6c1cff0ffdc6fb0a844d 100644 (file)
@@ -1,3 +1,5 @@
+.. _developer_guide:
+
 Developer Guide
 ===============
 
@@ -26,6 +28,7 @@ Project-specific Developer Guides
    didm-developer-guide
    distribution-version
    dlux
+   eman-developer-guide
    fabric-as-a-service
    infrautils-developer-guide
    iotdm-developer-guide
index 45b17d60740e7b9921ebe337677d691d420f147a..342bce0c05c42a7b0376a15073428b6653ce0fa2 100644 (file)
@@ -1,3 +1,5 @@
+.. _iotdm_dev_guide:
+
 IoTDM Developer Guide
 =====================
 
index 95a38076276dd06a75a26e207d785caacf82ab3a..96d7789d80c3597a10a276e9a17c0796b62634d6 100644 (file)
@@ -1,3 +1,5 @@
+.. _l2switch-dev-guide:
+
 L2Switch Developer Guide
 ========================
 
index aaafd4792c516ce2a600468da5e29904de3055da..bd1315a03ff4204007474e51a26f9c3448861e15 100644 (file)
@@ -1,3 +1,5 @@
+.. _nic-dev-guide:
+
 Network Intent Composition (NIC) Developer Guide
 ================================================
 
index 9ea87149bcd06873d2ff00d54c83f99845242f36..8b898f260a94dc2726b1c97a055010d14a56aac5 100644 (file)
@@ -1,3 +1,5 @@
+.. neutron-northbound-developer-guide:
+
 Neutron Northbound
 ==================
 
index 3ecead03cb2f619f9c4758039b5176bc53b46bbe..4e61a670ae8f960366b0314bbfd2cf78e447df81 100644 (file)
@@ -1,3 +1,5 @@
+.. neutron-service-developer-guide:
+
 Neutron Service Developer Guide
 ===============================
 
index ba40a05daae64c73bcd0b96b3be331e3c2f965c8..19db5a53963918beef45642eff1e8e9ca761482e 100644 (file)
@@ -1,3 +1,5 @@
+.. _ocpplugin-dev-guide:
+
 OCP Plugin Developer Guide
 ==========================
 
@@ -1155,4 +1157,3 @@ Notification to the MD-SAL.
         void onFaultInd(FaultInd notification);
 
     }
-
index e32c9579af39ff6fe478692683277e230e779618..b265136fbc03cafbb201f66f52595a94fcc44a84 100644 (file)
@@ -1,3 +1,5 @@
+.. _odl-parent-developer-guide:
+
 ODL Parent Developer Guide
 ==========================
 
@@ -24,21 +26,24 @@ These parent projects are:
 -  ``bundle-parent`` — the parent POM for Maven modules producing OSGi
    bundles
 
--  ``single-feature-parent`` — the parent POM for Maven modules producing
-   a single Karaf feature
+The following parent projects are deprecated, but still used in Carbon:
 
--  ``feature-repo-parent`` — the parent POM for Maven modules producing
-   feature repositories
+-  ``feature-parent`` — the parent POM for Maven modules producing
+   Karaf 3 feature repositories
 
--  ``karaf4-parent`` — the parent POM for Maven modules producing Karaf 4
+-  ``karaf-parent`` — the parent POM for Maven modules producing Karaf 3
    distributions
 
-The following parent projects are deprecated:
+The following parent projects are new in Carbon, for Karaf 4 support (which
+won’t be complete until Nitrogen):
 
--  ``feature-parent`` — the parent POM for Maven modules producing
-   Karaf 3 feature repositories
+-  ``single-feature-parent`` — the parent POM for Maven modules producing
+   a single Karaf 4 feature
 
--  ``karaf-parent`` — the parent POM for Maven modules producing Karaf 3
+-  ``feature-repo-parent`` — the parent POM for Maven modules producing
+   Karaf 4 feature repositories
+
+-  ``karaf4-parent`` — the parent POM for Maven modules producing Karaf 4
    distributions
 
 odlparent-lite
@@ -251,11 +256,67 @@ OSGi bundles:
 In addition to this, JUnit is included as a default dependency in “test”
 scope.
 
+features-parent
+~~~~~~~~~~~~~~~
+
+This inherits from ``odlparent`` and enables functionality useful for
+Karaf features:
+
+-  ``karaf-maven-plugin`` is activated, to build Karaf features — but
+   for OpenDaylight, projects need to use “jar” packaging (**not**
+   “feature” or “kar”);
+
+-  ``features.xml`` files are processed from templates stored in
+   ``src/main/features/features.xml``;
+
+-  Karaf features are tested after build to ensure they can be activated
+   in a Karaf container.
+
+The ``features.xml`` processing allows versions to be ommitted from
+certain feature dependencies, and replaced with “\ ``{{version}}``\ ”.
+For example:
+
+::
+
+    <features name="odl-mdsal-${project.version}" xmlns="http://karaf.apache.org/xmlns/features/v1.2.0"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:schemaLocation="http://karaf.apache.org/xmlns/features/v1.2.0 http://karaf.apache.org/xmlns/features/v1.2.0">
+
+        <repository>mvn:org.opendaylight.odlparent/features-odlparent/{{VERSION}}/xml/features</repository>
+
+        [...]
+        <feature name='odl-mdsal-broker-local' version='${project.version}' description="OpenDaylight :: MDSAL :: Broker">
+            <feature version='${yangtools.version}'>odl-yangtools-common</feature>
+            <feature version='${mdsal.version}'>odl-mdsal-binding-dom-adapter</feature>
+            <feature version='${mdsal.model.version}'>odl-mdsal-models</feature>
+            <feature version='${project.version}'>odl-mdsal-common</feature>
+            <feature version='${config.version}'>odl-config-startup</feature>
+            <feature version='${config.version}'>odl-config-netty</feature>
+            <feature version='[3.3.0,4.0.0)'>odl-lmax</feature>
+            [...]
+            <bundle>mvn:org.opendaylight.controller/sal-dom-broker-config/{{VERSION}}</bundle>
+            <bundle start-level="40">mvn:org.opendaylight.controller/blueprint/{{VERSION}}</bundle>
+            <configfile finalname="${config.configfile.directory}/${config.mdsal.configfile}">mvn:org.opendaylight.controller/md-sal-config/{{VERSION}}/xml/config</configfile>
+        </feature>
+
+As illustrated, versions can be ommitted in this way for repository
+dependencies, bundle dependencies and configuration files. They must be
+specified traditionally (either hard-coded, or using Maven properties)
+for feature dependencies.
+
+karaf-parent
+~~~~~~~~~~~~
+
+This allows building a Karaf 3 distribution, typically for local testing
+purposes. Any runtime-scoped feature dependencies will be included in the
+distribution, and the ``karaf.localFeature`` property can be used to
+specify the boot feature (in addition to ``standard``).
+
 single-feature-parent
 ~~~~~~~~~~~~~~~~~~~~~
 
 This inherits from ``odlparent`` and enables functionality useful for
-Karaf features:
+Karaf features:
 
 -  ``karaf-maven-plugin`` is activated, to build Karaf features, typically
    with “feature” packaging (“kar” is also supported);
@@ -283,7 +344,7 @@ feature-repo-parent
 ~~~~~~~~~~~~~~~~~~~
 
 This inherits from ``odlparent`` and enables functionality useful for
-Karaf feature repositories. It follows the same principles as
+Karaf feature repositories. It follows the same principles as
 ``single-feature-parent``, but is designed specifically for repositories
 and should be used only for this type of artifacts.
 
@@ -298,42 +359,110 @@ purposes. Any runtime-scoped feature dependencies will be included in the
 distribution, and the ``karaf.localFeature`` property can be used to
 specify the boot feature (in addition to ``standard``).
 
-Features
---------
+Features (for Karaf 3)
+----------------------
 
-The ODL Parent component for OpenDaylight provides a number of Karaf
-features which can be used by other Karaf features to use certain
+The ODL Parent component for OpenDaylight provides a number of Karaf 3
+features which can be used by other Karaf features to use certain
 third-party upstream dependencies.
 
 These features are:
 
--  Akka features (in the ``features4-akka`` repository):
+-  Akka features (in the ``features-akka`` repository):
 
-   -  ``odl4-akka-all`` — all Akka bundles;
+   -  ``odl-akka-all`` — all Akka bundles;
 
-   -  ``odl4-akka-scala-2.11`` — Scala runtime for OpenDaylight;
+   -  ``odl-akka-scala-2.11`` — Scala runtime for OpenDaylight;
 
-   -  ``odl4-akka-system-2.4`` — Akka actor framework bundles;
+   -  ``odl-akka-system-2.4`` — Akka actor framework bundles;
 
-   -  ``odl4-akka-clustering-2.4`` — Akka clustering bundles and
+   -  ``odl-akka-clustering-2.4`` — Akka clustering bundles and
       dependencies;
 
-   -  ``odl4-akka-leveldb-0.7`` — LevelDB;
+   -  ``odl-akka-leveldb-0.7`` — LevelDB;
 
-   -  ``odl4-akka-persistence-2.4`` — Akka persistence;
+   -  ``odl-akka-persistence-2.4`` — Akka persistence;
 
--  general third-party features (in the ``features4-odlparent``
+-  general third-party features (in the ``features-odlparent``
    repository):
 
-   -  ``odl4-netty-4`` — all Netty bundles;
+   -  ``odl-netty-4`` — all Netty bundles;
+
+   -  ``odl-guava-18`` — Guava 18;
+
+   -  ``odl-guava-21`` — Guava 21 (not indended for use in Carbon);
+
+   -  ``odl-lmax-3`` — LMAX Disruptor;
+
+   -  ``odl-triemap-0.2`` — Concurrent Trie HashMap.
+
+To use these, you need to declare a dependency on the appropriate
+repository in your ``features.xml`` file:
+
+::
+
+    <repository>mvn:org.opendaylight.odlparent/features-odlparent/{{VERSION}}/xml/features</repository>
+
+and then include the feature, *e.g.*:
+
+::
+
+    <feature name='odl-mdsal-broker-local' version='${project.version}' description="OpenDaylight :: MDSAL :: Broker">
+        [...]
+        <feature version='[3.3.0,4.0.0)'>odl-lmax</feature>
+        [...]
+    </feature>
+
+You also need to depend on the features repository in your POM:
+
+::
+
+    <dependency>
+        <groupId>org.opendaylight.odlparent</groupId>
+        <artifactId>features-odlparent</artifactId>
+        <classifier>features</classifier>
+        <type>xml</type>
+    </dependency>
+
+assuming the appropriate dependency management:
+
+::
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>org.opendaylight.odlparent</groupId>
+                <artifactId>odlparent-artifacts</artifactId>
+                <version>1.8.0-SNAPSHOT</version>
+                <scope>import</scope>
+                <type>pom</type>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
+(the version number there is appropriate for Carbon). For the time being
+you also need to depend separately on the individual JARs as
+compile-time dependencies to build your dependent code; the relevant
+dependencies are managed in ``odlparent``'s dependency management.
+
+| The suggested version ranges are as follows:
+
+-  ``odl-netty``: ``[4.0.37,4.1.0)`` or ``[4.0.37,5.0.0)``;
+
+-  ``odl-guava``: ``[18,19)`` (if your code is ready for it, ``[19,20)``
+   is also available, but the current default version of Guava in
+   OpenDaylight is 18);
 
-   -  ``odl4-guava-18`` — Guava 18;
+-  ``odl-lmax``: ``[3.3.4,4.0.0)``
 
-   -  ``odl4-guava-21`` — Guava 21 (not indended for use in Carbon);
+Features (for Karaf 4)
+----------------------
 
-   -  ``odl4-lmax-3`` — LMAX Disruptor;
+There are equivalent features to all the Karaf 3 features, for Karaf 4.
+The repositories use “features4” instead of “features”, and the features
+use “odl4” instead of “odl”.
 
-   -  ``odl4-triemap-0.2`` — Concurrent Trie HashMap;
+The following new features are specific to Karaf 4:
 
 -  Karaf wrapper features (also in the ``features4-odlparent``
    repository) — these can be used to pull in a Karaf feature
@@ -375,4 +504,6 @@ assuming the appropriate dependency management:
         </dependencies>
     </dependencyManagement>
 
-(the version number there is appropriate for Carbon).
+(the version number there is appropriate for Carbon). We no longer use version
+ranges, the feature dependencies all use the ``odlparent`` version (but you
+should rely on the artifacts POM).
index 37a8fcd85f0a2111ae59a7e2e74d60cd3ce5e110..a3071ae78be25b3fe6c3ef6863c1e7f7d6eff25b 100644 (file)
@@ -1,4 +1,4 @@
-.. _openflow-protocol-library:
+.. _openflow-protocol-library-dev-guide:
 
 OpenFlow Protocol Library Developer Guide
 =========================================
index 3fdf5f7235877b47c72c1d97ec34361b7bb767f4..b7840c50ffc9ec7ab7dc38809707f0574e23a018 100644 (file)
@@ -1,3 +1,5 @@
+.. _opflex-agent-ovs-dev-guide:
+
 OpFlex agent-ovs Developer Guide
 ================================
 
@@ -39,4 +41,3 @@ API Reference Documentation
 
 Internal API documentation can be found by in doc/html/index.html in
 any build.
-
index bbd15141a5de9b0b646775c051d6f4aff5e704fa..72128c3db852ca092865547cec22b507f55524b0 100644 (file)
@@ -1,3 +1,5 @@
+.. _opflex-genie-dev-guide:
+
 OpFlex genie Developer Guide
 ============================
 
@@ -21,4 +23,3 @@ API Reference Documentation
 
 Complete API documentation for the generated libmodelgbp can be found
 in doc/html/index.html in any build
-
index a096876d0653518c6d0cc329148275fa731d0971..2f8d371e6c67d3339dd6c0d5b199e5ef9232c613 100644 (file)
@@ -1,3 +1,5 @@
+.. _opflex-libopflex-dev-guide:
+
 OpFlex libopflex Developer Guide
 ================================
 
@@ -421,4 +423,3 @@ API Reference Documentation
 
 Complete API documentation can be found by in doc/html/index.html in
 any build.
-
index 467a9c32a98071637ea09ef64d7aea19ebe192e3..d1b48bfbfb2b91b1002e6fff99cb9360490366ea 100644 (file)
@@ -1,3 +1,4 @@
+.. _pcep-developer-guide:
 PCEP Developer Guide
 ====================
 
index 996bd2eb5ef5e04505473f65bafcc57bd3e1016f..1e693be20dc8434374e4c905442f99b247b12c2c 100644 (file)
@@ -1,3 +1,5 @@
+.. _sfc-dev-guide:
+
 Service Function Chaining
 =========================
 
index 839c7e3bdbfef8e85f3241215d45db2850ae84e6..edb37c3acffaf9939bb3c47e9a64af5a9be64a26 100644 (file)
@@ -1,3 +1,5 @@
+.. _snmp4sdn-dev-guide:
+
 SNMP4SDN Developer Guide
 ========================
 
@@ -250,4 +252,3 @@ Help
 
 -  `Latest troubleshooting in
    Wiki <https://wiki.opendaylight.org/view/SNMP4SDN:User_Guide#Troubleshooting>`__
-
index 6a6c3d6b1df963f01db7d9e95d0995dc5b26ab20..47513cf2c8862e76783b12056dd3ac41be1542f8 100644 (file)
@@ -1,3 +1,5 @@
+.. _ttp_cli_tools_dev_guide:
+
 TTP CLI Tools Developer Guide
 =============================
 
index 10618ccc71ecf276960d37bebe40c001af093daa..74f6e75f4feea63c4bac10254a745aeae8f4d526 100644 (file)
@@ -1,3 +1,5 @@
+.. _ttp_model_dev_guide:
+
 TTP Model Developer Guide
 =========================
 
index e6e0c99d1ff87a792ec8fdff97a5c92c067103a6..ca698261da84f6077b12c6961b6bff3411352091 100644 (file)
@@ -1,3 +1,5 @@
+.. _vtn-dev-guide:
+
 Virtual Tenant Network (VTN)
 ============================
 
@@ -280,4 +282,3 @@ Usage Examples
 
 -  `L2 Network using Single
    Controller <https://wiki.OpenDaylight.org/view/OpenDaylight_Virtual_Tenant_Network_(VTN):VTN_Coordinator:RestApi:How_to_configure_L2_Network_with_Single_Controller>`__
-
index 877a52aed2bc2f04f04ccb0f7e1d33aa1f555d88..8f5f4bde2e73e41c072b5dbda784932c741aedbc 100644 (file)
@@ -1,3 +1,5 @@
+.. _yangtools-developer-guide:
+
 YANG Tools Developer Guide
 ==========================
 
index 4bc0718650c3f1b291cc14cc30ea3905ac9e0dc6..645ea8904cbf3f3876ca38fb7b366595c88e1950 100644 (file)
@@ -1,3 +1,5 @@
+.. _getting_started_guide:
+
 #####################
 Getting Started Guide
 #####################
index c65ebbc446ac30b91bf16c4223c88d61ac523996..816070cbda37def04d41d8454a686259fb7b29dc 100644 (file)
@@ -71,6 +71,11 @@ For Example::
 * Typing ``[cmd] --help`` will show help for a specific command.
 * Press ``ctrl-d`` or type ``system:shutdown`` or ``logout`` to shutdown OpenDaylight.
 
+.. note:: Please take a look at the :ref:`security_deployment_recommendations`
+          and following sections under :ref:`security_considerations` if you're
+          planning on running OpenDaylight outside of an isolated test lab
+          environment.
+
 Install the Karaf features
 ==========================
 To install a feature, use the following command, where feature1 is the feature
diff --git a/docs/getting-started-guide/project-release-notes/aaa.rst b/docs/getting-started-guide/project-release-notes/aaa.rst
new file mode 100644 (file)
index 0000000..0685e1a
--- /dev/null
@@ -0,0 +1,136 @@
+===
+AAA
+===
+
+Major Features
+==============
+
+For each top-level feature, identify the name, url, description, etc. User-facing features are used directly by end users.
+
+odl-aaa-shiro
+-------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob_plain;f=features/shiro/features-aaa-shiro/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:**  ODL Shiro-based AAA implementation
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-csit-1node-authn-all-carbon/
+
+odl-aaa-authn
+-------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob;f=features/authn/features-aaa/src/main/features/features.xml;h=6c4eb853d527593662553e96e002df3b05e46f76;hb=refs/heads/stable/carbon
+* **Feature Description:**  Existing AAA infrastructure, now wrapped by odl-aaa-shiro
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-csit-1node-authn-all-carbon/
+
+odl-aaa-cert
+------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob;f=features/authn/features-aaa/src/main/features/features.xml;h=6c4eb853d527593662553e96e002df3b05e46f76;hb=refs/heads/stable/carbon
+* **Feature Description:**  MD-SAL based encrypted certificate management
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-csit-1node-authn-all-carbon/
+
+odl-aaa-cli
+------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob;f=features/authn/features-aaa/src/main/features/features.xml;h=6c4eb853d527593662553e96e002df3b05e46f76;hb=refs/heads/stable/carbon
+* **Feature Description:**  Basic karaf CLI commands for interacting with AAA
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-csit-1node-authn-all-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.
+
+* **User Guide(s):**
+
+  * :ref:`aaa-user-guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`aaa-dev-guide`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  No.
+
+* Other security issues?
+
+  N/A.
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-sonar/`_ (56.39% code coverage)
+* `Link to CSIT Jobs https://jenkins.opendaylight.org/releng/view/aaa/`_
+
+Migration
+---------
+
+* No data model changes occurred, so everything should work.  You can either copy the existing idmlight.db.mv.db into the new karaf distribution folder, or just start fresh with a new one.
+
+Compatiblity
+------------
+
+* Is this release compatible with the previous release?
+
+  Yes.
+
+* Any API changes?
+
+  No.
+
+* Any configuraiton changes?
+
+  Some CLI commands were modified for security and ease of use purposes.  Nothing else.
+
+Bugs Fixed
+----------
+
+* `8373 <https://bugs.opendaylight.org/show_bug.cgi?id=8373>`_ Unable to start blueprint container for bundle org.opendaylight.aaa.idmlight
+* `8062 <https://bugs.opendaylight.org/show_bug.cgi?id=8062>`_ Bad padding in encrypted data
+* `8214 <https://bugs.opendaylight.org/show_bug.cgi?id=8214>`_ NPE in org.opendaylight.aaa.shiro.realm.MDSALDynamicAuthorizationFilter
+* `8313 <https://bugs.opendaylight.org/show_bug.cgi?id=8313>`_ AAA dependencies cause it not to come up
+* `8157 <https://bugs.opendaylight.org/show_bug.cgi?id=8157>`_ Deleting a user and recreating it fails using the aaa-cli-jar
+* `7527 <https://bugs.opendaylight.org/show_bug.cgi?id=7527>`_ Karaf 4 migration: provide Karaf 4 aaa features
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+
+  N/A
+
+* `Link to Open Bugs https://bugs.opendaylight.org/buglist.cgi?component=General&list_id=78831&product=aaa&resolution=---`_
+
+End-of-life
+===========
+
+* N/A
+
+Standards
+=========
+
+* LDAP, ActiveDirectory (less tested)
+
+Release Mechanics
+=================
+
+* `Link to release plan https://wiki.opendaylight.org/view/AAA:Carbon:Release_Plan`_
+* Describe any major shifts in release schedule from the release plan
+
+  None.
diff --git a/docs/getting-started-guide/project-release-notes/alto.rst b/docs/getting-started-guide/project-release-notes/alto.rst
new file mode 100644 (file)
index 0000000..2d6b986
--- /dev/null
@@ -0,0 +1,115 @@
+=============================================
+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 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/
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`ALTO User Guide <alto-user-guide>`
+
+* **Developer Guide(s):**
+
+  * :ref:`ALTO Developer Guide <alto-developer-guide>`
+
+Security Considerations
+=======================
+
+Besides RESTCONF, ALTO also uses customized Jetty interfaces because YANG model
+is not compatible with formats specified in RFC 7285.
+
+The customized interfaces use port 8080 and are NOT protected by the AAA
+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/>`_
+* The tests are using the OpenDaylight CSIT infrastructure.
+
+  * How extensive was it? Not very extensive since the tests are customized to
+    test certain functionalities.
+  * What should be expected to work? The core modules (northbound and
+    resourcepool) and also some basic components (simple-ird)
+  * What has not be tested as much? Some basic components (simple-ecs and spce)
+    and extended components (multicost, incremental update and RSA service).
+
+Migration
+---------
+
+Migration with data from Boron to Carbon isn't supported.
+
+Compatiblity
+------------
+
+This release is not compatible with the previous release from the developer's
+point of view because we have changed the namespaces for most YANG models, which
+involves both API changes and configuration changes (blueprint configuration
+files).
+
+Java projects using the ALTO classes generated by yangtools MUST change the
+packages for the classes because of the namespace migration. The incompatiblity
+can be fixed using regex replacement.
+
+Projects using RESTCONF or the customized ALTO service do not need to migrate.
+
+Since ALTO is migrating services to Blueprint, services depending on ALTO may
+also need to migrate to Blueprint instead of using CONFIG subsystem.
+
+Bugs Fixed
+----------
+
+No bug is fixed in this release.
+
+Known Issues
+------------
+
+* `Bug 5753 <https://bugs.opendaylight.org/show_bug.cgi?id=5753>`_
+
+Both Jersey 1.0 and 2.0 are imported in karaf.
+
+This seems like a general bug which resides in several projects.
+
+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.*
+
+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.
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/ALTO:Carbon_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
diff --git a/docs/getting-started-guide/project-release-notes/bgp-ls-pcep.rst b/docs/getting-started-guide/project-release-notes/bgp-ls-pcep.rst
new file mode 100644 (file)
index 0000000..addb968
--- /dev/null
@@ -0,0 +1,217 @@
+===========
+BGP LS PCEP
+===========
+
+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;h=66c79d8a949d139b21ad3aab43d4b75bcf3cf385;hb=73449afa26d3771525d10abbf7441c094e638c9b
+* **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
+
+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;h=d614ef9789bd254242fae352fb701dc5ca816208;hb=73449afa26d3771525d10abbf7441c094e638c9bhttps://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/bmp/features-bmp/src/main/features/features.xml;h=d614ef9789bd254242fae352fb701dc5ca816208;hb=73449afa26d3771525d10abbf7441c094e638c9b
+* **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
+
+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;h=e43f22337c2492df39ff498f29744e8e69a8659a;hb=73449afa26d3771525d10abbf7441c094e638c9b
+* **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
+
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`BGP User Guide <bgp-user-guide>`
+  * :ref:`BGP Monitoring Protocol User Guide <bgp-monitoring-protocol-user-guide>`
+  * :ref:`PCEP User Guide <pcep-user-guide>`
+
+* **Developer Guide(s):**
+
+  * :ref:`BGP Developer Guide <bgp-developer-guide>`
+  * :ref:`BGP Monitoring Protocol Developer Guide <bgp-monitoring-protocol-developer-guide>`
+  * :ref:`PCEP Developer Guide <pcep-developer-guide>`
+
+Security Considerations
+=======================
+
+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 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/>`_
+
+  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.
+
+*  New BGP Openconfig statistics feature requires more testing.
+
+Migration
+---------
+
+BGP:
+^^^^
+
+Protocol Configuration
+''''''''''''''''''''''
+
+First we get old configuration
+
+**URL:** ``/restconf/config/openconfig-network-instance:network-instances/network-instance/global-bgp/openconfig-network-instance:protocols``
+
+**Method:** ``GET``
+
+where *example-bmp-monitor* old bmp monitor id
+
+Then we insert it
+
+**URL:** ``/restconf/config/openconfig-network-instance:network-instances/network-instance/global-bgp/openconfig-network-instance:protocols``
+
+**Method:** ``POST``
+
+Topology Configuration
+''''''''''''''''''''''
+
+First we get old configuration
+
+**URL:** ``/restconf/config/network-topology:network-topology``
+
+**Method:** ``GET``
+
+Then we insert it
+
+**URL:** ``/restconf/config/network-topology:network-topology``
+
+**Method:** ``POST``
+
+BMP:
+^^^^
+
+First we get old configuration
+
+**URL:** ``/restconf/config/network-topology:network-topology/topology/topology-netconf/node/controller-config/yang-ext:mount/config:modules/config:module/odl-bmp-impl-cfg:bmp-monitor-impl/example-bmp-monitor``
+
+**Method:** ``GET``
+
+**example-bmp-monitor** old bmp monitor id
+
+Then we insert it
+
+**URL:** ``/restconf/config/network-topology:network-topology/topology/topology-netconf/node/controller-config/yang-ext:mount/config:modules/config:module/odl-bmp-impl-cfg:bmp-monitor-impl/example-bmp-monitor``
+
+**Method:** ``PUT``
+
+PCEP:
+^^^^^
+
+There are no additional steps needed for migration to this release.
+
+Compatiblity
+------------
+
+* Is this release compatible with the previous release?
+  Yes
+* Any API changes?
+* Any configuration changes?
+  BGP Openconfig configuration should be used instead of previous BGP CSS configuration.
+
+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>`_
+
+Known Issues
+------------
+
+* `BUG-6562 <https://bugs.opendaylight.org/show_bug.cgi?id=6562>`_ Support add-path in base BGP NLRI
+
+End-of-life
+===========
+
+* None
+
+Standards
+=========
+
+* `RFC4271 <https://tools.ietf.org/html/rfc4271>`_ - A Border Gateway Protocol 4 (BGP-4)
+* `RFC4760 <https://tools.ietf.org/html/rfc4760>`_ - Multiprotocol Extensions for BGP-4
+* `RFC1997 <https://tools.ietf.org/html/rfc1997>`_ - BGP Communities Attribute
+* `RFC4360 <https://tools.ietf.org/html/rfc4360>`_ - BGP Extended Communities Attribute
+* `RFC4486 <https://tools.ietf.org/html/rfc4486>`_ - Subcodes for BGP Cease Notification Message
+* `RFC5004 <https://tools.ietf.org/html/rfc5004>`_ - Avoid BGP Best Path Transitions from One External to Another
+* `RFC7752 <https://tools.ietf.org/html/rfc7752>`_ - North-Bound Distribution of Link-State and TE Information using BGP
+* `RFC5440 <https://tools.ietf.org/html/rfc5440>`_ - Path Computation Element (PCE) Communication Protocol (PCEP)
+* `RFC5541 <https://tools.ietf.org/html/rfc5541>`_ - Encoding of Objective Functions in the Path Computation Element Communication Protocol (PCEP)
+* `RFC5455 <https://tools.ietf.org/html/rfc5455>`_ - Diffserv-Aware Class-Type Object for the Path Computation Element Communication Protocol
+* `RFC5492 <https://tools.ietf.org/html/rfc5492>`_ - Capabilities Advertisement with BGP-4
+* `RFC5521 <https://tools.ietf.org/html/rfc5521>`_ - Extensions to the Path Computation Element Communication Protocol (PCEP) for Route Exclusions
+* `RFC5557 <https://tools.ietf.org/html/rfc5557>`_ - Path Computation Element Communication Protocol (PCEP) Requirements and Protocol Extensions in Support of Global Concurrent Optimization
+* `RFC5575 <https://tools.ietf.org/html/rfc5575>`_ - Flow Specification
+* `RFC5886 <https://tools.ietf.org/html/rfc5886>`_ - A Set of Monitoring Tools for Path Computation Element (PCE)-Based Architecture
+* `RFC6286 <https://tools.ietf.org/html/rfc6286>`_ - Autonomous-System-Wide Unique BGP Identifier for BGP-4
+* `RFC6793 <https://tools.ietf.org/html/rfc6793>`_ - BGP Support for Four-Octet Autonomous System (AS) Number Space
+* `RFC7311 <https://tools.ietf.org/html/rfc7311>`_ - The Accumulated IGP Metric Attribute for BGP
+* `RFC7674 <http://tools.ietf.org/html/rfc7674 >`_ - Clarification of the Flowspec Redirect Extended Community
+* `RFC5668 <https://tools.ietf.org/html/rfc5668>`_ - 4-Octet AS Specific BGP Extended Community
+* `RFC3107 <https://tools.ietf.org/html/rfc3107>`_ - Carrying Label Information in BGP-4
+* `RFC4364 <https://tools.ietf.org/html/rfc4364>`_ - BGP/MPLS IP Virtual Private Networks (VPNs)
+* `RFC7432 <https://tools.ietf.org/html/rfc7432>`_ - BGP MPLS-Based Ethernet VPN
+* `RFC7911 <https://tools.ietf.org/html/rfc7911>`_ - Advertisement of Multiple Paths in BGP
+* `RFC2918 <https://tools.ietf.org/html/rfc2918>`_ - Route Refresh Capability for BGP-4
+* `draft-ietf-bess-evpn-overlay <https://tools.ietf.org/html/draft-ietf-bess-evpn-overlay-04>`_ - A Network Virtualization Overlay Solution using EVPN
+* `draft-ietf-pce-pceps <https://tools.ietf.org/html/draft-ietf-pce-pceps-03>`_ - Secure Transport for PCEP
+* `draft-gredler-idr-bgp-ls-segment-routing-ext-03 <https://tools.ietf.org/html/draft-gredler-idr-bgp-ls-segment-routing-ext-03>`_ - BGP Link-State extensions for Segment Routing
+* `draft-ietf-idr-bgpls-segment-routing-epe-05 <https://tools.ietf.org/html/draft-ietf-idr-bgpls-segment-routing-epe-05>`_ - Segment Routing Egress Peer Engineering BGP-LS Extensions
+* `draft-ietf-idr-flow-spec-v6-06 <https://tools.ietf.org/html/draft-ietf-idr-flow-spec-v6-06>`_ - Dissemination of Flow Specification Rules for IPv6 <br />
+* `draft-ietf-idr-flowspec-redirect-ip-01 <https://tools.ietf.org/html/draft-ietf-idr-flowspec-redirect-ip-01>`_ - BGP Flow-Spec Redirect to IP Action
+
+* Stateful extensions to the Path Computation Element Protocol, December 2013
+
+  * `draft-ietf-pce-stateful-pce-07 <https://tools.ietf.org/html/draft-ietf-pce-stateful-pce-07>`_ - PCEP Extensions for Stateful PCE
+  * `draft-ietf-pce-pce-initiated-lsp-00 <https://tools.ietf.org/html/draft-ietf-pce-pce-initiated-lsp-00>`_ - PCEP Extensions for PCE-initiated LSP Setup in a Stateful PCE Model
+
+* Segment routing extension to the Path Computation Element Protocol, October 2014
+
+  * `draft-ietf-pce-segment-routing-01 <https://tools.ietf.org/html/draft-ietf-pce-segment-routing-01>`_ - PCEP Extension for segment routing
+  * `draft-ietf-pce-lsp-setup-type-01 <https://tools.ietf.org/html/draft-ietf-pce-lsp-setup-type-01>`_ - PCEP Extension for path setup type
+  * `draft-ietf-pce-stateful-sync-optimizations-03 <https://tools.ietf.org/html/draft-ietf-pce-stateful-sync-optimizations-03>`_ - Optimizations of Label Switched Path State Synchronization Procedures for a Stateful PCE
+  * `draft-sivabalan-pce-binding-label-sid-01 <https://tools.ietf.org/html/draft-sivabalan-pce-binding-label-sid-01>`_ - Carrying Binding Label/Segment-ID in PCE-based Networks
+  * `RFC7854 <https://tools.ietf.org/html/rfc7854>`_ - BGP Monitoring Protocol
+
+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
diff --git a/docs/getting-started-guide/project-release-notes/bier.rst b/docs/getting-started-guide/project-release-notes/bier.rst
new file mode 100644 (file)
index 0000000..e505af1
--- /dev/null
@@ -0,0 +1,89 @@
+=======================================
+Bit Indexed Explicit Replication (BIER)
+=======================================
+
+odl-bier-all
+------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bier.git;a=blob;f=features/features-bier/src/main/features/features.xml
+* **Feature Description:**  This is a summary feature containing the default functionalities provided by BIER project.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/bier/job/bier-csit-1node-basic-all-carbon/
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  *  :ref:`bier-user-guide`
+
+* **Developer Guide(s):**
+
+  *  :ref:`bier-dev-guide`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  * BIER project needs to get topology information via OpenFlow and BIER configuration via NETCONF.
+
+* Other security issues?
+
+  * The required security issues are provided in the RESTCONF, NETCONF and OpenFlow project.
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=72693>`_ 76.5%
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/bier/job/bier-csit-1node-basic-all-carbon/>`_
+* Testing methodology. How extensive was it? What should be expected to work?
+  What has not been tested as much?
+* There are unit tests and integration test available under folder "test" and system test in CSIT but the NETCONF
+  interface is not tested and will be completed in next release.
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+
+* Not applicable as there is no previous release.
+
+Compatiblity
+------------
+
+* Is this release compatible with the previous release? No previous release.
+* Any API changes? No.
+* Any configuraiton changes? No.
+
+Bugs Fixed
+----------
+
+* Not applicable as there is no previous release.
+
+Known Issues
+------------
+
+* Not applicable as there is no previous release.
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this
+  release
+* N/A
+
+Standards
+=========
+
+* `Multicast using Bit Index Explicit Replication <https://datatracker.ietf.org/doc/draft-ietf-bier-architecture>`_
+* `YANG Data Model for BIER Protocol <https://datatracker.ietf.org/doc/draft-ietf-bier-bier-yang>`_
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/BIER:Carbon:Release_Plan>`_
+* Describe any major shifts in release schedule from the release plan
+* N/A
diff --git a/docs/getting-started-guide/project-release-notes/controller.rst b/docs/getting-started-guide/project-release-notes/controller.rst
new file mode 100644 (file)
index 0000000..bfafd11
--- /dev/null
@@ -0,0 +1,111 @@
+==========
+Controller
+==========
+
+Major Features
+==============
+
+odl-mdsal-broker
+----------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blob;f=features/mdsal/features-mdsal/src/main/features/features.xml
+* **Feature Description:**  Core MD-SAL implementations.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/controller/job/controller-csit-verify-3node-clustering/
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  * Yes, akka uses port 2550 and by default communicates with unencrypted, unauthenticated messages. Securing akka communication isn't described here, but those concerned should look at the "Configuring SSL/TLS for Akka Remoting" section at http://doc.akka.io/docs/akka//2.4.17/scala/remoting.html.
+
+* Other security issues?
+
+  * No
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://jenkins.opendaylight.org/releng/view/controller/job/controller-sonar/>`_ (60%)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/controller/>`_
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+
+  * There are no issues with migration from Boron to Carbon.
+
+Compatiblity
+------------
+
+* Is this release compatible with the previous release?
+
+  * Yes
+
+* Any API changes?
+
+  * No
+
+* Any configuration changes?
+
+  * Preview for Distributed Datastore Tell-Based protocol. This is enabled using etc/org.opendaylight.controller.cluster.datastore.cfg's
+    use-tell-based-protocol knob and should eliminate most sources of AskTimeouts.
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+
+  * `Bugs Fixed <https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2016-08-9&chfieldto=2017-05-25&list_id=78854&product=controller&query_format=advanced&resolution=FIXED>`_
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+
+  * None
+
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&chfieldfrom=2016-08-9&chfieldto=2017-05-25&list_id=78855&product=controller&query_format=advanced>`_
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this
+  release
+
+  * The XSQL component packaged in odl-mdsal-xsql has been deprecated and will be removed in
+    the next release.
+
+  * The following API elements are deprecated, pending future removal:
+
+    * org.opendaylight.controller.md.sal.binding.api.ClusteredDataChangeListener
+    * org.opendaylight.controller.md.sal.binding.api.DataChangeListener
+    * org.opendaylight.controller.sal.binding.api.AbstractBindingAwareConsumer
+    * org.opendaylight.controller.sal.binding.api.AbstractBindingAwareProvider
+    * org.opendaylight.controller.sal.binding.api.data.DataBrokerService
+    * org.opendaylight.controller.sal.binding.api.data.DataChangeListener
+    * org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction
+    * org.opendaylight.controller.sal.binding.api.data.DataProviderService
+    * org.opendaylight.controller.sal.binding.api.data.SynchronizedTransaction
+    * org.opendaylight.controller.sal.binding.api.NotificationListener
+    * org.opendaylight.controller.sal.binding.api.NotificationProviderService
+    * org.opendaylight.controller.sal.binding.api.NotificationService
+    * org.opendaylight.controller.sal.common.util.RpcErrors.java
+    * org.opendaylight.controller.sal.common.util.Rpcs.java
+    * org.opendaylight.controller.sal.core.api.model.SchemaService
+
+Standards
+=========
+
+* List of standards implemented and to what extent
+
+  * None
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/OpenDaylight_Controller:Carbon:Release_Plan>`_
diff --git a/docs/getting-started-guide/project-release-notes/dluxapps.rst b/docs/getting-started-guide/project-release-notes/dluxapps.rst
new file mode 100644 (file)
index 0000000..1b3977a
--- /dev/null
@@ -0,0 +1,120 @@
+========
+DluxApps
+========
+
+Major Features
+==============
+
+For each top-level feature, identify the name, url, description, etc.
+User-facing features are used directly by end users.
+
+odl-dluxapps-nodes
+------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;h=a0ccf2f80f3f88a63da6c73c8903f94247c31dbc;hb=621a9e576e15233177a20f89f83b3992999b9423
+* **Feature Description:**  Application displays list of nodes in openflow (flow:1) topology.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+odl-dluxapps-topology
+---------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;h=a0ccf2f80f3f88a63da6c73c8903f94247c31dbc;hb=621a9e576e15233177a20f89f83b3992999b9423
+* **Feature Description:**  Basic topology application. Displays nodes and links from openflow (flow:1) topology.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+odl-dluxapps-yangman
+--------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;h=a0ccf2f80f3f88a63da6c73c8903f94247c31dbc;hb=621a9e576e15233177a20f89f83b3992999b9423
+* **Feature Description:**  GUI for data manipulation in controller. Generates forms based on loaded Yang models.
+  User can interact with controller without knowledge of Yang models, test them, etc. Replacement of YangUI app.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/dluxapps/job/dluxapps-csit-1node-yangman-only-carbon/
+
+odl-dluxapps-yangui
+-------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;h=a0ccf2f80f3f88a63da6c73c8903f94247c31dbc;hb=621a9e576e15233177a20f89f83b3992999b9423
+* **Feature Description:**  Previous version of YangUI. Will be removed in next release.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+odl-dluxapps-yangvisualizer
+---------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;h=a0ccf2f80f3f88a63da6c73c8903f94247c31dbc;hb=621a9e576e15233177a20f89f83b3992999b9423
+* **Feature Description:**  Topology-like visualization of Yang models loaded in controller.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+Documentation
+=============
+
+* **Developer Guide(s):**
+
+  * `DluxApps Developer Guide <https://wiki.opendaylight.org/view/DluxApps:DeveloperGuide>`_
+
+Security Considerations
+=======================
+
+* There are no security issues found.
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=72613>`_
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/dluxapps/search/?q=dluxapps-csit>`_
+* GUI is tested mostly manually, CSITs are on the way.
+
+Migration
+---------
+
+* All applications are moved from Dlux project to DluxApps. Also feature names
+  changed, so instead odl-dlux-\* use odl-dluxapps-\*. Everything else works same.
+
+Compatiblity
+------------
+
+* Release is compatible with previous.
+* API changes are in feature names - odl-dlux-\* changes to odl-dluxapps-\*
+
+Bugs Fixed
+----------
+
+https://bugs.opendaylight.org/buglist.cgi?bug_status=__closed__&content=&no_redirect=1&order=Importance&product=dluxapps&query_format=specific
+
+Known Issues
+------------
+
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&content=&no_redirect=1&order=Importance&product=dluxapps&query_format=specific>`_
+
+End-of-life
+===========
+
+* odl-dluxapps-yangui - deprecated
+
+Standards
+=========
+
+* List of standrads implemented and to what extent
+
+  * N/A
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/DluxApps:Carbon_Release_Plan>`_
+* UT coverage is not increased
+* Yang Visualized refactor and redesign is not started
diff --git a/docs/getting-started-guide/project-release-notes/docs.rst b/docs/getting-started-guide/project-release-notes/docs.rst
new file mode 100644 (file)
index 0000000..a5b575e
--- /dev/null
@@ -0,0 +1,84 @@
+=============
+Documentation
+=============
+
+Major Features
+==============
+
+Not Applicable. The documentation project does not produce any code artifacts for the release.
+
+Documentation
+=============
+
+* **Installation Guide(s):**
+
+  * The :ref:`getting_started_guide` includes details about installation.
+
+* **User Guide(s):**
+
+  * The :ref:`user_guide` includes sub-guides for each major feature in each project.
+
+* **Developer Guide(s):**
+
+  * The :ref:`developer_guide` includes sub-guides for each major feature in each project.
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  * No.
+
+* Other security issues?
+
+  * None.
+
+Quality Assurance
+=================
+
+Not applicable.
+
+Migration
+---------
+
+Not applicable.
+
+Compatibility
+-------------
+
+Not applicable.
+
+Bugs Fixed
+----------
+
+Not applicable.
+
+Known Issues
+------------
+
+None.
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this
+  release.
+
+  * None.
+
+Standards
+=========
+
+* List of standrads implemented and to what extent
+
+  * None.
+
+Release Mechanics
+=================
+
+* `Documentation Carbon Release Plan
+  <https://wiki.opendaylight.org/view/Documentation/Release_Plans/Carbon_Release_Plan>`_
+* Describe any major shifts in release schedule from the release plan
+
+  * Dropped delivery of code-snippet import from projects.
+  * Didn't provide a general service chaining deployment guide.
diff --git a/docs/getting-started-guide/project-release-notes/eman.rst b/docs/getting-started-guide/project-release-notes/eman.rst
new file mode 100644 (file)
index 0000000..ec9a2ce
--- /dev/null
@@ -0,0 +1,102 @@
+====
+eman
+====
+
+Major Features
+==============
+
+odl-eman
+--------
+
+* **Feature URL:**  https://git.opendaylight.org/gerrit/gitweb?p=eman.git;a=blob;f=features/features-eman/src/main/features/features.xml;hb=stable/carbon
+* **Feature Description:**  This provides a Northbound API to the eman Information Model
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** none
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`eman-user-guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`eman-dev-guide`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  While eman does not expose other external interfaces, it does rely upon the
+  external interfaces exposed by the SNMP plugin.
+
+* Other security issues?
+
+  None
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report -  <https://sonar.opendaylight.org/overview?id=69960>`_
+* Link to CSIT Jobs -  No CSIT jobs for this experimental release
+* Other manual testing and QA information - Manual testing via RESTCONF and DLUX
+* Testing methodology. How extensive was it? What should be expected to work? What hasn't been tested as much?
+
+  Testing has been manual interaction via DLUX using an SNMP simulator as described in :ref:`eman-user-guide`.
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+
+  N/A as this is first release
+
+Compatiblity
+------------
+
+N/A as this is first release
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+
+  N/A as this is first release
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+
+  no known issues
+
+* Link to Open Bugs
+
+  no open bugs
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this release
+
+  N/A as this is first release
+
+Standards
+=========
+
+* List of standards implemented and to what extent
+
+  * `IETF Energy Management (eman) standards. <https://datatracker.ietf.org/wg/eman/charter/>`_
+    Only powerMeasurement table currently implemented.
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/Eman:Carbon_Release_Plan>`_
+* Describe any major shifts in release schedule from the release plan
+
+  None
diff --git a/docs/getting-started-guide/project-release-notes/faas-release-notes.rst b/docs/getting-started-guide/project-release-notes/faas-release-notes.rst
new file mode 100644 (file)
index 0000000..0328889
--- /dev/null
@@ -0,0 +1,95 @@
+==========================
+FaaS - Fabric As A Service
+==========================
+
+Major Features
+==============
+
+odl-faas-all
+------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=faas.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  This is a top level wrapper feature which includes all the sub features faas offers.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`faas_user_guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`faas_dev_guide`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  * No
+
+* Other security issues?
+
+  * N/A
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=58232>`_ (N/A)
+* There are unit tests and integration test scripts available under folder "demo" in the faas repo,
+  these scripts can be manually invoked for testing. these tests only depends on minnet and ovs
+  which can easily been installed on one VM.
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+
+  * No
+
+Compatiblity
+------------
+
+* Is this release compatible with the previous release? Yes
+* Any API changes? No.
+* Any configuraiton changes? No.
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+
+  * None
+
+Known Issues
+------------
+
+https://bugs.opendaylight.org/buglist.cgi?quicksearch=faas
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this
+  release
+
+  * None
+
+Standards
+=========
+
+* List of standrads implemented and to what extent
+
+  * None
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/FaaS:Carbon_Release_Plan>`_
+* Describe any major shifts in release schedule from the release plan
+
+  * None
diff --git a/docs/getting-started-guide/project-release-notes/federation.rst b/docs/getting-started-guide/project-release-notes/federation.rst
new file mode 100644 (file)
index 0000000..7a7fb24
--- /dev/null
@@ -0,0 +1,89 @@
+==========\r
+Federation\r
+==========\r
+\r
+Major Features\r
+==============\r
+\r
+federation-with-rabbit\r
+----------------------\r
+\r
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=federation.git;a=blob;f=features/features-federation/src/main/features/features.xml\r
+* **Feature Description:**  The federation service is a project that\r
+  facilitates the exchange of state between multiple OpenDaylight\r
+  deployments (henceforth 'sites'). These sites may be single node\r
+  deployments or cluster deployments. The 'federation-with-rabbit'\r
+  feature is a specific implementation of the federation service, based\r
+  on Rabbit MQ broker. Federation service currently only supports the\r
+  Rabbit MQ implementation.\r
+* **Top Level:** Yes\r
+* **User Facing:** Yes\r
+* **Experimental:** Yes\r
+* **CSIT Test:** No (tested via NetVirt CSIT)\r
+\r
+Documentation\r
+=============\r
+\r
+Please provide the URL to each document at docs.opendaylight.org. If\r
+the document is under review, provide a link to the change in Gerrit.\r
+\r
+* **Installation Guide(s):**\r
+\r
+  * https://git.opendaylight.org/gerrit/gitweb?p=federation.git;a=blob;f=docs/install-guide/federation-install-guide.rst\r
+\r
+* **Developer Guide(s):**\r
+\r
+  * https://git.opendaylight.org/gerrit/gitweb?p=federation.git;a=blob;f=docs/developer-guide/federation-developer-guide.rst\r
+\r
+Security Considerations\r
+=======================\r
+\r
+* No dedicated port numbers are used.\r
+* Securing of RabbitMQ is beyond the scope of this project but it is\r
+  suggested that standard RabbitMQ security procedures are applied.\r
+\r
+Quality Assurance\r
+=================\r
+\r
+* This project was not independently tested. Rather it was tested\r
+  indirectly by means of the NetVirt Federation Plugin.\r
+\r
+Migration\r
+---------\r
+\r
+* Not applicable. Federation is a new project released in the Carbon\r
+  release for the first time.\r
+\r
+Compatiblity\r
+------------\r
+\r
+* Not applicable. Federation is a new project released in the Carbon\r
+  release for the first time.\r
+\r
+Bugs Fixed\r
+----------\r
+\r
+* Not applicable. Federation is a new project released in the Carbon\r
+  release for the first time.\r
+\r
+Known Issues\r
+------------\r
+\r
+* There are no known issues with respect of the usage flow tested via\r
+  the NetVirt Federation Plugin\r
+\r
+End-of-life\r
+===========\r
+\r
+* Not applicable. Federation is a new project released in the Carbon\r
+  release for the first time.\r
+\r
+Standards\r
+=========\r
+\r
+* Not applicable\r
+\r
+Release Mechanics\r
+=================\r
+\r
+* https://wiki.opendaylight.org/view/Federation:Carbon_Release_Plan\r
diff --git a/docs/getting-started-guide/project-release-notes/gbp-release-notes.rst b/docs/getting-started-guide/project-release-notes/gbp-release-notes.rst
new file mode 100644 (file)
index 0000000..4847209
--- /dev/null
@@ -0,0 +1,258 @@
+======================
+Groupbasedpolicy (GBP)
+======================
+
+Major Features
+==============
+
+* GBP UI - Groupbasedpoilicy User Interface
+* Neutron Provider - maps neutron configuration to GBP service model
+* FaaS Renderer - maps GBP service model to the common abstraction logical network models of the Fabric As A Service
+* IOS-XE Renderer - maps GBP service model to IOS-XE based devices
+* IOvisor Renderer - maps GBP service model to agents of the IOVisor Linux Foundation project
+* Netconf Renderer - maps GBP service model to NETCONF based network elements
+* OpenFlow Overlay Renderer - enable network virtualization behavior using OpenFlow
+* SXP Distribution Service - enables SGT Exchange Protocol
+* VPP Renderer - enable network virtualization behavior for VPP devices
+
+odl-groupbasedpolicy-ofoverlay
+------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
+* **Feature Description:** Feature can be added to the base to enable a Network Virtualization behavior using OpenFlow
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-3-node-only-boron/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-6node-only-boron/
+
+odl-groupbasedpolicy-ovssfc
+---------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
+* **Feature Description:** Feature can be added to the base to enable a Network Virtualization behavior using OpenFlow that integrates with the SFC project
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-3-node-only-boron/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-6node-only-boron/
+
+odl-groupbasedpolicy-faas
+-------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
+* **Feature Description:**  This renderer maps GBP service model to the common abstraction logical network models of the Fabric As A Service (FAAS). In turns, FAAS maps those abstraction models to the physical networks.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+odl-groupbasedpolicy-iovisor
+----------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
+* **Feature Description:**  This renderer maps GBP service model to agents of the IOVisor Linux Foundation project
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+odl-groupbasedpolicy-netconf
+----------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
+* **Feature Description:**  This renderer maps GBP service model to NETCONF based network elements
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+odl-groupbasedpolicy-neutronmapper
+----------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
+* **Feature Description:**  This renderer maps Neutron northbound configuration to GBP service model
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-openstack-liberty-openstack-boron/
+
+odl-groupbasedpolicy-neutron-and-ofoverlay
+------------------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
+* **Feature Description:**  Neutron and OpenFlow Overlay
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-3-node-only-boron/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-6node-only-boron/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-openstack-liberty-openstack-boron/
+
+odl-groupbasedpolicy-vpp
+------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
+* **Feature Description:**  This renderer maps GBP service model to VPP devices
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+odl-groupbasedpolicy-neutron-vpp-mapper
+---------------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
+* **Feature Description:**  Neutron Northbound services for VPP renderer
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-openstack-liberty-openstack-boron/
+
+odl-groupbasedpolicy-ui
+-----------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
+* **Feature Description:**  Groupbasedpolicy User Interface
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+odl-groupbasedpolicy-ip-sgt-distribution-service
+------------------------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
+* **Feature Description:**  SXP Distribution Service
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+odl-groupbasedpolicy-ios-xe
+---------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
+* **Feature Description:**  This renderer maps GBP service model to IOS-XE devices
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+odl-groupbasedpolicy-sxp-ep-provider
+------------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
+* **Feature Description:**  SXP integration: Endpoint provider
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+odl-groupbasedpolicy-sxp-ise-adapter
+------------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
+* **Feature Description:**  SXP integration: ISE adapter
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+Documentation
+=============
+
+* **Installation Guide(s):**
+
+  * `Groupbasedpolicy Installation Guide <https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Installation_guide>`_
+
+* **User Guide(s):**
+
+  * :ref:`gbp-user-guide`
+
+Security Considerations
+=======================
+
+* No other external interfaces than RESTCONF
+* No known security issues
+
+Quality Assurance
+=================
+
+`Sonar report (67%) <https://sonar.opendaylight.org/overview?id=51201>`_
+
+Groupbasedpolicy CSIT:
+
+* https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-3-node-all-boron/
+* https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-6node-all-boron/
+* https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-openstack-liberty-openstack-boron/
+* https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-3node-clustering-all-boron/
+
+Other manual testing and QA information
+
+* GBP devstack demo
+* GBP-SFC demo
+* VPP demo
+
+Guides about how to run demo can be found on GBP wiki under `Demo <https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Consumability/Demo>`_
+
+Migration
+---------
+
+Migration from previous releases is not supported.
+
+Compatibility
+-------------
+* Is this release compatible with the previous release?
+
+  Yes
+
+* Any API changes?
+
+  Yes
+
+  https://git.opendaylight.org/gerrit/#/c/49041/ - Minor updates in names and descriptions for VPP renderer and adapter model to make it more readable.
+
+  https://git.opendaylight.org/gerrit/#/c/49190/ - Replacing InstanceIdentifier in VPP renderer model with NodeId.
+
+
+* Any configuration changes?
+
+  N/A
+
+Bugs Fixed
+----------
+
+* `Fixed Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=RESOLVED&chfield=[Bug%20creation]&chfieldfrom=2016-09-21&chfieldto=2017-05-25&list_id=78798&product=groupbasedpolicy&query_format=advanced&resolution=FIXED>`_
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+
+  N/A
+
+* `Open Bugs <bugs.opendaylight.org/buglist.cgi?bug_status=CONFIRMED&bug_status=OPEN&bug_status=IN_PROGRESS&chfield=[Bug creation]&chfieldfrom=2016-09-21&chfieldto=2017-05-25&list_id=78797&product=groupbasedpolicy&query_format=advanced&resolution=--->`_
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this release
+
+  N/A
+
+Standards
+=========
+
+* List of standrads implemented and to what extent
+
+  N/A
+
+Release Mechanics
+=================
+
+* `Release plan <https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Releases/Carbon/Release_plan>`_
+
+* Describe any major shifts in release schedule from the release plan
+
+  N/A
\ No newline at end of file
diff --git a/docs/getting-started-guide/project-release-notes/iotdm.rst b/docs/getting-started-guide/project-release-notes/iotdm.rst
new file mode 100644 (file)
index 0000000..fd057bb
--- /dev/null
@@ -0,0 +1,177 @@
+=====
+IoTDM
+=====
+
+Major Features
+==============
+
+odl-onem2m-core
+---------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=iotdm.git;a=blob_plain;f=onem2m/onem2m-features/features-onem2m/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:** This feature implements CSE services described in OneM2M specifications and provides some
+  APIs simplifying development and usage of new plugins. These APIs and related services are considered as IoTDM's plugin
+  infrastructure.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/iotdm/job/iotdm-csit-1node-basic-all-carbon/
+
+odl-onem2m-http
+---------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=iotdm.git;a=blob_plain;f=onem2m/onem2m-features/features-onem2m/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:** Implements communication over HTTP and HTTPS according to OneM2M specifications.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/iotdm/job/iotdm-csit-1node-basic-all-carbon/
+
+odl-onem2m-coap
+---------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=iotdm.git;a=blob_plain;f=onem2m/onem2m-features/features-onem2m/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:** Implements communication over CoAP and CoAPS according to OneM2M specifications.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/iotdm/job/iotdm-csit-1node-basic-all-carbon/
+
+odl-onem2m-mqtt
+---------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=iotdm.git;a=blob_plain;f=onem2m/onem2m-features/features-onem2m/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:** Implements communication over MQTT according to OneM2M specifications.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/iotdm/job/iotdm-csit-1node-basic-all-carbon/
+
+odl-onem2m-websocket
+--------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=iotdm.git;a=blob_plain;f=onem2m/onem2m-features/features-onem2m/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:** Implements communication over websocket according to OneM2M specifications.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/iotdm/job/iotdm-csit-1node-basic-all-carbon/
+
+odl-iotdmbundleloader
+---------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=iotdm.git;a=blob_plain;f=onem2mplugins/iotdmbundleloader/features/features-iotdmbundleloader/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:** Provides REST API to dynamically install/uninstall/reinstall new OSGI bundles to Karaf.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+odl-iotdmkaraffeatureloader
+---------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=iotdm.git;a=blob_plain;f=onem2mplugins/iotdmkaraffeatureloader/features/features-iotdmkaraffeatureloader/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:** Provides REST API to dynamically install/uninstall/reinstall new Karaf features from Karaf archive file.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+Documentation
+=============
+
+There is some outdated documentation at our wiki page: https://wiki.opendaylight.org/view/IoTDM:Main
+
+Some general information can be found in developer guide for IoTDM, see :ref:`iotdm_dev_guide`.
+
+There is more actual developers documentation as README files in IoTDM's sources.
+
+Security Considerations
+=======================
+
+Since this project implements OneM2M specifications including protocol bindings it is also opening multiple ports
+for plugins providing mapping between protocol specific representation of data to the common format used by
+onem2m-core. Port numbers opened by IoTDM depends on configuration of these plugins and also depends on number of
+instances of the plugins.
+
+There are some default server port numbers pre-configured for OneM2M related plugins,
+e.g.: HTTP: 8282(TCP), CoAP: 5683(UDP), Websocket: 8888(TCP) which are enabled by default.
+
+HTTPS and CoAPS communication can be used instead of unsecured versions but it must be configured properly.
+There are implemented also other experimental plugins opening ports by default: odl-onem2mexample:: 8283(TCP),
+dl-onem2medevice:: 8284(TCP) and 123(UDP)
+
+The experimental features odl-iotdmbundleloader and odl-iotdmkaraffeatureloader are insecure in this version since
+there are not implemented any security mechanisms yet.
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=org.opendaylight.iotdm%3Aiotdm-aggregator>`_ (0.6 %)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/iotdm/job/iotdm-csit-1node-basic-all-carbon/>`_
+* Other manual testing and QA information
+  HTTP communication tested manually by Postman collections and other communication (MQTT, CoAP, Websocket) tested
+  occasionally using some opensource tools.
+  We are using code coverage achieved by our CSIT test suites as QA metrics what is currently 35 %.
+
+* Testing methodology. How extensive was it? What should be expected to work? What hasn't been tested as much?
+  We have defined CSIT test suites including list of test cases without implementation including description only.
+  These tests are marked as "excluded" so they are not executed by CSIT jobs.
+  There are described 736 tests and 278 of them are implemented. These tests are testing HTTP communication only.
+  Other communication protocols are not being tested by CSIT jobs now.
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+  No, current release is backward incompatible.
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release?
+  No
+
+* Any API changes?
+  Yes, the REST API of onem2m-api feature has been modified and implementations of the OneM2M APIs have been
+  modified as well.
+
+* Any configuration changes?
+  There was not any configurable module in previous releases.
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+  Only bugs related to current release have been fixed.
+
+Known Issues
+------------
+
+There are several low priority issues opened in IoTDM's Bugzilla.
+Here are some major issues:
+7990 - Race condition after resource delete - https://bugs.opendaylight.org/show_bug.cgi?id=7990
+4316 - "mni" and "mbs" does not work stable - https://bugs.opendaylight.org/show_bug.cgi?id=4316
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this release
+  N/A
+
+Standards
+=========
+
+Subset of functionality described in OneM2M specifications: http://onem2m.org/technical/published-documents
+
+* TS 0001, version 2.10.0
+* TS 0004, version 2.7.1
+* TS 0008, version 1.3.2
+* TS 0009, version 2.6.1
+* TS 0010, version 2.4.1
+* TS 0020, version 2.1.0
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/Iotdm:_Carbon_Release_Plan>`_
diff --git a/docs/getting-started-guide/project-release-notes/l2switch.rst b/docs/getting-started-guide/project-release-notes/l2switch.rst
new file mode 100644 (file)
index 0000000..0ac9629
--- /dev/null
@@ -0,0 +1,97 @@
+========
+L2Switch
+========
+
+odl-l2switch-switch
+-------------------
+
+* **Feature URL:** https://github.com/opendaylight/l2switch/blob/stable/carbon/features/features-l2switch/src/main/features/features.xml
+* **Feature Description:** Provides a basic L2 Switch abstraction over multiple switches using OpenFlow
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-csit-1node-switch-all-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-integration-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-merge-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-sonar/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-validate-autorelease-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-clm-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-csit-1node-periodic-host-scalability-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-csit-1node-scalability-all-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-csit-1node-scalability-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-csit-1node-switch-all-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-csit-1node-switch-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-distribution-check-carbon/
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`l2switch-user-guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`l2switch-dev-guide`
+
+Security Considerations
+=======================
+
+* Are there any known security issues?
+
+  None.
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=50636>`_ (22.0% code coverage)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/l2switch/>`_
+* The tests are using the OpenDaylight CSIT infrastructure.
+
+  * How extensive was it? Extensive, covers functionality, scalability tests.
+  * What should be expected to work? The core modules like Address tracker, Packet handler,
+    Host tracker, loop removal, simple mininet ping.
+  * What has not be tested as much? Basic scalablity tests exists today, extensive scalability
+    could be performed.
+
+Migration
+---------
+
+Migration with data from Boron to Carbon is not supported.
+
+Compatibility
+-------------
+
+This release is compatible with the previous release.
+
+Since l2switch is migrating services to Blueprint, services depending on l2switch
+may also need to migrate to Blueprint instead of using CONFIG subsystem.
+
+Bugs Fixed
+----------
+
+No bug is fixed in this release.
+
+Known Issues
+------------
+
+* `Bug 6654 <https://bugs.opendaylight.org/show_bug.cgi?id=6654>`_
+
+l2switch does not work well when mininet is stopped/started with no delay.
+
+End-of-life
+===========
+No Changes
+
+Standards
+=========
+
+None.
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/L2_Switch:Carbon_Release_Plan>`_
+*  No major changes.
diff --git a/docs/getting-started-guide/project-release-notes/lispflowmapping.rst b/docs/getting-started-guide/project-release-notes/lispflowmapping.rst
new file mode 100644 (file)
index 0000000..3fd6bb4
--- /dev/null
@@ -0,0 +1,140 @@
+=================
+LISP Flow Mapping
+=================
+
+Major Features
+==============
+
+odl-lispflowmapping-msmr
+------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob;f=features/features-lispflowmapping/src/main/features/features.xml
+* **Feature Description:**  This is the core feature that provides the Mapping Services and includes the LISP southbound plugin feature as well.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/lispflowmapping/job/lispflowmapping-csit-1node-msmr-all-carbon/
+
+odl-lispflowmapping-neutron
+---------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob;f=features/features-lispflowmapping/src/main/features/features.xml
+* **Feature Description:**  This feature provides neutron integration.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+
+odl-lispflowmapping-ui
+----------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob;f=features/features-lispflowmapping/src/main/features/features.xml
+* **Feature Description:** This feature provides a GUI to access the Mapping Service data.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+
+Documentation
+=============
+
+* **User Guide(s):**
+    :ref:`lispflowmapping-user-guide`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+* Yes, the southbound plugin
+
+  * If so, how are they secure?
+    * LISP southbound plugin follows LISP `RFC6833 <https://tools.ietf.org/html/rfc6833>`_ security guidelines.
+
+  * What port numbers do they use?
+    * Port used: 4342
+
+* Other security issues?
+  * None
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=31299>`_ (68%)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/lispflowmapping/>`_
+* All modules have been unit tested. Integration tests have been performed for all major features. System tests have been performed on most major features.
+* Registering and retrieval of basic mappings have been tested more thoroughly. More complicated mapping policies have gone through less testing.
+
+
+Migration
+---------
+
+* Is is possible 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.
+
+Compatiblity
+------------
+
+* Is this release compatible with the previous release?
+
+  * Yes
+
+* Any API changes?
+
+  * No
+
+* Any configuraiton changes?
+
+  * No
+
+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
+
+
+Known Issues
+------------
+
+* Clustering is still an experimental feature and may have some issues particularly related to operational datastore consistency.
+
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&list_id=78877&order=Importance&product=lispflowmapping&query_format=specific>`_
+
+End-of-life
+===========
+
+* None
+
+Standards
+=========
+
+* The LISP implementation module and southbound plugin conforms to the IETF `RFC6830 <https://tools.ietf.org/html/rfc6830>`_ and `RFC6833 <https://tools.ietf.org/html/rfc6833>`_ , with the following exceptions:
+
+  - In Map-Request message, M bit(Map-Reply Record exist in the MapRequest) is processed but any mapping data at the bottom of a Map-Request are discarded.
+  - LISP LCAFs are limited to only up to one level of recursion, as described in the IETF `LISP YANG draft <https://tools.ietf.org/html/draft-ietf-lisp-yang-04>`_.
+  - No standards exist for the LISP Mapping System northbound API as of this date.
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/OpenDaylight_Lisp_Flow_Mapping:Carbon_Release_Plan>`_
+
+  * No major shifts from the release plan.
\ No newline at end of file
diff --git a/docs/getting-started-guide/project-release-notes/mdsal.rst b/docs/getting-started-guide/project-release-notes/mdsal.rst
new file mode 100644 (file)
index 0000000..5b58a9a
--- /dev/null
@@ -0,0 +1,84 @@
+============
+MD-SAL
+============
+
+Major Features
+==============
+
+odl-mdsal-binding
+-----------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/features-mdsal/src/main/features/features.xml;h=d41e7fd1e56cfe91934a5c077719ce4cb438b3ef;hb=refs/heads/stable/carbon
+* **Feature Description:** MDSAL Binding layer, representing mapping of YANG modeled data to respective Java Objects
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/mdsal/job/mdsal-csit-1node-periodic-bindingv1-only-carbon/
+
+odl-mdsal-binding2
+------------------
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/features-mdsal/src/main/features/features.xml;h=d41e7fd1e56cfe91934a5c077719ce4cb438b3ef;hb=refs/heads/stable/carbon
+* **Feature Description:** MDSAL Binding v2 layer, representing mapping of YANG modeled data to respective Java Objects
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+
+Documentation
+=============
+
+* **Developer Guide(s):**
+
+  * :ref:`MDSAL Developer guide <mdsal_dev_guide>`
+
+  * `MDSAL Binding v2 guide <https://github.com/opendaylight/mdsal/blob/stable/carbon/docs/src/main/asciidoc/developer/analysis/binding-v2.adoc>`_
+
+Security Considerations
+=======================
+
+* MDSAL libraries are designed to be embedded and not to be a stand-alone application so security concerns need to be addressed by the application using this library.
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=55311>`_ (70.6% line coverage)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/mdsal/job/mdsal-csit-1node-periodic-bindingv1-only-carbon/>`_
+
+Migration
+---------
+
+* no additional steps needed for migration
+
+Compatiblity
+------------
+
+* Release is compatible with the previous one
+* No configuration changes
+
+Bugs Fixed
+----------
+
+* `Link of fixed bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=RESOLVED&chfield=target_milestone&chfieldto=Now&component=General&f1=cf_target_milestone&f2=cf_target_milestone&f3=cf_target_milestone&f4=cf_target_milestone&j_top=AND_G&list_id=78839&o1=substring&product=mdsal&query_format=advanced&resolution=FIXED&resolution=INVALID&resolution=WONTFIX&resolution=DUPLICATE&resolution=WORKSFORME&v1=Carbon>`_
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&chfield=target_milestone&chfieldto=Now&component=General&f1=cf_target_milestone&f2=cf_target_milestone&f3=cf_target_milestone&f4=cf_target_milestone&f5=cf_target_milestone&j_top=AND_G&list_id=78842&o1=substring&product=mdsal&query_format=advanced&resolution=---&v1=Carbon>`_
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this
+  release
+
+  none
+
+Standards
+=========
+
+* relies on processing according to `RFC 6020 <https://tools.ietf.org/html/rfc6020>`_ and `RFC 7950 <https://tools.ietf.org/html/rfc7950>`_.
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/MD-SAL:Carbon:Release_Plan>`_
\ No newline at end of file
diff --git a/docs/getting-started-guide/project-release-notes/netconf.rst b/docs/getting-started-guide/project-release-notes/netconf.rst
new file mode 100644 (file)
index 0000000..0a624dc
--- /dev/null
@@ -0,0 +1,200 @@
+============
+NETCONF
+============
+
+Major Features
+==============
+
+For each top-level feature, identify the name, url, description, etc.
+User-facing features are used directly by end users.
+
+odl-netconf-topology
+--------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
+* **Feature Description:**  NETCONF southbound plugin, configuration through mdsal
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-1node-userfeatures-only-carbon/
+
+odl-netconf-clustered-topology
+------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
+* **Feature Description:**  NETCONF southbound plugin, configuration through mdsal
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-3node-clustering-only-carbon/
+
+odl-netconf-console
+-------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
+* **Feature Description:**  NETCONF southbound configuration with karaf cli
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+
+odl-netconf-connector-all
+-------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
+* **Feature Description:** NETCONF southbound plugin, configuration with configub subsystem
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-1node-userfeatures-only-carbon/
+
+odl-netconf-mdsal
+-----------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf/features-netconf/src/main/features/features.xml;h=29e9400108a8790ac7786fbfc6e2d3bbd1fa2ec0;hb=refs/heads/stable/carbon
+* **Feature Description:** NETCONF server for mdsal
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-1node-userfeatures-only-carbon/
+
+odl-restconf
+------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/restconf/features-restconf/src/main/features/features.xml;h=77c9687fba7862f018b8cea43830cc1b9688c8e5;hb=refs/heads/stable/carbon
+* **Feature Description:** Restconf
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:**  Tested by any suit that uses Restconf
+
+odl-mdsal-apidocs
+-----------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/restconf/features-restconf/src/main/features/features.xml;h=77c9687fba7862f018b8cea43830cc1b9688c8e5;hb=refs/heads/stable/carbon
+* **Feature Description:** MDSal - apidocs
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+
+odl-yanglib
+-----------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/yanglib/features-yanglib/src/main/features/features.xml;h=81ccb4954eb32394a9d4ef1986ad0e4bb67b9e1f;hb=refs/heads/stable/carbon
+* **Feature Description:** Yanglib server
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+
+odl-netconf-callhome-ssh
+------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
+* **Feature Description:** Netconf call home
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-1node-callhome-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.
+
+* **User Guide(s):**
+
+  * `Netconf user guide <http://docs.opendaylight.org/en/latest/user-guide/netconf-user-guide.html>`_
+
+* **Developer Guide(s):**
+
+  * `Netconf developer guide <http://docs.opendaylight.org/en/latest/developer-guide/netconf-developer-guide.html>`_
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  Yes, we have md-sal and css netconf servers. Also server for netconf call-home.
+
+  * If so, how are they secure?
+
+    NETCONF over SSH
+
+  * What port numbers do they use?
+
+    Please see https://wiki.opendaylight.org/view/Ports. Netconf call-home uses TCP 6666
+
+* Other security issues?
+
+  None that we are aware of
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=54548>`_ Test coverage percent: 63.3%
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/netconf/>`_
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+
+  Yes, no specific steps needed apart from migrating netconf's topology configuration from DS.
+
+Compatiblity
+------------
+
+* Is this release compatible with the previous release?
+
+  Yes
+
+* Any API changes?
+
+  No
+
+* Any configuraiton changes?
+
+  md-sal netconf northbound is started via blueprint instead of config subsystem.
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+
+  https://bugs.opendaylight.org/buglist.cgi?bug_status=RESOLVED&bug_status=VERIFIED&chfield=resolution&chfieldfrom=2016-09-08&chfieldto=Now&chfieldvalue=FIXED&list_id=78801&product=netconf&query_format=advanced&resolution=FIXED
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+
+  None
+
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&list_id=78793&product=netconf&query_format=advanced&resolution=--->`_
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this
+  release
+
+  NETCONF southbound plugin, configuration with configub subsystem is deprecated
+
+Standards
+=========
+
+* `RFC 6241 <https://tools.ietf.org/html/rfc6241>`_ - Network Configuration Protocol (NETCONF)
+* `RFC 6470 <https://tools.ietf.org/html/rfc6470>`_ - Base Notifications partly supported, netconf-config-change unsupported
+* `draft-ietf-yang-library-06 <https://tools.ietf.org/html/draft-ietf-netconf-yang-library-06>`_
+* `draft-bierman-netconf-restconf-04 <https://tools.ietf.org/html/draft-bierman-netconf-restconf-04>`_
+* `RFC 8040 <https://tools.ietf.org/html/rfc8040>`_ - RESTCONF protocol
+
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/NETCONF:Carbon:Release_Plan>`_
+* Describe any major shifts in release schedule from the release plan
+
+  No shifts
diff --git a/docs/getting-started-guide/project-release-notes/netide.rst b/docs/getting-started-guide/project-release-notes/netide.rst
new file mode 100644 (file)
index 0000000..fca04fe
--- /dev/null
@@ -0,0 +1,116 @@
+==============
+NetIDE Project
+==============
+
+Major Features
+==============
+
+odl-netide-api
+--------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netide.git;a=blob;f=features/features-netide/src/main/features/features.xml
+* **Feature Description:**  This feature provides the YANG models for
+  NetIDE interoperability layer for SDN Applications written for other
+  SDN Controllers to run on OpenDaylight managed infrastructure.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-all-carbon/
+  https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-only-carbon/
+
+odl-netide-impl
+---------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netide.git;a=blob;f=features/features-netide/src/main/features/features.xml
+* **Feature Description:**  This feature is the main feature of NetIDE. This
+  plugin provides the implementation to transfer Openflow commands from other
+  SDN controllers to the switches.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-all-carbon/
+  https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-only-carbon/
+
+odl-netide-rest
+---------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netide.git;a=blob;f=features/features-netide/src/main/features/features.xml
+* **Feature Description:**  This feature is the wrapper feature that installs
+  the odl-netide-api & odl-netide-impl feature with other required features for
+  restconf access to provide a functional Openflow commands to the switches.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-all-carbon/
+  https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-only-carbon/
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * `NetIDE User Guide <http://docs.opendaylight.org/en/stable-boron/user-guide/netide-user-guide.html>`_
+
+* **Developer Guide(s):**
+
+  * `NetIDE Developer Guide <http://docs.opendaylight.org/en/stable-boron/developer-guide/netide-developer-guide.html>`_
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF? No
+* Other security issues? none
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview/coverage?id=org.opendaylight.netide%3Anetide-aggregator>`_ (74.4)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/netide/>`_
+* NetIDE was tested through Unit Tests, IT test and system tests. A manual
+  testing plan was also completed. See `Carbon Test Plan <https://wiki.opendaylight.org/view/NetIDE:Carbon:System_Test>`_
+
+Migration
+---------
+
+* Is is possible 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.
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release? Yes
+* Any API changes? No changes in the yang models from previous release. Only enhancements completed.
+* Any configuration changes? No
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release: None
+
+Known Issues
+------------
+
+* List key known issues with workarounds: None
+
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this release: None
+
+Standards
+=========
+
+Openflow versions: 
+
+* `OpenFlow1.3.2 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.3.2.pdf>`_
+* `OpenFlow1.0.0 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.0.0.pdf>`_
+
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/NetIDE:Carbon_Release_Plan>`_
+* Describe any major shifts in release schedule from the release plan: None
diff --git a/docs/getting-started-guide/project-release-notes/netvirt.rst b/docs/getting-started-guide/project-release-notes/netvirt.rst
new file mode 100644 (file)
index 0000000..38de8b4
--- /dev/null
@@ -0,0 +1,85 @@
+=======
+NetVirt
+=======
+
+Major Features
+==============
+
+Feature Name
+------------
+
+* **Feature Name:** odl-netvirt-openstack
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netvirt.git;a=blob_plain;f=vpnservice/features/src/main/features/features.xml
+* **Feature Description:**  This feature provides a network virtualization solution.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netvirt-csit/job/netvirt-csit-1node-openstack-newton-nodl-v2-upstream-stateful-carbon/
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * `NetVirt User Guide <http://docs.opendaylight.org/en/latest/submodules/netvirt/docs/user-guide/index.html>`_
+  * `OpenStack with NetVirt <http://docs.opendaylight.org/en/latest/submodules/netvirt/docs/openstack-guide/index.html>`_
+
+* **Developer Guide(s):**
+
+  * `NetVirt Developer Guide <http://docs.opendaylight.org/en/latest/submodules/netvirt/docs/developer-guide/index.html>`_
+
+* **Contributor Guide(s):**
+
+  * `NetVirt Contributor Guide <http://docs.opendaylight.org/en/latest/submodules/netvirt/docs/contributor-guide/index.html>`_
+
+Security Considerations
+=======================
+
+No known issues.
+
+Quality Assurance
+=================
+
+* `Sonar Report <https://sonar.opendaylight.org/overview?id=64219>`_
+* `All CSIT Jobs <https://jenkins.opendaylight.org/releng/view/netvirt-csit>`_
+* `Default stateful tests <https://jenkins.opendaylight.org/releng/view/netvirt-csit/job/netvirt-csit-1node-openstack-newton-nodl-v2-upstream-stateful-carbon>`_
+* `Conntrack SNAT stateful tests <https://jenkins.opendaylight.org/releng/view/netvirt-csit/job/netvirt-csit-1node-openstack-newton-nodl-v2-upstream-stateful-snat-conntrack-carbon>`_
+* `v1 tests <https://jenkins.opendaylight.org/releng/view/netvirt-csit/job/netvirt-csit-1node-openstack-newton-upstream-stateful-carbon>`_
+* `Learn tests <https://jenkins.opendaylight.org/releng/view/netvirt-csit/job/netvirt-csit-1node-openstack-newton-nodl-v2-upstream-learn-carbon>`_
+* `Transparent tests <https://jenkins.opendaylight.org/releng/view/netvirt-csit/job/netvirt-csit-1node-openstack-newton-nodl-v2-upstream-transparent-carbon>`_
+
+Migration
+---------
+
+Nothing beyond general Carbon migration requirements.
+
+Compatibility
+-------------
+
+Nothing beyond general Carbon Compatibility requirements.
+
+Bugs Fixed
+----------
+
+* `Closed Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=RESOLVED&bug_status=VERIFIED&component=General&list_id=78695&order=changeddate%2Cpriority%2Cbug_severity&product=netvirt&query_based_on=&query_format=advanced&resolution=FIXED&resolution=INVALID&resolution=WONTFIX&resolution=DUPLICATE&resolution=WORKSFORME&version=Carbon>`_
+
+Known Issues
+------------
+
+* `Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&component=General&list_id=78574&order=bugs.bug_severity%2Cbugs.priority&product=netvirt&query_format=advanced&resolution=--->`_
+
+End-of-life
+===========
+
+* odl-ovsdb-openstack: the feature was replaced with odl-netvirt-openstack
+
+Standards
+=========
+
+N/A
+
+Release Mechanics
+=================
+
+* `Release Plan <https://wiki.opendaylight.org/view/NetVirt:Carbon:Release_Plan>`_
+* Project was on schedule
diff --git a/docs/getting-started-guide/project-release-notes/neutron-northbound.rst b/docs/getting-started-guide/project-release-notes/neutron-northbound.rst
new file mode 100644 (file)
index 0000000..285f515
--- /dev/null
@@ -0,0 +1,242 @@
+==================
+Neutron Northbound
+==================
+
+Major Features
+==============
+
+* YANG model for OpenStack Neutron integration
+* REST API for OpenStack Neutron integration which stores necessary
+  information into Neutron YANG model
+* Logger to log activity on Neutron YANG models
+* helper library to support for OpenStack service providers
+
+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.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** no CSIT tests as test weiver had been requested.
+  OpenStack CI results can be found from
+  https://review.openstack.org/#/q/project:openstack/networking-odl
+
+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
+* **Top Level:** No
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** no CSIT tests as test weiver had been requested.
+  OpenStack CI results can be found from
+  https://review.openstack.org/#/q/project:openstack/networking-odl
+
+
+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 Description:**  SPI for Neutron northbound feature
+* **Top Level:** No
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** no CSIT tests as test weiver had been requested.
+  OpenStack CI results can be found from
+  https://review.openstack.org/#/q/project:openstack/networking-odl
+
+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
+* **Top Level:** No
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** no CSIT tests as test weiver had been requested.
+  OpenStack CI results can be found from
+  https://review.openstack.org/#/q/project:openstack/networking-odl
+
+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 Description:**  Logger on activity on Neutron YANG models
+* **Top Level:** No
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** no CSIT tests as test weiver had been requested.
+  OpenStack CI results can be found from
+  https://review.openstack.org/#/q/project:openstack/networking-odl
+
+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
+* **Top Level:** No
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** no CSIT tests as test weiver had been requested.
+  OpenStack CI results can be found from
+  https://review.openstack.org/#/q/project:openstack/networking-odl
+
+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
+* **Top Level:** No
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** no CSIT tests as test weiver had been requested.
+  OpenStack CI results can be found from
+  https://review.openstack.org/#/q/project:openstack/networking-odl
+
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`neutron-service-user-guide` is a guide for cloud admin who
+    deploys OpenStack with OpenDaylight.
+
+* **Developer Guide(s):**
+
+  * :ref:`neutron-northbound-developer-guide` is a guide for those who
+    develops new Neutron Northbound API which OpenStack Neutron talks to.
+  * :ref:`neutron-service-developer-guide` is a guide for those who
+    develops new OpenStack Service Provider like netvirt,
+    group-based-policy.
+
+.. Commented out because Colin doens't think it provides any value.
+.. Architectural Issues
+.. --------------------
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  Yes. REST API for OpenStack Neutron.
+
+  * If so, how are they secure?
+    It's authenticated by AAA.
+  * What port numbers do they use?
+    8080 and 8181 by default. 8087 is also used by networking-odl/devstack.
+
+* Other security issues?
+
+  None.
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=org.opendaylight.neutron%3Aproject-neutron>`_ (78.2%)
+* Link to CSIT Jobs N/A
+* Other manual testing and QA information
+
+  * OpenStack CI results can be found from
+    https://review.openstack.org/#/q/project:openstack/networking-odl
+  * failure rate of OpenStack CI
+    http://grafana.openstack.org/dashboard/db/networking-odl-failure-rate
+  * Other OpenDaylight projects which provides OpenStack Service
+    (e.g. netvirt, group-based-policy and vtn etc..) have their own system
+    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?
+
+  * 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
+  * OpenStack CI
+
+Migration
+---------
+
+* Is it possible migrate from the previous release? If so, how?
+
+  No as incompatble change was introduced.
+
+Compatiblity
+------------
+
+* Is this release compatible with the previous release?
+
+  Yes.
+
+* 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/>`_
+
+* Any configuraiton changes?
+
+  No.
+
+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>`_
+
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+
+  None
+
+* `Link to Open Bugs
+  <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&list_id=78677&order=Importance&product=neutron&query_format=specific>`_
+
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this release
+
+  N/A
+
+Standards
+=========
+
+* List of standrads implemented and to what extent
+
+  `OpenStack Neutron API
+  <https://developer.openstack.org/api-ref/networking/v2/>`_
+  ODL Neutron Northbound REST API is based on OpenStack Neutron API
+  and OpenStack Neutron implementation. So the two REST APIs are
+  similar inherently, but different if necessary for technical
+  reason. The goal of ODL Neutron Northbound project is to help
+  OpenStack ODL driver for OpenStack Neutron (networking-odl) and ODL
+  OpenStack Service Provider(netvirt, group-based-policy, and vtn
+  etc...). Not re-implement OpenStack Neutron API.
+
+
+Release Mechanics
+=================
+
+* `Link to release plan
+  <https://wiki.opendaylight.org/view/NeutronNorthbound:Carbon_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
diff --git a/docs/getting-started-guide/project-release-notes/nic.rst b/docs/getting-started-guide/project-release-notes/nic.rst
new file mode 100644 (file)
index 0000000..7bc42e3
--- /dev/null
@@ -0,0 +1,166 @@
+===
+NIC
+===
+
+Major Features
+==============
+
+odl-nic-core-mdsal
+------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nic.git;a=blob_plain;f=features/odl-nic-core-mdsal/pom.xml;hb=stable/carbon
+* **Feature Description:**  This feature contains the dependencies to use MDSAL
+  features on NIC
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
+
+odl-nic-intent-common
+---------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nic.git;a=blob_plain;f=features/odl-nic-intent-common/pom.xml;hb=stable/carbon
+* **Feature Description:**  This feature contains the lifecycle management for
+  Intents, also is used to join two major features 'intent-statemachine' and
+  'intent-listeners'. This feature enable NIC to work with different renderers
+  at the same time.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
+
+odl-nic-statemachine
+--------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nic.git;a=blob_plain;f=features/odl-nic-intent-statemachine/pom.xml;hb=stable/carbon
+* **Feature Description:**  This feature is used to manage Intent state
+  transactions and then share those transactions on MD-SAL.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
+
+odl-nic-listeners
+-----------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nic.git;a=blob_plain;f=features/odl-nic-listeners/pom.xml;hb=stable/carbon
+* **Feature Description:**  This feature dependes of 'odl-nic-core-mdsal' to
+  listen about changes on MDSAL, it works as a listener for Intent and network
+  events.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
+
+odl-nic-renderer-of
+-------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nic.git;a=blob_plain;f=features/odl-nic-renderer-of/pom.xml;hb=stable/carbon
+* **Feature Description:**  This feature is responsible to apply network
+  configurations based in Intents. Once an Intent is created, the
+  'intent-common' module will extract all information and then, send to
+  'renderer-of'.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
+
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`nic-user-guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`nic-dev-guide`
+
+Additional information can be found at the
+`NIC wiki page <https://wiki.opendaylight.org/view/Network_Intent_Composition:Main>`_.
+  
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  No
+
+* Other security issues?
+
+  N/A
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=44164>`_ (48.1% code coverage)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/>`_
+* Other manual testing and QA information
+* Testing methodology. How extensive was it? What should be expected to work?
+  What has not been tested as much?
+
+  There are a guide to evaluate manual tests using NIC on our `wiki page
+  <https://wiki.opendaylight.org/view/Network_Intent_Composition:Main>`_
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+
+  Migration with user configuration and state is not supported.
+
+Compatibility
+-------------
+
+* 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
+
+  For Carbon release, NIC contains multiple renderers, but just one renderer can be used at the same time
+  to use another renderer after start NIC, you have to uninstall NIC and restart ODL.
+
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&list_id=79901&product=nic>`_
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this
+  release
+
+* odl-nic-renderer-nemo
+* odl-nic-renderer-vtn
+* odl-nic-core-hazelcast
+
+Standards
+=========
+
+* List of standards implemented and to what extent
+
+  N/A
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/NIC:Carbon:Release_Plan>`_
+* Describe any major shifts in release schedule from the release plan
+
+  Increase code coverage and initial implementation of Intent life cycle management.
diff --git a/docs/getting-started-guide/project-release-notes/ocpplugin-release-notes.rst b/docs/getting-started-guide/project-release-notes/ocpplugin-release-notes.rst
new file mode 100644 (file)
index 0000000..3a52182
--- /dev/null
@@ -0,0 +1,118 @@
+==========
+OCP-plugin
+==========
+
+Major Features
+==============
+
+odl-ocpplugin-southbound
+------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ocpplugin.git;a=blob;f=features/features-ocpplugin/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:**  Handling of OCP v4.1.1 request/response messages
+* **Top Level:** No
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/ocpplugin/job/ocpplugin-csit-1node-get-all-carbon
+
+
+odl-ocpplugin-app-ocp-service
+-----------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ocpplugin.git;a=blob;f=features/features-ocpplugin/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:**  User facing interface and rrh-agent registration and lifecycle management
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/ocpplugin/job/ocpplugin-csit-1node-get-all-carbon
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`ocpplugin-user-guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`ocpplugin-dev-guide`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  * There is no futher secure description on the OCP 4.1.1 spec, it's out of our design scope, so there is no extenal security interface other than RESTCONF.
+
+* Other security issues?
+
+  * No other security issue
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=64810>`_ (61.7%)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/ocpplugin/job/ocpplugin-csit-1node-get-all-carbon>`_
+* Other manual testing and QA information
+
+  * More detail testing, https://wiki.opendaylight.org/view/OCP_Plugin:Carbon_System_Test_Report
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+
+  * Yes, there is no change in config and no need to migrate data in the datastore.
+
+Compatiblity
+------------
+
+* Is this release compatible with the previous release?
+
+  * Release is compatible with previous.
+
+* Any API changes?
+
+  * N/A
+
+* Any configuration changes?
+
+  * N/A
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+
+  * `7634 <https://bugs.opendaylight.org/show_bug.cgi?id=7634>`_ Karaf 4 migration: provide Karaf 4 ocpplugin features
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+
+  * N/A
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this release
+
+  * Nothing deprecated, EOL.
+
+Standards
+=========
+* List of standards implemented and to what extent
+
+  * `OCP(ORI [Open Radio Interface] C&M [Control and Management]) v4.1.1 <http://www.etsi.org/deliver/etsi_gs/ORI/001_099/00202/04.01.01_60/gs_ORI00202v040101p.pdf>`_
+
+  * The ocpplugin poeject extended connection establishment and state machines used on both ends of the connection.
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/OCP_Plugin:Carbon:Release_Plan>`_
+
+* Describe any major shifts in release schedule from the release plan
+
+  * N/A
diff --git a/docs/getting-started-guide/project-release-notes/odlparent.rst b/docs/getting-started-guide/project-release-notes/odlparent.rst
new file mode 100644 (file)
index 0000000..d226d44
--- /dev/null
@@ -0,0 +1,95 @@
+==========
+ODL Parent
+==========
+
+Major Features
+==============
+
+There are no user-visible features.
+
+Documentation
+=============
+
+* **Developer Guide(s):**
+
+  * :ref:`odl-parent-developer-guide`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  No
+
+* Other security issues?
+
+  No
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=23179>`_ (6.9% coverage)
+* There are no CSIT jobs, ODL Parent has a system test waiver
+* ODL Parent is tested by all builds, and manually tested by running the basic
+  Karaf container and verifying the scripts we modify (``client`` in
+  particular).
+* We verify the following:
+
+  * ``start`` starts the Karaf container.
+    (in a working state, capable of installing features)
+  * ``client`` can connect to a running Karaf container.
+  * ``stop`` stops a running Karaf container.
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+
+  Yes. There are no specific migration aspects related to ODL Parent.
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release?
+
+  Yes.
+
+* Any API changes?
+
+  Yes, but they are backwards-compatible.
+
+* Any configuration changes?
+
+  No. ODL Parent has no user-visible configuration.
+
+Bugs Fixed
+----------
+
+* `6236: Code generation performance optimization required in YangTemplate <https://bugs.opendaylight.org/show_bug.cgi?id=6236>`_
+* `6523: RuntimeException at MethodVisitor.visitParameter <https://bugs.opendaylight.org/show_bug.cgi?id=6523>`_
+* `6790: Karaf ssh EOFError <https://bugs.opendaylight.org/show_bug.cgi?id=6790>`_
+* `7537: Add git.properties <https://bugs.opendaylight.org/show_bug.cgi?id=7537>`_
+* `7745: Port already in use: 1099 <https://bugs.opendaylight.org/show_bug.cgi?id=7745>`_
+* `7813: Karaf: do not package Spring <https://bugs.opendaylight.org/show_bug.cgi?id=7813>`_
+
+Known Issues
+------------
+
+* The Karaf 4 distribution doesn’t work; the workaround is to use Karaf 3 for Carbon.
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&product=odlparent>`_
+
+End-of-life
+===========
+
+* All the Karaf 3 features are deprecated and will be removed in Nitrogen.
+
+Standards
+=========
+
+* N/A.
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/ODL_Parent:Carbon_Release_Plan>`_
+* We failed to implement the switch to Karaf 4; this has been postponed to Nitrogen.
diff --git a/docs/getting-started-guide/project-release-notes/openflowjava.rst b/docs/getting-started-guide/project-release-notes/openflowjava.rst
new file mode 100644 (file)
index 0000000..ced3325
--- /dev/null
@@ -0,0 +1,90 @@
+============
+Openflowjava
+============
+
+Major Features
+==============
+
+odl-openflowjava-protocol
+-------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowjava.git;a=blob;f=features/features-openflowjava/src/main/features/features.xml;h=f1b58ba66493ccbfd496cb9d4f072cc8398340c3;hb=refs/heads/stable/carbon
+* **Feature Description:**  This feature exposes SwitchConnectionProvider for building openflow connections
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-clustering-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-bulkomatic-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-periodic-bulkomatic-clustering-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-gate-scale-stats-collection-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-scale-stats-collection-daily-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-sw-scalability-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-link-scalability-daily-only-carbon/
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * `user guide <https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Startup_Guide>`_
+
+* **Developer Guide(s):**
+
+  * :ref:`developer guide <openflow-protocol-library-dev-guide>`
+
+Security Considerations
+=======================
+
+* openflowjava listens on given TCP/UDP ports and propagates messages to consumer (by default TCP:6633 and TCP:6653)
+* OpenFlow messages can inflict high load on consumer which needs to be handled there
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=11724>`_ (85.8% line coverage)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_ (supplied by openflowplugin)
+
+Migration
+---------
+
+* no additional migration steps needed
+
+Compatiblity
+------------
+
+* release is compatible with the previous release
+* no API changes
+* no configuration changes
+
+Bugs Fixed
+----------
+
+* `List of bugs fixed since the previous release: <https://bugs.opendaylight.org/buglist.cgi?bug_status=RESOLVED&chfield=target_milestone&chfieldto=Now&component=General&f1=cf_target_milestone&f2=cf_target_milestone&f3=cf_target_milestone&f4=cf_target_milestone&f5=cf_target_milestone&j_top=AND_G&list_id=78956&o1=substring&product=openflowjava&query_format=advanced&resolution=FIXED&resolution=INVALID&resolution=WONTFIX&resolution=DUPLICATE&resolution=WORKSFORME&v1=Carbon>`_
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&chfield=target_milestone&chfieldto=Now&component=General&f1=cf_target_milestone&f2=cf_target_milestone&f3=cf_target_milestone&f4=cf_target_milestone&f5=cf_target_milestone&f6=cf_target_milestone&j_top=AND_G&list_id=78961&o1=substring&product=openflowjava&query_format=advanced&resolution=---&v1=Carbon>`_
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this
+  release
+
+  none
+
+Standards
+=========
+
+* based on `openflow switch specification 1.3.2 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.3.2.pdf>`_
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Carbon_Release_Plan>`_
diff --git a/docs/getting-started-guide/project-release-notes/openflowplugin.rst b/docs/getting-started-guide/project-release-notes/openflowplugin.rst
new file mode 100644 (file)
index 0000000..2e407bc
--- /dev/null
@@ -0,0 +1,274 @@
+======================
+OpenFlowPlugin Project
+======================
+
+Major Features
+==============
+
+odl-openflowplugin-app-config-pusher
+------------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-app-config-pusher/pom.xml
+* **Feature Description:** Pushes node configuration changes to OpenFlow device
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-clustering-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-bulkomatic-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-periodic-bulkomatic-clustering-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-gate-scale-stats-collection-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-scale-stats-collection-daily-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-sw-scalability-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-link-scalability-daily-only-carbon/
+
+odl-openflowplugin-app-forwardingrules-manager
+----------------------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-app-forwardingrules-manager/pom.xml
+* **Feature Description:** Sends changes in config datastore to OpenFlow device incrementally. forwardingrules-manager can be replaced with forwardingrules-sync and vice versa.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-gate-scale-stats-collection-daily-only-carbon/
+
+odl-openflowplugin-app-forwardingrules-sync
+-------------------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-app-forwardingrules-sync/pom.xml
+* **Feature Description:** Sends changes in config datastore to OpenFlow devices taking previous state in account and doing diffs between previous and new state. forwardingrules-sync can be replaced with forwardingrules-manager and vice versa.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-scale-stats-collection-daily-frs-only-carbon/
+
+odl-openflowplugin-app-table-miss-enforcer
+------------------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-app-table-miss-enforcer/pom.xml
+* **Feature Description:** Sends table miss flows to OpenFlow device when it connects
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-sw-scalability-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-link-scalability-daily-only-carbon/
+
+odl-openflowplugin-app-topology
+-------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-app-topology/pom.xml
+* **Feature Description:** Discovers topology of connected OpenFlow devices
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-clustering-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-bulkomatic-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-periodic-bulkomatic-clustering-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-gate-scale-stats-collection-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-scale-stats-collection-daily-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-sw-scalability-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-link-scalability-daily-only-carbon/
+
+odl-openflowplugin-nxm-extensions
+---------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=extension/features-extension-aggregator/odl-openflowplugin-nxm-extensions/pom.xml
+* **Feature Description:** Support for OpenFlow Nicira Extensions
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/netvirt/job/netvirt-csit-1node-openstack-newton-upstream-stateful-snat-conntrack-carbon/
+
+odl-openflowplugin-flow-services
+--------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-flow-services/pom.xml
+* **Feature Description:** Wrapper feature for standard applications
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-clustering-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-bulkomatic-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-periodic-bulkomatic-clustering-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-gate-scale-stats-collection-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-scale-stats-collection-daily-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-sw-scalability-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-link-scalability-daily-only-carbon/
+
+odl-openflowplugin-flow-services-rest
+-------------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-flow-services-rest/pom.xml
+* **Feature Description:** Wrapper + REST interface
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-clustering-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-bulkomatic-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-periodic-bulkomatic-clustering-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-gate-scale-stats-collection-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-scale-stats-collection-daily-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-sw-scalability-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-link-scalability-daily-only-carbon/
+
+odl-openflowplugin-flow-services-ui
+-----------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-flow-services-ui/pom.xml
+* **Feature Description:** Wrapper + REST interface + UI
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-clustering-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-bulkomatic-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-periodic-bulkomatic-clustering-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-gate-scale-stats-collection-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-scale-stats-collection-daily-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-sw-scalability-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-link-scalability-daily-only-carbon/
+
+odl-openflowplugin-nsf-model
+----------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-nsf-model/pom.xml
+* **Feature Description:** OpenFlowPlugin YANG models
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-clustering-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-bulkomatic-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-periodic-bulkomatic-clustering-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-gate-scale-stats-collection-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-scale-stats-collection-daily-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-sw-scalability-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-link-scalability-daily-only-carbon/
+
+odl-openflowplugin-southbound
+-----------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-southbound/pom.xml
+* **Feature Description:** Southbound API implementation
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-clustering-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-bulkomatic-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-periodic-bulkomatic-clustering-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-gate-scale-stats-collection-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-scale-stats-collection-daily-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-sw-scalability-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-link-scalability-daily-only-carbon/
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :doc:`../../user-guide/openflow-plugin-project-user-guide`
+
+* **Developer Guide(s):**
+
+  * :doc:`../../developer-guide/openflow-plugin-project-developer-guide`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF? Yes, OpenFlow devices
+* Other security issues?
+
+  * `Insecure OpenFlowPlugin <--> OpenFlow device connections <https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:_TLS_Support>`_
+  * Topology spoofing: non authenticated LLDP packets to detect links between switches which makes it vulnerable to a number of attacks, one of which is topology spoofing  The problem is that all controllers we have tested set chassisSubtype value to the MAC address of the local port of the switch, which makes it easy for an adversary to spoof that switch since controllers use that MAC address as a unique identifier of the switch. By intercepting clear LLDP packets containing MAC addresses, a malicious switch can spoof other switches to falsify the controller’s topology graph.
+  * DoS: an adversary switch could generate LLDP flood resulting in bringing down the openflow network
+  * `DoS attack when the switch rejects to receive packets from the controller <https://wiki.opendaylight.org/view/Security_Advisories#.5BModerate.5D_CVE-2017-1000357_Denial_of_Service_attack_when_the_switch_rejects_to_receive_packets_from_the_controller>`_
+
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=org.opendaylight.openflowplugin%3Aopenflowplugin-aggregator>`_ (73.8)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_
+
+Migration
+---------
+
+* Is is possible 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.
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release? Yes
+* Any API changes? No changes in the yang models from previous release
+* Any configuration changes? Other than addition of `single-layer-serialization <https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:OF13%2B_Single_Layer_Serialization>`_ configuration parameter there were no changes.
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+
+  https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2016-08-09&chfieldto=2017-05-25&list_id=78767&product=openflowplugin&query_format=advanced&resolution=FIXED
+
+Known Issues
+------------
+
+* List key known issues with workarounds: None
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&component=General&list_id=78939&product=openflowplugin&query_format=advanced&resolution=--->`_
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this release:
+
+  Beryllium design (a.k.a. Helium design) was deprecated in Boron and projects were moved to the Boron (a.k.a. Lithium) design. All new Boron development in Carbon was on the Boron design only - and future development will only be on the Boron design going forward. Helium design is planned to be removed in Nitrogen release.
+
+Standards
+=========
+
+OpenFlow versions:
+
+* `OpenFlow1.3.2 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.3.2.pdf>`_
+* `OpenFlow1.0.0 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.0.0.pdf>`_
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:Carbon_Release_Plan>`_
diff --git a/docs/getting-started-guide/project-release-notes/opflex.rst b/docs/getting-started-guide/project-release-notes/opflex.rst
new file mode 100644 (file)
index 0000000..37bf82c
--- /dev/null
@@ -0,0 +1,103 @@
+======
+OpFlex
+======
+
+Major Features
+==============
+
+OpFlex Agent
+------------
+
+OpFlex Agent provides support for local enforcement of group-based
+policy model synced using the OpFlex protocol using an Open
+vSwitch-based bridge.  Supported renderer currently works with Cisco
+ACI.
+
+libopflex
+---------
+
+libopflex provides an implementation of the OpFlex protocol along with
+an in-memory managed object database for managing OpFlex data.
+
+genie
+-----
+
+Genie provides a modeling language and code generator for producing
+data models that work with libopflex.  Genie also contains the
+group-based policy model that is used by the OpFlex Agent.
+
+
+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:`opflex-agent-ovs-install-guide`
+
+* **User Guide(s):**
+
+  * :ref:`opflex-agent-ovs-user-guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`opflex-libopflex-dev-guide`
+  * :ref:`opflex-genie-dev-guide`
+  * :ref:`opflex-agent-ovs-dev-guide`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  * No.
+
+* Other security issues?
+
+  * None.
+
+Quality Assurance
+=================
+
+* OpFlex projects are tested with extensive unit testing as well as
+  Cisco-internal automated testing with ACI.
+* Unit tests run as part of `regular build <https://jenkins.opendaylight.org/releng/view/opflex/job/opflex-merge-carbon/34/>`_
+
+Migration
+---------
+
+* Simply install and restart daemons.
+
+Compatiblity
+------------
+
+OpFlex GBP model and configuration files remain backward compatible.
+
+Bugs Fixed
+----------
+
+* Flows that are routed are allowed to hairpin out the same interface
+* Allow working with newer compilers and development environments
+
+  * Newest versions of boost remove support for comments in JSON; we
+    work around this by stripping comments before doing JSON parsing
+    for configuration files
+  * Various changes and improvements to enable working with musl and
+    alpine linux
+
+Known Issues
+------------
+
+* None
+
+End-of-life
+===========
+
+* None
+
+Standards
+=========
+
+* `OpFlex protocol <https://tools.ietf.org/html/draft-smith-opflex-03>`_ (reference implementation)
diff --git a/docs/getting-started-guide/project-release-notes/ovsdb.rst b/docs/getting-started-guide/project-release-notes/ovsdb.rst
new file mode 100644 (file)
index 0000000..3aa2f6c
--- /dev/null
@@ -0,0 +1,201 @@
+=============
+OVSDB Project
+=============
+
+Major Features
+==============
+
+odl-ovsdb-southbound-api
+------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=southbound/southbound-features/features/src/main/features/features.xml
+* **Feature Description:**  This feature provides the YANG models for northbound users to configure the OVSDB device.
+  These YANG models are designed based on the `OVSDB schema <http://openvswitch.org/ovs-vswitchd.conf.db.5.pdf>`_. This
+  feature does not provide the implementation of YANG models. If user/developer prefer to write their own implementation
+  they can use this feature to load the YANG models in the controller.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-carbon/
+  * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-carbon/
+
+odl-ovsdb-southbound-impl
+-------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=southbound/southbound-features/features/src/main/features/features.xml
+* **Feature Description:**  This feature is the main feature of the OVSDB Southbound plugin. This plugin handle the OVS
+  device that supports the `OVSDB schema <http://openvswitch.org/ovs-vswitchd.conf.db.5.pdf>`_ and uses the
+  `OVSDB protocol <https://tools.ietf.org/html/rfc7047>`_. This feature provides the implementation of the defined YANG
+  models. Developers developing the in-controller application and want to leverage OVSDB for device configuration can
+  add dependency on this feature and it will load all the required modules.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-carbon/
+  * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-carbon/
+
+odl-ovsdb-southbound-impl-rest
+------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=southbound/southbound-features/features/src/main/features/features.xml
+* **Feature Description:**  This feature is the wrapper feature that installs the odl-ovsdb-southbound-api &
+  odl-ovsdb-southbound-impl feature with other required features for restconf access to provide a functional OVSDB
+  southbound plugin. Users, who want to develop application that manages the OVSDB supported devices but want to runs
+  the application outside of the OpenDaylight controller must install this feature.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-carbon/
+  * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-carbon/
+
+
+odl-ovsdb-hwvtepsouthbound-api
+------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=hwvtepsouthbound/hwvtepsouthbound-features/features/src/main/features/features.xml
+* **Feature Description:**  This feature provides the YANG models for northbound users to configure the device
+  that supports OVSDB Hardware vTEP schema. These YANG models are designed based on the
+  `OVSDB Hardware vTEP schema <http://openvswitch.org/docs/vtep.5.pdf>`_. This feature does not provide the
+  implementation of YANG models. If user/developer prefer to write their own implementation of the defined YANG
+  model, they can use this feature to install the  YANG models in the controller.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** Currently no CSIT Tests are available, but work is in progress and will be available by nitrogen
+  release.
+
+odl-ovsdb-hwvtepsouthbound
+--------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=hwvtepsouthbound/hwvtepsouthbound-features/features/src/main/features/features.xml
+* **Feature Description:**  This feature is the main feature of the OVSDB Hardware vTep Southbound plugin. This plugin
+  handle the OVS device that supports the `OVSDB Hardware vTEP schema <http://openvswitch.org/docs/vtep.5.pdf>`_ and
+  uses the `OVSDB protocol <https://tools.ietf.org/html/rfc7047>`_. This feature provides the implementation of the
+  defined YANG  models. Developers developing the in-controller application and want to leverage OVSDB Hardware vTEP
+  plugin for device configuration can add dependency on this feature and it will load all the required modules.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** Currently no CSIT Tests are available, but work is in progress and will be available by nitrogen
+  release.
+
+odl-ovsdb-hwvtepsouthbound-rest
+-------------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=hwvtepsouthbound/hwvtepsouthbound-features/features/src/main/features/features.xml
+* **Feature Description:**  This feature is the wrapper feature that installs the odl-ovsdb-hwvtepsouthbound-api &
+  odl-ovsdb-hwvtepsouthbound feature with other required features for restconf access to provide a functional OVSDB
+  Hardware vTEP plugin. Users, who want to develop application that manages the hardware vTEP supported devices but want
+  to runs the application outside of the OpenDaylight controller must install this feature.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** Currently no CSIT Tests are available, but work is in progress and will be available by nitrogen
+  release.
+
+odl-ovsdb-library
+-----------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=library/features/features/src/main/features/features.xml
+* **Feature Description:**  Encode/decoder library for OVSDB and Hardware vTEP schema.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-carbon/
+  * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-carbon/
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :doc:`OVSDB User Guide <../../user-guide/ovsdb-user-guide>`
+
+* **Developer Guide(s):**
+
+  * :doc:`OVSDB Developer Guide <../../developer-guide/ovsdb-developer-guide>`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF? Yes, Southbound Connection to OVSDB/Hardware vTEP devices.
+
+* Other security issues?
+
+  Plugin's connection to device is by default unsecured. User need to explicitly enable the TLS support through ovsdb
+  library configuration file. User can refer to the wiki page
+  `here <https://wiki.opendaylight.org/view/OVSDB_Integration:TLS_Communication>`_ for the instructions.
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview/coverage?id=org.opendaylight.ovsdb%3Aovsdb>`_ (57%)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/ovsdb/>`_
+*
+* OVSDB southbound plugin is extensively tested through Unit Tests, IT test and system tests. OVSDB southbound plugin
+  is tested in both single node setup as well as three node cluster setup. Hardware vTEP plugin is currently tested
+  through (1) Unit testing (2) NetVirt project L2 Gateway features CSIT tests and (3) Manual Testing.
+  (2) https://jenkins.opendaylight.org/releng/view/netvirt/job/netvirt-csit-hwvtep-1node-openstack-newton-nodl-v2-upstream-stateful-carbon
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+  Yes. User facing features and interfaces are not changed, only enhancements are done.
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release? No
+* Any API changes? No changes in the YANG models from previous release. Only one minor enhancement is being done.
+  https://git.opendaylight.org/gerrit/#/c/50993/
+
+* Any configuration changes? No
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+  https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2016-08-09&chfieldto=2017-05-25&list_id=78767&product=ovsdb&query_format=advanced&resolution=FIXED
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+  None
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&list_id=78768&product=ovsdb&query_format=advanced&resolution=--->`_
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in thisrelease
+
+  None
+
+Standards
+=========
+
+* `Open vSwitch Database Management Protocol <https://tools.ietf.org/html/rfc7047>`_
+* `OVSDB Schema <http://openvswitch.org/ovs-vswitchd.conf.db.5.pdf>`_
+* `Hardware vTep Schema <http://openvswitch.org/docs/vtep.5.pdf>`_
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/OpenDaylight_OVSDB:Carbon_Release_Plan>`_
+* Describe any major shifts in release schedule from the release plan
+
+  We planned to do some exploratory work to improve the performance, scalability and robustness, but it didn't make the
+  expected progress in this release. Project will continue this effort in the next release.
index 5a30d73690a212f5de67327f18d094ba9543a9e0..3b80bf0cda3905fc3ba44f294bfa577224c6efae 100644 (file)
@@ -52,14 +52,15 @@ Feature Name
 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.
+.. 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):**
 
   * `Guide Name <URL>`_
-  * *Note: for most projects this should not be needed since it should just be
-    feature:install <feature-name>*
+
+    .. note: for most projects this should not be needed since it should just
+             be ``feature:install <feature-name>``.
 
 * **User Guide(s):**
 
@@ -112,14 +113,14 @@ Migration
           some project-speicific work and instructions which should be
           explained here. Remove this note.
 
-Compatiblity
-------------
+Compatibility
+-------------
 
 .. Please include a short description of any changes not just a link to a patch
 
 * Is this release compatible with the previous release?
 * Any API changes?
-* Any configuraiton changes?
+* Any configuration changes?
 
 Bugs Fixed
 ----------
diff --git a/docs/getting-started-guide/project-release-notes/sfc.rst b/docs/getting-started-guide/project-release-notes/sfc.rst
new file mode 100644 (file)
index 0000000..a84879d
--- /dev/null
@@ -0,0 +1,341 @@
+=========================
+Service Function Chaining
+=========================
+
+Major Features
+==============
+
+odl-sfc-netconf
+---------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  Provides functionality to communicate with netconf capable Service Functions.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-scf-openflow
+--------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  SFC stand-alone openflow classifier.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-scf-vpp
+--------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  SFC stand-alone vpp classifier.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-openflow-renderer
+-------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  Renderer functionality for OpenFlow capable switches.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfclisp
+-----------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  Programs LISP capable switches.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-sb-rest
+---------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  Implements a South Bound Rest interface to send configuration to REST-capable switches.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-ui
+----------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  This feature is the SFC User Interface.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-vnfm-tacker
+-------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  Tacker VNF Manager interface.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-ios-xe-renderer
+-----------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  Renderer functionality for IO XE switches that use netconf.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-vpp-renderer
+--------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  Renderer functionality for fd.io VPP (Vector Packet Processor) switches that use netconf.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-pot
+-----------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  This feature implements a Proof of Transit for the Service Functions.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+These features are consumed by the User facing features above
+=============================================================
+
+
+odl-sfc-genius
+--------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  This feature implements the Genius utilities created by SFC project.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-model
+-------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  This feature defines and implements the SFC data model as specified here https://datatracker.ietf.org/doc/rfc7665/
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-pot-netconf-renderer
+----------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  This feature implements the Netconf rendering for the Proof of Transit for the Service Functions.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-provider
+----------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  This feature provides an easy-to-use interface to the sfc-model.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-provider-rest
+---------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  This feature provides no functionality, and just installs the necessary features for SFC restconf.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-ovs
+-----------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  This feature provides functionality for SFC to communicate with OVSDB for SFF configuration.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+odl-sfc-test-consumer
+---------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
+* **Feature Description:**  This feature is used for testing only.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-boron
+
+
+Features removed in this release
+================================
+
+* odl-sfc-bootstrap - used to load an initial configuration that is no longer needed
+* odl-sfcofl2 - was deprecated since it was renamed to odl-sfc-openflow-renderer
+
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`sfc-user-guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`sfc-dev-guide`
+
+
+Security Considerations
+=======================
+
+None.
+
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=19574>`_ (55.9%)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/sfc/>`_
+* All modules have been unit tested. Integration tests have been performed for
+  all major features. System tests have been performed on most major features.
+
+Migration
+---------
+
+The impacts on the SFC data models in this release are minimal.
+Several fields that were marked as deprecated in Beryllium and
+Boron have been removed in Carbon, as follows. No automatic data
+migration is supported.
+
+**Service Chain Symmetry**
+
+Previously a Service Chain could be marked symmetric by using
+either the symmetric flag in the Service Function Chain (SFC),
+the Service Function Path (SFP), or the Rendered Service Path (RSP).
+This approach can be confusing if the SFC, SFP, or RSP have different
+values for the symmetric flag. The symmetric flag has been removed
+from the SFC and RSP and can now only be set in the SFP. Additionally,
+if the symmetric flag is not present in the SFP, if any of the Service
+Functions is of a Service Funtion Type (SFT) that has the bidirectional
+flag set true, then the Service Chain will be symmetric. The SFP
+symmetric flag overides the SFT bidirectional flag. To say that
+a Service Chain is symmetric means that 2 RSPs will be created
+internally, one uplink and another downlink.
+
+
+**Deprecated Service Function fields**
+
+The Service Function ``nsh-aware`` and ``requires-classification`` fields
+have been moved to the Service Function Type.
+
+Compatiblity
+------------
+
+Other than the API changes mentioned in the previous section, this
+release is compatible with the previous release.
+
+Bugs Fixed
+----------
+
+List of bugs fixed since the previous release
+
+* https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2016-08-09&chfieldto=2017-05-25&list_id=78767&product=sfc&query_format=advanced&resolution=FIXED
+
+
+Known Issues
+------------
+
+SFC needs changes in OVS to include the Network Service Headers (NSH) Chaining
+encapsulation feature. This patch has been ongoing for quite a while (2 years+),
+and still has not been officially merged. Until NSH is officially merged in
+OVS, SFC will use a branched version of OVS based on 2.6.1, called the
+"Yi Yang Patch", `located here <https://github.com/yyang13/ovs_nsh_patches>`_.
+Previous versions of this OVS patch only supported VXLAN-GPE + NSH
+encapsulation, but this version supports both ETH + NSH and VXLAN-GPE + ETH + NSH.
+
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&list_id=78823&order=Importance&product=sfc&query_format=specific>`_
+
+The following bug was found during Carbon RC testing, which was
+originally marked as a blocker. Upon further investigation, the
+MDSAL team decided its not a blocker and decided to postpone
+fixing it until Carbon SR1.
+
+* https://bugs.opendaylight.org/show_bug.cgi?id=8501
+
+
+End-of-life
+===========
+
+List of features/APIs which are EOLed, deprecated, and/or removed in this release
+
+* In the Beryllium release, the Service Function nsh-aware and request-classification
+  API fields were deprecated, and were subsequently removed in Carbon.
+
+  * Use the corresponding fields in the Service Function Type instead.
+
+* In the Boron release, the symmetrice API field was deprecated in the Service
+  Function Chain and Rendered Service Path data models, and were subsequently
+  removed in Carbon.
+
+  * Use the Service Function Path (SFP) symmetric field instead of the SFC or
+    RSP symmetric field.
+  * Or, if the SFP symmetric field is not present and any of the Service
+    Functions has a Service Function type that sets bidirection true, then
+    the resulting Rendered Service Path will be symmetric.
+
+Standards
+=========
+
+* List of standards implemented and to what extent
+
+* `IETF SFC RFC <https://datatracker.ietf.org/doc/rfc7665>`_
+* `IETF NSH <https://tools.ietf.org/html/draft-ietf-sfc-nsh-07>`_ Only NSH Metadata type 1 is implemented.
+* `OpenFlow v1.3 <http://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-switch-v1.3.4.pdf>`_
+
+
+Release Mechanics
+=================
+
+* `ODL SFC Carbon release plan <https://wiki.opendaylight.org/view/Service_Function_Chaining:Carbon_Release_Plan>`_
+* No major shifts in the release schedule from the release plan
diff --git a/docs/getting-started-guide/project-release-notes/snmp4sdn.rst b/docs/getting-started-guide/project-release-notes/snmp4sdn.rst
new file mode 100644 (file)
index 0000000..7882aa9
--- /dev/null
@@ -0,0 +1,105 @@
+========\r
+SNMP4SDN\r
+========\r
+\r
+Major Features\r
+==============\r
+\r
+odl-snmp4sdn-snmp4sdn\r
+---------------------\r
+\r
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=snmp4sdn.git;a=blob;f=features/features-snmp4sdn/src/main/resources/features.xml\r
+* **Feature Description:**  This feature will install all bundles required for SNMP4SDN Plugin\r
+* **Top Level:** Yes\r
+* **User Facing:** Yes\r
+* **Experimental:** Yes\r
+* **CSIT Test:** NA\r
+\r
+\r
+Documentation\r
+=============\r
+\r
+* **User Guide:**\r
+\r
+  * :ref:`snmp4sdn-user-guide`\r
+\r
+* **Developer Guide(s):**\r
+\r
+  * :ref:`snmp4sdn-dev-guide`\r
+\r
+Security Considerations\r
+=======================\r
+\r
+* The interface or configurable resource exposed to users includes RESTCONF API\r
+  and the switch list file. Switch list file, which is a plain-text file,\r
+  contains security information such as SNMP community.\r
+\r
+* SNMP4SDN Plugin configures switches via SNMP protocol, and listens to SNMP\r
+  listen port for link-up/down trap. SNMP v2c is used.\r
+\r
+Quality Assurance\r
+=================\r
+\r
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=44354>`_ (Test coverage percent NA)\r
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/snmp4sdn/>`_\r
+* Other manual testing and QA information\r
+* For each function of SNMP4SDN Plugin, use REST API to confirm it's\r
+  availability and correctness. Existing functions includes flow configuration\r
+  (such as VLAN and forwarding table) and topology discovery.\r
+\r
+Migration\r
+---------\r
+\r
+* Is is possible migrate from the previous release? If so, how?\r
+\r
+  Yes. Features as well as interfaces are not changed.\r
+\r
+Compatiblity\r
+------------\r
+\r
+* Is this release compatible with the previous release?\r
+\r
+  Yes\r
+\r
+* Any API changes?\r
+\r
+  No\r
+\r
+* Any configuraiton changes?\r
+\r
+  No\r
+\r
+\r
+Bugs Fixed\r
+----------\r
+\r
+* None (no bugs reported since the previous release)\r
+\r
+Known Issues\r
+------------\r
+\r
+* List key known issues with workarounds\r
+\r
+  None\r
+\r
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&list_id=78998&order=Importance&product=snmp4sdn&query_format=specific>`_\r
+\r
+End-of-life\r
+===========\r
+\r
+* List of features/APIs which are EOLed, deprecated, and/or removed in this release\r
+\r
+  None\r
+\r
+Standards\r
+=========\r
+\r
+* List of standards implemented and to what extent\r
+\r
+  None (no standards implemented, and use a third-party library to configure switches in standard SNMP protocol)\r
+\r
+Release Mechanics\r
+=================\r
+\r
+* `Link to release plan <https://wiki.opendaylight.org/view/SNMP4SDN:Release_Plan_Carbon>`_\r
+* No changes in this release\r
diff --git a/docs/getting-started-guide/project-release-notes/sxp.rst b/docs/getting-started-guide/project-release-notes/sxp.rst
new file mode 100644 (file)
index 0000000..3d0d88d
--- /dev/null
@@ -0,0 +1,173 @@
+==========================================
+Scalable-Group Tag eXchange Protocol (SXP)
+==========================================
+
+Major Features
+==============
+
+odl-sxp-api
+-----------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;h=60b04abb2af30126b121f56357f086a051251e0d;hb=refs/heads/stable/carbon
+* **Feature Description:**  This feature provides models based on `RFC <https://tools.ietf.org/pdf/draft-smith-kandula-sxp-05.pdf>`_.
+* **Top Level:** No
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+odl-sxp-core
+------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;h=60b04abb2af30126b121f56357f086a051251e0d;hb=refs/heads/stable/carbon
+* **Feature Description:**  This feature performs tasks for managing SXP devices and provides the implementation of `RFC <https://tools.ietf.org/pdf/draft-smith-kandula-sxp-05.pdf>`_.
+* **Top Level:** No
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+odl-sxp-controller
+------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;h=60b04abb2af30126b121f56357f086a051251e0d;hb=refs/heads/stable/carbon
+* **Feature Description:**  This feature performs tasks regarding managing SXP devices via RESTCONF.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-basic-all-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-filtering-all-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-topology-all-carbon/
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-3node-periodic-clustering-all-carbon/
+
+odl-sxp-robot
+-------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;h=60b04abb2af30126b121f56357f086a051251e0d;hb=refs/heads/stable/carbon
+* **Feature Description:**  This is a sample feature used in CSIT testing.
+* **Top Level:** No
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-periodic-performance-all-carbon/
+
+odl-sxp-route
+-------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;h=60b04abb2af30126b121f56357f086a051251e0d;hb=refs/heads/stable/carbon
+* **Feature Description:**  This feature that performs managing of SXP devices in cluster environment.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-3node-periodic-routing-all-carbon/
+
+
+Documentation
+=============
+
+* **Installation Guide(s):**
+
+  * `InstallationGuide <https://wiki.opendaylight.org/view/SXP:Lithium:Installation_Guide>`_
+
+* **User Guide(s):**
+
+  * `SXP User Guide <http://docs.opendaylight.org/en/latest/user-guide/sxp-user-guide.html>`_
+
+* **Developer Guide(s):**
+
+  * `SXP Developer Guide <http://docs.opendaylight.org/en/latest/developer-guide/sxp-developer-guide.html>`_
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  * Yes on port 64999 based on `SXP RFC <https://tools.ietf.org/pdf/draft-smith-kandula-sxp-05.pdf>`_ secured by TCP-MD5, optionally also with SSL.
+
+* Other security issues?
+
+  * TCP-MD5 security option is now deprecated, and in future will replaced by TCP-AO
+
+Quality Assurance
+=================
+
+* Link to `Sonar Report <https://sonar.opendaylight.org/overview?id=45270>`_ (80%)
+
+* Link to CSIT Jobs
+
+  * `CSIT Job basic <https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-basic-all-carbon/>`_
+  * `CSIT Job filtering <https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-filtering-all-carbon/>`_
+  * `CSIT Job topology <https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-topology-all-carbon/>`_
+  * `CSIT Job clustering <https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-3node-periodic-clustering-all-carbon/>`_
+  * `CSIT Job performance <https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-periodic-performance-all-carbon/>`_
+  * `CSIT Job routing <https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-3node-periodic-routing-all-carbon/>`_
+
+* Other manual testing and QA information
+
+  * N/A
+
+* Testing methodology. How extensive was it? What should be expected to work? What hasn't been tested as much?
+
+  * `CSIT Test document 1 <https://wiki.opendaylight.org/view/File:SXP_Automated_testing.pdf>`_
+  * `CSIT Test document 2 <https://wiki.opendaylight.org/view/File:SXP_Automated_testing_filtering.pdf>`_
+  * `CSIT Test document 3 <https://wiki.opendaylight.org/view/File:SXP_Automated_testing_cluster.pdf>`_
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+
+  * Yes, no data models were changed that would break the migration.
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release?
+
+  * Functionality is fully backwards compatible.
+
+* Any API changes?
+
+  * Add SSL option to be used for security `Patch 1 <https://git.opendaylight.org/gerrit/#/c/52278/>`_
+  * Add models for configuring routed SXP devices in cluster `Patch 2 <https://git.opendaylight.org/gerrit/#/c/49656/>`_
+
+* Any configuration changes?
+
+  * N/A
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+
+  * `Fixed BUGS <https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2016-08-9&chfieldto=2017-05-25&list_id=78466&product=sxp&query_format=advanced&resolution=FIXED>`_
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+
+  * N/A
+
+* `Open Bugs <https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2016-08-9&chfieldto=2017-05-25&list_id=78466&product=sxp&query_format=advanced&bug_status=__open__>`_
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this release
+
+  * Added models for managing of feature odl-sxp-route `API <https://git.opendaylight.org/gerrit/#/c/49656/>`_
+
+Standards
+=========
+
+* List of standards implemented and to what extent
+
+  * `SXP <https://tools.ietf.org/pdf/draft-smith-kandula-sxp-05.pdf>`_ Fully implemented
+
+Release Mechanics
+=================
+
+* `Release plan <https://wiki.opendaylight.org/view/SXP:Carbon:Release_Plan>`_
+
+* Describe any major shifts in release schedule from the release plan
+
+  * N/A
+
diff --git a/docs/getting-started-guide/project-release-notes/topology-processing-framework.rst b/docs/getting-started-guide/project-release-notes/topology-processing-framework.rst
new file mode 100644 (file)
index 0000000..7b9a48a
--- /dev/null
@@ -0,0 +1,135 @@
+============
+Topology Processing Framework
+============
+
+Major Features
+==============
+
+odl-topoprocessing-framewrok
+------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/src/main/resources/features.xml;h=0f4b0c438e19f57682ae5586696c36f238bb6255;hb=refs/heads/stable/carbon
+* **Feature Description:**  Topology processing core
+* **Top Level:** No
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-carbon/
+
+odl-topoprocessing-mlmt
+------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/src/main/resources/features.xml;h=0f4b0c438e19f57682ae5586696c36f238bb6255;hb=refs/heads/stable/carbon
+* **Feature Description:**  Multi-Layer and Multi-Technology (MLMT) module
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-carbon/
+
+odl-topoprocessing-network-topology
+------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/src/main/resources/features.xml;h=0f4b0c438e19f57682ae5586696c36f238bb6255;hb=refs/heads/stable/carbon
+* **Feature Description:**  Support for network-topology model
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-carbon/
+
+odl-topoprocessing-inventory
+------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/src/main/resources/features.xml;h=0f4b0c438e19f57682ae5586696c36f238bb6255;hb=refs/heads/stable/carbon
+* **Feature Description:**  Support for inventory model
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-carbon/
+
+odl-topoprocessing-I2rs
+------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/src/main/resources/features.xml;h=0f4b0c438e19f57682ae5586696c36f238bb6255;hb=refs/heads/stable/carbon
+* **Feature Description:**  Support for i2rs model
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-carbon/
+
+odl-topoprocessing-inventory-rendering
+------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/src/main/resources/features.xml;h=0f4b0c438e19f57682ae5586696c36f238bb6255;hb=refs/heads/stable/carbon
+* **Feature Description:**  Rendering demo
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-carbon/
+
+Documentation
+=============
+
+* **Developer Guide(s):**
+
+  * `Docs on docs.opendaylight.org <http://docs.opendaylight.org/en/latest/developer-guide/topology-processing-framework-developer-guide.html>`_
+  * `Rst documentation <https://git.opendaylight.org/gerrit/gitweb?p=docs.git;a=blob;f=docs/developer-guide/topology-processing-framework-developer-guide.rst;h=9ee838bc79b80bb1b6a8230f8d5402495348e8e0;hb=refs/heads/stable/boron>`_
+  * `Wiki <https://wiki.opendaylight.org/view/Topology_Processing_Framework:Developer_Guide>`_
+
+Security Considerations
+=======================
+
+* No external interfaces other then restconf
+* No known security issues
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=31056>`_ (80.2%)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-carbon/>`_
+
+Migration
+---------
+
+* Not supported
+
+Compatiblity
+------------
+
+* Compatible
+
+Bugs Fixed
+----------
+
+* `Link to fixed bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&bug_status=RESOLVED&bug_status=VERIFIED&chfield=bug_status&chfieldfrom=2016-09-08&chfieldto=2017-04-24&component=General&product=topoprocessing&query_format=advanced&resolution=FIXED&resolution=INVALID&resolution=WONTFIX&resolution=DUPLICATE&resolution=WORKSFORME>`_
+
+Known Issues
+------------
+
+* Leafs which are children (direct or indirect) of list can't be used as target fields
+* Aggregation of termination points in case of more mappings works only if all underlay topologies are from the same model and only if that model is Network Topology or I2RS
+* Aggregation of termination points in combination with aggregation of nodes doesn't work with inventory model
+* Aggregation of termination points in combination with aggregation of nodes in case of more mappings works only if aggregation of termination points is specified on each underlay topology and only if model of all underlay topologies is the same
+* Filtration of termination points in case of more filters works only if all underlay topologies are from the same model
+* Maximum of one correlation per correlation item (aggregation may not work correctly in case of more correlation with the same correlation item)
+* Link aggregation works only if user specify also link computation
+
+
+**MLMT limitations**
+
+* The mlmt module provides YANG models as based on:
+  * network-topology YANG model version 2013-10-21
+  * TED YANG model version 2013-10-21
+* The mlmt module works with underlay topologies based on:
+  * network-topology YANG model version 2013-10-21
+  * isis-topology YANG model version 2013-10-21
+* The mlmt module does not support underlay topologies based on ospf-topology YANG model 2013-10-21.
+
+
+End-of-life
+===========
+
+* Network Topology model is not supported for overlay topologies
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/Topology_Processing_Framework:CARBON_Release_Plan>`_
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
@@ -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-release-notes/ttp.rst b/docs/getting-started-guide/project-release-notes/ttp.rst
new file mode 100644 (file)
index 0000000..31a0cf7
--- /dev/null
@@ -0,0 +1,124 @@
+===================
+Table Type Patterns
+===================
+
+Major Features
+==============
+
+odl-ttp-model
+-------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ttp.git;a=blob;f=features/features-ttp/src/main/features/features.xml;hb=stable/carbon
+* **Feature Description:**  Provides a YANG model for describing
+  `ONF TTP 1.0 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/OpenFlow%20Table%20Type%20Patterns%20v1.0.pdf>`
+  Table Type Patterns (TTPs) in JSON as well as a database of TTPs and an
+  augmentation adding supported and active TTPs on OpenFlow nodes.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** None.
+
+TTP CLI Tools
+-------------
+
+* **Feature URL:** The Carbon executable jar can be found here: https://nexus.opendaylight.org/content/repositories/public/org/opendaylight/ttp/parser/0.4.0-Carbon/parser-0.4.0-Carbon-jar-with-dependencies.jar
+* **Feature Description:**  Provides stand-alone command line tools to validate
+  and interact with TTPs in XML or JSON.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** None.
+
+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.
+
+* **User Guide(s):**
+
+  * :ref:`ttp_cli_tools_user_guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`ttp_cli_tools_dev_guide`
+  * :ref:`ttp_model_dev_guide`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  * No.
+
+* Other security issues?
+
+  * None.
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview/coverage?id=org.opendaylight.ttp%3Attp-parent>`_ (43.3% Test Coverage)
+* No CSIT testing.
+* There was minimal manual testing in Carbon, but also there were no changes
+  beyond keeping up-to-date with changes in upstream projects. Unit tests cover
+  the basics of the model.
+
+Migration
+---------
+
+* Is is possible 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
+  has not been tested and isn't officially supported.
+
+Compatiblity
+------------
+
+* Is this release compatible with the previous release?
+
+  Yes. There have been no code changes except to tolerate changes in upstream
+  projects.
+
+* Any API changes?
+
+  No. No changes in models or APIs.
+
+* Any configuration changes?
+
+  No. The TTP project has no configuration.
+
+Bugs Fixed
+----------
+
+None fixed.
+
+Known Issues
+------------
+
+The TTP YANG model does not match the ONF TTP JSON precisely. Exact details are
+documented in the `TTP model YANG
+<https://git.opendaylight.org/gerrit/gitweb?p=ttp.git;a=blob;f=ttp-model/src/main/yang/ttp.yang;hb=stable/carbon>`_
+file.
+
+`Open Bugs <https://bugs.opendaylight.org/buglist.cgi?component=General&list_id=79056&product=ttp&resolution=--->`_
+
+End-of-life
+===========
+
+None.
+
+Standards
+=========
+
+`ONF TTP 1.0
+<https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/OpenFlow%20Table%20Type%20Patterns%20v1.0.pdf>`_
+
+Release Mechanics
+=================
+
+* `Carbon Table Type Patterns Release Plan
+  <https://wiki.opendaylight.org/view/Table_Type_Patterns/Carbon/Release_Plan>`_
+
+  * Dropped all new features including TTP 1.1 support, Dynamic Mapping, and auto-loading of TTP repositories.
diff --git a/docs/getting-started-guide/project-release-notes/usc.rst b/docs/getting-started-guide/project-release-notes/usc.rst
new file mode 100644 (file)
index 0000000..d2d5441
--- /dev/null
@@ -0,0 +1,101 @@
+======================
+Unified Secure Channel
+======================
+
+Major Features
+==============
+
+* USC Agent provides proxy and agent functionality on top of all standard
+  protocols supported by the device. It initiates call-home with the controller,
+  maintains live connections with with the controller, acts as a demuxer/muxer
+  for packets with the USC header, and authenticates the controller.
+* USC Plugin is responsible for communication between the controller and the USC
+  agent . It responds to call-home with the controller, maintains live
+  connections with the devices, acts as a muxer/demuxer for packets with the USC
+  header, and provides support for TLS/DTLS.
+* USC Manager handles configurations, high availability, security, monitoring,
+  and clustering support for USC.
+* USC UI is responsible for displaying a graphical user interface representing
+  the state of USC in the OpenDaylight DLUX UI.
+
+USC Channel UI
+--------------
+
+* **Feature Name:** odl-usc-channel-ui
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=usc.git;a=blob;f=usc-features/src/main/features/features.xml;
+* **Feature Description:**  Responsible for communication between the controller
+  and the USC agent . It responds to call-home with the controller, maintains
+  live connections with the devices, acts as muxer/demuxer for packets with the
+  USC header, and provides support for TLS/DTLS.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/usc/job/usc-csit-1node-tcp-all-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.
+
+* **User Guide(s):**
+
+  * `USC User Guide <http://docs.opendaylight.org/en/latest/user-guide/unified-secure-channel.html>`_
+
+* **Developer Guide(s):**
+
+  * `USC Developer Guide <http://docs.opendaylight.org/en/latest/developer-guide/unified-secure-channel.html>`_
+
+Security Considerations
+=======================
+
+* USC uses TLS and DTLS to secure the channels. Asymmetric authentication
+  handshake when establishing the channels. Mutual authentication achieved with
+  certificates configured in usc.properties for both the controller and the
+  device.
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=44336>`_
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/usc/job/usc-csit-1node-tcp-all-carbon/>`_
+* `Link to Additional Details <https://wiki.opendaylight.org/view/USC:Carbon:Integration_Test>`_
+* Code is covered by unit and integration tests
+* System Tests are performed by CSIT jobs using java test agent.
+
+
+Migration
+---------
+
+* Nothing beyond general Carbon migration requirements.
+
+Compatiblity
+------------
+
+* Nothing beyond general Carbon compatibility constraints.
+
+Bugs Fixed
+----------
+
+* `Bug Report <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&bug_status=VERIFIED&list_id=47710&product=usc&query_format=advanced&resolution=--->`_
+
+Known Issues
+------------
+
+* `3402 <https://bugs.opendaylight.org/show_bug.cgi?id=4558>`_ USC features has configuration issues with 3-node cluster environment.
+
+End-of-life
+===========
+
+* Nothing deprecated, EOL.
+
+Standards
+=========
+
+* N/A
+
+Release Mechanics
+=================
+
+* `USC Release Plan <https://wiki.opendaylight.org/view/USC:Carbon:Release_Plan>`_
+* Project was on schedule
diff --git a/docs/getting-started-guide/project-release-notes/vbd.rst b/docs/getting-started-guide/project-release-notes/vbd.rst
new file mode 100644 (file)
index 0000000..89a50a9
--- /dev/null
@@ -0,0 +1,104 @@
+===============================
+Honeycomb Virtual Bridge Domain
+===============================
+
+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;h=66f8ed281850afadcf769a2b9e0925aaedce983a;hb=refs/heads/stable/carbon
+* **Feature Description:**  This feature provides models to configure Virtual Bridge Domains on VPP.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+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;h=66f8ed281850afadcf769a2b9e0925aaedce983a;hb=refs/heads/stable/carbon
+* **Feature Description:**  This feature provides the GUI for VBD.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+
+Documentation
+=============
+
+* `Wiki <https://wiki.opendaylight.org/view/Honeycomb/VBD>`_
+* `VBD API https://wiki.opendaylight.org/view/Honeycomb/VBD/API>`_
+
+Security Considerations
+=======================
+
+* N/A
+
+Quality Assurance
+=================
+
+* `Sonar Report <https://sonar.opendaylight.org/overview?id=68028>`_ (0% - no coverage results available)
+* 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>`_
+* 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.
+
+Compatiblity
+------------
+
+* Not compatible with previous VPP 17.01 or older stable versions.
+
+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
+
+
+Known Issues
+------------
+
+* Due to yang updates for keeping VPP Rendering compatible with the latest
+  stable for VPP, 17.04, we are not going to be compatible with previous stable
+  VPPs. This, on the other hand, comes with a lot of augmentations of features.
+
+End-of-life
+===========
+
+* N/A
+
+Standards
+=========
+
+* N/A
+
+Release Mechanics
+=================
+
+* `Release plan <https://wiki.opendaylight.org/view/Honeycomb/VBD/Carbon/Release_Plan>`_
+* no major shifts from official release plan
diff --git a/docs/getting-started-guide/project-release-notes/vtn.rst b/docs/getting-started-guide/project-release-notes/vtn.rst
new file mode 100644 (file)
index 0000000..439a168
--- /dev/null
@@ -0,0 +1,102 @@
+===
+VTN
+===
+
+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;h=e4fe7f62405d07653bffa291f984f2cd30db4a4c;hb=refs/heads/stable/carbon#l41
+* **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/
+
+
+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;h=e4fe7f62405d07653bffa291f984f2cd30db4a4c;hb=refs/heads/stable/carbon#l49
+* **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/
+
+Documentation
+=============
+
+* **Installation Guide(s):**
+
+  * :ref:`vtn-install-guide`
+
+* **User Guide(s):**
+
+  * :ref:`VTN User Guide <vtn-user-guide>`
+
+* **Developer Guide(s):**
+
+  * :ref:`VTN Developer Guide <vtn-dev-guide>`
+  * :ref:`VTN Openstack Developer Guide <vtn-openstack-dev-guide>`
+
+Security Considerations
+=======================
+
+* No Issues.
+
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.vtn%3Adistribution&did=1>`_ (56.2%)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/vtn/>`_
+*  CSIT covers most of the options in RESTCONF
+*  The 3 node deployment has not been tested well.
+
+Migration
+---------
+
+* Not Supported.
+
+Compatiblity
+------------
+
+* No Specific Compatibility issues.
+
+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
+
+Known Issues
+------------
+
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?component=VTN%20Manager&list_id=78860&product=vtn&resolution=--->`_
+
+End-of-life
+===========
+
+* None
+
+Standards
+=========
+
+* None
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/VTN:Carbon_Release_Plan>`_
+* There was no deviation from the plan.
diff --git a/docs/getting-started-guide/project-release-notes/yangtools.rst b/docs/getting-started-guide/project-release-notes/yangtools.rst
new file mode 100644 (file)
index 0000000..4864ede
--- /dev/null
@@ -0,0 +1,123 @@
+==========
+YANG Tools
+==========
+
+Major Features
+==============
+
+Carbon release marks the sixth release of YANG Tools components. We have fixed `56 <https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_severity=enhancement&columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_severity%2Ccf_issue_type%2Cshort_desc%2Cbug_status%2Cpriority%2Cdeadline%2Ccf_target_milestone&component=General&f1=cf_target_milestone&known_name=Carbon%3A%20Yangtools&list_id=78630&o1=substring&order=bug_id&product=yangtools&query_based_on=Carbon%3A%20Yangtools&query_format=advanced&resolution=FIXED&v1=Carbon>`_ issues ranging from small annoyances to major reworks.
+
+New major features delivered in this release are
+
+* Introduction of YANG 1.1 (`RFC 7950 <https://tools.ietf.org/html/rfc7950>`_)
+  support in YANG parser
+  (`Bug 2305 <https://bugs.opendaylight.org/show_bug.cgi?id=2305>`_)
+* Introduction of deviation statements support, i.e., when assembling a
+  SchemaContext, target nodes of deviations are updated according to the deviate
+  type (`Bug 6261 <https://bugs.opendaylight.org/show_bug.cgi?id=6261>`_).
+
+odl-yangtools-yang-data
+-----------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=yangtools.git;a=blob;f=features/features-yangtools/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:** to install YANG Data APIs and implementation.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** System test waiver request pending.
+
+odl-yangtools-common
+--------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=yangtools.git;a=blob;f=features/features-yangtools/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:** to install common concepts and utilities.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** System test waiver request pending.
+
+odl-yangtools-yang-parser
+-------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=yangtools.git;a=blob;f=features/features-yangtools/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:** to install YANG model APIs and YANG Parser
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/yangtools/job/yangtools-csit-1node-periodic-system-only-carbon/
+
+Documentation
+=============
+* **Developer Guide(s):**
+
+  * :ref:`yangtools-developer-guide`
+
+Security Considerations
+=======================
+
+* YANG Tools libraries are designed to be embedded and not to be a stand-alone
+  application so security concerns need to be addressed by the application
+  using this library.
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=13079>`_
+  (Test coverage 76%)
+* `Link to CSIT Jobs
+  <https://jenkins.opendaylight.org/releng/view/yangtools/job/yangtools-csit-1node-periodic-system-only-carbon/>`_
+
+Migration
+---------
+
+* It is possible to migrate from the previous release. Aside from adjusting to
+  the removal of deprecated API elements and changed elements, there are no
+  additional steps needed for migration to this release.
+
+Compatiblity
+------------
+
+* Release is compatible with the previous one.
+* API changes:
+
+  * `Change of if-feature related API
+    <https://wiki.opendaylight.org/view/Weather#Yangtools:_Change_of_if-feature_related_API>`_
+  * `Change in yangtools's yang-model-api
+    <https://wiki.opendaylight.org/view/Weather#Change_in_yangtools.27s_yang-model-api>`_
+  * `Changes in yang-model-api in order to support Yang 1.1
+    <https://bugs.opendaylight.org/show_bug.cgi?id=6989>`_
+* No configuration changes.
+
+Bugs Fixed
+----------
+
+* List of fixed `Bugs (56)
+  <https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_severity=enhancement&columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_severity%2Ccf_issue_type%2Cshort_desc%2Cbug_status%2Cpriority%2Cdeadline%2Ccf_target_milestone&component=General&f1=cf_target_milestone&known_name=Carbon%3A%20Yangtools&list_id=78630&o1=substring&order=bug_id&product=yangtools&query_based_on=Carbon%3A%20Yangtools&query_format=advanced&resolution=FIXED&v1=Carbon>`_.
+
+Known Issues
+------------
+
+* `Link to Open Bugs
+  <https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_severity=enhancement&columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_severity%2Ccf_issue_type%2Cshort_desc%2Cbug_status%2Cpriority%2Cdeadline%2Ccf_target_milestone&component=General&f1=cf_target_milestone&known_name=Carbon%3A%20Yangtools&list_id=78805&o1=substring&product=yangtools&query_based_on=Carbon%3A%20Yangtools&query_format=advanced&resolution=---&v1=Carbon>`_
+
+End-of-life
+===========
+
+* This release has not introduced any new deprecation of a major feature or API.
+  However, there are some minor deprecations such as:
+
+  * YangStatementSourceImpl has been deprecated
+  * YinStatementSourceImpList has been deprecated
+  * some methods in DataTreeFactory have been deprecated
+
+Standards
+=========
+
+* YANG parser processing according to
+  `RFC 6020 <https://tools.ietf.org/html/rfc6020>`_ and
+  `RFC 7950 <https://tools.ietf.org/html/rfc7950>`_.
+
+Release Mechanics
+=================
+
+* `Link to the release plan <https://wiki.opendaylight.org/view/YANG_Tools:Carbon:Release_Plan>`_
diff --git a/docs/getting-started-guide/project-specific-guides/nemo.rst b/docs/getting-started-guide/project-specific-guides/nemo.rst
new file mode 100644 (file)
index 0000000..879131c
--- /dev/null
@@ -0,0 +1,86 @@
+======================
+NEtwork MOdeling(NEMO)
+======================
+
+Major Features
+==============
+
+
+* odl nemo rest provides an abstracted intent model whose target is to enable network users/applications to describe their intent in an intuitive way without caring about the underlying physical network.
+* nemo engine is the core module of NEMO project, which releases the mapping from intent to physical network. It includes two import process: intent-virtual network(VN) and virtual network-physical network(PN).
+* openflow renderer is a sourthbound render to translate the mapping result of VN-PN to flow table in devices supporting for openflow protocol.
+* cli render is also a sourthbound render to translate the mapping result of VN-PNinto forwarding table in devices supporting for traditional protocol.
+* nemo engine ui is reponsible for showing the status of physical network, intent, generated virtual network and mapping result of VN-PN, which facilitate users to understand better the intent handling process if they want to.
+
+NEMO Engine UI
+--------------
+
+* **Feature Name:** odl-nemo-engine-ui
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nemo.git;a=blob;f=nemo-features/src/main/features/features.xml;
+* **Feature Description:**  DSL based for the abstraction of network models and conclusion of operation patterns.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nemo/job/nemo-csit-1node-engine-all-carbon/
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * `NEMO User Guide <http://docs.opendaylight.org/en/latest/user-guide/nemo-user-guide.html>`_
+
+* **Developer Guide(s):**
+
+  * `NEMO Developer Guide <http://docs.opendaylight.org/en/latest/developer-guide/nemo-developer-guide.html>`_
+
+Security Considerations
+=======================
+
+* There are no security issues found.
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=53347>`_ 42.8%
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/nemo/job/nemo-csit-1node-engine-all-carbon/>`_
+* `Manual Tests <https://wiki.opendaylight.org/view/NEMO:Carbon:System_Test>`_
+* External System Test is done manually, since the sandbox environment could not satisfy NEMO's requirements.
+
+Migration
+---------
+
+* Nothing beyond general Carbon migration requirements. 
+
+Compatiblity
+------------
+
+* Nothing beyond general Carbon compatibility constraints. 
+
+Bugs Fixed
+----------
+
+* `Bug Report <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&bug_status=VERIFIED&list_id=47710&product=nemo&query_format=advanced&resolution=--->`_
+
+Known Issues
+------------
+
+
+* For using openflow-renderer, requiring special switch to construct physical network. The install guide is in https://github.com/zhangmroy?tab=repositories. Other virtual switch, such as, ovs, will be support in the Carbon version.
+* For using cli-renderer, the physical network should be constructed with HuaWei's device: NE40E. More devices will be considered in the Carbon version.
+
+End-of-life
+===========
+
+* Nothing deprecated, EOL. 
+
+Standards
+=========
+
+* N/A
+
+Release Mechanics
+=================
+
+* `NEMO Release Plan <https://wiki.opendaylight.org/view/NEMO:Carbon:Release_Plan>`_
+* Project was on schedule
index 93f8030803587e5af7839975ec9685979b33a5b7..9c732221727455ad35072c225098b8eb91b610e1 100644 (file)
@@ -1,3 +1,5 @@
+.. _opflex-agent-ovs-install-guide:
+
 OpFlex agent-ovs Install Guide
 ==============================
 
index dcb9f7c69cf0b4af32339935578046816c893466..3c0d04dcc71133f61b6ee55a953267d0af2453c9 100644 (file)
@@ -1,3 +1,5 @@
+.. _tsdr-install-guide:
+
 TSDR Installation Guide
 =======================
 
index 1d70f25fac7db9bec47f8119d6200ef54108a0dc..918fcaf30dc70f1401431f3676583dabc10ecb84 100644 (file)
@@ -1,3 +1,5 @@
+.. _vtn-install-guide:
+
 VTN Installation Guide
 ======================
 
index 21f1c68a007889b0813c88487644b6dc94d215da..70ac5ac7f4f2250ff3583ce6bb111168bd59483c 100644 (file)
@@ -1,3 +1,5 @@
+.. _security_considerations:
+
 ***********************
 Security Considerations
 ***********************
@@ -66,11 +68,13 @@ OpenDaylight Security Resources
 
 * For the list of current OpenDaylight security issues that are either being
   fixed or resolved, refer to
-  https://wiki.opendaylight.org/view/Security_Advisories.
+  https://wiki.opendaylight.org/view/Security:Advisories.
 
 * To learn more about the OpenDaylight security issues policies and procedure,
   refer to https://wiki.opendaylight.org/view/Security:Main
 
+.. _security_deployment_recommendations:
+
 Deployment Recommendations
 ==========================
 
index 303a0e08069062723b82919fd19f6170d93299e8..97ea60968943678d3a2421ab4f4117bcacf3942f 100644 (file)
@@ -1,3 +1,5 @@
+.. _vtn-openstack-dev-guide:
+
 OpenStack with Virtual Tenant Network
 =====================================
 
index ab5906cdae7cd795320bfbf357e7b12ba1b7cfff..f29f45ea9039119d06da0d66ab0267762a5c37e0 100644 (file)
@@ -26,92 +26,93 @@ Verify the distribution-karaf file with the signature.
 Releasing OpenDaylight
 ======================
 
-- Block submit permissions for registered users and elevate RE's committer rights on gerrit. **(Helpdesk)**
+- Block submit permissions for registered users and elevate RE's committer
+  rights on Gerrit.
+  **(Helpdesk)**
 
   .. figure:: images/gerrit-update-committer-rights.png
 
   .. note::
 
-     Enable **Exclusive** checkbox for the submit button to override any existing persmissions.
+     Enable **Exclusive** checkbox for the submit button to override any
+     existing persmissions. Code-Review and Verify permissions are only needed
+     during version bumping. DO NOT enable it during code freeze.
 
-- Export ${RELEASE} and ${BUILDNUM} with current release name and build number.
+- Nexus: click release for staging repo
+  **(Helpdesk)**
 
-  .. code-block:: bash
+- Nexus: click release for gpgsign repo (created above in Preparations)
+  **(Helpdesk)**
 
-     export RELEASE=Beryllium-SR4
-     export BRANCH=${RELEASE//-*}
-     export BUILDNUM=55
+- Pull latest autorelease repository
+  **(Release Engineering Team)**
 
-- Nexus: click release for staging repo **(Helpdesk)**
-- Nexus: click release for gpgsign repo (created above in Preparations) **(Helpdesk)**
-- Send email to Helpdesk with binary URL to update website **(Helpdesk)**
-- Send email to TSC and Release mailing lists announcing release binaries location **(Release Engineering Team)**
-- Clone autorelease repository. **(Release Engineering Team)**
+  .. note:: If you already cloned autorelease the clone line can be skipped below.
 
   .. code-block:: bash
 
       git clone --recursive https://git.opendaylight.org/gerrit/releng/autorelease
-
-- Checkout autorelease and switch to release branch eg stable/carbon **(Release Engineering Team)**
-
-  .. code-block:: bash
-
-      git checkout -b stable/${BRANCH,,} origin/stable/${BRANCH,,}
+      cd autorelease
       git submodule update --init
-      git submodule foreach git checkout -b stable/${BRANCH,,} origin/stable/${BRANCH,,}
-
-- Make sure your git repo is setup to push (use git-review)
-
-  .. code-block:: bash
-
       git review -s
       git submodule foreach 'git review -s'
 
-- Download patches (\*.bundle files and taglist.log.gz) from log server.
+- Make sure the latest lftools is installed
+  **(Release Engineering Team)**
+
+  .. note:: If you already created an lftools virtualenv you can skip the mkvirtualenv step below.
 
   .. code-block:: bash
 
-      mkdir /tmp/patches && cd /tmp/patches
-      wget https://logs.opendaylight.org/releng/jenkins092/autorelease-release-${BRANCH,,}/${BUILDNUM}/archives/all-bundles.tar.gz
-      gunzip all-bundles.tar.gz
-      wget https://logs.opendaylight.org/releng/jenkins092/autorelease-release-${BRANCH,,}/${BUILDNUM}/archives/patches/taglist.log.gz
-      gunzip taglist.log.gz
+      mkvirtualenv lftools
+      workon lftools
+      pip install --upgrade lftools
 
-- Run the following commands for every project in the release, to apply patches to each project directory.
+- Publish release tags
+  **(Release Engineering Team)**
 
   .. code-block:: bash
 
-      pip install lftools
-      lftools version patch ${RELEASE}
-      git review -y -t ${RELEASE}
-      git push gerrit release/${RELEASE,,}
+      export RELEASE=Beryllium-SR4
+      export STREAM=${RELEASE//-*}
+      export BUILD_NUM=55
+      export PATCH_URL="https://logs.opendaylight.org/releng/jenkins092/autorelease-release-${STREAM,,}/${BUILD_NUM}/archives/patches.tar.gz"
+      ./scripts/release-tags.sh "${RELEASE}" /tmp/patches "$PATCH_URL"
 
-- Merge all patches on gerrit in the order generated by merge-order.log
+- Run autorelease-version-bump-${STREAM} job
+  **(Release Engineering Team)**
 
-- Tag autorelease too
+- Send email to Helpdesk with binary URL to update website
+  **(Helpdesk)**
 
-  .. code-block:: bash
+- Send email to TSC and Release mailing lists announcing release binaries location
+  **(Release Engineering Team)**
 
-      git checkout `cat /tmp/patches/taglist.log | grep autorelease | awk '{print $2}'`
-      git submodule foreach git checkout release/${RELEASE,,}
-      git commit -asSm "Release ${RELEASE}"
-      git tag -asm "OpenDaylight ${RELEASE} release" release/${RELEASE,,}
-      git push gerrit release/${RELEASE,,}
+- Merge all patches generated by the job
+  **(Release Engineering Team)**
 
-- Re-enable submit permissions for registered users and disable elevated RE committer rights on gerrit.
+- Re-enable submit permissions for registered users and disable elevated RE
+  committer rights on gerrit
+  **(Helpdesk)**
 
-- Release notes is auto generated by job autorelease-generate-release-notes-${BRANCH,,}
-  triggered at the end of every autorelease build. The release notes file (release_notes.rst) is
-  available under archives.
+- Send email to release/tsc/dev notifying tagging and version bump complete
+  **(Release Engineering Team)**
 
-  Alternatively, release notes can also be manually generated with the script.
+- Run autorelease-generate-release-notes-${STREAM} job
   **(Release Engineering Team)**
 
+  This job is run a the end of every autorelease build can be used only for
+  service releases (SR). The release notes file (release_notes.rst) is available
+  under archives. For major releases (Nitrogen, Carbon) the docs repository has
+  to branched and published which is only done after release reviews are
+  completed.
+
+  Release notes can also be manually generated with the script.
+
   .. code-block:: bash
 
       git checkout stable/${BRANCH,,}
       cd scripts/release_notes_management/ && ./build.sh
 
-  The output file (release_notes.rst) generated by the build script is available under autorelease/scripts/release_notes_management/projects/.
-
-- Send email to release/tsc/dev notifying tagging and version bump complete **(Release Engineering Team)**
+  The output file (release_notes.rst) generated by the build script is available
+  under autorelease/scripts/release_notes_management/projects/.
index d62b55360adaa5a04b93e34c969ae269bb0b9f64..0ad6c9cf7ef475ec54ececc94a1c810f0b049306 160000 (submodule)
@@ -1 +1 @@
-Subproject commit d62b55360adaa5a04b93e34c969ae269bb0b9f64
+Subproject commit 0ad6c9cf7ef475ec54ececc94a1c810f0b049306
index 3b5773dbe9c201e2c6e736681603516c2431dfeb..bc3bcb560ffd019226d5b1947b01399400cbd015 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 3b5773dbe9c201e2c6e736681603516c2431dfeb
+Subproject commit bc3bcb560ffd019226d5b1947b01399400cbd015
index fe5a12c56420bd8b38990229de302520d80bb204..034aa1e0e39ab018a39b628a4b667c70823a71a4 160000 (submodule)
@@ -1 +1 @@
-Subproject commit fe5a12c56420bd8b38990229de302520d80bb204
+Subproject commit 034aa1e0e39ab018a39b628a4b667c70823a71a4
index d60bcc30f66befb84d9e3eeea0e8fc76960e6b12..f6f218e678efa332886f0bfcf65d7aabf4b0d135 160000 (submodule)
@@ -1 +1 @@
-Subproject commit d60bcc30f66befb84d9e3eeea0e8fc76960e6b12
+Subproject commit f6f218e678efa332886f0bfcf65d7aabf4b0d135
index e59ad39056b21ab857257358549702a8e17caa4a..04f91da97651e7339d4fb2bb07cba452d265cd9c 160000 (submodule)
@@ -1 +1 @@
-Subproject commit e59ad39056b21ab857257358549702a8e17caa4a
+Subproject commit 04f91da97651e7339d4fb2bb07cba452d265cd9c
index 56ff696904c1a0f1bd826a8cec2ae3896d1640ac..2a0238989f8e675dc142dc972864f93bc22777d7 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 56ff696904c1a0f1bd826a8cec2ae3896d1640ac
+Subproject commit 2a0238989f8e675dc142dc972864f93bc22777d7
index 9b2cc647306a24369a9de9b65c8883c48cba5ec5..b56ebae0e15096343cb3b13a02a26f7159c7384b 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 9b2cc647306a24369a9de9b65c8883c48cba5ec5
+Subproject commit b56ebae0e15096343cb3b13a02a26f7159c7384b
index 89e28719ffc133f82b9744168fdff5b18a77e45f..141ff24e0f0ab4f6b0cf10efcd6007d32efbff07 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 89e28719ffc133f82b9744168fdff5b18a77e45f
+Subproject commit 141ff24e0f0ab4f6b0cf10efcd6007d32efbff07
index e782d68c76feed9d4a5f0142c5c6b8d04f0db91c..beaa99a440ddb0bc3171d36d112f42367422a37b 160000 (submodule)
@@ -1 +1 @@
-Subproject commit e782d68c76feed9d4a5f0142c5c6b8d04f0db91c
+Subproject commit beaa99a440ddb0bc3171d36d112f42367422a37b
index 4a2f0ffb4dcf6730aabb233dc00c7c2cfbeae05b..57feadd2019907696adf15057e68e0e4f5ad182c 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 4a2f0ffb4dcf6730aabb233dc00c7c2cfbeae05b
+Subproject commit 57feadd2019907696adf15057e68e0e4f5ad182c
index 3afb35f6183164c7c80103d6a18ebbeb71318862..35a169b2784a6567c9dc43e77192c682d21d9b33 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 3afb35f6183164c7c80103d6a18ebbeb71318862
+Subproject commit 35a169b2784a6567c9dc43e77192c682d21d9b33
index ff4726911f21a329262cc5c11fbbcd7ca1f2b6ba..dded9e78e6b7a24dbfd48aab6c37ee022b786d24 100644 (file)
@@ -1,3 +1,5 @@
+.. _alto-user-guide
+
 ALTO User Guide
 ===============
 
@@ -302,4 +304,3 @@ Following is an example ALTO query:
       ]
       }
     }
-
index 32fcd71a4c117c75e7aa43acc314f3a8fcd10c31..a00bc151d45c3018a47cf2ebb881e88a5b14f480 100644 (file)
@@ -1,3 +1,5 @@
+.. _aaa-user-guide:
+
 Authentication, Authorization and Accounting (AAA) Services
 ===========================================================
 
index 581607dcac271ffde9b80e5c1abdd85e34021be4..cd8021dc9849d4491f3da38d1b659ad1bcd4123e 100644 (file)
@@ -1,3 +1,4 @@
+.. _bgp-monitoring-protocol-user-guide:
 BGP Monitoring Protocol User Guide
 ==================================
 This guide contains information on how to use the OpenDaylight BGP Monitoring Protocol (BMP) plugin.
index a85531538ae1383a1ab785a24c5992ef009c5697..e34fe297a1861aebd4e43d74b4a770ea16aeac9e 100644 (file)
@@ -1,3 +1,4 @@
+.. _bgp-user-guide:
 BGP User Guide
 ==============
 This guide contains information on how to use OpenDaylight Border Gateway Protocol (BGP) plugin.
index e1b78bfa7d4e1fc27fd647a103260402e5ce6fd8..4ed1fd20b71f420d3f06da503ec1196db6cef258 100644 (file)
@@ -1,3 +1,5 @@
+.. _bier-user-guide:
+
 BIER User Guide
 ===============
 
diff --git a/docs/user-guide/eman-user-guide.rst b/docs/user-guide/eman-user-guide.rst
new file mode 100644 (file)
index 0000000..e30e76b
--- /dev/null
@@ -0,0 +1,98 @@
+.. _eman-user-guide:
+
+eman User Guide
+===============
+
+Overview
+--------
+
+The OpenDaylight Energy Management (eman) plugin implements an abstract
+Information Model that describes energy measurement and control features
+that may be supported by a variety of device types. The eman plugin may
+support a number of southbound interfaces to accommodate a set of
+protocols, including but not limited to SNMP, NETCONF, IPDR. The plugin
+presents a northbound REST API. This framework enables any number of
+applications to interoperate with any number of devices in order to
+measure and optimize energy usage. The Information Model will be
+inherited from the `SCTE 216 standard – Adaptive Power Systems Interface
+Specification (APSIS)
+<http://www.scte.org/SCTEDocs/Standards/ANSI_SCTE%20216%202015.pdf>`_,
+which in turn inherits definitions within the `IETF eman document set
+<https://datatracker.ietf.org/wg/eman/documents/>`_.
+
+This documentation is directed to those operating the features such as
+network administrator, cloud administrator, network engineer, or system
+administrators.
+
+eman is composed of 3 Karaf features:
+    * ``eman`` incudes the YANG model and its implementation
+    * ``eman-api`` adds support for REST
+    * ``eman-ui`` adds support for DLUX.
+
+Developers will typically interface with ``eman-api``.
+
+eman Architecture
+-----------------
+
+``eman`` defines a YANG model that represents the IETF energy management
+Information Model, and includes RPCs. The implementation of the model
+currently supports an SNMP 'binding' via interfacing with the
+OpenDaylight SNMP module. In the future, other Southbound protocols may
+be supported.
+
+Developers my use the ``eman-api`` feature to read and write energy
+related data and commands to devices that support the IETF eman MIBS.
+
+Besides a set of common controller features eman depends upon the
+OpenDaylight SNMP features to be installed.
+
+Configuring eman
+----------------
+
+eman relies upon the presence of SNMP agents.
+
+The following describes a way to install and configure an SNMP simulator
+on localhost.
+
+on macOS, open terminal
+
+1. Install snmpsim.::
+
+    $ sudo easy_install -n snmpsim
+
+2. configure filesystem::
+
+    mkdir ~/.snmpsim, then mkdir ~/.snmpsim/data/
+
+3. Install moak data. This file is used by pysnmp to provide mock data
+   for an APSIS agent::
+
+    copy eman/sample_code/data/energy-object.snmprec to ~/.snmpsim/data/.
+
+4. launch snmp simulator::
+
+    $ sudo snmpsimd.py --agent-udpv4-endpoint=127.0.0.1:161
+        —process-group=<your group> —process-user=<your user>
+
+5. VerifyOpen another terminal window and execute::
+
+    $ snmpget -v2c -c energy-object localhost:161 1.3.6.1.2.1.229.0.1.0.
+
+   The result should be ‘1’, as defined in your snmprec file
+
+.. note::
+     group and user are settings within our local OS.
+     For Mac users, look at settings/users and groups.
+     If port 161 is not available, use another unprivileged port such as 1161.
+
+.. note::
+     snmpget queries snmpsimd to return a value for the OID 1.3.6.1.2.1.229.0.1.0.
+     According to the energy-object.snmprec file, the value for that OID is ‘1’.
+     Try other OIDs, or edit the snmprec file to see your results
+
+Future release may include more flexible and robust means to simulate
+a network of energy aware SNMP agents.
+
+Typically, a process may periodically poll a device to acquire power
+measurements and repose them into MD-SAL. Subsequently, process may read a
+history of power measurements from MD-SAL via the eman operational API.
index 74a0bbcccd1773b3efd5066e252271fa3e5264f4..cac7040029439d9206941f71d67294a01d933582 100644 (file)
@@ -1,3 +1,5 @@
+.. _faas_user_guide:
+
 Fabric As A Service
 ===================
 
index f0344a9f33534017d5f967f02c9aa3a27e822dff..c27ae2bda6f495b4329f2615eefcce84dbaf69ab 100644 (file)
@@ -1,3 +1,5 @@
+.. _gbp-user-guide:
+
 Group Based Policy User Guide
 =============================
 
index cb5d6a5a3400e9eab8ec820cac3f2985783a22b8..c1caaa5bd21ea0787780201ef99f597dfc84899b 100644 (file)
@@ -1,3 +1,5 @@
+.. _user_guide:
+
 OpenDaylight User Guide
 =======================
 
@@ -31,6 +33,7 @@ Project-specific User Guides
    cardinal_-opendaylight-monitoring-as-a-service
    centinel-user-guide
    didm-user-guide
+   eman-user-guide
    fabric-as-a-service
    genius-user-guide
    group-based-policy-user-guide
index 1cac8e8f6e74f8017874acedd0db010aee6f33db..381e9f9b3b3e5e6a072af58d011f5f23411f6b95 100644 (file)
@@ -1,3 +1,5 @@
+.. _l2switch-user-guide:
+
 L2 Switch User Guide
 ====================
 
index de5a03f16009a81211586137f9ee4e8b032cd7cd..1d7710909ba237cd6c110319c317ae04ebc6ce47 100644 (file)
@@ -1,3 +1,5 @@
+.. _lispflowmapping-user-guide:
+
 LISP Flow Mapping User Guide
 ============================
 
@@ -361,7 +363,8 @@ a client and two servers, then performing a failover between the two
 Prerequisites
 ^^^^^^^^^^^^^
 
--  **OpenDaylight Boron**
+-  **The OpenDaylight Karaf Distribution** (`download
+   <https://www.opendaylight.org/downloads>`_)
 
 .. _instructions:
 
@@ -374,7 +377,7 @@ Prerequisites
    file. You can import this file to Postman by clicking *Import* at the
    top, choosing *Download from link* and then entering the following
    URL:
-   `<https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob_plain;f=resources/tutorial/OOR/Beryllium_Tutorial.json.postman_collection;hb=refs/heads/stable/boron>`__.
+   `<https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob_plain;f=resources/tutorial/OOR/Beryllium_Tutorial.json.postman_collection;hb=refs/heads/stable/carbon>`__.
    Alternatively, you can save the file on your machine, or if you have
    the repository checked out, you can import from there. You will need
    to create a new Postman Environment and define some variables within:
@@ -421,11 +424,6 @@ The figure below gives a sketch of network topology that will be used in the tut
 In LISP terminology **client**, **server1** and **server2** are mobile nodes (MN in OOR),
 **controller** is a MS/MR and **service-node** is a RTR.
 
-.. note::
-
-    While the tutorial uses OOR as the data plane, it could be any
-    LISP-enabled hardware or software router (commercial/open source).
-
 Instructions
 ^^^^^^^^^^^^
 
@@ -433,8 +431,8 @@ The below steps use the command line tool cURL to talk to the LISP Flow
 Mapping RPC REST API. This is so that you can see the actual request
 URLs and body content on the page.
 
-1.  Install and run OpenDaylight Boron release on the controller VM.
-    Please follow the general OpenDaylight Boron Installation Guide
+1.  Install and run the OpenDaylight distribution on the controller VM.
+    Please follow the general OpenDaylight Installation Guide
     for this step. Once the OpenDaylight controller is running install
     the *odl-lispflowmapping-msmr* feature from the Karaf CLI:
 
@@ -476,13 +474,12 @@ URLs and body content on the page.
 
     .. note::
 
-        The ``resources/tutorial/OOR`` directory in the *stable/boron*
-        branch of the project git repository has the files used in the
-        tutorial `checked
-        in <https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=tree;f=resources/tutorial/OOR;hb=refs/heads/stable/boron>`__,
-        so you can just copy the files to ``/etc/oor.conf`` on the
-        respective VMs. You will also find the JSON files referenced
-        below in the same directory.
+        The ``resources/tutorial/OOR`` directory in the project git repository
+        has the files used in the tutorial `checked in
+        <https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=tree;f=resources/tutorial/OOR;hb=refs/heads/stable/carbon>`_,
+        so you can just copy the files to ``/etc/oor.conf`` on the respective
+        VMs. You will also find the JSON files referenced below in the same
+        directory.
 
 7.  Define a key and EID prefix association in OpenDaylight using the
     RPC REST API for the **client** EID (1.1.1.1/32) to allow
@@ -563,7 +560,7 @@ URLs and body content on the page.
 
     An alternative way for retrieving mappings from OpenDaylight using the
     southbound interface is using the
-    ```lig`` <https://github.com/davidmeyer/lig>`__ open source tool.
+    `lig <https://github.com/davidmeyer/lig>`__ open source tool.
 
 11. Register the EID-to-RLOC mapping of the server EID 2.2.2.2/32 to the
     controller, pointing to **server1** and **server2** with a higher
@@ -779,15 +776,16 @@ The steps shown below will demonstrate setting up a LISP network between
 a client and a server using VPP. We demonstrate how to use VPP lite to
 build a IP4 LISP overlay on an Ubuntu host using namespaces and af_packet
 interfaces. All configuration files used in the tutorials can be found
-`here <https://gerrit.fd.io/r/gitweb?p=one.git;a=tree;f=tutorial;hb=HEAD>`__.
+`here <https://gerrit.fd.io/r/gitweb?p=one.git;a=tree;f=tutorial>`__.
 
 Prerequisites
 ^^^^^^^^^^^^^
 
--  **OpenDaylight Boron**
+-  **The OpenDaylight Karaf Distribution** (`download
+   <https://www.opendaylight.org/downloads>`_)
 
 -  **The Postman Chrome App**: Please follow the instructions_ and import
-   postman collection from the following URL: `<https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob;f=resources/tutorial/FD_io/lfm_vpp.postman_collection.json;hb=HEAD>`__.
+   postman collection from the following URL: `<https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob;f=resources/tutorial/FD_io/lfm_vpp.postman_collection.json;hb=refs/heads/stable/carbon>`__.
 
 -  **Vagrant** (optional): Download it from `Vagrant website <https://www.vagrantup.com/downloads.html>`__
    and follow the setup instructions.
@@ -876,11 +874,11 @@ Follow the instructions below sequentially.
 
        sudo apt-get install bridge-utils ethtool
 
-6.  Now, install and run OpenDaylight Boron release on the VM. Please
-    follow the general OpenDaylight Boron Installation Guide for this
-    step from :ref:`install_odl`. Before running OpenDaylight, we need
-    to change the configuration for RTR to work. Update ``etc/custom.properties``
-    with the ``lisp.elpPolicy`` to be replace.
+6.  Now, install and run OpenDaylight on the VM. Please follow the general
+    OpenDaylight Installation Guide for this step from :ref:`install_odl`.
+    Before running OpenDaylight, we need to change the configuration for RTR
+    to work. Update ``etc/custom.properties`` with the ``lisp.elpPolicy`` to
+    be replace.
     ::
 
         lisp.elpPolicy = replace
@@ -901,7 +899,7 @@ Follow the instructions below sequentially.
 
 7.  For setting up VPP, get the files from ``resources/tutorial/FD_io``
     folder of the lispflowmapping repo. The files can also be found `here
-    <https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=tree;f=resources/tutorial/FD_io;hb=refs/heads/stable/boron>`__.
+    <https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=tree;f=resources/tutorial/FD_io;hb=refs/heads/stable/carbon>`__.
     Copy the ``vpp1.config``, ``vpp2.config`` and ``rtr.config`` files in
     ``/etc/vpp/lite/``.
 
@@ -1023,14 +1021,14 @@ Follow the instructions below sequentially.
         }
 
     The JSON files regarding these can be found in `here
-    <https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=tree;f=resources/tutorial/FD_io;hb=refs/heads/stable/boron>`__.
+    <https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=tree;f=resources/tutorial/FD_io;hb=refs/heads/stable/carbon>`__.
     Even though there is no southbound registration for mapping to OpenDaylight, using
     northbound policy we can specify mappings, when Client requests for
     the Server eid, Client gets a reply from OpenDaylight.
 
 9.  Assuming all files have been created and OpenDaylight has been configured as
     explained above, execute the host script you've created or the ``topology_setup.sh``
-    script from `here <https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=tree;f=resources/tutorial/FD_io;hb=refs/heads/stable/boron>`__.
+    script from `here <https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=tree;f=resources/tutorial/FD_io;hb=refs/heads/stable/carbon>`__.
 
 10. If all goes well, you can now test connectivity between the namespaces with:
     ::
@@ -1044,6 +1042,264 @@ Follow the instructions below sequentially.
 
             sudo ./topology_setup.sh clean
 
+Creating a LISP overlay with Cisco IOS-XE
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This section describes how to create a simple LISP overlay using the Cisco
+IOS-XE network operating system as the data plane software running on the
+`Cisco CSR 1000v Series Cloud Services Router
+<http://www.cisco.com/c/en/us/support/routers/cloud-services-router-1000v/model.html>`_.
+
+Prerequisites
+^^^^^^^^^^^^^
+
+-  **The OpenDaylight Karaf Distribution** (`download
+   <https://www.opendaylight.org/downloads>`_)
+
+-  **CSR1Kv image with Cisco IOS-XE version 03.13.00.S or later** (`download
+   <http://www.cisco.com/c/en/us/support/routers/cloud-services-router-1000v/model.html#~tab-downloads>`_;
+   the instructions have been tested on version 03.15.00.S).
+
+-  **A virtualization platform** supported by CSR1Kv images (VMware ESXi,
+   Citrix XenServer, KVM, and Microsoft Hyper-V).
+
+Target Environment
+^^^^^^^^^^^^^^^^^^
+
+The CSR1Kv images are configured with one management interface
+(``GigabitEthernet1``), and another interface (``GigabitEthernet2``) connected
+to a host-only network on the virtualization platform, while the LISP mapping
+system is assumed to be running in a Linux virtual machine, which has the
+``eth0`` interface in NAT mode to allow outside internet access and ``eth1``
+connected to the host-only network, with the following IP addresses (please
+adjust configuration files, JSON examples, etc.  accordingly if you’re using
+another addressing scheme):
+
++--------------------------+--------------------------+--------------------------+
+| Node                     | Node Type                | IP Address               |
++==========================+==========================+==========================+
+| **controller**           | OpenDaylight             | 192.168.16.11            |
++--------------------------+--------------------------+--------------------------+
+| **client**               | CSR1Kv                   | 192.168.16.30            |
++--------------------------+--------------------------+--------------------------+
+| **server**               | CSR1Kv                   | 192.168.16.31            |
++--------------------------+--------------------------+--------------------------+
+
+Table: Nodes in the tutorial
+
+The scenario and EID allocation is the same as the OOR scenario, except that
+there is no **server2** and **service-node** (for now).
+
+Before this tutorial can be followed, basic connectivity between the Linux VM
+and the CSRs should work on the host-only network.
+
+Instructions
+^^^^^^^^^^^^
+
+The below steps use the command line tool cURL to talk to the LISP Flow
+Mapping RPC REST API. This is so that you can see the actual request
+URLs and body content on the page. The easy way is to just use Postman.
+
+1.  Install and run the OpenDaylight distribution on the controller VM.
+    Please follow the general OpenDaylight Installation Guide from
+    :ref:`install_odl` for this step. Once the OpenDaylight controller is
+    running install the *odl-lispflowmapping-msmr* feature from the Karaf CLI:
+
+    ::
+
+        feature:install odl-lispflowmapping-msmr
+
+    It takes quite a while to load and initialize all features and their
+    dependencies. It’s worth running the command ``log:tail`` in the
+    Karaf console to see when the log output is winding down, and
+    continue with the tutorial after that.
+
+2.  Create the **client** and **server** VMs following the installation
+    instructions from the `CSR1Kv Configuration Guide
+    <http://www.cisco.com/c/en/us/td/docs/routers/csr1000/software/configuration/b_CSR1000v_Configuration_Guide.html>`_.
+
+3.  Define a key and EID prefix association in OpenDaylight using the RPC REST
+    API for the **client** and **server** EIDs (1.1.1.1/32 and 2.2.2.2/32
+    respectively) to allow registration from the southbound.  Run the below
+    command on the **controller** (or any machine that can reach
+    **controller**, by replacing *localhost* with the IP address of
+    **controller**).
+
+    ::
+
+        curl -u "admin":"admin" -H "Content-type: application/json" -X PUT \
+            http://localhost:8181/restconf/config/odl-mappingservice:mapping-database/virtual-network-identifier/0/authentication-key/ipv4:1.1.1.1%2f32/ \
+            --data @add-key.json
+
+    where the content of the *add-key.json* file is the following:
+
+    .. code:: json
+
+        {
+            "authentication-key": {
+                "eid-uri": "ipv4:1.1.1.1/32",
+                "eid": {
+                    "address-type": "ietf-lisp-address-types:ipv4-prefix-afi",
+                    "ipv4-prefix": "1.1.1.1/32"
+                },
+                "mapping-authkey": {
+                    "key-string": "password",
+                    "key-type": 1
+                }
+            }
+        }
+
+    The same should be done for 2.2.2.2/32 too.
+
+4.  Verify that the key is added properly by requesting the following
+    URL:
+
+    ::
+
+        curl -u "admin":"admin" -H "Content-type: application/json" -X GET \
+            http://localhost:8181/restconf/config/odl-mappingservice:mapping-database/virtual-network-identifier/0/authentication-key/ipv4:1.1.1.1%2f32/
+
+    The output the above invocation should look like this:
+
+    .. code:: json
+
+        {
+            "authentication-key":[
+                {
+                    "eid-uri":"ipv4:1.1.1.1/32",
+                    "eid":{
+                        "ipv4-prefix":"1.1.1.1/32",
+                        "address-type":"ietf-lisp-address-types:ipv4-prefix-afi"
+                    },
+                    "mapping-authkey":{
+                        "key-string":"password"
+                        ,"key-type":1
+                    }
+                }
+            ]
+        }
+
+5.  Configure the CSR installations from the previous step. The EID needs to
+    be configured on a loopback interface (except when the CSR is used as a
+    router not a simple client like in this tutorial and the EID is assigned
+    to a real interface).
+
+    ::
+
+        interface Loopback0
+         ip address 1.1.1.1 255.255.255.255
+
+6.  The LISP specific configuration goes to a ``router lisp`` section in the
+    configuration. A ``locator-set`` defines the list of locators with their
+    priorities and weights, either statically, or better yet, as an interface
+    name:
+
+    ::
+
+        locator-set rloc-network
+         IPv4-interface GigabitEthernet2 priority 1 weight 1
+         exit
+
+7.  To make sure a Map-Request is using the above defined ``rloc-network``
+    locator set, the following configuration is used:
+
+    ::
+
+        map-request itr-rlocs rloc-network
+
+8.  Each Instance ID needs its own configuration. For the default Instance ID
+    of 0, the following configuration is needed for a besic setup:
+
+    ::
+
+        eid-table default instance-id 0
+         database-mapping 1.1.1.1/32 locator-set rloc-network
+         map-cache 0.0.0.0/0 map-request
+         no ipv4 map-cache-persistent
+         ipv4 itr map-resolver 192.168.16.11
+         ipv4 itr
+         ipv4 etr map-server 192.168.16.11 key password
+         ipv4 etr
+         exit
+
+    ``database-mapping`` defines the EID prefix the router will register in
+    the mapping system and which locator set it will use (``rloc-network`` in
+    this case, which was defined in step 6).
+
+    The next line creates a static map-cache entry for the whole IPv4 EID
+    space, causing a Map-Request to be triggered for every destination (that
+    is not directly connected on some interface).
+
+    LISP routers save their map cache to a fie which is used to restore
+    previous state on reboot. To avoid confusion due to state restored from a
+    previous run, ``no ipv4 map-cache-persistent`` can be used to disable this
+    behavior for non-production testing environments.
+
+    A ``map-resolver`` is then defined, where Map-Requests will be directed to
+    for mapping lookups, and then a ``map-server`` association with a shared
+    secret key.
+
+9.  Here's the full configuration that needs to be pasted into the
+    configuration of the **client** to follow this tutorial:
+
+    ::
+
+        interface Loopback0
+         ip address 1.1.1.1 255.255.255.255
+        !
+        router lisp
+         locator-set rloc-network
+          IPv4-interface GigabitEthernet2 priority 1 weight 1
+          exit
+         !
+         map-request itr-rlocs rloc-network
+         eid-table default instance-id 0
+          database-mapping 1.1.1.1/32 locator-set rloc-network
+          map-cache 0.0.0.0/0 map-request
+          no ipv4 map-cache-persistent
+          ipv4 itr map-resolver 192.168.16.11
+          ipv4 itr
+          ipv4 etr map-server 192.168.16.11 key password
+          ipv4 etr
+          exit
+         !
+         exit
+
+    Configuring the **server** is done by replacing ``1.1.1.1`` with
+    ``2.2.2.2`` in the above configuration snippet.
+
+10. The CSR nodes should now register their EID-to-RLOC mappings to
+    OpenDaylight. To verify, the corresponding EIDs can be looked up via the
+    REST API:
+
+    ::
+
+        curl -u "admin":"admin" -H "Content-type: application/json" -X GET \
+            http://localhost:8181/restconf/operational/odl-mappingservice:mapping-database/virtual-network-identifier/0/mapping/ipv4:1.1.1.1%2f32/southbound/
+
+    An alternative way for retrieving mappings from OpenDaylight using the
+    southbound interface is using the
+    `lig <https://github.com/davidmeyer/lig>`_ open source tool.
+
+    Yet another different way is to use the OpenDaylight mappingservice CLI,
+    and type the following at the Karaf prompt:
+
+    ::
+
+        mappingservice:mappings
+
+    This needs the *odl-lispflowmapping-mappingservice-shell* feature to be
+    loaded. The output is intended for debugging purposes and shows the full
+    Java objects stored in the map-cache.
+
+
+11. Now the LISP network is up. It can be verified by pinging the **server**
+    EID from the **client** CSR EID:
+
+    ::
+
+        ping 2.2.2.2 source 1.1.1.1
+
 LISP Flow Mapping Support
 -------------------------
 
index 234b010510f76d503ecc23b54abac482dbf9a5e5..06de306ceefcd5b6cca7900af5dcf272120a6bd7 100644 (file)
@@ -1,3 +1,5 @@
+.. _nic-user-guide:
+
 Network Intent Composition (NIC) User Guide
 ===========================================
 
index 91681c0c3f1908058d839d8b5bdd422cb7316ae4..a01d91344c902dc4c239f142b99d67edced244c4 100644 (file)
@@ -1,3 +1,5 @@
+.. neutron-service-user-guide:
+
 Neutron Service User Guide
 ==========================
 
index 2b491933edf12fbc1fc8c7fc7a509827602e01fa..e6b83f5bd38d4a5f3c9e5dcbdd6ef9a7e2282ec2 100644 (file)
@@ -1,3 +1,5 @@
+.. _ocpplugin-user-guide:
+
 OCP Plugin User Guide
 =====================
 
@@ -295,4 +297,3 @@ the form of both northbound and southbound APIs, including:
 
 The API is documented in the OCP Plugin Developer Guide under the
 section Southbound API and Northbound API, respectively.
-
index 0337322f9e5bb3e2dc0211953f06c1b628b43f76..d7212fc4e9f0c1d2d188ee513868cc4c92fed14e 100644 (file)
@@ -1,3 +1,5 @@
+.. _opflex-agent-ovs-user-guide:
+
 OpFlex agent-ovs User Guide
 ===========================
 
index 8e5d21c2eb2294b83e5530380a9dcfef852e105f..8cba92ecc27a7696656486b85649c4f740f8f6f9 100644 (file)
@@ -1,3 +1,4 @@
+.. _pcep-user-guide:
 PCEP User Guide
 ===============
 This guide contains information on how to use the OpenDaylight Path Computation Element Configuration Protocol (PCEP) plugin.
index c633e7dd7d75eeba6a2a7a2f7facf534a2dde138..abe6ba73a7f1731d859c8814c7751e2c7d6a2d12 100644 (file)
@@ -1,3 +1,5 @@
+.. _sfc-user-guide:
+
 Service Function Chaining
 =========================
 
index cb6fd6eea15da6fcdc8660a9d2006e3e135e0174..6a4d220fa9da29ee7a79ac50b008c2694267c527 100644 (file)
@@ -1,3 +1,5 @@
+.. _snmp4sdn-user-guide:
+
 SNMP4SDN User Guide
 ===================
 
@@ -627,4 +629,3 @@ Help
 -  Latest
    `troubleshooting <https://wiki.opendaylight.org/view/SNMP4SDN:User_Guide#Troubleshooting>`__
    in Wiki
-
index 5fe3345aabfee134781ce8decf1d21935a011adc..2d06d3f6a72be6c067300fc695ed09883306d452 100644 (file)
@@ -1,3 +1,5 @@
+.. _tsdr-user-guide:
+
 TSDR User Guide
 ===============
 
index 08583a74bc63c9456c4c5abba719e07c108716cc..e5efc1063a073099b8da6a3319e30b3ec328a669 100644 (file)
@@ -1,3 +1,5 @@
+.. _ttp_cli_tools_user_guide:
+
 TTP CLI Tools User Guide
 ========================
 
index ecf2bad2593e3ad213aaf418cded748c39b213da..602e71bdfabc85641794e14a8c72082ed684e33d 100644 (file)
@@ -1,3 +1,5 @@
+.. _vtn-user-guide:
+
 Virtual Tenant Network (VTN)
 ============================
 
@@ -4720,4 +4722,3 @@ SCVMM User Guide
 
    -  OpenDaylight Congestion Control with SCVMM VTN:
       https://youtu.be/34YMOTzbNJM
-
diff --git a/tox.ini b/tox.ini
index 637759701f21e5142fb5d877261722bbfd0d6159..ba046a16d88bf33ff970123e44f9e8d6fa7374c0 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -6,8 +6,10 @@ skipsdist = true
 [testenv:coala]
 basepython = python3
 deps =
-    coala
-    coala-bears
+    coala==0.11
+    coala-bears==0.11
+    # Requests 2.16 breaks coala dependency on chardet
+    requests<2.16
     nodeenv
 commands =
     nodeenv -p
old mode 100644 (file)
new mode 100755 (executable)
index a7b76b1..9fc7ede
@@ -446,6 +446,170 @@ curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendayl
 curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-07-21-17.00.log.html
 curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-07-21-17.00.log.txt
 curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-07-21-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-07-28-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-07-28-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-07-28-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-07-28-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-07-28-17.40.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-07-28-17.40.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-07-28-17.40.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-07-28-17.40.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-04-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-04-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-04-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-04-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-11-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-11-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-11-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-11-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-18-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-18-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-18-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-18-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-25-16.59.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-25-16.59.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-25-16.59.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-08-25-16.59.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-01-17.02.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-01-17.02.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-01-17.02.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-01-17.02.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-08-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-08-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-08-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-08-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-15-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-15-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-15-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-15-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-22-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-22-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-22-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-09-22-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-10-13-17.01.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-10-13-17.01.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-10-13-17.01.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-10-13-17.01.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-10-20-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-10-20-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-10-20-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-10-20-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-10-27-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-10-27-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-10-27-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-10-27-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-03-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-03-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-03-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-03-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-10-15.29.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-10-15.29.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-10-15.29.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-10-15.29.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-10-18.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-10-18.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-10-18.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-10-18.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-17-18.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-17-18.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-17-18.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-11-17-18.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-01-18.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-01-18.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-01-18.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-01-18.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-08-18.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-08-18.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-08-18.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-08-18.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-15-18.01.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-15-18.01.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-15-18.01.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-15-18.01.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-23-04.30.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-23-04.30.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-23-04.30.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2016/tsc/opendaylight-meeting-tsc.2016-12-23-04.30.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-05-18.04.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-05-18.04.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-05-18.04.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-05-18.04.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-12-18.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-12-18.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-12-18.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-12-18.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-19-18.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-19-18.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-19-18.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-19-18.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-26-18.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-26-18.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-26-18.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-01-26-18.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-02-02-18.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-02-02-18.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-02-02-18.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-02-02-18.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-02-09-18.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-02-09-18.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-02-09-18.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-02-09-18.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-02-24-04.34.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-02-24-04.34.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-02-24-04.34.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-02-24-04.34.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-02-18.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-02-18.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-02-18.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-02-18.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-09-17.59.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-09-17.59.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-09-17.59.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-09-17.59.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-16-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-16-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-16-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-16-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-24-03.30.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-24-03.30.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-24-03.30.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-24-03.30.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-27-17.17.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-27-17.17.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-27-17.17.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-27-17.17.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-30-17.03.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-30-17.03.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-30-17.03.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-03-30-17.03.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-04-13-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-04-13-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-04-13-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-04-13-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-04-20-17.01.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-04-20-17.01.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-04-20-17.01.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-04-20-17.01.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-04-28-03.30.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-04-28-03.30.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-04-28-03.30.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-04-28-03.30.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-04-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-04-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-04-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-04-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-11-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-11-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-11-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-11-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-18-17.00.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-18-17.00.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-18-17.00.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-18-17.00.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-26-03.30.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-26-03.30.log.html
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-26-03.30.log.txt
+curl -O https://meetings.opendaylight.org/opendaylight-meeting/2017/tsc/opendaylight-meeting-tsc.2017-05-26-03.30.txt
 curl -O https://wiki.opendaylight.org/images/0/0f/TSC_2013-05-16_Minutes.pdf
 curl -O https://wiki.opendaylight.org/images/1/16/TSC_2013-06-13_Minutes.pdf
 curl -O https://wiki.opendaylight.org/images/2/22/TSC_2013-10-03_Minutes.pdf