intersphinx_mapping['unimgr'] = ('https://docs.opendaylight.org/projects/unimgr/en/latest/', None)
# OpenDaylight Documentation Releases
-intersphinx_mapping['odl-neon'] = ('https://docs.opendaylight.org/en/latest/', None)
+intersphinx_mapping['odl-sodium'] = ('https://docs.opendaylight.org/en/latest/', None)
+intersphinx_mapping['odl-neon'] = ('https://docs.opendaylight.org/en/stable-neon/', None)
intersphinx_mapping['odl-fluorine'] = ('https://docs.opendaylight.org/en/stable-fluorine/', None)
intersphinx_mapping['odl-oxygen'] = ('https://docs.opendaylight.org/en/stable-oxygen/', None)
intersphinx_mapping['odl-nitrogen'] = ('https://docs.opendaylight.org/en/stable-nitrogen/', None)
project_cfg: opendaylight
project: OpenDaylight Documentation
-version: Neon
+version: Sodium
html_logo: _static/odl_small.png
* `odlparent <https://javadocs.opendaylight.org/odlparent>`_
* `yangtools <https://javadocs.opendaylight.org/yangtools>`_
+* `mdsal <https://javadocs.opendaylight.org/mdsal>`_
Managed Projects
================
-* `bgpcep <https://javadocs.opendaylight.org/bgpcep/fluorine>`_
-* `controller <https://javadocs.opendaylight.org/controller/fluorine>`_
-* `genius <https://javadocs.opendaylight.org/genius/fluorine>`_
-* `infrautils <https://javadocs.opendaylight.org/infrautils/fluorine>`_
-* `lispflowmapping <https://javadocs.opendaylight.org/lispflowmapping/fluorine>`_
-* `mdsal <https://javadocs.opendaylight.org/mdsal/fluorine>`_
-* `netvirt <https://javadocs.opendaylight.org/netvirt/fluorine>`_
-* `neutron <https://javadocs.opendaylight.org/neutron/fluorine>`_
-* `openflowplugin <https://javadocs.opendaylight.org/openflowplugin/fluorine>`_
-* `ovsdb <https://javadocs.opendaylight.org/ovsdb/fluorine>`_
-* `p4plugin <https://javadocs.opendaylight.org/p4plugin/fluorine>`_
+* `bgpcep <https://javadocs.opendaylight.org/bgpcep/sodium>`_
+* `controller <https://javadocs.opendaylight.org/controller/sodium>`_
+* `genius <https://javadocs.opendaylight.org/genius/sodium>`_
+* `infrautils <https://javadocs.opendaylight.org/infrautils/sodium>`_
+* `lispflowmapping <https://javadocs.opendaylight.org/lispflowmapping/sodium>`_
+* `netvirt <https://javadocs.opendaylight.org/netvirt/sodium>`_
+* `neutron <https://javadocs.opendaylight.org/neutron/sodium>`_
+* `openflowplugin <https://javadocs.opendaylight.org/openflowplugin/sodium>`_
+* `ovsdb <https://javadocs.opendaylight.org/ovsdb/sodium>`_
:glob:
:maxdepth: 1
- projects/*
+.. projects/*
-`odlparent`_
-
-.. _odlparent: https://git.opendaylight.org/gerrit/gitweb?p=odlparent.git;a=blob;f=NEWS.rst
.. Service Release Notes
.. =====================
+++ /dev/null
-===
-aaa
-===
-
-Major Features
-==============
-
-odl-aaa-shiro
-----------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob_plain;f=features/odl-aaa-shiro/pom.xml;hb=refs/heads/stable/fluorine
-* **Feature Description:** ODL Shiro-based AAA implementation
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-csit-1node-authn-all-fluorine/
-
-odl-aaa-cert
-------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob_plain;f=features/odl-aaa-cert/pom.xml;hb=refs/heads/stable/fluorine
-* **Feature Description:** MD-SAL based encrypted certificate management
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-csit-1node-authn-all-fluorine/
-
-odl-aaa-cli
-------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob_plain;f=features/odl-aaa-cli/pom.xml;hb=refs/heads/stable/fluorine
-* **Feature Description:** Basic karaf CLI commands for interacting with AAA
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-csit-1node-authn-all-fluorine/
-
-Documentation
-=============
-
-* **User Guide(s):**
-
- * :ref:`aaa-user-guide`
-
-* **Developer Guide(s):**
-
- * :ref:`aaa-dev-guide`
-
-Security Considerations
-=======================
-
-* Do you have any external interfaces other than RESTCONF?
-
- No
-
-* Other security issues?
-
- No
-
-Quality Assurance
-=================
-
-* `Link to Sonar Report <https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-sonar/>`_ (54% code coverage)
-* `Link to 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?
-
- * Yes
-
-* Any API changes?
-
- * No
-
-* Any configuration changes?
-
- * No
-
-Bugs Fixed
-----------
-
-* List of bugs fixed since the previous release
-
- * `Fixed BUGS <https://jira.opendaylight.org/issues/?jql=project%20%3D%20AAA%20AND%20issuetype%20%3D%20Bug%20AND%20status%20%3D%20Resolved%20AND%20resolution%20%3D%20Done%20AND%20resolutiondate%20%3E%20%272018%2F10%2F01%27%20%20%20ORDER%20BY%20resolutiondate>`_
-
-Known Issues
-------------
-
-* List key known issues with workarounds
-
- * None
-
-End-of-life
-===========
-
-* List of features/APIs which are EOLed, deprecated, and/or removed in this
- release
-
- * None
-
-Standards
-=========
-
-* List of standards implemented and to what extent
-
- * LDAP, JDBC, ActiveDirectory
-
-Release Mechanics
-=================
-
-* N/A
+++ /dev/null
-==========
-controller
-==========
-
-Major Features
-==============
-
-odl-mdsal-broker
-----------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blob;f=features/mdsal/odl-mdsal-broker/pom.xml;hb=refs/heads/stable/fluorine
-* **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/
-
-Documentation
-=============
-
-* **Developer Guide(s):**
-
- * :ref:`Developer Guide <controller-dev-guide>`
-
-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.5.11/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 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?
-
- * Yes
-
-* Any API changes?
-
- * Some deprecated APIs have been removed
-
-* Any configuration changes?
-
- * No
-
-Bugs Fixed
-----------
-
-* List of bugs fixed since the previous release
-
- * `Fixed BUGS <https://jira.opendaylight.org/issues/?jql=project%20%3D%20CONTROLLER%20AND%20issuetype%20%3D%20Bug%20AND%20status%20%3D%20Resolved%20AND%20resolution%20%3D%20Done%20AND%20resolutiondate%20%3E%20%272018%2F10%2F01%27%20ORDER%20BY%20resolutiondate>`_
-
-Known Issues
-------------
-
-* List key known issues with workarounds
-
- * None
-
-End-of-life
-===========
-
-* List of features/APIs which are EOLed, deprecated, and/or removed in this
- release
-
- * The controller binding and DOM MD-SAL APIs, classes and interfaces in packages prefixed with org.opendaylight.controller, have been deprecated in favor of the APIs in the mdsal project prefixed with org.opendaylight.mdsal.
-
- * Various other APIs and classes in the controller project that have been long since
- deperecated and no longer used have been removed.
-
-Standards
-=========
-
-* List of standrads implemented and to what extent
-
- * None
-
-Release Mechanics
-=================
-
-* `TSC-154 <https://jira.opendaylight.org/browse/TSC-134>`_
+++ /dev/null
-==================
-Data Export/Import
-==================
-
-Major Features
-==============
-
-odl-daexim
-----------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=daexim.git;a=blob;f=features/odl-daexim/src/main/feature/feature.xml;hb=refs/heads/stable/neon
-* **Feature Description:** This is a wrapper feature which includes all the sub features provided by daexim project.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** No
-* **CSIT Test:** `Single node <https://jenkins.opendaylight.org/releng/view/daexim/job/daexim-csit-1node-basic-only-neon/>`_. `Three node cluster <https://jenkins.opendaylight.org/releng/view/daexim/job/daexim-csit-3node-clustering-basic-only-neon/>`_.
-
-
-Documentation
-=============
-
-* **User Guide(s):**
-
- * :ref:`Data Export/Import User Guide <daexim-user-guide>`
-
-* **Developer Guide(s):**
-
- * :ref:`Data Export/Import Developer Guide <daexim-dev-guide>`
-
-Security Considerations
-=======================
-
-* Do you have any external interfaces other than RESTCONF?
-
- * No
-
-* Other security issues?
-
- * None
-
-Quality Assurance
-=================
-
-* `Link to Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.daexim%3Adaexim>`_
-* Code coverage is 78.8%.
-* There are extensive unit-tests in the code.
-
-
-Migration
----------
-
-* Is it possible to migrate from the previous release? If so, how?
-
- * Migration should work across all releases.
-
-
-Compatibility
--------------
-
-* Is this release compatible with the previous release?
-
- * Yes
-
-* Any API changes?
-
- * No.
-
-* Any configuration changes?
-
- * No.
-
-
-Bugs Fixed
-----------
-
-* List of bugs fixed since the previous release
-
- * All known bugs have been resolved.
-
-Known Issues
-------------
-
-* None.
-* `Current list of bugs <https://jira.opendaylight.org/projects/DAEXIM/issues/?filter=allopenissues>`_
-
-End-of-life
-===========
-
-* List of features/APIs which are EOLed, deprecated, and/or removed in
- this release
-
- * None
-
-Standards
-=========
-
-* List of standards implemented and to what extent
-
- * None
-
-Release Mechanics
-=================
-
-* Describe any major shifts in release schedule from the release plan
-
- * None
+++ /dev/null
-========================
-Integration/Distribution
-========================
-
-Major Features
-==============
-
-odl-integration-all
--------------------
-
-* **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=features/singles/odl-integration-all/pom.xml;hb=refs/heads/stable/neon
-* **Description:** An aggregate feature grouping Managed projects user-facing ODL features.
- This feature is used to verify all user features can be installed together without Karaf
- becoming unusable or without port conflicts.
-* **Top Level:** Yes.
-* **User Facing:** Yes, but not intended for production use (only for testing purposes).
-* **Experimental:** No.
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/distribution/job/distribution-sanity-neon
-
-odl-integration-compatible-with-all
------------------------------------
-
-* **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=features/singles/odl-integration-compatible-with-all/pom.xml;hb=refs/heads/stable/neon
-* **Description:** An aggregate feature grouping Managed projects user-facing ODL features
- which are not pro-active and which (as a group) should be compatible with most other ODL features.
- This feature is used in CSIT multi-project feature test (-all- CSIT job).
-* **Top Level:** Yes.
-* **User Facing:** Yes, but not intended for production use (only for testing purposes).
-* **Experimental:** No.
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/distribution/job/distribution-sanity-neon
-
-Managed distribution archive
-----------------------------
-* **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=karaf/pom.xml;hb=refs/heads/stable/neon
-* **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:** https://jenkins.opendaylight.org/releng/view/distribution/job/distribution-sanity-neon
-
-Full distribution archive
-----------------------------
-* **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=opendaylight/pom.xml;hb=refs/heads/stable/neon
-* **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:** https://jenkins.opendaylight.org/releng/view/distribution/job/distribution-sanity-neon
-
-Documentation
-=============
-
-* **User Guide**
-
- * :ref:`Clustering scripts in Distribution <getting-started-clustering-scripts>`
-
-* **Developer Guide**
-
- * :doc:`Distribution Guides <integration-distribution:index>`
-
-Security Considerations
-=======================
-
-* Karaf 4 exposes ssh console on port 8101. The security is basically the
- same as in upstream Karaf of corresponding versions, except library version
- overrides implemented in odlparent:karaf-parent. See :ref:`securing-karaf`
-
-Quality Assurance
-=================
-
-CSIT job: https://jenkins.opendaylight.org/releng/job/distribution-csit-1node-userfeatures-all-neon
-
-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
-----------
-
-Known Issues
-------------
-
-* `ODLPARENT-110 <https://jira.opendaylight.org/browse/ODLPARENT-110>`_
-
- Successive feature installation from karaf4 console causes bundles refresh.
-
- **Workaround:**
-
- * Use --no-auto-refresh option in the karaf feature install command.
-
- .. code:: bash
-
- feature:install --no-auto-refresh odl-netconf-topology
-
- * List all the features you need in the karaf config boot file.
-
- * Install all features at once in console, for example:
-
- .. code:: bash
-
- feature:install odl-restconf odl-netconf-mdsal odl-mdsal-apidocs odl-clustering-test-app odl-netconf-topology
-
-* `ODLPARENT-113 <https://jira.opendaylight.org/browse/ODLPARENT-113>`_
-
- The ssh-dss method is used by Karaf SSH console, but no longer supported by clients such as OpenSSH.
-
- **Workaround:**
-
- * Use the bin/client script, which uses karaf:karaf as the default credentials.
-
- * Use this ssh option:
-
- .. code:: bash
-
- ssh -oHostKeyAlgorithms=+ssh-dss -p 8101 karaf@localhost
-
- After restart, Karaf is unable to re-use the generated host.key file.
-
- **Workaround:** Delete the etc/host.key file before starting Karaf again.
-
-Standards
-=========
-
-No standard implemented directly (see upstream projects).
-
-Release Mechanics
-=================
-
-See :ref:`managed-release`
-
-
+++ /dev/null
-======
-GENIUS
-======
-
-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 --
-
-* **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
-
-Major Features
-==============
-
-odl-genius-api
---------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius-api/pom.xml;hb=refs/heads/stable/neon
-* **Feature Description:** This feature includes API for all the functionalities
- provided by Genius.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** No
-* **CSIT Test:**
-
- * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-neon/
-
- * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-gate-only-neon/
-
-odl-genius
-----------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius/pom.xml;hb=refs/heads/stable/neon
-* **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 Test:**
-
- * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-neon/
-
- * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-gate-only-neon/
-
- Apart from this, the feature is well tested by the netvirt CSIT suites.
-
-odl-genius-rest
----------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius-rest/pom.xml;hb=refs/heads/stable/neon
-* **Feature Description:** This feature includes RESTCONF with 'odl-genius'
- feature.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** No
-* **CSIT Test:**
-
- * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-neon/
-
- * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-gate-only-neon/
-
-odl-genius-fcaps-application
-----------------------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius-fcaps-application/pom.xml;hb=refs/heads/stable/neon
-* **Feature Description:** includes genius FCAPS application.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** None
-
-odl-genius-fcaps-framework
---------------------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius-fcaps-application/pom.xml;hb=refs/heads/stable/neon
-* **Feature Description:** includes genius FCAPS framework.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** None
-
-Documentation
-=============
-
-* **Installation Guide(s):**
-
- * N/A
-
-* **User Guide(s):**
-
- * :doc:`Developer Guide <genius:index>`
-
-* **Developer Guide(s):**
-
- * :doc:`Developer Guide <genius:index>`
-
-Security Considerations
-=======================
-
-* Do you have any external interfaces other than RESTCONF?
-
- * No
-
-* Other security issues?
-
- * N/A
-
-Quality Assurance
-=================
-
-* Link to `Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.genius%3Agenius-aggregator>`_ (84.2%)
-
-* Link to CSIT Jobs
-
- * `CSIT Job basic <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-neon/>`_
-
- * `CSIT Job clustering <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-gate-only-neon/>`_
-
- * `Netvirt CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-netvirt-neon/>`_
-
- * `Netvirt Cluster CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-netvirt-neon/>`_
-
- .. note:: Genius is used extensively in NetVirt, so NetVirt's CSIT also
- provides confidence in genius.
-
-* Other manual testing and QA information
-
- * 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
-----------
-
-* List of bugs fixed since the previous release
-
- * `Fixed BUGS <https://jira.opendaylight.org/browse/GENIUS-261?jql=project%20%3D%20GENIUS%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20(Resolved%2C%20Verified)%20AND%20fixVersion%20%3D%20Neon>`_
-
-Known Issues
-------------
-
-* List key known issues with workarounds
-
- * N/A
-
-* `Open Bugs <https://jira.opendaylight.org/browse/GENIUS-268?jql=project%20%3D%20GENIUS%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20(Open%2C%20Confirmed)>`_
-
-End-of-life
-===========
-
-* List of features/APIs which are EOLed, deprecated, and/or removed in this release
-
- *
-
-Standards
-=========
-
-* List of standards implemented and to what extent
-
- * N/A
-
-Release Mechanics
-=================
-
-* `Release plan <https://docs.opendaylight.org/en/latest/release-process/release-schedule.html>`_
-
-* Describe any major shifts in release schedule from the release plan
-
- * No shifts
+++ /dev/null
-=================
-LISP Flow Mapping
-=================
-
-Major Features
-==============
-
-odl-lispflowmapping-msmr
-------------------------
-
-* **Feature URL:** 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:** https://jenkins.opendaylight.org/releng/view/lispflowmapping/job/lispflowmapping-csit-1node-msmr-all-fluorine/
-
-odl-lispflowmapping-neutron
----------------------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=lispflowmapping.git;a=blob;f=features/odl-lispflowmapping-neutron/pom.xml;hb=stable/fluorine
-* **Feature Description:** This feature provides Neutron integration.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-
-Documentation
-=============
-
-* **User Guide(s):**
- :ref:`lispflowmapping-user-guide`
-
-Security Considerations
-=======================
-
-* Do you have any external interfaces other than RESTCONF?
-* Yes, the southbound plugin
-
- * If so, how are they secure?
- * LISP southbound plugin follows LISP `RFC6833 <https://tools.ietf.org/html/rfc6833>`_ security guidelines.
-
- * What port numbers do they use?
- * Port used: 4342
-
-* Other security issues?
- * None
-
-Quality Assurance
-=================
-
-* `Link to Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.lispflowmapping%3Alispflowmapping-all>`_ (59.6%)
-* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/lispflowmapping/>`_
-* All modules have been unit tested. Integration tests have been performed for all major features. System tests have been performed on most major features.
-* Registering and retrieval of basic mappings have been tested more thoroughly. More complicated mapping policies have gone through less testing.
-
-
-Migration
----------
-
-* Is it possible to migrate from the previous release? If so, how?
-
- * LISP Flow Mapping service will auto-populate the datastructures from existing MD-SAL data upon service start if the data has already been migrated separately. No automated way for transfering 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
-------------
-
-* Clustering is still an experimental feature and may have some issues particularly related to operational datastore consistency.
-
-* `Link to Open Bugs <https://jira.opendaylight.org/projects/LISPMAP/issues/>`_
-
-End-of-life
-===========
-
-* None
-
-Standards
-=========
-
-* The LISP implementation module and southbound plugin conforms to the IETF `RFC6830 <https://tools.ietf.org/html/rfc6830>`_ and `RFC6833 <https://tools.ietf.org/html/rfc6833>`_ , with the following exceptions:
-
- - In Map-Request message, M bit(Map-Reply Record exist in the MapRequest) is processed but any mapping data at the bottom of a Map-Request are discarded.
- - LISP LCAFs are limited to only up to one level of recursion, as described in the IETF `LISP YANG draft <https://tools.ietf.org/html/draft-ietf-lisp-yang-07>`_.
- - No standards exist for the LISP Mapping System northbound API as of this date.
-
-Release Mechanics
-=================
-
-* `Release plan <https://docs.opendaylight.org/en/stable-neon/release-process/release-schedule.html>`_
+++ /dev/null
-=============
-OVSDB Project
-=============
-
-Major Features
-==============
-
-odl-ovsdb-southbound-api
-------------------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=southbound/southbound-features/odl-ovsdb-southbound-api/pom.xml;h=7baad461a78e7dd311516ec03b7dbf7c9a0679aa;hb=refs/heads/stable/neon
-* **Feature Description:** This feature provides the YANG models for northbound users to configure the OVSDB device.
- These YANG models are designed based on the `OVSDB schema <http://openvswitch.org/ovs-vswitchd.conf.db.5.pdf>`_. This
- feature does not provide the implementation of YANG models. If user/developer prefer to write their own implementation
- they can use this feature to load the YANG models in the controller.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** No
-* **CSIT Test:**
-
- * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-neon/
- * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-neon/
-
-odl-ovsdb-southbound-impl
--------------------------
-
-* **Feature URL:** 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/neon
-* **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:**
-
- * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-neon/
- * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-neon/
-
-odl-ovsdb-southbound-impl-rest
-------------------------------
-
-* **Feature URL:** 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/neon
-* **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:**
-
- * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-neon/
- * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-neon/
-
-
-odl-ovsdb-hwvtepsouthbound-api
-------------------------------
-
-* **Feature URL:** 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/neon
-* **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.
-
- * https://jenkins.opendaylight.org/releng/view/Patch-Test/job/ovsdb-patch-test-l2gw-neon/
-
-odl-ovsdb-hwvtepsouthbound
---------------------------
-
-* **Feature URL:** 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/neon
-* **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.
-
- * https://jenkins.opendaylight.org/releng/view/Patch-Test/job/ovsdb-patch-test-l2gw-neon/
-
-odl-ovsdb-hwvtepsouthbound-rest
--------------------------------
-
-* **Feature URL:** 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/neon
-* **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.
-
- * https://jenkins.opendaylight.org/releng/view/Patch-Test/job/ovsdb-patch-test-l2gw-neon/
-
-odl-ovsdb-library
------------------
-
-* **Feature URL:** 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/neon
-* **Feature Description:** Encode/decoder library for OVSDB and Hardware vTEP schema.
-* **Top Level:** Yes
-* **User Facing:** No
-* **Experimental:** No
-* **CSIT Test:**
-
- * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-neon/
- * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-neon/
-
-Documentation
-=============
-
-* **User Guide(s):**
-
- * :doc:`OVSDB User Guide <../../user-guide/ovsdb-user-guide>`
-
-* **Developer Guide(s):**
-
- * :doc:`OVSDB Developer Guide <../../developer-guide/ovsdb-developer-guide>`
-
-Security Considerations
-=======================
-
-* Do you have any external interfaces other than RESTCONF? Yes, Southbound Connection to OVSDB/Hardware vTEP devices.
-
-* Other security issues?
-
- Plugin's connection to device is by default unsecured. 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
-=================
-
-* `Link to Sonar Report <https://sonar.opendaylight.org/overview/coverage?id=org.opendaylight.ovsdb%3Aovsdb>`_ (57%)
-* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/ovsdb/>`_
-*
-* OVSDB southbound plugin is extensively tested through Unit Tests, IT test and system tests. OVSDB southbound plugin
- is tested in both single node setup as well as three node cluster setup. Hardware vTEP plugin is currently tested
- through (1) Unit testing (2) CSIT Tests (3) NetVirt project L2 Gateway features CSIT tests and (4) Manual Testing.
- (3) https://jenkins.opendaylight.org/releng/job/netvirt-csit-1node-openstack-queens-upstream-stateful-neon
-
-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
-----------
-
-* `List of bugs fixed since the previous release <https://jira.opendaylight.org/issues/?jql=project%20%3D%20OVSDB%20AND%20resolution%20%3D%20Done%20AND%20affectedVersion%20%3D%20Neon%20>`_
-
-Known Issues
-------------
-
-* List key known issues with workarounds
- None
-* `Link to Open Bugs <https://jira.opendaylight.org/issues/?jql=project%20%3D%20OVSDB%20AND%20resolution%20%3D%20Unresolved%20AND%20affectedVersion%20%3D%20Neon%20>`_
-
-End-of-life
-===========
-
-* List of features/APIs which are EOLed, deprecated, and/or removed in thisrelease
-
- None
-
-Standards
-=========
-
-* `Open vSwitch Database Management Protocol <https://tools.ietf.org/html/rfc7047>`_
-* `OVSDB Schema <http://openvswitch.org/ovs-vswitchd.conf.db.5.pdf>`_
-* `Hardware vTep Schema <http://openvswitch.org/docs/vtep.5.pdf>`_
-
-Release Mechanics
-=================
-
-* `Link to release plan <https://jira.opendaylight.org/browse/TSC-192>`_
-
-
-
+++ /dev/null
-============
-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.
-
-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/neon
-* **Feature Description:** This feature provides service recovery functionaility 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-neon
-
-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/neon
-* **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
-
-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.
-
- * :doc:`Developer Guide <genius:index>`
-
-Security Considerations
-=======================
-
-* Do you have any external interfaces other than RESTCONF?
-
- * No
-
-* Other security issues?
-
- * N/A
-
-Quality Assurance
-=================
-
-* Link to `Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.serviceutils%3Aserviceutils-aggregator>`_
-
-* Link to CSIT Jobs
-
- .. note:: Serviceutils is used extensively in Genius, NetVirt and SFC, so the respective project CSITs cover the serviceutils functionality.
-
- * `CSIT Job basic <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-neon/>`_
-
- * `CSIT Job clustering <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-gate-only-neon/>`_
-
- * `Netvirt CSIT for Serviceutils patches <https://jenkins.opendaylight.org/releng/job/serviceutils-patch-test-netvirt-neon/>`_
-
- * `Netvirt cluster CSIT for Serviceutils patches <https://jenkins.opendaylight.org/releng/job/serviceutils-patch-test-cluster-netvirt-neon/>`_
-
- * `Genius Cluster CSIT for Serviceutils patches <https://jenkins.opendaylight.org/releng/job/serviceutils-patch-test-genius-neon/>`_
-
-* Other manual testing and QA information
-
- * 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
-----------
-
-* List of bugs fixed since the previous release
-
- * `Fixed BUGS <https://jira.opendaylight.org/issues/?jql=project%20%3D%20SRVUTILS%20AND%20issuetype%20%3D%20Bug%20AND%20status%20%3D%20Done%20AND%20fixVersion%20%3D%20Neon%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC>`_
-
-Known Issues
-------------
-
-* List key known issues with workarounds
-
- * N/A
-
-End-of-life
-===========
-
-* List of features/APIs which are EOLed, deprecated, and/or removed in this release
-
- * N/A
-
-Standards
-=========
-
-* List of standards implemented and to what extent
-
- * N/A
-
-Release Mechanics
-=================
-
-* `Release plan <https://docs.opendaylight.org/en/latest/release-process/release-schedule.html>`_
-
-* Describe any major shifts in release schedule from the release plan
-
- * No shifts
Code Review / docs.git / commitdiff