-.. _alto-developer-guide
+.. _alto-developer-guide:
ALTO Developer Guide
====================
+.. _controller-dev-guide:
+
Controller
==========
+.. _nemo-dev-guide:
+
NEtwork MOdeling (NEMO)
=======================
+.. _netconf-dev-guide:
+
NETCONF Developer Guide
=======================
-.. neutron-northbound-developer-guide:
+.. _neutron-northbound-developer-guide:
Neutron Northbound
==================
-.. neutron-service-developer-guide:
+.. _neutron-service-developer-guide:
Neutron Service Developer Guide
===============================
+.. _sxp-dev-guide:
+
SXP Developer Guide
===================
+.. _topoprocessing-dev-guide:
+
Topology Processing Framework Developer Guide
=============================================
+.. _usc-dev-guide:
+
Unified Secure Channel
======================
odl-aaa-authn
-------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob;f=features/authn/features-aaa/src/main/features/features.xml;h=6c4eb853d527593662553e96e002df3b05e46f76;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob;f=features/authn/features-aaa/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** Existing AAA infrastructure, now wrapped by odl-aaa-shiro
* **Top Level:** Yes
* **User Facing:** Yes
odl-aaa-cert
------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob;f=features/authn/features-aaa/src/main/features/features.xml;h=6c4eb853d527593662553e96e002df3b05e46f76;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob;f=features/authn/features-aaa/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** MD-SAL based encrypted certificate management
* **Top Level:** Yes
* **User Facing:** Yes
odl-aaa-cli
------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob;f=features/authn/features-aaa/src/main/features/features.xml;h=6c4eb853d527593662553e96e002df3b05e46f76;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=aaa.git;a=blob;f=features/authn/features-aaa/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** Basic karaf CLI commands for interacting with AAA
* **Top Level:** Yes
* **User Facing:** Yes
Quality Assurance
=================
-* `Link to Sonar Report https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-sonar/`_ (56.39% code coverage)
-* `Link to CSIT Jobs https://jenkins.opendaylight.org/releng/view/aaa/`_
+* `Link to Sonar Report <https://jenkins.opendaylight.org/releng/view/aaa/job/aaa-sonar/>`_ (56.39% code coverage)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/aaa/>`_
Migration
---------
* No data model changes occurred, so everything should work. You can either copy the existing idmlight.db.mv.db into the new karaf distribution folder, or just start fresh with a new one.
-Compatiblity
-------------
+Compatibility
+-------------
* Is this release compatible with the previous release?
No.
-* Any configuraiton changes?
+* Any configuration changes?
Some CLI commands were modified for security and ease of use purposes. Nothing else.
N/A
-* `Link to Open Bugs https://bugs.opendaylight.org/buglist.cgi?component=General&list_id=78831&product=aaa&resolution=---`_
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?component=General&list_id=78831&product=aaa&resolution=--->`_
End-of-life
===========
Release Mechanics
=================
-* `Link to release plan https://wiki.opendaylight.org/view/AAA:Carbon:Release_Plan`_
+* `Link to release plan <https://wiki.opendaylight.org/view/AAA:Carbon:Release_Plan>`_
* Describe any major shifts in release schedule from the release plan
None.
Migration with data from Boron to Carbon isn't supported.
-Compatiblity
-------------
+Compatibility
+-------------
This release is not compatible with the previous release from the developer's
point of view because we have changed the namespaces for most YANG models, which
files).
Java projects using the ALTO classes generated by yangtools MUST change the
-packages for the classes because of the namespace migration. The incompatiblity
+packages for the classes because of the namespace migration. The incompatibility
can be fixed using regex replacement.
Projects using RESTCONF or the customized ALTO service do not need to migrate.
odl-bgpcep-bgp
--------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/bgp/features-bgp/src/main/features/features.xml;h=66c79d8a949d139b21ad3aab43d4b75bcf3cf385;hb=73449afa26d3771525d10abbf7441c094e638c9b
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/bgp/features-bgp/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** OpenDaylight Border Gateway Protocol (BGP) plugin.
* **Top Level:** Yes
* **User Facing:** Yes
odl-bgpcep-bmp
--------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/bmp/features-bmp/src/main/features/features.xml;h=d614ef9789bd254242fae352fb701dc5ca816208;hb=73449afa26d3771525d10abbf7441c094e638c9bhttps://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/bmp/features-bmp/src/main/features/features.xml;h=d614ef9789bd254242fae352fb701dc5ca816208;hb=73449afa26d3771525d10abbf7441c094e638c9b
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/bmp/features-bmp/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** OpenDaylight BGP Monitoring Protocol (BMP) plugin.
* **Top Level:** Yes
* **User Facing:** Yes
odl-bgpcep-pcep
---------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/pcep/features-pcep/src/main/features/features.xml;h=e43f22337c2492df39ff498f29744e8e69a8659a;hb=73449afa26d3771525d10abbf7441c094e638c9b
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=bgpcep.git;a=blob;f=features/pcep/features-pcep/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** OpenDaylight Path Computation Element Configuration Protocol (PCEP) plugin.
* **Top Level:** Yes
* **User Facing:** Yes
There are no additional steps needed for migration to this release.
-Compatiblity
-------------
+Compatibility
+-------------
* Is this release compatible with the previous release?
Yes
* Any API changes?
* Any configuration changes?
- BGP Openconfig configuration should be used instead of previous BGP CSS configuration.
+ BGP OpenConfig configuration should be used instead of previous BGP CSS configuration.
Bugs Fixed
----------
* Not applicable as there is no previous release.
-Compatiblity
-------------
+Compatibility
+-------------
* Is this release compatible with the previous release? No previous release.
* Any API changes? No.
-* Any configuraiton changes? No.
+* Any configuration changes? No.
Bugs Fixed
----------
* **Experimental:** No
* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/controller/job/controller-csit-verify-3node-clustering/
+Documentation
+=============
+
+* **User Guide(s):**
+
+ * :ref:`User Guide <controller-user-guide>`
+
+* **Developer Guide(s):**
+
+ * :ref:`controller-dev-guide`
+
Security Considerations
=======================
* There are no issues with migration from Boron to Carbon.
-Compatiblity
-------------
+Compatibility
+-------------
* Is this release compatible with the previous release?
* No changes has been done from the last release.
-Compatiblity
-------------
+Compatibility
+-------------
* Release is compatible with previous release.
* No API changes has been done.
The Boron configfile would work, but users are advised to consider reporting a bumped version.
* No upgrade path for other features.
-Compatiblity
-------------
+Compatibility
+-------------
* No API changes in Karaf 3.
* Karaf features are not compatible with Boron.
odl-dluxapps-nodes
------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;h=a0ccf2f80f3f88a63da6c73c8903f94247c31dbc;hb=621a9e576e15233177a20f89f83b3992999b9423
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;hb=621a9e576e15233177a20f89f83b3992999b9423
* **Feature Description:** Application displays list of nodes in openflow (flow:1) topology.
* **Top Level:** Yes
* **User Facing:** Yes
odl-dluxapps-topology
---------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;h=a0ccf2f80f3f88a63da6c73c8903f94247c31dbc;hb=621a9e576e15233177a20f89f83b3992999b9423
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;hb=621a9e576e15233177a20f89f83b3992999b9423
* **Feature Description:** Basic topology application. Displays nodes and links from openflow (flow:1) topology.
* **Top Level:** Yes
* **User Facing:** Yes
odl-dluxapps-yangman
--------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;h=a0ccf2f80f3f88a63da6c73c8903f94247c31dbc;hb=621a9e576e15233177a20f89f83b3992999b9423
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;hb=621a9e576e15233177a20f89f83b3992999b9423
* **Feature Description:** GUI for data manipulation in controller. Generates forms based on loaded Yang models.
User can interact with controller without knowledge of Yang models, test them, etc. Replacement of YangUI app.
* **Top Level:** Yes
odl-dluxapps-yangui
-------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;h=a0ccf2f80f3f88a63da6c73c8903f94247c31dbc;hb=621a9e576e15233177a20f89f83b3992999b9423
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;hb=621a9e576e15233177a20f89f83b3992999b9423
* **Feature Description:** Previous version of YangUI. Will be removed in next release.
* **Top Level:** Yes
* **User Facing:** Yes
odl-dluxapps-yangvisualizer
---------------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;h=a0ccf2f80f3f88a63da6c73c8903f94247c31dbc;hb=621a9e576e15233177a20f89f83b3992999b9423
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/src/main/features/features.xml;hb=621a9e576e15233177a20f89f83b3992999b9423
* **Feature Description:** Topology-like visualization of Yang models loaded in controller.
* **Top Level:** Yes
* **User Facing:** Yes
* All applications are moved from Dlux project to DluxApps. Also feature names
changed, so instead odl-dlux-\* use odl-dluxapps-\*. Everything else works same.
-Compatiblity
-------------
+Compatibility
+-------------
* Release is compatible with previous.
* API changes are in feature names - odl-dlux-\* changes to odl-dluxapps-\*
N/A as this is first release
-Compatiblity
-------------
+Compatibility
+-------------
N/A as this is first release
* No
-Compatiblity
-------------
+Compatibility
+-------------
* Is this release compatible with the previous release? Yes
* Any API changes? No.
-* Any configuraiton changes? No.
+* Any configuration changes? No.
Bugs Fixed
----------
\r
* **Installation Guide(s):**\r
\r
- * https://git.opendaylight.org/gerrit/gitweb?p=federation.git;a=blob;f=docs/install-guide/federation-install-guide.rst\r
+ * :doc:`../../submodules/federation/docs/install-guide/federation-install-guide`\r
\r
* **Developer Guide(s):**\r
\r
- * https://git.opendaylight.org/gerrit/gitweb?p=federation.git;a=blob;f=docs/developer-guide/federation-developer-guide.rst\r
+ * :doc:`../../submodules/federation/docs/developer-guide/federation-developer-guide`\r
\r
Security Considerations\r
=======================\r
* Not applicable. Federation is a new project released in the Carbon\r
release for the first time.\r
\r
-Compatiblity\r
-------------\r
+Compatibility\r
+-------------\r
\r
* Not applicable. Federation is a new project released in the Carbon\r
release for the first time.\r
* LISP Flow Mapping service will auto-populate the datastructures from existing MD-SAL data upon service start if the data has already been migrated separately.
-Compatiblity
-------------
+Compatibility
+-------------
* Is this release compatible with the previous release?
* No
-* Any configuraiton changes?
+* Any configuration changes?
* No
odl-mdsal-binding
-----------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/features-mdsal/src/main/features/features.xml;h=d41e7fd1e56cfe91934a5c077719ce4cb438b3ef;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/features-mdsal/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** MDSAL Binding layer, representing mapping of YANG modeled data to respective Java Objects
* **Top Level:** Yes
* **User Facing:** No
odl-mdsal-binding2
------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/features-mdsal/src/main/features/features.xml;h=d41e7fd1e56cfe91934a5c077719ce4cb438b3ef;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/features-mdsal/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** MDSAL Binding v2 layer, representing mapping of YANG modeled data to respective Java Objects
* **Top Level:** Yes
* **User Facing:** No
* no additional steps needed for migration
-Compatiblity
-------------
+Compatibility
+-------------
* Release is compatible with the previous one
* No configuration changes
* **User Guide(s):**
- * `NEMO User Guide <http://docs.opendaylight.org/en/latest/user-guide/nemo-user-guide.html>`_
+ * :ref:`nemo-user-guide`
* **Developer Guide(s):**
- * `NEMO Developer Guide <http://docs.opendaylight.org/en/latest/developer-guide/nemo-developer-guide.html>`_
+ * :ref:`nemo-dev-guide`
Security Considerations
=======================
* Nothing beyond general Carbon migration requirements.
-Compatiblity
-------------
+Compatibility
+-------------
* Nothing beyond general Carbon compatibility constraints.
odl-netconf-topology
--------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** NETCONF southbound plugin, configuration through mdsal
* **Top Level:** Yes
* **User Facing:** Yes
odl-netconf-clustered-topology
------------------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** NETCONF southbound plugin, configuration through mdsal
* **Top Level:** Yes
* **User Facing:** Yes
odl-netconf-console
-------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** NETCONF southbound configuration with karaf cli
* **Top Level:** Yes
* **User Facing:** Yes
odl-netconf-connector-all
-------------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** NETCONF southbound plugin, configuration with configub subsystem
* **Top Level:** Yes
* **User Facing:** Yes
odl-netconf-mdsal
-----------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf/features-netconf/src/main/features/features.xml;h=29e9400108a8790ac7786fbfc6e2d3bbd1fa2ec0;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf/features-netconf/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** NETCONF server for mdsal
* **Top Level:** Yes
* **User Facing:** Yes
odl-restconf
------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/restconf/features-restconf/src/main/features/features.xml;h=77c9687fba7862f018b8cea43830cc1b9688c8e5;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/restconf/features-restconf/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** Restconf
* **Top Level:** Yes
* **User Facing:** Yes
odl-mdsal-apidocs
-----------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/restconf/features-restconf/src/main/features/features.xml;h=77c9687fba7862f018b8cea43830cc1b9688c8e5;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/restconf/features-restconf/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** MDSal - apidocs
* **Top Level:** Yes
* **User Facing:** Yes
odl-yanglib
-----------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/yanglib/features-yanglib/src/main/features/features.xml;h=81ccb4954eb32394a9d4ef1986ad0e4bb67b9e1f;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/yanglib/features-yanglib/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** Yanglib server
* **Top Level:** Yes
* **User Facing:** Yes
odl-netconf-callhome-ssh
------------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** Netconf call home
* **Top Level:** Yes
* **User Facing:** Yes
* **User Guide(s):**
- * `Netconf user guide <http://docs.opendaylight.org/en/latest/user-guide/netconf-user-guide.html>`_
+ * :ref:`netconf-user-guide`
* **Developer Guide(s):**
- * `Netconf developer guide <http://docs.opendaylight.org/en/latest/developer-guide/netconf-developer-guide.html>`_
+ * :ref:`netconf-dev-guide`
Security Considerations
=======================
Yes, no specific steps needed apart from migrating netconf's topology configuration from DS.
-Compatiblity
-------------
+Compatibility
+-------------
* Is this release compatible with the previous release?
No
-* Any configuraiton changes?
+* Any configuration changes?
md-sal netconf northbound is started via blueprint instead of config subsystem.
* **User Guide(s):**
- * `NetVirt User Guide <http://docs.opendaylight.org/en/latest/submodules/netvirt/docs/user-guide/index.html>`_
- * `OpenStack with NetVirt <http://docs.opendaylight.org/en/latest/submodules/netvirt/docs/openstack-guide/index.html>`_
+ * :doc:`../../submodules/netvirt/docs/user-guide/index`
+ * :doc:`../../submodules/netvirt/docs/openstack-guide/index`
* **Developer Guide(s):**
- * `NetVirt Developer Guide <http://docs.opendaylight.org/en/latest/submodules/netvirt/docs/developer-guide/index.html>`_
+ * :doc:`../../submodules/netvirt/docs/developer-guide/index`
* **Contributor Guide(s):**
- * `NetVirt Contributor Guide <http://docs.opendaylight.org/en/latest/submodules/netvirt/docs/contributor-guide/index.html>`_
+ * :doc:`../../submodules/netvirt/docs/contributor-guide/index`
Security Considerations
=======================
develops new OpenStack Service Provider like netvirt,
group-based-policy.
-.. Commented out because Colin doens't think it provides any value.
-.. Architectural Issues
-.. --------------------
-
Security Considerations
=======================
No as incompatble change was introduced.
-Compatiblity
-------------
+Compatibility
+-------------
* Is this release compatible with the previous release?
* `Neutron YANG model update
<https://git.opendaylight.org/gerrit/#/c/51534/>`_
-* Any configuraiton changes?
+* Any configuration changes?
No.
* Yes, there is no change in config and no need to migrate data in the datastore.
-Compatiblity
-------------
+Compatibility
+-------------
* Is this release compatible with the previous release?
No, current release is backward incompatible.
-Compatiblity
-------------
+Compatibility
+-------------
* Is this release compatible with the previous release?
No
odl-openflowjava-protocol
-------------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowjava.git;a=blob;f=features/features-openflowjava/src/main/features/features.xml;h=f1b58ba66493ccbfd496cb9d4f072cc8398340c3;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowjava.git;a=blob;f=features/features-openflowjava/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** This feature exposes SwitchConnectionProvider for building openflow connections
* **Top Level:** Yes
* **User Facing:** Yes
* no additional migration steps needed
-Compatiblity
-------------
+Compatibility
+-------------
* release is compatible with the previous release
* no API changes
* Simply install and restart daemons.
-Compatiblity
-------------
+Compatibility
+-------------
OpFlex GBP model and configuration files remain backward compatible.
The Service Function ``nsh-aware`` and ``requires-classification`` fields
have been moved to the Service Function Type.
-Compatiblity
-------------
+Compatibility
+-------------
Other than the API changes mentioned in the previous section, this
release is compatible with the previous release.
\r
Yes. Features as well as interfaces are not changed.\r
\r
-Compatiblity\r
-------------\r
+Compatibility\r
+-------------\r
\r
* Is this release compatible with the previous release?\r
\r
\r
No\r
\r
-* Any configuraiton changes?\r
+* Any configuration changes?\r
\r
No\r
\r
odl-sxp-api
-----------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;h=60b04abb2af30126b121f56357f086a051251e0d;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** This feature provides models based on `RFC <https://tools.ietf.org/pdf/draft-smith-kandula-sxp-05.pdf>`_.
* **Top Level:** No
* **User Facing:** No
odl-sxp-core
------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;h=60b04abb2af30126b121f56357f086a051251e0d;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** This feature performs tasks for managing SXP devices and provides the implementation of `RFC <https://tools.ietf.org/pdf/draft-smith-kandula-sxp-05.pdf>`_.
* **Top Level:** No
* **User Facing:** No
odl-sxp-controller
------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;h=60b04abb2af30126b121f56357f086a051251e0d;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** This feature performs tasks regarding managing SXP devices via RESTCONF.
* **Top Level:** Yes
* **User Facing:** Yes
odl-sxp-robot
-------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;h=60b04abb2af30126b121f56357f086a051251e0d;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** This is a sample feature used in CSIT testing.
* **Top Level:** No
* **User Facing:** No
odl-sxp-route
-------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;h=60b04abb2af30126b121f56357f086a051251e0d;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/features-sxp/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** This feature that performs managing of SXP devices in cluster environment.
* **Top Level:** Yes
* **User Facing:** Yes
* **Installation Guide(s):**
- * `InstallationGuide <https://wiki.opendaylight.org/view/SXP:Lithium:Installation_Guide>`_
+ * `Installation Guide <https://wiki.opendaylight.org/view/SXP:Lithium:Installation_Guide>`_
* **User Guide(s):**
- * `SXP User Guide <http://docs.opendaylight.org/en/latest/user-guide/sxp-user-guide.html>`_
+ * :ref:`sxp-user-guide`
* **Developer Guide(s):**
- * `SXP Developer Guide <http://docs.opendaylight.org/en/latest/developer-guide/sxp-developer-guide.html>`_
+ * :ref:`sxp-dev-guide`
Security Considerations
=======================
-============
+=============================
Topology Processing Framework
-============
+=============================
Major Features
==============
-odl-topoprocessing-framewrok
-------------
+odl-topoprocessing-framework
+----------------------------
* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/src/main/resources/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** Topology processing core
* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-carbon/
odl-topoprocessing-mlmt
-------------
+-----------------------
* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/src/main/resources/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** Multi-Layer and Multi-Technology (MLMT) module
* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-carbon/
odl-topoprocessing-network-topology
-------------
+-----------------------------------
* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/src/main/resources/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** Support for network-topology model
* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-carbon/
odl-topoprocessing-inventory
-------------
+----------------------------
* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/src/main/resources/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** Support for inventory model
* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-carbon/
odl-topoprocessing-I2rs
-------------
+-----------------------
* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/src/main/resources/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** Support for i2rs model
* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/topoprocessing/job/topoprocessing-csit-1node-topology-operations-all-carbon/
odl-topoprocessing-inventory-rendering
-------------
+--------------------------------------
* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=features/src/main/resources/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** Rendering demo
* **Developer Guide(s):**
- * `Docs on docs.opendaylight.org <http://docs.opendaylight.org/en/latest/developer-guide/topology-processing-framework-developer-guide.html>`_
- * `Rst documentation <https://git.opendaylight.org/gerrit/gitweb?p=docs.git;a=blob;f=docs/developer-guide/topology-processing-framework-developer-guide.rst;hb=refs/heads/stable/carbon>`_
+ * :ref:`topoprocessing-dev-guide`
* `Wiki <https://wiki.opendaylight.org/view/Topology_Processing_Framework:Developer_Guide>`_
Security Considerations
* Not supported
-Compatiblity
-------------
+Compatibility
+-------------
* Compatible
* :ref:`TSDR User Guide <tsdr-user-guide>`
-* **Developer Guide(s):**
- * N/A
-
-
Security Considerations
=======================
* Yes, since there's no change of features from the previous releases.
-Compatiblity
-------------
+Compatibility
+-------------
* Is this release compatible with the previous release?
Yes.
RESTCONF GETs and then import it by doing RESTCONF PUTs after the fact, this
has not been tested and isn't officially supported.
-Compatiblity
-------------
+Compatibility
+-------------
* Is this release compatible with the previous release?
* **User Guide(s):**
- * `USC User Guide <http://docs.opendaylight.org/en/latest/user-guide/unified-secure-channel.html>`_
+ * :ref:`usc-user-guide`
* **Developer Guide(s):**
- * `USC Developer Guide <http://docs.opendaylight.org/en/latest/developer-guide/unified-secure-channel.html>`_
+ * :ref:`usc-dev-guide`
Security Considerations
=======================
* Nothing beyond general Carbon migration requirements.
-Compatiblity
-------------
+Compatibility
+-------------
* Nothing beyond general Carbon compatibility constraints.
==============
odl-vbd
-------------------
+-------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=honeycomb/vbd.git;a=blob;f=features/vbd-features/src/main/features/features.xml;h=66f8ed281850afadcf769a2b9e0925aaedce983a;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=honeycomb/vbd.git;a=blob;f=features/vbd-features/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** This feature provides models to configure Virtual Bridge Domains on VPP.
* **Top Level:** Yes
* **User Facing:** Yes
* **CSIT Test:** N/A
odl-vbd-ui
-------------------
+----------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=honeycomb/vbd.git;a=blob;f=features/vbd-features/src/main/features/features.xml;h=66f8ed281850afadcf769a2b9e0925aaedce983a;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=honeycomb/vbd.git;a=blob;f=features/vbd-features/src/main/features/features.xml;hb=refs/heads/stable/carbon
* **Feature Description:** This feature provides the GUI for VBD.
* **Top Level:** Yes
* **User Facing:** Yes
=============
* `Wiki <https://wiki.opendaylight.org/view/Honeycomb/VBD>`_
-* `VBD API https://wiki.opendaylight.org/view/Honeycomb/VBD/API>`_
+* `VBD API <https://wiki.opendaylight.org/view/Honeycomb/VBD/API>`_
Security Considerations
=======================
* Please upgrade to VPP 17.04 stable.
-Compatiblity
-------------
+Compatibility
+-------------
* Not compatible with previous VPP 17.01 or older stable versions.
odl-vtn-manager-rest
--------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=vtn.git;a=blob;f=manager/features/features-vtn-manager/src/main/features/features.xml;h=e4fe7f62405d07653bffa291f984f2cd30db4a4c;hb=refs/heads/stable/carbon#l41
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=vtn.git;a=blob;f=manager/features/features-vtn-manager/src/main/features/features.xml;hb=refs/heads/stable/carbon#l41
* **Feature Description:** This is the feature that allows users to use the VTN virtualization, by creating the various components as needed for the network.
* **Top Level:** Yes
* **User Facing:** Yes
odl-vtn-manager-neutron
----------------------
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=vtn.git;a=blob;f=manager/features/features-vtn-manager/src/main/features/features.xml;h=e4fe7f62405d07653bffa291f984f2cd30db4a4c;hb=refs/heads/stable/carbon#l49
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=vtn.git;a=blob;f=manager/features/features-vtn-manager/src/main/features/features.xml;hb=refs/heads/stable/carbon#l49
* **Feature Description:** This feature provides support for integration with Openstack (L2 API)
* **Top Level:** Yes
* **User Facing:** Yes
* Not Supported.
-Compatiblity
-------------
+Compatibility
+-------------
* No Specific Compatibility issues.
the removal of deprecated API elements and changed elements, there are no
additional steps needed for migration to this release.
-Compatiblity
-------------
+Compatibility
+-------------
* Release is compatible with the previous one.
* API changes:
-.. _alto-user-guide
+.. _alto-user-guide:
ALTO User Guide
===============
+.. _nemo-user-guide:
+
NEtwork MOdeling (NEMO)
=======================
+.. _netconf-user-guide:
+
NETCONF User Guide
==================
-.. neutron-service-user-guide:
+.. _neutron-service-user-guide:
Neutron Service User Guide
==========================
+.. _controller-user-guide:
+
OpenDaylight Controller Overview
================================
+.. _sxp-user-guide:
+
SXP User Guide
==============
+.. _usc-user-guide:
+
Unified Secure Channel
======================