+.. _alto-developer-guide
+
ALTO Developer Guide
====================
If necessary, you can add a northbound route module in
``alto-core/standard-northbound-routes``.
-
--- /dev/null
+.. _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
+.. _developer_guide:
+
Developer Guide
===============
didm-developer-guide
distribution-version
dlux
+ eman-developer-guide
fabric-as-a-service
infrautils-developer-guide
iotdm-developer-guide
+.. _odl-parent-developer-guide:
+
ODL Parent Developer Guide
==========================
- ``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
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 4 features:
- ``karaf-maven-plugin`` is activated, to build Karaf features, typically
with “feature” packaging (“kar” is also supported);
~~~~~~~~~~~~~~~~~~~
This inherits from ``odlparent`` and enables functionality useful for
-Karaf feature repositories. It follows the same principles as
+Karaf 4 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.
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 3 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
</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).
+.. _yangtools-developer-guide:
+
YANG Tools Developer Guide
==========================
+.. _getting_started_guide:
+
#####################
Getting Started Guide
#####################
--- /dev/null
+=============================================
+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
--- /dev/null
+==========
+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>`_
--- /dev/null
+=============
+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.
--- /dev/null
+====
+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
--- /dev/null
+=====
+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 more actual developers documentation can be found in source code as README files.
+
+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>`_
--- /dev/null
+==========
+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.
--- /dev/null
+============
+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):**
+
+ * `developer guide <https://git.opendaylight.org/gerrit/gitweb?p=docs.git;a=blob;f=docs/developer-guide/openflow-protocol-library-developer-guide.rst;h=37a8fcd85f0a2111ae59a7e2e74d60cd3ce5e110;hb=refs/heads/master>`_
+
+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>`_
--- /dev/null
+======================
+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>`_
When copying, please remove this entire "About this Document" section and
simply fill out the next sections.
+.. important::
+
+ Please do not remove any sections. Also, short sentences are better than
+ "n/a" or "none" as it is often confusing as to whether that means there are
+ no issues or you simply didn't think about or address anything.
+
============
Project Name
============
==============
For each top-level feature, identify the name, url, description, etc.
-User-facing features are used directly by end users.
+User-facing features are used directly by end users. Remove this paragraph.
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):**
- * `Guide Name <URL>`_
+ * Link to Guide. Should be formatted something like::
+
+ :ref:`Guide name <guide-label-name>`
+
+ Where the <guide-label-name> is something like::
+
+ .. _guide-label-name:
+
+ Project User Guide
+ ==================
+ ....
+
+ As described in `Cross-referencing arbitrary locations
+ <http://www.sphinx-doc.org/en/stable/markup/inline.html#cross-referencing-arbitrary-locations>`_.
* **Developer Guide(s):**
- * `Guide Name <URL>`_
+ * Link to Guide. Use same format as above.
Security Considerations
=======================
* Is is possible migrate from the previous release? If so, how?
-Compatiblity
-------------
+.. note:: This is asking if somebody can move from an installation of the
+ previous release while keeping data. This isn't currently, natively
+ supported in Opendaylight, so if it's possible, it is because of
+ some project-speicific work and instructions which should be
+ explained here. Remove this note.
+
+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
----------
+.. Please include a short description of any bugs not just the link.
+
* List of bugs fixed since the previous release
Known Issues
------------
+.. Please include a short description of any bugs not just the link.
+
* List key known issues with workarounds
* `Link to Open Bugs <URL>`_
* `Link to release plan <URL>`_
* Describe any major shifts in release schedule from the release plan
-.. note::
-
- We will also ask about your testing of the latest SR, but that should
- probably not formally be part of this document.
+.. note:: We will also ask about your testing of the latest SR, but that should
+ probably not formally be part of this document. Remove this note.
--- /dev/null
+============
+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>`_
--- /dev/null
+==========
+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>`_
--- /dev/null
+======================
+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
-Subproject commit 80a80017fcc372c3e6d3191f1054a0091587eac4
+Subproject commit fe5a12c56420bd8b38990229de302520d80bb204
-Subproject commit d60bcc30f66befb84d9e3eeea0e8fc76960e6b12
+Subproject commit f9cea84e41d5c539fcd697ff52633081732977b4
-Subproject commit e59ad39056b21ab857257358549702a8e17caa4a
+Subproject commit 33940ceeb5cd308d11ded76eff2feb38b8ecbb7a
-Subproject commit 107974017bc4b1004e8e670c4fdf7ba90ef4058a
+Subproject commit 06956dcd01d066e2d99e7ef867b081428d69971c
-Subproject commit 9b2cc647306a24369a9de9b65c8883c48cba5ec5
+Subproject commit ea3b5b7f786463fbf264673b34fc01a154e1698b
-Subproject commit b3bed41ee9ee2613e280edd8d8fb3b1bf0a61810
+Subproject commit 89e28719ffc133f82b9744168fdff5b18a77e45f
-Subproject commit fd025133d48ba38490623b0a76bf405fee2a86ea
+Subproject commit 7bee3600fcfc05cb1435563a6ef5ebbbaa5d2f27
-Subproject commit 4a2f0ffb4dcf6730aabb233dc00c7c2cfbeae05b
+Subproject commit 57feadd2019907696adf15057e68e0e4f5ad182c
-Subproject commit 26ef0bed9a58e6d99dca9b6f1e1abd724131be88
+Subproject commit 42d935b040cba9d447948454b0baeff712c7797d
+.. _alto-user-guide
+
ALTO User Guide
===============
]
}
}
-
--- /dev/null
+.. _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 MAC OS, open terminal
+
+1. Install snmpsim.::
+
+ $ sudo apt install 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.
+.. _user_guide:
+
OpenDaylight User Guide
=======================
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
[testenv:coala]
basepython = python3
deps =
- coala
+ coala<0.11
coala-bears
nodeenv
commands =
Code Review / docs.git / commitdiff