-============
- AAA
-============
+===
+AAA
+===
Overview
========
-AAA stands for Authentication, Authorization, and Accounting. All three of
-these services can help improve the security posture of an OpenDaylight deployment.
+AAA (Authentication, Authorization, and Accounting) are services that
+help improve the security posture of an OpenDaylight deployment. By
+default, the majority of OpenDaylight's northbound APIs (and all RESTCONF
+APIs) are protected by AAA after installing the +odl-restconf+ feature.
+When an API is *not* protected by AAA, it will be noted in the release notes.
-The vast majority of OpenDaylight's northbound APIs (and all RESTCONF APIs) are
-protected by AAA by default when installing the +odl-restconf+ feature. In the
-cases that APIs are *not* protected by AAA, this will be noted in the
-per-project release notes.
+Major Features
+==============
-Behavior Changes
-================
+odl-aaa-shiro
+-------------
-* Eliminate the Oauth2 Provider Implementation that was based on Apache Oltu.
- `AAA-173 <https://https://jira.opendaylight.org/browse/AAA-173>`_: https://jira.opendaylight.org/browse/AAA-173
+* Feature URL: `ODL Shiro <https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob_plain;f=features/odl-aaa-shiro/pom.xml;hb=refs/heads/stable/sodium>`_
+* Feature Description: ODL Shiro-based AAA implementation
+* Top Level: Yes
+* User Facing: Yes
+* Experimental: Yes
+* CSIT Test: `CSIT <https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-csit-1node-authn-all-sodium/>`_
-New and Modified Features
-=========================
+odl-aaa-cert
+------------
-* N/A
+* Feature URL: `ODL Cert <https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob_plain;f=features/odl-aaa-cert/pom.xml;hb=refs/heads/stable/sodium>`_
+* Feature Description: MD-SAL based encrypted certificate management
+* Top Level: Yes
+* User Facing: Yes
+* Experimental: Yes
+* CSIT Test: `CSIT <https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-csit-1node-authn-all-sodium/>`_
-Deprecated Features
-===================
+odl-aaa-cli
+-----------
-* N/A
+* Feature URL: `ODL CLI <https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob_plain;f=features/odl-aaa-cli/pom.xml;hb=refs/heads/stable/sodium>`_
+* Feature Description: Basic karaf CLI commands for interacting with AAA
+* Top Level: Yes
+* User Facing: Yes
+* Experimental: Yes
+* CSIT Test: `CSIT <https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-csit-1node-authn-all-sodium/>`_
+
+Documentation
+=============
+
+* **User Guide**
+
+ * `Authentication, Authorization and Accounting (AAA) Services <https://docs.opendaylight.org/en/stable-oxygen/user-guide/authentication-and-authorization-services.html#aaa-user-guide>`_
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+ * No
+
+* Other security issues?
+
+ * No
+
+Quality Assurance
+=================
+
+* `Sonar Report <https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-sonar/>`_
+* `CSIT Jobs <https://jenkins.opendaylight.org/releng/view/aaa/>`_
+
+Migration
+=========
+
+* Is it possible to migrate from the previous release? If so, how?
+
+ * Yes, no specific steps needed.
+
+Compatibility
+=============
+
+* Is this release compatible with the previous release?
-Resolved Issues
-===============
+ * Yes
+
+* Any API changes?
+
+ * No
+
+* Any configuration changes?
+
+ * No
+
+Behavior Changes
+================
+
+.. list-table::
+ :widths: 15 55
+ :header-rows: 1
+
+ * - **Bug ID**
+ - **Description**
+
+ * - `AAA-173 <https://jira.opendaylight.org/browse/AAA-173>`_
+ - Eliminate the Oauth2 Provider Implementation that was based on Apache Oltu.
+
+Bug Fixes
+=========
* `Closed Bugs <https://jira.opendaylight.org/browse/AAA-185?jql=project%20%3D%20aaa%20AND%20type%20%3D%20Bug%20AND%20status%20%3D%20Resolved%20%20AND%20fixVersion%20%3D%20Sodium%20>`_
Known Issues
============
-* `Open Bugs <https://jira.opendaylight.org/browse/AAA-186?jql=project%20%3D%20aaa%20AND%20type%20%3D%20Bug%20AND%20status%20in%20(Confirmed%2C%20"In%20Progress"%2C%20Open)>`_
+* `Open Bugs <https://jira.opendaylight.org/browse/AAA-185?jql=project%20%3D%20aaa%20AND%20type%20%3D%20Bug%20AND%20status%20%3D%20Resolved%20%20AND%20fixVersion%20%3D%20Sodium%20>`_
+
+End-of-life
+===========
+
+* List of features/APIs that were EOLed, deprecated, and/or removed from this release.
+
+ * None
+
+Standards
+=========
+
+* List of standards implemented and to what extent.
+
+ * N/A
+
+Release Mechanics
+=================
+
+* N/A
-============
-BGPCEP
-============
+===========
+BGP LS PCEP
+===========
-Overview
-========
+BGP Plugin
+==========
-The OpenDaylight controller provides an implementation of BGP (RFC 4271) as a south-bound protocol plugin.
-The implementation renders all basic *BGP speaker capabilities*:
+The OpenDaylight controller provides an implementation of BGP
+(Border Gateway Protocol), which is based on `RFC 4271 <https://tools.ietf.org/html/rfc4271>`_)
+as a south-bound protocol plugin. The implementation renders all
+basic *BGP speaker capabilities*, including:
* inter/intra-AS peering
* routes advertising
* read-write programmable RIBs
* read-only reachability/linkstate topology view
-|
-
-The OpenDaylight PCEP plugin provides all basic service units necessary to build-up a PCE-based controller.
-In addition, it offers LSP management functionality for Active Stateful PCE - the cornerstone for majority of PCE-enabled SDN solutions.
-It consists of the following components:
+PCEP Plugin
+===========
+The OpenDaylight Path Computation Element Communication Protocol (PCEP)
+plugin provides all basic service units necessary to build-up a
+PCE-based controller. Defined by `rfc8231 <https://tools.ietf.org/html/rfc8231>`_,
+PCEP offers LSP management functionality for Active Stateful PCE, which is
+the cornerstone for majority of PCE-enabled SDN solutions. It consists of
+the following components:
* Protocol library
* PCEP session handling
* Stateful PCE LSP-DB
* Active Stateful PCE LSP Operations
-Behavior Changes
-================
+Major Features
+==============
+
+odl-bgpcep-bgp
+--------------
+
+* Feature URL: `BGPCEP BGP <https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/bgp/features-bgp/pom.xml;h=f5acb8c44359fb258ef3b22c00269e48a091b7ee;hb=refs/heads/stable/sodium>`_
+* Feature Description: OpenDaylight Border Gateway Protocol (BGP) plugin.
+* Top Level: Yes
+* User Facing: Yes
+* Experimental: No
+* CSIT Test: `CSIT <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-userfeatures-all-sodium>`_
+
+odl-bgpcep-bmp
+--------------
+
+* Feature URL: `BGPCEP BMP <https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/bmp/features-bmp/pom.xml;h=6b195866c508ea053ecec4445973467b31aa7bfe;hb=refs/heads/stable/sodium>`_
+* Feature Description: OpenDaylight BGP Monitoring Protocol (BMP) plugin.
+* Top Level: Yes
+* User Facing: Yes
+* Experimental: No
+* CSIT Test: `CSIT <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-userfeatures-all-sodium>`_
+
+odl-bgpcep-pcep
+---------------
+
+* Feature URL: `BGPCEP PCEP <https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=tree;f=features/pcep/features-pcep;h=252a957bf6b8549ad53cedb45bbd76dca9ba7cb5;hb=refs/heads/stable/sodium>`_
+* Feature Description: OpenDaylight Path Computation Element Configuration Protocol (PCEP) plugin.
+* Top Level: Yes
+* User Facing: Yes
+* Experimental: No
+* CSIT Test: `CSIT <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-userfeatures-all-sodium>`_
+
+Documentation
+=============
+
+User Guide(s):
+--------------
* N/A
+.. * `BGP User Guide <https://docs.opendaylight.org/en/stable-sodium/user-guide/bgpcep-guide/bgp/index.html#bgp-user-guide>`_
+.. * `BGP Monitoring Protocol User Guide <https://docs.opendaylight.org/en/stable-sodium/user-guide/bgpcep-guide/bmp/index.html#bgp-monitoring-protocol-user-guide>`_
+.. * `PCEP User Guide <https://docs.opendaylight.org/en/stable-sodium/user-guide/bgpcep-guide/pcep/index.html#pcep-user-guide>`_
+
+Developer Guide(s):
+-------------------
+
+* N/A
+
+.. * `BGP Developer Guide <https://docs.opendaylight.org/en/stable-sodium/user-guide/bgpcep-guide/bgp/index.html#bgp-user-guide>`_
+.. * `BGP Monitoring Protocol Developer Guide <https://docs.opendaylight.org/en/stable-sodium/user-guide/bgpcep-guide/bmp/index.html#bgp-monitoring-protocol-user-guide>`_
+.. * `PCEP Developer Guide <https://docs.opendaylight.org/en/stable-sodium/user-guide/bgpcep-guide/pcep/index.html#pcep-user-guide>`_
+
+Security Considerations
+=======================
+
+* None Known: All protocol implements the TCP Authentication Option (TCP MD5)
+
+Quality Assurance
+=================
+
+* `Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.bgpcep%3Abgpcep-aggregator>`_ (72.4%)
+* `CSIT Jobs <https://jenkins.opendaylight.org/releng/view/bgpcep/>`_
+* `User features test <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-gate-userfeatures-all-sodium/>`_
+
+.. * `PCEP performance and scale tests <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-throughpcep-only-sodium/>`_
+.. * `BGP Application peer performance and scale tests <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-throughpcep-all-sodium/>`_
+.. * `BGP performance and scale test <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-1node-periodic-bgp-ingest-mixed-all-sodium/>`_
+.. * `BGP clustering <https://jenkins.opendaylight.org/releng/view/bgpcep/job/bgpcep-csit-3node-periodic-bgpclustering-ha-only-sodium/>`_
+
+The BGP extensions were tested manually with a vendor’s BGP router
+implementation or other software implementations (exaBGP, bagpipeBGP).
+Also, they are covered by the unit tests and automated system tests.
+
+Migration
+=========
+
+No additional migration steps needed.
+
+Compatibility
+=============
+
+* Is this release compatible with the previous release?
+
+ * Yes
+
+* Any API changes?
+
+ * No
+
+* Any configuration changes?
+
+ * BGP CSS configuration is not longer supported. BMP CSS configuration is
+ not longer supported. PCEP CSS configuration is not longer supported.
+
+
New and Modified Features
=========================
* `BGPCEP-871 <https://jira.opendaylight.org/browse/BGPCEP-871>`_: RPC to provide PCEP session statistics
* `BGPCEP-868 <https://jira.opendaylight.org/browse/BGPCEP-868>`_: Support for draft-ietf-idr-ext-opt-param
-Deprecated Features
-===================
-* N/A
-
-Resolved Issues
-===============
+Bug Fixes
+=========
* `Closed Bugs <https://jira.opendaylight.org/browse/BGPCEP-877?jql=project%20%3D%20BGPCEP%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20(Resolved%2C%20Verified)%20AND%20fixVersion%20%3D%20Sodium>`_
============
* `Open Bugs <https://jira.opendaylight.org/browse/BGPCEP-880?jql=project%20%3D%20BGPCEP%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20(Open%2C%20"In%20Progress"%2C%20"In%20Review"%2C%20Confirmed)>`_
+
+End-of-life
+===========
+
+* BGP CSS Configuration.
+* PCEP CSS Configuration.
+* BMP CSS Configuration.
+
+Standards
+=========
+
+* N/A
+
+.. * `BGP Supported Capabilities <https://docs.opendaylight.org/en/stable-sodium/user-guide/bgpcep-guide/bgp/bgp-user-guide-supported-capabilities.html#bgp-user-guide-supported-capabilities>`_
+.. * `PCEP Supported Capabilities <https://docs.opendaylight.org/en/stable-sodium/user-guide/bgpcep-guide/pcep/pcep-user-guide-supported-capabilities.html#pcep-user-guide-supported-capabilities>`_
+.. * `BGP Monitoring Protocol Supported Capabilities <https://docs.opendaylight.org/en/stable-sodium/user-guide/bgpcep-guide/bmp/bgp-monitoring-protocol-user-guide-supported-capabilities.html#bgp-monitoring-protocol-user-guide-supported-capabilities>`_
+
+Release Mechanics
+=================
+
+* `Release plan <https://wiki.opendaylight.org/view/BGP_LS_PCEP:Sodium_Release_Plan>`_
-
-======
-DAEXIM
-======
+==================
+Data Export/Import
+==================
Overview
========
-DAEXIM or Data Export/Import feature allows OpenDaylight administrators
+Data Export/Import (Daexim) feature allows OpenDaylight administrators
to export the current system state to the file system or to import the
state from the file system.
+Major Features
+==============
-Behavior Changes
-================
-
-DAEXIM is a mature feature. No behavior changes were introduced in this
-release.
-
-
-New and Modified Features
-=========================
-
-This release provides the following new and modified features:
+This release provides the following features:
-* **Feature URL:** `DAEXIM Feature <https://git.opendaylight.org/gerrit/gitweb?p=daexim.git;a=blob;f=features/odl-daexim/src/main/feature/feature.xml;hb=refs/heads/stable/sodium>`_
+* **Feature URL:** `Daexim Feature <https://git.opendaylight.org/gerrit/gitweb?p=daexim.git;a=blob;f=features/odl-daexim/src/main/feature/feature.xml;hb=refs/heads/stable/sodium>`_
* **Feature Description:** This wrapper feature includes all the sub-features provided by the Daexim project.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** Yes
-* **CSIT Test:** `Single node tests <https://jenkins.opendaylight.org/releng/view/daexim/job/daexim-csit-1node-basic-only-sodium/>`_, `Three node cluster tests <https://jenkins.opendaylight.org/releng/view/daexim/job/daexim-csit-3node-clustering-basic-only-sodium/>`_
+* **CSIT Test:**
+
+ * `Single node tests <https://jenkins.opendaylight.org/releng/view/daexim/job/daexim-csit-1node-basic-only-sodium/>`_
+ * `Three node cluster tests <https://jenkins.opendaylight.org/releng/view/daexim/job/daexim-csit-3node-clustering-basic-only-sodium/>`_
+
+Documentation
+=============
+
+* User Guide:
+
+ * `Data Export/Import User Guide <https://docs.opendaylight.org/en/stable-oxygen/user-guide/daexim-user-guide.html#daexim-user-guide>`_
+
+* Developer Guide:
+
+ * `Data Export/Import Developer Guide <https://docs.opendaylight.org/en/stable-oxygen/developer-guide/daexim-developer-guide.html#daexim-dev-guide>`_
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+ * No
+
+* Other security issues?
+
+ * None
+
+Quality Assurance
+=================
+* `Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.daexim%3Adaexim>`_
+* Code coverage is 78.8%
+* There are extensive unit-tests in the code.
-Deprecated Features
-===================
+Migration
+=========
-This release did not remove any feature.
+* Is it possible to migrate from the previous release? If so, how?
+ * Migration should work across all releases.
-Resolved Issues
-===============
+Compatibility
+=============
+
+* Is this release compatible with the previous release?
+
+ * Yes
+
+* Any API changes?
+
+ * No
+
+* Any configuration changes?
+
+ * No
+
+Bug Fixes
+=========
The following table lists the resolved issues fixed in this release.
* - General commit
- Address Sonar warnings found in the code. No behavior changes.
+Known Issues
+============
+
+* `Open issues <https://jira.opendaylight.org/projects/Daexim/issues>`_
+End-of-life
+===========
+* List of features/APIs that were EOLed, deprecated, and/or removed from this release
-Known Issues
-============
+ * None
+
+Standards
+=========
+
+* List of standards implemented.
+
+ * None
+
+Release Mechanics
+=================
-There are no known issues that exist in this release. List of open
-issues can be found `here <https://jira.opendaylight.org/projects/DAEXIM/issues>`_.
+* Describe any major shifts in release schedule from the release plan.
+ * None
* :ref:`Clustering scripts in Distribution <getting-started-clustering-scripts>`
-Behavior Changes
-================
-No behavior change in this release.
+Major Features
+==============
-New and Modified Features
-=========================
+Managed Distribution Archive
+----------------------------
-No new features were added in this release, and no existing features were
-modified.
+* Gitweb URL: `Managed Archive <https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=karaf/pom.xml;hb=refs/heads/stable/sodium>`_
+* Description: Zip or tar.gz; when extracted, a self-consistent ODL installation with Managed projects is created.
+* Top Level: Yes.
+* User Facing: Yes.
+* Experimental: No.
+* CSIT Test: `CSIT <https://jenkins.opendaylight.org/releng/view/distribution/job/distribution-sanity-sodium>`_
-Deprecated Features
-===================
+Full Distribution Archive
+-------------------------
-No existing features were removed in this release.
+* Gitweb URL: `Distribution Archive <https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=opendaylight/pom.xml;hb=refs/heads/stable/sodium>`_
+* Description: Zip or tar.gz; when extracted, a self-consistent ODL installation with all projects is created.
+* Top Level: Yes.
+* User Facing: Yes.
+* Experimental: No.
+* CSIT Test: `CSIT <https://jenkins.opendaylight.org/releng/view/distribution/job/distribution-sanity-sodium>`_
-Resolved Issues
-===============
+Documentation
+=============
+
+* User Guide
+
+ * `Clustering scripts in Distribution <https://docs.opendaylight.org/en/stable-sodium/getting-started-guide/clustering.html#getting-started-clustering-scripts>`_
+
+* Developer Guide
+
+ * `Distribution Guides <https://docs.opendaylight.org/projects/integration-distribution/en/stable-sodium/index.html>`_
+
+Security Considerations
+=======================
+
+* `CSIT job <https://jenkins.opendaylight.org/releng/job/distribution-csit-1node-userfeatures-all-sodium>`_
+
+* No additional manual testing was needed.
+
+Migration
+=========
+Every distribution major release comes with new and deprecated project features, as well
+as new Karaf version. Because of this it is recommend to perform a new ODL installation.
+
+Compatibility
+=============
+Test features change every release, but these are only intended for distribution test.
+
+Bugs Fixed
+==========
No issues were resolved in this release.
**Workaround:** Delete the etc/host.key file before starting Karaf again.
+Standards
+=========
+
+No standard implemented directly (see upstream projects).
+
+Release Mechanics
+=================
+
+* `Managed Release <https://docs.opendaylight.org/en/stable-sodium/release-process/managed-release.html#managed-release>`_
======
-GENIUS
+Genius
======
Overview
Genius project provides Generic Network Interfaces, Utilities & Services. Any
ODL application can use these to achieve interference-free co-existence with
-other applications using Genius. OpendayLight Neon Genius provides following
-modules --
+other applications using Genius. OpendayLight Genius provides following
+modules:
-* **Interface (logical port) Manager** allows bindings/registration of
- multiple services to logical ports/interfaces
-* **Overlay Tunnel Manager** creates and maintains overlay tunnels between
- configured tunnel endpoints
-* **Aliveness Monitor** provides tunnel/nexthop aliveness monitoring services
-* **ID Manager** generates cluster-wide persistent unique integer IDs
-* **MD-SAL Utils** provides common generic APIs for interaction with MD-SAL
-* **Resource Manager** provides a resource sharing framework for applications
- sharing common resources e.g. table-ids, group-ids etc.
-* **FCAPS Application** generates various alarms and counters for the different
- genius modules
-* **FCAPS Framework** module collectively fetches all data generated by fcaps
- application. Any underlying infrastructure can subscribe for its events to
- have a generic overview of the various alarms and counters
+.. list-table::
+ :widths: 20 50
+ :header-rows: 1
-Behavior Changes
-================
+ * - **Module**
+ - **Description**
-* N/A
+ * - **Interface (logical port) Manager**
+ - Allows bindings/registration of multiple services to
+ logical ports/interfaces.
+ * - **Overlay Tunnel Manager**
+ - Creates and maintains overlay tunnels between configured
+ tunnel endpoints.
+ * - **Aliveness Monitor**
+ - Provides tunnel/nexthop aliveness monitoring services
+ * - **ID Manager**
+ - Generates cluster-wide persistent unique integer IDs
+ * - **MD-SAL Utils**
+ - Provides common generic APIs for interaction with MD-SAL
+ * - **Resource Manager**
+ - Provides a resource sharing framework for applications
+ sharing common resources e.g. table-ids, group-ids etc.
+ * - **FCAPS Application**
+ - Generates various alarms and counters for the different
+ genius modules
+ * - **FCAPS Framework**
+ - Module collectively fetches all data generated by fcaps
+ application. Any underlying infrastructure can subscribe
+ for its events to have a generic overview of the various
+ alarms and counters.
-New and Modified Features
-=========================
-* https://jira.opendaylight.org/browse/TSC-211
+Major Features
+==============
-Deprecated Features
-===================
+odl-genius-api
+--------------
-* N/A
+* Feature URL: `ODL API <https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius-api/pom.xml;hb=refs/heads/stable/sodium>`_
+* Feature Description: This feature includes API for all the functionalities provided by Genius.
+* Top Level: Yes
+* User Facing: Yes
+* Experimental: No
+* CSIT Tests:
-Resolved Issues
-===============
+ * `CSIT: 1 Node <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-sodium/>`_
+ * `CSIT: 3 Nodes <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-gate-only-sodium/>`_
-* https://jira.opendaylight.org/projects/GENIUS/issues/GENIUS-95?filter=doneissues
+odl-genius
+----------
+
+* Feature URL: `ODL <https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius/pom.xml;hb=refs/heads/stable/sodium>`_
+* Feature Description: This feature provides all functionalities provided by genius modules,
+ including interface manager, tunnel manager, resource manager and ID manager and MDSAL Utils.
+ It includes Genius APIs and implementation.
+* Top Level: Yes
+* User Facing: Yes
+* Experimental: No
+* CSIT Tests:
+
+ * `CSIT: 1 node <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-sodium/>`_
+ * `CSIT: 3 nodes <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-gate-only-sodium/>`_
+
+In addition, the feature is well tested by the netvirt CSIT suites.
+
+odl-genius-rest
+---------------
+
+* Feature URL: `REST <https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius-rest/pom.xml;hb=refs/heads/stable/sodium>`_
+* Feature Description: This feature includes RESTCONF with ‘odl-genius’ feature.
+* Top Level: Yes
+* User Facing: Yes
+* Experimental: No
+* CSIT Test:
+
+ * `CSIT: 1 node <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-sodium/>`_
+ * `CSIT: 3 nodes <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-gate-only-sodium/>`_
+
+odl-genius-fcaps-application
+----------------------------
+
+* Feature URL: `FCAPS Application <https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius-fcaps-application/pom.xml;hb=refs/heads/stable/sodium>`_
+* Feature Description: includes genius FCAPS application.
+* Top Level: Yes
+* User Facing: Yes
+* Experimental: Yes
+* CSIT Test: None
+
+odl-genius-fcaps-framework
+--------------------------
+
+* Feature URL: `FCAPS Framework <https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius-fcaps-application/pom.xml;hb=refs/heads/stable/sodium>`_
+* Feature Description: Includes genius FCAPS framework.
+* Top Level: Yes
+* User Facing: Yes
+* Experimental: Yes
+* CSIT Test: None
+
+Documentation
+=============
+
+* Developer Guide
+
+ * `Developer Guide <https://docs.opendaylight.org/projects/genius/en/stable-sodium/index.html>`_
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+ * No
+
+* Other security issues?
+
+ * N/A
+
+Quality Assurance
+=================
+
+* `Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.genius%3Agenius-aggregator>`_
+
+* CSIT Jobs:
+
+ * `CSIT Job basic <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-sodium/>`_
+ * `CSIT Job clustering <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-gate-only-sodium/>`_
+ * `Netvirt CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-netvirt-sodium/>`_
+ * `Netvirt Cluster CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-netvirt-sodium/>`_
+
+ .. Note:: Genius is used extensively in NetVirt, so NetVirt’s CSIT also provides
+ confidence in genius.
+
+Migration
+=========
+
+* Is it possible to migrate from the previous release? If so, how?
+
+ * Yes, a normal upgrade of the software should work.
+
+Compatibility
+=============
+
+* Is this release compatible with the previous release?
+
+ * Yes
+
+* Any API changes?
+
+ * No
+
+* Any configuration changes?
+
+ * No
+
+Bug Fixes
+=========
+
+* `Bug Fixes <https://jira.opendaylight.org/projects/GENIUS/issues/GENIUS-95?filter=doneissues>`_
Known Issues
============
-* https://jira.opendaylight.org/projects/GENIUS/issues/GENIUS-77?filter=allopenissues
\ No newline at end of file
+* `Known Issues <https://jira.opendaylight.org/projects/GENIUS/issues/GENIUS-77?filter=allopenissues>`_
+
+End-of-life
+===========
+
+* List of features/APIs that were EOLed, deprecated, and/or removed from this release.
+
+ * None
+
+Standards
+=========
+
+* List of standards implemented.
+
+ * N/A
+
+Release Mechanics
+=================
+
+* `Release Plan <https://jira.opendaylight.org/browse/TSC-211>`_
odl-infrautils-all
------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-all/pom.xml;hb=stable/sodium
-* **Feature Description:** This feature exposes all infrautils framework features
+* **Feature URL:** `All features <https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-all/pom.xml;hb=stable/sodium>`_
+* **Feature Description:** This feature exposes all infrautils framework features.
* **Top Level:** Yes
* **User Facing:** No
* **Experimental:** Yes
-* **CSIT Test:** covered by Netvirt and Genius CSITs
- * https://jenkins.opendaylight.org/releng/view/netvirt-csit/job/netvirt-csit-1node-1cmb-0ctl-0cmp-openstack-rocky-upstream-stateful-sodium
- * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-sodium/
+* **CSIT Test:**
+
+ * `Netvirt <https://jenkins.opendaylight.org/releng/view/netvirt/job/netvirt-csit-1node-0cmb-1ctl-2cmp-openstack-queens-upstream-stateful-sodium/>`_
+
+ * `Genius <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-sodium/>`_
odl-infrautils-jobcoordinator
-----------------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-jobcoordinator/pom.xml;hb=stable/sodium
-* **Feature Description:** This feature provides technical utilities and infrastructures for other projects to use.
+* **Feature URL:** `Jobcoordinator <https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-jobcoordinator/pom.xml;hb=stable/sodium>`_
+* **Feature Description:** This feature provides technical utilities and infrastructures for other projects to use.
* **Top Level:** Yes
* **User Facing:** No
* **Experimental:** No
-* **CSIT Test:** covered by Netvirt and Genius CSITs
+* **CSIT Test:** Covered by Netvirt and Genius CSITs
odl-infrautils-metrics
----------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-metrics/pom.xml;hb=stable/sodium
-* **Feature Description:** This feature exposes the new infrautils.metrics API with labels and first implementation based on Dropwizard incl. thread watcher
+* **Feature URL:** `Metrics <https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-metrics/pom.xml;hb=stable/sodium>`_
+* **Feature Description:** This feature exposes the new infrautils.metrics API with labels and first implementation based on Dropwizard incl. thread watcher.
* **Top Level:** Yes
* **User Facing:** No
* **Experimental:** Yes
-* **CSIT Test:** covered by Netvirt and Genius CSITs
+* **CSIT Test:** Covered by Netvirt and Genius CSITs.
odl-infrautils-ready
--------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-ready/pom.xml;hb=stable/sodium
-* **Feature Description:** This feature exposes the system readiness framework
+* **Feature URL:** `Ready <https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-ready/pom.xml;hb=stable/sodium>`_
+* **Feature Description:** This feature exposes the system readiness framework.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
-* **CSIT Test:** covered by Netvirt and Genius CSITs
+* **CSIT Test:** Covered by Netvirt and Genius CSITs.
odl-infrautils-caches
---------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-caches/pom.xml;hb=stable/sodium
-* **Feature Description:** This feature exposes new infrautils.caches API, CLI commands for monitoring, and first implementation based on Guava
+* **Feature URL:** `Cache <https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-caches/pom.xml;hb=stable/sodium>`_
+* **Feature Description:** This feature exposes new infrautils.caches API, CLI commands for monitoring, and first implementation based on Guava.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** Yes
-* **CSIT Test:** covered by Netvirt and Genius CSITs
+* **CSIT Test:** Covered by Netvirt and Genius CSITs.
odl-infrautils-diagstatus
-------------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-diagstatus/pom.xml;hb=stable/sodium
-* **Feature Description:** This feature exposes the status and diagnostics framework
+* **Feature URL:** `Diagstatus <https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-diagstatus/pom.xml;hb=stable/sodium>`_
+* **Feature Description:** This feature exposes the status and diagnostics framework.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
-* **CSIT Test:** covered by Netvirt and Genius CSITs
+* **CSIT Test:** Covered by Netvirt and Genius CSITs.
odl-infrautils-metrics-prometheus
---------------------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-metrics-prometheus/pom.xml;hb=stable/sodium
-* **Feature Description:** This feature exposes metrics by HTTP on /metrics/prometheus from the local ODL to an external Prometheus set up to scrape that.
+* **Feature URL:** `Prometheus <https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-metrics-prometheus/pom.xml;hb=stable/sodium>`_
+* **Feature Description:** This feature exposes metrics by HTTP on /metrics/prometheus from the local
+ ODL to an external Prometheus setup.
* **Top Level:** Yes
* **User Facing:** No
* **Experimental:** Yes
Documentation
=============
-* **Installation Guide(s):**
-
- * N/A
-
-* **User Guide(s):**
-
- * :doc:`Developer Guide <infrautils:index>`
-
* **Developer Guide(s):**
* :doc:`Developer Guide <infrautils:index>`
Quality Assurance
=================
-* `Link to Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.infrautils%3Ainfrautils>`_
-
+* `Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.infrautils%3Ainfrautils>`_.
* Project infrautils provides low-level technical framework utilities
and therefore no CSIT automated system testing is available. However
- the same gets covered by the CSIT of users of infrautils (eg : Genius, Netvirt)
-
-* Link to CSIT Jobs
+ the same gets covered by the CSIT of users of infrautils (eg : Genius, Netvirt).
+* CSIT Jobs:
* `Genius CSIT Job <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-only-sodium//>`_
* `Netvirt CSIT Job for Infrautils patches <https://jenkins.opendaylight.org/releng/job/infrautils-patch-test-netvirt-sodium/>`_
- * `GENIUS CSIT Job for Infrautils patches <https://jenkins.opendaylight.org/releng/job/infrautils-patch-test-genius-sodium/>`_
+ * `GENIUS CSIT Job for Infrautils patches <https://jenkins.opendaylight.org/releng/job/infrautils-patch-test-netvirt-sodium/>`_
-* Other manual testing and QA information
+* Other manual testing and QA information.
* N/A
Bugs Fixed
----------
-* No major bug fixes
+* There were no significant bugs fixed since the previous release.
Known Issues
------------
-* List key known issues with workarounds
-
- * N/A
-
-* Open Bugs
-
- * `All open BUGS <https://jira.opendaylight.org/browse/INFRAUTILS-53?jql=project%20%3D%20INFRAUTILS%20AND%20issuetype%20%3D%20Bug%20AND%20status%20%3D%20Open%20AND%20fixVersion%20%3D%20Sodium/>`_
+* `Open Bugs <https://jira.opendaylight.org/browse/INFRAUTILS-53?jql=project%20%3D%20INFRAUTILS%20AND%20issuetype%20%3D%20Bug%20AND%20status%20%3D%20Open%20AND%20fixVersion%20%3D%20Sodium/>`_
End-of-life
===========
-* List of features/APIs which are EOLed, deprecated, and/or removed in this release
+* List of features/APIs that were EOLed, deprecated, and/or removed from this release.
- * counters infrastructure (replaced by metrics)
+ * Counters infrastructure (replaced by metrics).
Standards
=========
-* List of standards implemented and to what extent
+* List of standards implemented and to what extent.
* N/A
Release Mechanics
=================
-* `Release plan <https://jira.opendaylight.org/browse/TSC-219>`_
-
-* Describe any major shifts in release schedule from the release plan
-
- * No shifts
\ No newline at end of file
+* `Release plan <https://docs.opendaylight.org/en/stable-sodium/release-process/release-schedule.html>`_
Overview
========
-The LISP Flow Mapping service provides LISP Mapping System services.
-This includes LISP Map-Server and LISP Map-Resolver services to store
-and serve mapping data to data plane nodes as well as to OpenDaylight
-applications. Mapping data can include mapping of virtual addresses to
-physical network addresses where the virtual nodes are reachable or hosted
-at. Mapping data can also include a variety of routing policies
-including traffic engineering and load balancing. To leverage this
-service, OpenDaylight applications and services can use the northbound
-REST API to define the mappings and policies in the LISP Mapping
-Service. Data plane devices capable of LISP control protocol can
-leverage this service through a southbound LISP plugin. LISP-enabled
-devices must be configured to use this OpenDaylight service as their Map-
-Server and/or Map-Resolver.
+LISP (Locator ID Separation Protocol) Flow Mapping service provides mapping services,
+including LISP Map-Server and LISP Map-Resolver services that store and serve mapping
+data to dataplane nodes and to OpenDaylight applications. Mapping data can include
+mapping of virtual addresses to physical network addresses where the virtual nodes
+are reachable or hosted. Mapping data can also include a variety of routing policies
+including traffic engineering and load balancing. To leverage this service,
+OpenDaylight applications and services can use the northbound REST API to
+define the mappings and policies in the LISP Mapping Service. Dataplane
+devices capable of LISP control protocol can leverage this service through
+a southbound LISP plugin. LISP-enabled devices must be configured to use this
+OpenDaylight service, since their Map- Server and/or Map-Resolver.
-The southbound LISP plugin supports the LISP control protocol
-(Map-Register, Map-Request, Map-Reply messages), and can also be used to
-register mappings in the OpenDaylight mapping service.
+Southbound LISP plugin supports the LISP control protocol (that is, Map-Register,
+Map-Request, Map-Reply messages). It can also be used to register mappings in the
+OpenDaylight mapping service.
-Behavior Changes
-================
+Major Features
+==============
-This is a maintenance release with no behavior changes.
+odl-lispflowmapping-msmr
+------------------------
-New and Modified Features
-=========================
+* **Feature URL:** `MSMR <https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob;f=features/odl-lispflowmapping-msmr/pom.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:** `CSIT <https://jenkins.opendaylight.org/releng/view/lispflowmapping/job/lispflowmapping-csit-1node-msmr-all-sodium/>`_
-No new features were added in this release, and no existing features were
-modified.
+odl-lispflowmapping-neutron
+---------------------------
-Deprecated Features
-===================
+* **Feature URL:** `Neutron <https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob;f=features/odl-lispflowmapping-neutron/pom.xml;hb=stable/sodium>`_
+* **Feature Description:** This feature provides Neutron integration.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
-No existing features were removed in this release.
+Documentation
+=============
-Resolved Issues
-===============
+* **User Guide(s):**
-No issues were resolved in this release.
+ * :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
+=================
+
+* `Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.lispflowmapping%3Alispflowmapping-all>`_ (59.6%)
+* `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 it possible to migrate from the previous release? If so, how?
+
+ * LISP Flow Mapping service will auto-populate the data structures from existing
+ MD-SAL data upon service start if the data has already been migrated separately.
+ No automated way for transferring the data is provided in this release.
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release?
+
+ * Yes
+
+* Any API changes?
+
+ * No
+
+* Any configuration changes?
+
+ * No
+
+Bugs Fixed
+----------
+
+* None
Known Issues
-============
+------------
+
+* `Open Bugs <https://jira.opendaylight.org/projects/LISPMAP/issues/?filter=allopenissues>`_
+
+End-of-life
+===========
+
+* List of features/APIs that were EOLed, deprecated, and/or removed from this release.
+
+ * N/A
+
+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-07>`_.
+ - No standards exist for the LISP Mapping System northbound API as of this date.
+
+Release Mechanics
+=================
-The LISP Flow Mapping Jira has a `list of known open issues <https://jira.opendaylight.org/projects/LISPMAP/issues/?filter=allopenissues>`_.
+* `Release plan <https://docs.opendaylight.org/en/stable-sodium/release-process/release-schedule.html>`_
NETCONF
=======
-Overview
-========
+Major Features
+==============
-Behavior Changes
-================
+For each top-level feature, identify the name, URL, description, etc.
+User-facing features are used directly by end users.
-* N/A
+odl-netconf-topology
+--------------------
+
+* **Feature URL:** `NETCONF Topology <https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/odl-netconf-topology/pom.xml;hb=refs/heads/stable/sodium>`_
+* **Feature Description:** NETCONF southbound plugin single-node, configuration through MD-SAL.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** `NETCONF CSIT <https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-1node-userfeatures-all-sodium/>`_
+
+odl-netconf-clustered-topology
+------------------------------
+
+* **Feature URL:** `Clustered Topology <https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/odl-netconf-clustered-topology/pom.xml;hb=refs/heads/stable/sodium>`_
+* **Feature Description:** NETCONF southbound plugin clustered, configuration through MD-SAL.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** `Cluster CSIT <https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-3node-clustering-all-sodium/>`_
+
+odl-netconf-console
+-------------------
+
+* **Feature URL:** `Console <https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/odl-netconf-console/pom.xml;hb=refs/heads/stable/sodium>`_
+* **Feature Description:** NETCONF southbound configuration with Karaf CLI.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+
+odl-netconf-mdsal
+-----------------
+
+* **Feature URL:** `MD-SAL <https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf/odl-netconf-mdsal/pom.xml;hb=refs/heads/stable/sodium>`_
+* **Feature Description:** NETCONF server for MD-SAL.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** `MD-SAL CSIT <https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-1node-userfeatures-all-sodium/>`_
+
+odl-restconf
+------------
+
+* **Feature URL:** `RESTCONF <https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/restconf/odl-restconf/pom.xml;hb=refs/heads/stable/sodium>`_
+* **Feature Description:** RESTCONF
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** Tested by any suite that uses RESTCONF.
+
+odl-mdsal-apidocs
+-----------------
+
+* **Feature URL:** `API Docs <https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/restconf/odl-mdsal-apidocs/pom.xml;hb=refs/heads/stable/sodium>`_
+* **Feature Description:** MD-SAL - apidocs
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+
+odl-yanglib
+-----------
+
+* **Feature URL:** `YANG Lib <https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/yanglib/odl-yanglib/pom.xml;hb=refs/heads/stable/sodium>`_
+* **Feature Description:** Yanglib server.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+
+odl-netconf-callhome-ssh
+------------------------
+
+* **Feature URL:** `Call Home SSH <https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/odl-netconf-callhome-ssh/pom.xml;hb=refs/heads/stable/sodium>`_
+* **Feature Description:** NETCONF Call Home.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** `Call Home CSIT <https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-1node-callhome-all-sodium/>`_.
New and Modified Features
=========================
+The following list are the new and modified features introduced in this release:
+
* An option was provided in YANG tools that preserves the ordering of requests as
defined in the YANG file when formulating the NETCONF payload. This help devices
that are strict on the ordering of elements. To do this, the JAVA parameter
mount point names to either contain IP address and port (default), or just the IP address.
This feature was added for the NETCONF *call-home* feature.
-Deprecated Features
-===================
+Documentation
+=============
+
+* **User Guide:**
+
+ * :ref:`netconf-user-guide`
+
+* **Developer Guide:**
+
+ * :ref:`netconf-dev-guide`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+ * Yes, we have MD-SAL and CSS NETCONF servers. Also, a server for NETCONF Call Home.
+
+* If so, how are they secure?
-* N/A
+ * NETCONF over SSH
-Resolved Issues
-===============
+* What port numbers do they use?
+
+ * Refer to `Ports <https://wiki.opendaylight.org/view/Ports>`_. NETCONF Call Home uses TCP port 6666.
+
+* Other security issues?
+
+ * None
+
+Quality Assurance
+=================
+
+* `Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.netconf%3Anetconf-aggregator>`_ Test coverage percent: 64.8%
+* `CSIT Jobs <https://jenkins.opendaylight.org/releng/view/netconf/>`_
+
+Migration
+---------
+
+* Is it possible to migrate from the previous release? If so, how?
+
+ * Yes. No additional steps required.
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release?
+
+ * Yes
+
+* Any API changes?
+
+ * No
+
+* Any configuration changes?
+
+ * No
+
+Bugs Fixed
+----------
.. list-table::
:widths: 15 55
have deviations.
Known Issues
-============
+------------
.. list-table::
:widths: 15 55
* - **Bug ID**
- **Description**
- * - `NETCONF 644 <https://jira.opendaylight.org/browse/NETCONF-644?jql=project%20%3D%20netconf%20AND%20type%20%3D%20Bug%20AND%20status%20!%3D%20%20Resolved)>`_
- - In some cases, the standard edit-config failed when the module augmenting base NETCONF
- was retrieved from a device.
+ * - `NETCONF-644 <https://jira.opendaylight.org/browse/NETCONF-644>`_
+ - In some cases, the standard edit-config failed when the module
+ augmenting base NETCONF was retrieved from a device.
+
+End-of-life
+===========
+
+* List of features/APIs that were EOLed, deprecated, and/or removed from this release:
+
+ * N/A
+
+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
+=================
+
+* `Release plan <https://wiki.opendaylight.org/view/Simultaneous_Release:Sodium_Release_Plan>`_
=======
-NETVIRT
+NetVirt
=======
Major Features
* **Feature Name:** odl-netvirt-openstack
* **Feature URL:** `odl-netvirt-openstack <https://git.opendaylight.org/gerrit/gitweb?p=netvirt.git;a=blob;f=features/odl-netvirt-openstack/pom.xml;hb=HEAD>`_
-* **Feature Description:** NetVirt is a network virtualization solution that includes the following components as well
- as others: Open vSwitch based virtualization for software switches, Hardware VTEP for hardware switches,
- Service Function Chaining support within a virtualized environment, support for OVS and DPDK-accelerated
- OVS data paths, L3VPN (BGPVPN), EVPN, ELAN, distributed L2 and L3, NAT and Floating IPs, IPv6, Security Groups,
- MAC and IP learning.
+* **Feature Description:** NetVirt is a network virtualization solution that includes the following components:
+
+ * Open vSwitch based virtualization for software switches.
+ * Hardware VTEP for hardware switches.
+ * Service Function Chaining support within a virtualized environment.
+ * Support for OVS and DPDK-accelerated.
+ * OVS data paths, L3VPN (BGPVPN), EVPN, ELAN, distributed L2 and L3, NAT and Floating IPs, IPv6, Security Groups,
+ MAC and IP learning.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
-* **CSIT Test:** `NetVirt CSIT <https://jenkins.opendaylight.org/releng/view/netvirt-csit/job/netvirt-csit-1node-1cmb-0ctl-0cmp-openstack-rocky-upstream-stateful-sodium/>`_
+* **CSIT Test:** `NetVirt CSIT <https://jenkins.opendaylight.org/releng/job/netvirt-csit-1node-0cmb-1ctl-2cmp-openstack-queens-upstream-stateful-sodium/>`_
Documentation
=============
Security Considerations
=======================
-No known issues.
+* No known issues.
Quality Assurance
=================
-* `Sonar Report <https://sonar.opendaylight.org/overview?id=64219>`_
+* `Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.netvirt%3Anetvirt>`_
* `All CSIT Jobs <https://jenkins.opendaylight.org/releng/view/netvirt-csit>`_
-* `Main test job <https://jenkins.opendaylight.org/releng/view/netvirt-csit/job/netvirt-csit-1node-1cmb-0ctl-0cmp-openstack-rocky-upstream-stateful-sodium/>`_
+* `Main test job <https://jenkins.opendaylight.org/releng/job/netvirt-csit-1node-0cmb-1ctl-2cmp-openstack-queens-upstream-stateful-fluorine/>`_
Migration
---------
-Nothing beyond general migration requirements.
+* Nothing beyond general migration requirements.
Compatibility
-------------
-Nothing beyond general compatibility requirements.
+* Nothing beyond general compatibility requirements.
Bugs Fixed
----------
-* `Closed Bugs <https://jira.opendaylight.org/browse/NETVIRT-1617?jql=project%20%3D%20NETVIRT%20AND%20resolution%20%3D%20Done%20AND%20fixVersion%20%3D%20Sodium>`_
+* `Fixed Bugs <https://jira.opendaylight.org/browse/NETVIRT-1617?jql=project%20%3D%20NETVIRT%20AND%20resolution%20%3D%20Done%20AND%20fixVersion%20%3D%20Sodium>`_
Known Issues
------------
End-of-life
===========
-SFC Netvirt as well as COE Netvirt Integration is reaching an EOL due to lack of support from respective
-projects. COE Netvirt CSIT jobs are already disabled, SFC is deprecated for Sodium, and soon to be
-removed for Magnesium, if required support does not come from SFC project.
+Both SFC Netvirt and COE Netvirt Integration are reaching an EOL due to lack of support
+from their respective projects. COE Netvirt CSIT jobs are already disabled, and SFC is deprecated
+for Sodium and will be removed for Magnesium if support does not come from the SFC project.
Standards
=========
-N/A
+* N/A
Release Mechanics
=================
* `Release Plan <https://jira.opendaylight.org/browse/TSC-209>`_
-* Project was on schedule
\ No newline at end of file
Overview
========
-OpenFlow Plugin project provides the following functionality to the end user.
-* **OpenFlow 1.0/1.3 Implementation** Project provides the implementation of
-the OpenFlow 1.0 and OpenFlow 1.3 specification.
-* **ONF Approved extensions** Project also provides the implementation of
-following ONF OpenFlow 1.4 feature that is approved as an extensions for the
-OpenFlow 1.3 specification. Following is the list of extensions.
-** OpenFlow 1.4 Bundle Feature
-* **Nicira Extensions** Project provides the implementation of the Nicira
-Extensions. Some of the important extensions implemented are
-** Connection Tracking Extension
-** Group Add-Mod Extension
-* **OpenFlow Based Applications** Project provides the following applications
-that user can leverage out-of-the-box in developing their application or as a
-direct end consumer.
-** Forwarding Rules Manager : Application provides functionality to
-add/remove/update flow/groups/meters.
-** LLDP Speaker : Application sends periodic LLDP packet out on each OpenFlow
-switch port for link discovery.
-** Topology LLDP Discovery : Application intercept the LLDP packets and
-discover the link information.
-** Topology Manager : Application receives the discovered links information
-from Topology LLDP Discovery application and stores in the topology yang
-model data store.
-** Reconciliation Framework : Framework that exposes API's that consumer
-application (in-controller) can leverage to participate in the switch
-reconciliation process in the event of switch connection/reconnection.
-** Arbitrator Reconciliation : Application exposes API's that consumer
-application or direct user can leverage to trigger the device
-configuration reconciliation.
-* **OpenFlow Java Library** Project provides the OpenFlow Java Library that
-converts the data based on OpenFlow plugin data models to the OpenFlow java
-models before sending it down the wire to the device.
-
-Behavior Changes
-================
-
-This release introduces no behavior changes from the previous release.
+The OpenFlow Plugin project provides the following functionality:
+
+* OpenFlow 1.0/1.3 Implementation Project provides the implementation of the
+ OpenFlow 1.0 and OpenFlow 1.3 specification.
+* ONF Approved extensions Project provides the implementation of following ONF
+ OpenFlow 1.4 feature, which is approved as extensions for the OpenFlow 1.3
+ specification.
+* OpenFlow 1.4 Bundle Feature:
+
+ * Nicira Extensions Project provides the implementation of the Nicira Extensions.
+ Some of the important extensions implemented are **Connection Tracking Extension**
+ and **Group Add-Mod Extension**
+
+* OpenFlow-Based Applications Project provides the following applications that user can
+ leverage out-of-the-box in developing their application or as a direct end consumer:
+
+ * Forwarding Rules Manager: Application provides functionality to add/remove/update
+ flow/groups/meters.
+ * LLDP Speaker: Application sends periodic LLDP packet out on each OpenFlow switch
+ port for link discovery.
+ * Topology LLDP Discovery: Application intercept the LLDP packets and discover the
+ link information.
+ * Topology Manager: Application receives the discovered links information from
+ Topology LLDP Discovery application and stores in the topology yang model datastore.
+ * Reconciliation Framework: Framework that exposes the APIs that consumer application
+ (in-controller) can leverage to participate in the switch reconciliation process in
+ the event of switch connection/reconnection.
+ * Arbitrator Reconciliation: Application exposes the APIs that consumer application
+ or direct user can leverage to trigger the device configuration reconciliation.
+ * OpenFlow Java Library Project provides the OpenFlow Java Library that converts
+ the data based on OpenFlow plugin data models to the OpenFlow java models before
+ sending it down the wire to the device.
New and Modified Features
=========================
-This releases provides the following new and modified features:
+This release provides the following new and modified features:
-* **Feature:** OVS based NA Responder for IPv6 default gateway.
-* **Feature Description:** Feature implements a OVS based service that respond
- to Neighbour Advertisement request for IPv6 default gateway.
+* Feature: OVS based NA Responder for IPv6 default gateway.
+* Feature Description: Feature implements an OVS based service that respond to Neighbor
+ Advertisement request for IPv6 default gateway.
-Deprecated Features
-===================
+odl-openflowjava-protocol
+-------------------------
-This releases does not removed any feature.
+* **Feature URL:** `JAVA Protocol <https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=openflowjava/features-openflowjava-aggregator/odl-openflowjava-protocol/pom.xml>`_
+* **Feature Description:** OpenFlow protocol implementation.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** `JAVA CSIT <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_
-Resolved Issues
-===============
+odl-openflowplugin-app-config-pusher
+------------------------------------
+
+* **Feature URL:** `Config Pusher <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:** `Pusher CSIT <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_
+
+odl-openflowplugin-app-forwardingrules-manager
+----------------------------------------------
+
+* **Feature URL:** `Forwarding Rules Manager <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:** `FR Manager CSIT <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_
+
+odl-openflowplugin-app-forwardingrules-sync
+-------------------------------------------
+
+* **Feature URL:** `Forwarding Rules Sync <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:** `FR Sync CSIT <https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-all-Sodium/>`_
+
+odl-openflowplugin-app-table-miss-enforcer
+------------------------------------------
+
+* **Feature URL:** `Miss Enforcer <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:** `Enforcer CSIT <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_
+
+odl-openflowplugin-app-topology
+-------------------------------
+
+* **Feature URL:** `App Topology <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. It a wrapper feature
+ that loads the following features:
+
+ * odl-openflowplugin-app-lldp-speaker
+ * odl-openflowplugin-app-topology-lldp-discovery
+ * odl-openflowplugin-app-topology-manager).
+
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** `App Topology CSIT <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_
+
+odl-openflowplugin-app-lldp-speaker
+-----------------------------------
+
+* **Feature URL:** `LLDP Speaker <https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-app-topology/pom.xml>`_
+* **Feature Description:** Send periodic LLDP packets on all the ports of all the connected OpenFlow devices.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** `LLDP Speaker CSIT <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_
+
+odl-openflowplugin-app-topology-lldp-discovery
+----------------------------------------------
+
+* **Feature URL:** `LLDP Discovery <https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-app-topology/pom.xml>`_
+* **Feature Description:** Receives the LLDP packet sent by LLDP speaker service and generate the link information and publish to the downstream services looking for link notifications.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** `LLDP Discovery CSIT <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_
+
+odl-openflowplugin-app-topology-manager
+---------------------------------------
+
+* **Feature URL:** `Topology Manager <https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-app-topology/pom.xml>`_
+* **Feature Description:** Listen to the link added/removed notification and node connect/disconnection notification and update the link information in the OpenFlow topology.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:** `Topology Manager CSIT <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_
+
+odl-openflowplugin-nxm-extensions
+---------------------------------
+
+* **Feature URL:** `NXM Extensions <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:** `NXM Extensions CSIT <https://jenkins.opendaylight.org/releng/view/netvirt/job/netvirt-csit-1node-openstack-pike-gate-stateful-snat-conntrack-Sodium/>`_
+
+odl-openflowplugin-onf-extensions
+---------------------------------
+
+* **Feature URL:** `ONF Extensions <https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=extension/features-extension-aggregator/odl-openflowplugin-onf-extensions/pom.xml>`_
+* **Feature Description:** Support for Open Networking Foundation Extensions.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** No
+
+odl-openflowplugin-flow-services
+--------------------------------
+
+* **Feature URL:** `Flow Services <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:** `Flow Services CSIT <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_
+
+odl-openflowplugin-flow-services-rest
+-------------------------------------
+
+* **Feature URL:** `Flow Services Rest <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:** `Flow Services Rest CSIT <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_
-Following URL contains the list of issues resolved with this release.
+odl-openflowplugin-flow-services-ui
+-----------------------------------
-https://jira.opendaylight.org/browse/OPNFLWPLUG-1073?jql=project%20%3D%20OPNFLWPLUG%20AND%20issuetype%20in%20(Bug%2C%20Improvement)%20AND%20status%20in%20(Resolved%2C%20Verified)%20AND%20fixVersion%20%3D%20Sodium%20ORDER%20BY%20created%20DESC
+* **Feature URL:** `Serices UI <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:** `Flow Services UI CSIT <https://jenkins.opendaylight.org/releng/view/openflowplugin>`_
+
+odl-openflowplugin-nsf-model
+----------------------------
+
+* **Feature URL:** `NSF Model <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:** `NSF CSIT <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_
+
+odl-openflowplugin-southbound
+-----------------------------
+
+* **Feature URL:** `Southbound <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:** `Southbound CSIT <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_
+
+Documentation
+=============
+
+* **Features Documentation:**
+
+ * :doc:`openflowplugin:index`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+ * Yes, OpenFlow devices
+
+* Other security issues?
+
+ N/A
+
+Quality Assurance
+=================
+
+* `Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.openflowplugin%3Aopenflowplugin-aggregator>`_ (67.6%)
+* `CSIT Jobs <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_
+
+Migration
+---------
+
+* Is it possible to migrate from the previous release? If so, how?
+
+ * Yes, APIs from the previous release are supported in the Sodium release.
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release? Yes
+
+Bugs Fixed
+----------
+
+List of bugs fixed since the previous release.
+
+* `Fixed bugs <https://jira.opendaylight.org/browse/OPNFLWPLUG-1073?jql=project%20%3D%20OPNFLWPLUG%20AND%20issuetype%20in%20(Bug%2C%20Improvement)%20AND%20status%20in%20(Resolved%2C%20Verified)%20AND%20fixVersion%20%3D%20Sodium%20ORDER%20BY%20created%20DESC>`_
Known Issues
-============
+------------
-The following table lists the known issues that exist in this release.
+* List key known issues with workarounds:
.. list-table::
:widths: 15 55
:header-rows: 1
- * - **Key**
- - **Summary**
+ * - **Bug ID**
+ - **Description**
+
+ * - `OPNFLWPLUG-1075 <https://jira.opendaylight.org/browse/OPNFLWPLUG-1075>`_
+ - Group tx-chain closed by port event thread.
+ * - `OPNFLWPLUG-1074 <https://jira.opendaylight.org/browse/OPNFLWPLUG-1074>`_
+ - Table stats not available after a switch flap.
+
+End-of-life
+===========
+
+* List of features/APIs that were EOLed, deprecated, and/or removed from this release.
+
+ * None
+
+Standards
+=========
+
+OpenFlow versions:
+
+* `OpenFlow1.3.2 <https://www.openflow.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.3.2.pdf>`_
+* `OpenFlow1.0.0 <https://www.openflow.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.0.0.pdf>`_
- * - OPNFLWPLUG-1075
- - Group tx-chain closed by port event thread
+Release Mechanics
+=================
- * - OPNFLWPLUG-1074
- - Table stats not available after a switch flap
+* `Release plan <https://jira.opendaylight.org/browse/TSC-163>`_
-=====
-OVSDB
-=====
+=============
+OVSDB Project
+=============
Overview
========
-OVSDB Project provides the following functionality to the end user.
-* **OVSDB Southbound Plugin** Plugin handles 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 leverage this functionality.
-* **HWvTep Southbound Plugin** Plugin handles the OVS device that supports the
-`OVSDB Hardware vTEP schema <http://openvswitch.org/docs/vtep.5.pdf>`_ and uses
-`OVSDB protocol <https://tools.ietf.org/html/rfc7047>`_. This feature
-provides the implementation of the project defined YANG models. Developers
-developing the in-controller application and want to leverage OVSDB Hardware
-vTEP plugin for device configuration can leverage this functionality.
+The OVSDB Project provides the following functionality:
-Behavior Changes
-================
+* OVSDB Southbound Plugin handles the OVS device that supports the OVSDB
+ schema and uses the OVSDB protocol. 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 leverage this functionality.
+* HWvTep Southbound Plugin handles the OVS device that supports the OVSDB
+ Hardware vTEP schema and uses OVSDB protocol. This feature provides the
+ implementation of the project defined YANG models. Developers developing
+ the in-controller application and want to leverage OVSDB Hardware vTEP
+ plugin for device configuration can leverage this functionality.
-No behavioural changes introduced in this release.
+Major Features
+==============
-New and Modified Features
-=========================
+odl-ovsdb-southbound-api
+------------------------
-No new feature implemented in this release.
-No existing features were modified in this release.
+* **Feature URL:** `Southbound API <https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=southbound/southbound-features/odl-ovsdb-southbound-api/pom.xml;h=7baad461a78e7dd311516ec03b7dbf7c9a0679aa;hb=refs/heads/stable/sodium>`_
+* **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:**
-Deprecated Features
-===================
+ * `Southbound all Sodium <https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-sodium/>`_
+ * `Clustering <https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-sodium/>`_
-This releases does not remove any deprecated features.
+odl-ovsdb-southbound-impl
+-------------------------
-Resolved Issues
-===============
+* **Feature URL:** `Southbound IMPL <https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=southbound/southbound-features/odl-ovsdb-southbound-impl/pom.xml;h=261a85eacef24c1985a11f60d018816b1f880b10;hb=refs/heads/stable/sodium>`_
+* **Feature Description:** This feature is the main feature of the OVSDB Southbound plugin. This plugin handles 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 that want to leverage OVSDB for device configuration can
+ add a dependency on this feature and all the required modules will be loaded.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:**
-No issue resolved in the sodium release.
+ * `Southbound all Sodium <https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-sodium/>`_
+ * `Clustering <https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-sodium/>`_
+
+odl-ovsdb-southbound-impl-rest
+------------------------------
+
+* **Feature URL:** `Southbound IMPL Rest <https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=southbound/southbound-features/odl-ovsdb-southbound-impl-rest/pom.xml;h=6a14e3f90fceba595695d69cdab2571e1a306999;hb=refs/heads/stable/sodium>`_
+* **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 applications that manage the OVSDB supported devices but want to run
+ the application outside of the OpenDaylight controller must install this feature.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:**
+
+ * `Southbound all Sodium <https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-sodium/>`_
+ * `Clustering <https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-sodium/>`_
+
+odl-ovsdb-hwvtepsouthbound-api
+------------------------------
+
+* **Feature URL:** `HWVT Southbound API <https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=hwvtepsouthbound/hwvtepsouthbound-features/odl-ovsdb-hwvtepsouthbound-api/pom.xml;h=e08f4233a6025da2d84dc1d87b6fb220a187e070;hb=refs/heads/stable/sodium>`_
+* **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:** Minimal set of CSIT test is already in place. More work is in progress and will have better functional
+ coverage in future release: `CSIT <https://jenkins.opendaylight.org/releng/view/Patch-Test/job/ovsdb-patch-test-l2gw-sodium/>`_
+
+odl-ovsdb-hwvtepsouthbound
+--------------------------
+
+* **Feature URL:** `HWVTEP Southbound <https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=hwvtepsouthbound/hwvtepsouthbound-features/odl-ovsdb-hwvtepsouthbound/pom.xml;h=3bb0d9f0093d83d0a82b3b8edffc0acfc93ee93c;hb=refs/heads/stable/sodium>`_
+* **Feature Description:** This feature is the main feature of the OVSDB Hardware vTep Southbound plugin. This plugin
+ handles 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 that want to leverage OVSDB Hardware vTEP
+ plugin for device configuration can add a dependency on this feature, and all the required modules will be loaded.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** Minimal set of CSIT test is already in place. More work is in progress and will have better functional
+ coverage in future release. `CSIT <https://jenkins.opendaylight.org/releng/view/Patch-Test/job/ovsdb-patch-test-l2gw-sodium/>`_
+
+odl-ovsdb-hwvtepsouthbound-rest
+-------------------------------
+
+* **Feature URL:** `HWVTEP Southbound Rest <https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=hwvtepsouthbound/hwvtepsouthbound-features/odl-ovsdb-hwvtepsouthbound-rest/pom.xml;h=8691103618cbe430994657016229b23c9b372d9d;hb=refs/heads/stable/sodium>`_
+* **Feature Description:** This feature is the wrapper feature that installs the odl-ovsdb-hwvtepsouthbound-api &
+ odl-ovsdb-hwvtepsouthbound features with other required features for restconf access to provide a functional OVSDB
+ Hardware vTEP plugin. Users who want to develop applications that manage the Hardware vTEP supported devices but want
+ to run the applications outside of the OpenDaylight controller must install this feature.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** Minimal set of CSIT test is already in place. More work is in progress and will have better functional
+ coverage in future release. `CSIT <https://jenkins.opendaylight.org/releng/view/Patch-Test/job/ovsdb-patch-test-l2gw-sodium/>`_
+
+odl-ovsdb-library
+-----------------
+
+* **Feature URL:** `Library <https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=library/features/odl-ovsdb-library/pom.xml;h=58002499237ac290071a89ca5e0b9c9297974400;hb=refs/heads/stable/sodium>`_
+* **Feature Description:** Encode/decoder library for OVSDB and Hardware vTEP schema.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** No
+* **CSIT Test:**
+
+ * `All Sodium <https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-sodium/>`_
+ * `Only Sodium <https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-sodium/>`_
+
+Documentation
+=============
+
+* N/A
+
+.. * **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. Users need to explicitly
+ enable the TLS support through ovsdb library configuration file. Users can refer
+ to the wiki page `here <https://wiki.opendaylight.org/view/OVSDB_Integration:TLS_Communication>`_ for the instructions.
+
+Quality Assurance
+=================
+
+* `Sonar Report <https://sonar.opendaylight.org/overview/coverage?id=org.opendaylight.ovsdb%3Aovsdb>`_ (57%)
+* `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 a single-node and three-node cluster setup. Hardware vTEP plugin is currently tested
+ through:
+
+ * Unit testing
+ * CSIT testing
+ * NetVirt project L2 Gateway features CSIT tests
+ * Manual testing
+
+Migration
+---------
+
+* Is it possible to 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?
+
+ * Yes
+
+* Any API changes?
+
+ * No changes in the YANG models from previous release.
+
+* Any configuration changes?
+
+ * No
+
+Bugs Fixed
+----------
+
+* There were no significant issues resolved in the sodium release.
Known Issues
-============
+------------
+
* `Open Bugs <https://jira.opendaylight.org/browse/OVSDB-487?jql=project%20%3D%20ovsdb%20%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20created%20DESC%2C%20affectedVersion%20ASC%2C%20priority%20DESC%2C%20updated%20DESC)>`_
+
+End-of-life
+===========
+
+* List of features/APIs that were EOLed, deprecated, and/or removed from this release.
+
+ * N/A
+
+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
+=================
+
+* `Release plan <https://jira.opendaylight.org/browse/TSC-211>`_
SERVICEUTILS
============
-ServiceUtils is an infrastructure project for OpenDaylight aimed at providing utilities
-that will assist in Operation and Maintenance of different services provided by OpenDaylight.
-A service is a functionality provided by the ODL controller as seen by the operator.
-These services can be categerized as Networking services, e.g. L2, L3/VPN, NAT etc., and Infra services, e.g. Openflow.
-These services are provided by different ODL projects like Netvirt, Genius and Openflowplugin and are comprised
-of a set of java karaf bundles and associated MD-SAL datastores.
+The ServiceUtils infrastructure project provides the utilities that assist in
+the operation and maintenance of different services that are provided by OpenDaylight.
+A service is a functionality provided by the ODL controller. These services can be
+categorized as Networking services (that is, L2, L3/VPN, NAT, etc.) and Infra services
+(that is, Openflow). These services are provided by different ODL projects, such as Netvirt,
+Genius and the Openflow plugin. They are comprised of a set of Java Karaf bundles and
+associated MD-SAL datastores.
Major Features
==============
odl-serviceutils-srm
--------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=serviceutils.git;a=blob;f=features/odl-serviceutils-srm/pom.xml;hb=refs/heads/stable/sodium
-* **Feature Description:** This feature provides service recovery functionaility for ODL services
+* **Feature URL:** `SRM <https://git.opendaylight.org/gerrit/gitweb?p=serviceutils.git;a=blob;f=features/odl-serviceutils-srm/pom.xml;hb=refs/heads/stable/sodium>`_
+* **Feature Description:** This feature provides service recovery functionality for ODL services.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
* **CSIT Test:**
- * ServiceRecovery is tested by Genius CSIT.
- https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-sodium
+ * ServiceRecovery is tested by `Genius CSIT <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-sodium>`_.
odl-serviceutils-tools
----------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=serviceutils.git;a=blob;f=features/odl-serviceutils-tools/pom.xml;hb=refs/heads/stable/sodium
-* **Feature Description:** This feature currently has utilities for datatree listeners, as well as Upgrade support.
+* **Feature URL:** `Tools <https://git.opendaylight.org/gerrit/gitweb?p=serviceutils.git;a=blob;f=features/odl-serviceutils-tools/pom.xml;hb=refs/heads/stable/sodium>`_
+* **Feature Description:** This feature currently has utilities for datatree listeners, as well as Upgrade support.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
-* **CSIT Test:**
-
- * Does not have CSIT on its own, but heavily tested by genius and netvirt CSITs
+* **CSIT Test:** Does not have CSIT on its own, but heavily tested by Genius and Netvirt CSITs.
Documentation
=============
-* **Installation Guide(s):**
-
- * N/A
-
-* **User Guide(s):**
-
- * N/A
-
-* **Developer Guide(s):**
-
- The project was spun off from GENIUS, and most of the assocaited documentation is still with GENIUS.
+* **Developer Guide:**
* :doc:`Developer Guide <genius:index>`
Quality Assurance
=================
-* Link to `Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.serviceutils%3Aserviceutils-aggregator>`_
+* `Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.serviceutils%3Aserviceutils-aggregator>`_
-* Link to CSIT Jobs
+* Link to CSIT Jobs:
.. note:: Serviceutils is used extensively in Genius, NetVirt and SFC, so the respective project CSITs cover the serviceutils functionality.
* `Genius Cluster CSIT for Serviceutils patches <https://jenkins.opendaylight.org/releng/job/serviceutils-patch-test-genius-sodium/>`_
-* Other manual testing and QA information
+* Other manual testing and QA information.
* N/A
Bugs Fixed
----------
-* List of bugs fixed since the previous release
-
- * NIL
+* There were no significant issues resolved in the sodium release.
Known Issues
------------
-* List key known issues with workarounds
-
- * N/A
+* There were no significant issues known in the sodium release.
End-of-life
===========
-* List of features/APIs which are EOLed, deprecated, and/or removed in this release
+* List of features/APIs that were EOLed, deprecated, and/or removed from this release.
- * N/A
+ * None
Standards
=========
-* List of standards implemented and to what extent
+* List of standards implemented.
* N/A
=================
* `Release plan <https://jira.opendaylight.org/browse/TSC-215>`_
-
-* Describe any major shifts in release schedule from the release plan
-
- * No shifts
\ No newline at end of file
-======================
+=============
Transport PCE
-======================
+=============
Major Features
==============
-* Service Handler - translate WDM optical services creation requests so they can be treated by the different modules below - northbound API based on openroadm service models.
-* Topology management
-* Path Calculation Engine (PCE, here in a different meaning than the BGPCEP project since it is not based on (G)MPLS )
-* Renderer - responsible for the path configuration through optical equipment - based on the netconf protocol and openroadm specifications. Southbound plugin.
-* Optical Line Management (OLM)
+.. list-table::
+ :widths: 15 55
+ :header-rows: 1
+
+ * - **Bug ID**
+ - **Description**
+
+ * - Service Handler
+ - Translates WDM optical services creation requests, so they can be
+ treated by the different modules - northbound API based on Open
+ ROADM service models.
+ * - Topology management
+ - Provides topology management.
+ * - Path Calculation Engine (PCE)
+ - Provides a different meaning than the BGPCEP project,
+ since it is not based on (G)MPLS)
+ * - Renderer
+ - Responsible for the path configuration through optical equipment,
+ based on the NETCONF protocol and Open ROADM specifications.
+ Southbound plugin.
+ * - Optical Line Management (OLM)
+ - Provides an optical fiber line monitoring and management.
Documentation
=============
Quality Assurance
=================
-* `Link to Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.transportpce%3Atransportpce-aggregator>`_
-* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/transportpce/>`_
+* `Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.transportpce%3Atransportpce-aggregator>`_
+* `CSIT Jobs <https://jenkins.opendaylight.org/releng/view/transportpce/>`_
* functional tests: look at the jenkins releng tox job or download sources and launch tox from the root folder.
Improvements
------------
-* This release supports the OpenROADM device version 2.2.1 (this support was experimental in Neon)
-* Openroadm and transportPCE are now based on IETF RFC8345 standard official network models (contrary to Fluorine which was relying on IETF I2RS draft).
-* The discrepancies between the topology db and the portmapping has been fixed in this release.
-* TransportPCE uses flexmap since Neon. The sodium release fixes a bug in the map formula used by Neon. https://git.opendaylight.org/gerrit/c/transportpce/+/84197
-* TransportPCE now relies on the new ODL databroker implementation instead of the deprectad controller one. https://git.opendaylight.org/gerrit/c/transportpce/+/83996
-* Others deprecated functions related to Transaction services have also been migrated https://git.opendaylight.org/gerrit/c/transportpce/+/83839/1
+* Supports the OpenROADM device version 2.2.1 (this support was experimental in Neon)
+* Openroadm and transport PCE are now based on IETF RFC8345 standard official network models
+ (contrary to Fluorine which was relying on IETF I2RS draft).
+* Discrepancies between the topology db and the portmapping has been fixed in this release.
+* Transport PCE uses flexmap since Neon. The sodium release fixes a bug in the map formula
+ used by Neon. https://git.opendaylight.org/gerrit/c/transportpce/+/84197
+* Transport PCE now relies on the new ODL databroker implementation instead of the deprecated
+ controller one: `83996 <https://git.opendaylight.org/gerrit/c/transportpce/+/83996>`_
+* Others deprecated functions related to Transaction services have also been migrated,
+ refer to `83839 <https://git.opendaylight.org/gerrit/c/transportpce/+/83839/1>`_
+
+Documentation
+=============
+
+* N/A
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+ * No
+
+* Other security issues?
+
+ * N/A
+
+Quality Assurance
+=================
+
+* N/A
+
+Migration
+=========
+
+* Is it possible to migrate from the previous release? If so, how?
+
+ * Yes, a normal upgrade of the software should work.
+
+Compatibility
+=============
+
+* Is this release compatible with the previous release?
+
+ * Yes
+
+* Any API changes?
+
+ * No
+
+* Any configuration changes?
+
+ * No
+
+Bugs Fixed
+==========
+
+* N/A
+
+Known Issues
+============
+
+* N/A
+
+End-of-life
+===========
+
+* List of features/APIs that were EOLed, deprecated, and/or removed from this release
+
+ * N/A
+
+Standards
+=========
+
+* List of standards implemented.
+
+ * N/A
+
+Release Mechanics
+=================
+
+* N/A
Code Review / docs.git / commitdiff