docs/documentation.rst,
docs/getting-started-guide/**,
docs/opendaylight-with-openstack/**,
+ docs/release-notes/projects/**,
docs/submodules/aaa/**,
docs/submodules/coe/**,
docs/submodules/federation/**,
other_features
api
installing_opendaylight
- release_notes
project-specific-guides/index
common-features/index
security_considerations
+++ /dev/null
-====
-DIDM
-====
-
-Major Features
-==============
-
-odl-didm-all
-------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=didm.git;a=blob;f=features/src/main/features/features.xml;hb=HEAD
-* **Feature Description:** Device Identification and device driver framework
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** None
-
-odl-didm-ovs-all
-----------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=didm.git;a=blob;f=vendor/ovs/features/src/main/features/features.xml;hb=HEAD
-* **Feature Description:** DIDM OVS reference driver
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** NA
-
-odl-didm-ovs-all
-----------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=didm.git;a=blob;f=vendor/hp/features/src/main/features/features.xml;hb=HEAD
-* **Feature Description:** DIDM HP device identification and driver management
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** NA
-
-
-
-Documentation
-=============
-
-* **User Guide(s):**
-
- * :ref:`DIDM User Guide <didm-user-guide>`
-
-* **Developer Guide(s):**
-
- * :ref:`DIDM Developer Guide <didm-developer-guide>`
-
-Security Considerations
-=======================
-
-* There are no security issue found.
-
-Quality Assurance
-=================
-
-* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=org.opendaylight.didm%3Adidm-aggregator>`_
-* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/didm/job/didm-csit-1node-discovery-only-carbon/>`_
-* Testing is done manually.
-
-Migration
----------
-
-* No changes has been done from the last release.
-
-Compatibility
--------------
-
-* Release is compatible with previous release.
-* No API changes has been done.
-* No configuration changes has been done.
-
-Bugs Fixed
-----------
-
-* No bugfix has been done.
-
-Known Issues
-------------
-
-* Initial release for device driver support. The release only supports device driver feature for HP 3800 and OVS (Open vSwitch).
-* RPC "adjustFlow" is not adjusting the flows as expected for HP switch platform.
-
-End-of-life
-===========
-
-* No changes has been done from previous supported API.
-
-Standards
-=========
-
-* :ref:`Flow Objective API <didm-flow-objective-api>`
-
-Release Mechanics
-=================
-
-* `Link to release plan <https://wiki.opendaylight.org/view/DIDM:Carbon>`_
+++ /dev/null
-=============
-Documentation
-=============
-
-Major Features
-==============
-
-Not Applicable. The documentation project does not produce any code artifacts for the release.
-
-Documentation
-=============
-
-* **Installation Guide(s):**
-
- * The :ref:`getting_started_guide` includes details about installation.
-
-* **User Guide(s):**
-
- * The :ref:`user_guide` includes sub-guides for each major feature in each project.
-
-* **Developer Guide(s):**
-
- * The :ref:`developer_guide` includes sub-guides for each major feature in each project.
-
-Security Considerations
-=======================
-
-* Do you have any external interfaces other than RESTCONF?
-
- * No.
-
-* Other security issues?
-
- * None.
-
-Quality Assurance
-=================
-
-Not applicable.
-
-Migration
----------
-
-Not applicable.
-
-Compatibility
--------------
-
-Not applicable.
-
-Bugs Fixed
-----------
-
-Not applicable.
-
-Known Issues
-------------
-
-None.
-
-End-of-life
-===========
-
-* List of features/APIs which are EOLed, deprecated, and/or removed in this
- release.
-
- * None.
-
-Standards
-=========
-
-* List of standrads implemented and to what extent
-
- * None.
-
-Release Mechanics
-=================
-
-* `Documentation Carbon Release Plan
- <https://wiki.opendaylight.org/view/Documentation/Release_Plans/Carbon_Release_Plan>`_
-* Describe any major shifts in release schedule from the release plan
-
- * Dropped delivery of code-snippet import from projects.
- * Didn't provide a general service chaining deployment guide.
+++ /dev/null
-=====
-IoTDM
-=====
-
-Major Features
-==============
-
-odl-onem2m-core
----------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=iotdm.git;a=blob_plain;f=onem2m/onem2m-features/features-onem2m/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:** This feature implements CSE services described in OneM2M specifications and provides some
- APIs simplifying development and usage of new plugins. These APIs and related services are considered as IoTDM's plugin
- infrastructure.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/iotdm/job/iotdm-csit-1node-basic-all-carbon/
-
-odl-onem2m-http
----------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=iotdm.git;a=blob_plain;f=onem2m/onem2m-features/features-onem2m/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:** Implements communication over HTTP and HTTPS according to OneM2M specifications.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/iotdm/job/iotdm-csit-1node-basic-all-carbon/
-
-odl-onem2m-coap
----------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=iotdm.git;a=blob_plain;f=onem2m/onem2m-features/features-onem2m/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:** Implements communication over CoAP and CoAPS according to OneM2M specifications.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/iotdm/job/iotdm-csit-1node-basic-all-carbon/
-
-odl-onem2m-mqtt
----------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=iotdm.git;a=blob_plain;f=onem2m/onem2m-features/features-onem2m/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:** Implements communication over MQTT according to OneM2M specifications.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/iotdm/job/iotdm-csit-1node-basic-all-carbon/
-
-odl-onem2m-websocket
---------------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=iotdm.git;a=blob_plain;f=onem2m/onem2m-features/features-onem2m/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:** Implements communication over websocket according to OneM2M specifications.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/iotdm/job/iotdm-csit-1node-basic-all-carbon/
-
-odl-iotdmbundleloader
----------------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=iotdm.git;a=blob_plain;f=onem2mplugins/iotdmbundleloader/features/features-iotdmbundleloader/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:** Provides REST API to dynamically install/uninstall/reinstall new OSGI bundles to Karaf.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** N/A
-
-odl-iotdmkaraffeatureloader
----------------------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=iotdm.git;a=blob_plain;f=onem2mplugins/iotdmkaraffeatureloader/features/features-iotdmkaraffeatureloader/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:** Provides REST API to dynamically install/uninstall/reinstall new Karaf features from Karaf archive file.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** N/A
-
-Documentation
-=============
-
-There is some outdated documentation at our wiki page: https://wiki.opendaylight.org/view/IoTDM:Main
-
-Some general information can be found in developer guide for IoTDM, see :ref:`iotdm_dev_guide`.
-
-There is more actual developers documentation as README files in IoTDM's sources.
-
-Security Considerations
-=======================
-
-Since this project implements OneM2M specifications including protocol bindings it is also opening multiple ports
-for plugins providing mapping between protocol specific representation of data to the common format used by
-onem2m-core. Port numbers opened by IoTDM depends on configuration of these plugins and also depends on number of
-instances of the plugins.
-
-There are some default server port numbers pre-configured for OneM2M related plugins,
-e.g.: HTTP: 8282(TCP), CoAP: 5683(UDP), Websocket: 8888(TCP) which are enabled by default.
-
-HTTPS and CoAPS communication can be used instead of unsecured versions but it must be configured properly.
-There are implemented also other experimental plugins opening ports by default: odl-onem2mexample:: 8283(TCP),
-dl-onem2medevice:: 8284(TCP) and 123(UDP)
-
-The experimental features odl-iotdmbundleloader and odl-iotdmkaraffeatureloader are insecure in this version since
-there are not implemented any security mechanisms yet.
-
-Quality Assurance
-=================
-
-* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=org.opendaylight.iotdm%3Aiotdm-aggregator>`_ (0.6 %)
-* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/iotdm/job/iotdm-csit-1node-basic-all-carbon/>`_
-* Other manual testing and QA information
- HTTP communication tested manually by Postman collections and other communication (MQTT, CoAP, Websocket) tested
- occasionally using some opensource tools.
- We are using code coverage achieved by our CSIT test suites as QA metrics what is currently 35 %.
-
-* Testing methodology. How extensive was it? What should be expected to work? What hasn't been tested as much?
- We have defined CSIT test suites including list of test cases without implementation including description only.
- These tests are marked as "excluded" so they are not executed by CSIT jobs.
- There are described 736 tests and 278 of them are implemented. These tests are testing HTTP communication only.
- Other communication protocols are not being tested by CSIT jobs now.
-
-Migration
----------
-
-* Is it possible to migrate from the previous release? If so, how?
- No, current release is backward incompatible.
-
-Compatibility
--------------
-
-* Is this release compatible with the previous release?
- No
-
-* Any API changes?
- Yes, the REST API of onem2m-api feature has been modified and implementations of the OneM2M APIs have been
- modified as well.
-
-* Any configuration changes?
- There was not any configurable module in previous releases.
-
-Bugs Fixed
-----------
-
-* List of bugs fixed since the previous release
- Only bugs related to current release have been fixed.
-
-Known Issues
-------------
-
-There are several low priority issues opened in IoTDM's Bugzilla.
-Here are some major issues:
-7990 - Race condition after resource delete - https://bugs.opendaylight.org/show_bug.cgi?id=7990
-4316 - "mni" and "mbs" does not work stable - https://bugs.opendaylight.org/show_bug.cgi?id=4316
-
-End-of-life
-===========
-
-* List of features/APIs which are EOLed, deprecated, and/or removed in this release
- N/A
-
-Standards
-=========
-
-Subset of functionality described in OneM2M specifications: http://onem2m.org/technical/published-documents
-
-* TS 0001, version 2.10.0
-* TS 0004, version 2.7.1
-* TS 0008, version 1.3.2
-* TS 0009, version 2.6.1
-* TS 0010, version 2.4.1
-* TS 0020, version 2.1.0
-
-Release Mechanics
-=================
-
-* `Link to release plan <https://wiki.opendaylight.org/view/Iotdm:_Carbon_Release_Plan>`_
+++ /dev/null
-==============
-NetIDE Project
-==============
-
-Major Features
-==============
-
-odl-netide-api
---------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netide.git;a=blob;f=features/features-netide/src/main/features/features.xml
-* **Feature Description:** This feature provides the YANG models for
- NetIDE interoperability layer for SDN Applications written for other
- SDN Controllers to run on OpenDaylight managed infrastructure.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-all-carbon/
- https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-only-carbon/
-
-odl-netide-impl
----------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netide.git;a=blob;f=features/features-netide/src/main/features/features.xml
-* **Feature Description:** This feature is the main feature of NetIDE. This
- plugin provides the implementation to transfer Openflow commands from other
- SDN controllers to the switches.
-* **Top Level:** Yes
-* **User Facing:** No
-* **Experimental:** Yes
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-all-carbon/
- https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-only-carbon/
-
-odl-netide-rest
----------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netide.git;a=blob;f=features/features-netide/src/main/features/features.xml
-* **Feature Description:** This feature is the wrapper feature that installs
- the odl-netide-api & odl-netide-impl feature with other required features for
- restconf access to provide a functional Openflow commands to the switches.
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** Yes
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-all-carbon/
- https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-only-carbon/
-
-Documentation
-=============
-
-* **User Guide(s):**
-
- * :ref:`netide-user-guide`
-
-* **Developer Guide(s):**
-
- * :ref:`netide-dev-guide`
-
-Security Considerations
-=======================
-
-* Do you have any external interfaces other than RESTCONF? No
-* Other security issues? none
-
-Quality Assurance
-=================
-
-* `Link to Sonar Report <https://sonar.opendaylight.org/overview/coverage?id=org.opendaylight.netide%3Anetide-aggregator>`_ (74.4)
-* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/netide/>`_
-* NetIDE was tested through Unit Tests, IT test and system tests. A manual
- testing plan was also completed. See `Carbon Test Plan <https://wiki.opendaylight.org/view/NetIDE:Carbon:System_Test>`_
-
-Migration
----------
-
-* Is it possible to migrate from the previous release? If so, how?
-
- Yes. No state data kept in datastore. User facing features and interfaces have not changed between releases, only
- enhancements/bugfixes were added.
-
-Compatibility
--------------
-
-* Is this release compatible with the previous release? Yes
-* Any API changes? No changes in the yang models from previous release. Only enhancements completed.
-* Any configuration changes? No
-
-Bugs Fixed
-----------
-
-* List of bugs fixed since the previous release: None
-
-Known Issues
-------------
-
-* List key known issues with workarounds: None
-
-
-End-of-life
-===========
-
-* List of features/APIs which are EOLed, deprecated, and/or removed in this release: None
-
-Standards
-=========
-
-Openflow versions:
-
-* `OpenFlow1.3.2 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.3.2.pdf>`_
-* `OpenFlow1.0.0 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.0.0.pdf>`_
-
-
-Release Mechanics
-=================
-
-* `Link to release plan <https://wiki.opendaylight.org/view/NetIDE:Carbon_Release_Plan>`_
-* Describe any major shifts in release schedule from the release plan: None
+++ /dev/null
-============
-Openflowjava
-============
-
-Major Features
-==============
-
-odl-openflowjava-protocol
--------------------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowjava.git;a=blob;f=features/features-openflowjava/src/main/features/features.xml;hb=refs/heads/stable/carbon
-* **Feature Description:** This feature exposes SwitchConnectionProvider for building openflow connections
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** No
-* **CSIT Test:**
-
- * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-only-carbon/
- * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-frs-only-carbon/
- * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-clustering-only-carbon/
- * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-bulkomatic-perf-daily-only-carbon/
- * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-periodic-bulkomatic-clustering-perf-daily-only-carbon/
- * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-gate-scale-stats-collection-daily-only-carbon/
- * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-scale-stats-collection-daily-frs-only-carbon/
- * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-sw-scalability-daily-only-carbon/
- * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-link-scalability-daily-only-carbon/
-
-Documentation
-=============
-
-* **User Guide(s):**
-
- * `user guide <https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Startup_Guide>`_
-
-* **Developer Guide(s):**
-
- * :ref:`developer guide <openflow-protocol-library-dev-guide>`
-
-Security Considerations
-=======================
-
-* openflowjava listens on given TCP/UDP ports and propagates messages to consumer (by default TCP:6633 and TCP:6653)
-* OpenFlow messages can inflict high load on consumer which needs to be handled there
-
-Quality Assurance
-=================
-
-* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=11724>`_ (85.8% line coverage)
-* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_ (supplied by openflowplugin)
-
-Migration
----------
-
-* no additional migration steps needed
-
-Compatibility
--------------
-
-* release is compatible with the previous release
-* no API changes
-* no configuration changes
-
-Bugs Fixed
-----------
-
-* `List of bugs fixed since the previous release: <https://bugs.opendaylight.org/buglist.cgi?bug_status=RESOLVED&chfield=target_milestone&chfieldto=Now&component=General&f1=cf_target_milestone&f2=cf_target_milestone&f3=cf_target_milestone&f4=cf_target_milestone&f5=cf_target_milestone&j_top=AND_G&list_id=78956&o1=substring&product=openflowjava&query_format=advanced&resolution=FIXED&resolution=INVALID&resolution=WONTFIX&resolution=DUPLICATE&resolution=WORKSFORME&v1=Carbon>`_
-
-Known Issues
-------------
-
-* List key known issues with workarounds
-* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&chfield=target_milestone&chfieldto=Now&component=General&f1=cf_target_milestone&f2=cf_target_milestone&f3=cf_target_milestone&f4=cf_target_milestone&f5=cf_target_milestone&f6=cf_target_milestone&j_top=AND_G&list_id=78961&o1=substring&product=openflowjava&query_format=advanced&resolution=---&v1=Carbon>`_
-
-End-of-life
-===========
-
-* List of features/APIs which are EOLed, deprecated, and/or removed in this
- release
-
- none
-
-Standards
-=========
-
-* based on `openflow switch specification 1.3.2 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.3.2.pdf>`_
-
-Release Mechanics
-=================
-
-* `Link to release plan <https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Carbon_Release_Plan>`_
.. toctree::
:maxdepth: 1
+ release-notes/index
getting-started-guide/index
user-guide/index
opendaylight-with-openstack/index
-*************
+#############
Release Notes
-*************
+#############
Target Environment
==================
issues became apparent when managing thousands of OpenFlow
switches, however this may vary depending on deployment and use cases.
-.. _proj_rel_notes:
-
Project-specific Release Notes
==============================
.. toctree::
:maxdepth: 1
- project-release-notes/aaa
- project-release-notes/alto
- project-release-notes/bgp-ls-pcep
- project-release-notes/bier
- project-release-notes/cardinal
- project-release-notes/controller
- project-release-notes/daexim-release-notes
- project-release-notes/distribution-release-notes
- project-release-notes/dlux
- project-release-notes/dluxapps
- project-release-notes/eman
- project-release-notes/faas-release-notes
- project-release-notes/gbp-release-notes
- project-release-notes/genius
- project-release-notes/infrautils
- project-release-notes/l2switch
- project-release-notes/lispflowmapping
- project-release-notes/mdsal
- project-release-notes/nemo
- project-release-notes/netconf
- project-release-notes/netvirt
- project-release-notes/neutron-northbound
- project-release-notes/nic
- project-release-notes/ocpplugin-release-notes
- project-release-notes/odlparent
- project-release-notes/of-config-release-notes
- project-release-notes/openflowplugin
- project-release-notes/opflex
- project-release-notes/ovsdb
- project-release-notes/packetcable
- project-release-notes/sfc
- project-release-notes/snmp
- project-release-notes/snmp4sdn
- project-release-notes/sxp
- project-release-notes/topology-processing-framework
- project-release-notes/ttp
- project-release-notes/unimgr
- project-release-notes/usc
- project-release-notes/vbd
- project-release-notes/vtn
- project-release-notes/yangtools
+ projects/aaa
+ projects/alto
+ projects/bgp-ls-pcep
+ projects/bier
+ projects/cardinal
+ projects/controller
+ projects/daexim
+ projects/didm
+ projects/distribution
+ projects/dlux
+ projects/dluxapps
+ projects/eman
+ projects/faas
+ projects/gbp
+ projects/genius
+ projects/infrautils
+ projects/iotdm
+ projects/l2switch
+ projects/lispflowmapping
+ projects/mdsal
+ projects/nemo
+ projects/netconf
+ projects/netide
+ projects/netvirt
+ projects/neutron-northbound
+ projects/nic
+ projects/ocpplugin
+ projects/odlparent
+ projects/odl-sdni.rst
+ projects/of-config
+ projects/openflowjava
+ projects/openflowplugin
+ projects/opflex
+ projects/ovsdb
+ projects/packetcable
+ projects/sfc
+ projects/snmp
+ projects/snmp4sdn
+ projects/sxp
+ projects/topology-processing-framework
+ projects/tsdr
+ projects/ttp
+ projects/unimgr
+ projects/usc
+ projects/vbd
+ projects/vtn
+ projects/yangtools
-==========\r
-Federation\r
-==========\r
-\r
-Major Features\r
-==============\r
-\r
-federation-with-rabbit\r
-----------------------\r
-\r
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=federation.git;a=blob;f=features/features-federation/src/main/features/features.xml\r
-* **Feature Description:** The federation service is a project that\r
- facilitates the exchange of state between multiple OpenDaylight\r
- deployments (henceforth 'sites'). These sites may be single node\r
- deployments or cluster deployments. The 'federation-with-rabbit'\r
- feature is a specific implementation of the federation service, based\r
- on Rabbit MQ broker. Federation service currently only supports the\r
- Rabbit MQ implementation.\r
-* **Top Level:** Yes\r
-* **User Facing:** Yes\r
-* **Experimental:** Yes\r
-* **CSIT Test:** No (tested via NetVirt CSIT)\r
-\r
-Documentation\r
-=============\r
-\r
-Please provide the URL to each document at docs.opendaylight.org. If\r
-the document is under review, provide a link to the change in Gerrit.\r
-\r
-* **Installation Guide(s):**\r
-\r
- * :doc:`../../submodules/federation/docs/install-guide/federation-install-guide`\r
-\r
-* **Developer Guide(s):**\r
-\r
- * :doc:`../../submodules/federation/docs/developer-guide/federation-developer-guide`\r
-\r
-Security Considerations\r
-=======================\r
-\r
-* No dedicated port numbers are used.\r
-* Securing of RabbitMQ is beyond the scope of this project but it is\r
- suggested that standard RabbitMQ security procedures are applied.\r
-\r
-Quality Assurance\r
-=================\r
-\r
-* This project was not independently tested. Rather it was tested\r
- indirectly by means of the NetVirt Federation Plugin.\r
-\r
-Migration\r
----------\r
-\r
-* Not applicable. Federation is a new project released in the Carbon\r
- release for the first time.\r
-\r
-Compatibility\r
--------------\r
-\r
-* Not applicable. Federation is a new project released in the Carbon\r
- release for the first time.\r
-\r
-Bugs Fixed\r
-----------\r
-\r
-* Not applicable. Federation is a new project released in the Carbon\r
- release for the first time.\r
-\r
-Known Issues\r
-------------\r
-\r
-* There are no known issues with respect of the usage flow tested via\r
- the NetVirt Federation Plugin\r
-\r
-End-of-life\r
-===========\r
-\r
-* Not applicable. Federation is a new project released in the Carbon\r
- release for the first time.\r
-\r
-Standards\r
-=========\r
-\r
-* Not applicable\r
-\r
-Release Mechanics\r
-=================\r
-\r
-* https://wiki.opendaylight.org/view/Federation:Carbon_Release_Plan\r
+==========
+Federation
+==========
+
+Major Features
+==============
+
+federation-with-rabbit
+----------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=federation.git;a=blob;f=features/features-federation/src/main/features/features.xml
+* **Feature Description:** The federation service is a project that
+ facilitates the exchange of state between multiple OpenDaylight
+ deployments (henceforth 'sites'). These sites may be single node
+ deployments or cluster deployments. The 'federation-with-rabbit'
+ feature is a specific implementation of the federation service, based
+ on Rabbit MQ broker. Federation service currently only supports the
+ Rabbit MQ implementation.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** No (tested via NetVirt CSIT)
+
+Documentation
+=============
+
+Please provide the URL to each document at docs.opendaylight.org. If
+the document is under review, provide a link to the change in Gerrit.
+
+* **Installation Guide(s):**
+
+ * :doc:`../../submodules/federation/docs/install-guide/federation-install-guide`
+
+* **Developer Guide(s):**
+
+ * :doc:`../../submodules/federation/docs/developer-guide/federation-developer-guide`
+
+Security Considerations
+=======================
+
+* No dedicated port numbers are used.
+* Securing of RabbitMQ is beyond the scope of this project but it is
+ suggested that standard RabbitMQ security procedures are applied.
+
+Quality Assurance
+=================
+
+* This project was not independently tested. Rather it was tested
+ indirectly by means of the NetVirt Federation Plugin.
+
+Migration
+---------
+
+* Not applicable. Federation is a new project released in the Carbon
+ release for the first time.
+
+Compatibility
+-------------
+
+* Not applicable. Federation is a new project released in the Carbon
+ release for the first time.
+
+Bugs Fixed
+----------
+
+* Not applicable. Federation is a new project released in the Carbon
+ release for the first time.
+
+Known Issues
+------------
+
+* There are no known issues with respect of the usage flow tested via
+ the NetVirt Federation Plugin
+
+End-of-life
+===========
+
+* Not applicable. Federation is a new project released in the Carbon
+ release for the first time.
+
+Standards
+=========
+
+* Not applicable
+
+Release Mechanics
+=================
+
+* https://wiki.opendaylight.org/view/Federation:Carbon_Release_Plan
-========\r
-SNMP4SDN\r
-========\r
-\r
-Major Features\r
-==============\r
-\r
-odl-snmp4sdn-snmp4sdn\r
----------------------\r
-\r
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=snmp4sdn.git;a=blob;f=features/odl-snmp4sdn-snmp4sdn/pom.xml;h=eece899425487cf81e81e3d87bff78a2f3d2797c;hb=HEAD\r
-* **Feature Description:** This feature will install all bundles required for SNMP4SDN Plugin\r
-* **Top Level:** Yes\r
-* **User Facing:** Yes\r
-* **Experimental:** Yes\r
-* **CSIT Test:** NA\r
-\r
-\r
-Documentation\r
-=============\r
-\r
-* **User Guide:**\r
-\r
- * :ref:`snmp4sdn-user-guide`\r
-\r
-* **Developer Guide(s):**\r
-\r
- * :ref:`snmp4sdn-dev-guide`\r
-\r
-Security Considerations\r
-=======================\r
-\r
-* The interface or configurable resource exposed to users includes RESTCONF API\r
- and the switch list file. Switch list file, which is a plain-text file,\r
- contains security information such as SNMP community.\r
-\r
-* SNMP4SDN Plugin configures switches via SNMP protocol, and listens to SNMP\r
- listen port for link-up/down trap. SNMP v2c is used.\r
-\r
-Quality Assurance\r
-=================\r
-\r
-* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=44354>`_ (Test coverage percent NA)\r
-* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/snmp4sdn/>`_\r
-* Other manual testing and QA information\r
-* For each function of SNMP4SDN Plugin, use REST API to confirm it's\r
- availability and correctness. Existing functions includes flow configuration\r
- (such as VLAN and forwarding table) and topology discovery.\r
-\r
-Migration\r
----------\r
-\r
-* Is it possible to migrate from the previous release? If so, how?\r
-\r
- No\r
-\r
-Compatibility\r
--------------\r
-\r
-* Is this release compatible with the previous release?\r
-\r
- Yes\r
-\r
-* Any API changes?\r
-\r
- No\r
-\r
-* Any configuration changes?\r
-\r
- No\r
-\r
-\r
-Bugs Fixed\r
-----------\r
-\r
-* None (no bugs reported since the previous release)\r
-\r
-Known Issues\r
-------------\r
-\r
-* List key known issues with workarounds\r
-\r
- None\r
-\r
-* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&list_id=78998&order=Importance&product=snmp4sdn&query_format=specific>`_\r
-\r
-End-of-life\r
-===========\r
-\r
-* List of features/APIs which are EOLed, deprecated, and/or removed in this release\r
-\r
- None\r
-\r
-Standards\r
-=========\r
-\r
-* List of standards implemented and to what extent\r
-\r
- None (no standards implemented, and use a third-party library to configure switches in standard SNMP protocol)\r
-\r
-Release Mechanics\r
-=================\r
-\r
-* `Link to release plan <https://wiki.opendaylight.org/view/SNMP4SDN:Release_Plan_Nitrogen>`_\r
-* No changes in this release\r
+========
+SNMP4SDN
+========
+
+Major Features
+==============
+
+odl-snmp4sdn-snmp4sdn
+---------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=snmp4sdn.git;a=blob;f=features/odl-snmp4sdn-snmp4sdn/pom.xml;h=eece899425487cf81e81e3d87bff78a2f3d2797c;hb=HEAD
+* **Feature Description:** This feature will install all bundles required for SNMP4SDN Plugin
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** NA
+
+
+Documentation
+=============
+
+* **User Guide:**
+
+ * :ref:`snmp4sdn-user-guide`
+
+* **Developer Guide(s):**
+
+ * :ref:`snmp4sdn-dev-guide`
+
+Security Considerations
+=======================
+
+* The interface or configurable resource exposed to users includes RESTCONF API
+ and the switch list file. Switch list file, which is a plain-text file,
+ contains security information such as SNMP community.
+
+* SNMP4SDN Plugin configures switches via SNMP protocol, and listens to SNMP
+ listen port for link-up/down trap. SNMP v2c is used.
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=44354>`_ (Test coverage percent NA)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/snmp4sdn/>`_
+* Other manual testing and QA information
+* For each function of SNMP4SDN Plugin, use REST API to confirm it's
+ availability and correctness. Existing functions includes flow configuration
+ (such as VLAN and forwarding table) and topology discovery.
+
+Migration
+---------
+
+* Is it possible to migrate from the previous release? If so, how?
+
+ No
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release?
+
+ Yes
+
+* Any API changes?
+
+ No
+
+* Any configuration changes?
+
+ No
+
+
+Bugs Fixed
+----------
+
+* None (no bugs reported since the previous release)
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+
+ None
+
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&list_id=78998&order=Importance&product=snmp4sdn&query_format=specific>`_
+
+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 (no standards implemented, and use a third-party library to configure switches in standard SNMP protocol)
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/SNMP4SDN:Release_Plan_Nitrogen>`_
+* No changes in this release
Code Review / docs.git / commitdiff