=== Key Features
-The following table describes the key features provided by the OpenDaylight controller.
+A list of the key functionality provided in OpenDaylight Helium can be found in the table in the <<_installing_components,section below>>.
+
+////
+The following table describes the key features provided by OpenDaylight Helium.
[cols="2",option="headers"]
|==============================================
| Maven support | Used to simplify build automation.
| OSGi framework | Serves as the controller’s back-end, allowing it to dynamically load bundles, package JAR files, and bind bundles together when exchanging information.
| Java interface support | Used by specific bundles to implement call-back functions for events and indicate the awareness of specific states.
-| Service Abstraction Layer (SAL) | Allows the controller to support multiple protocols (such as BGP-LS and OpenFlow) on the southbound interface. Also provides consistent services for modules and applications (which is where the business logic is embedded).
+| Model- Driven Service Abstraction Layer (MD-SAL) | Allows the controller to support multiple protocols (such as BGP-LS and OpenFlow) on the southbound interface. Also provides consistent services for modules and applications (which is where the business logic is embedded).
| Switch Manager | Once a network element has been discovered, its details (such as device type, software version, etc.) are stored by the Switch Manager.
| High Availability (HA) | The controller supports cluster-based HA, allowing you to connect multiple controllers and configure them to act as one in order to ensure the controller’s continuous operation.
|==============================================
-
+////
=== Target Environment
NOTE: If you are using Oracle, JDK version 1.7.0_45 or later is required.
==== For Development
-Although the OpenDaylight controller is developed as a normal Java project, it makes heavy use of the Xtend language. While development is possible with bare tools, we recommend you use Eclipse with the Xtend plugin.
+Although the OpenDaylight controller is developed as a normal Java project, it makes heavy use of the Xtend language in some places. While development is possible with bare tools, we recommend you use Eclipse with the Xtend plugin.
=== Known Issues and Limitation
+Other than as noted in project-specific release notes, there are two known limitations.
+
+. The Karaf distribution of OpenDaylight requires internet access when run for the first time.
+. There are scales beyond which the controller has been unreliable when collecting flow statistics from OpenFlow switches. In tests, theses issues became apparent when managing 10s of thousands of OpenFlow switches, however this may vary depending on deployment and use cases. Flow programming has been unaffected in our tests.
+
+==== Full Bug List
+
All of the known issues for the OpenDaylight controller are listed https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_status%2Cresolution%2Cshort_desc%2Cchangeddate%2Ccf_target_milestone&f1=cf_target_milestone&list_id=15952&n1=1&o1=substring&product=controller&query_based_on=&query_format=advanced&resolution=---&v1=Lithium[here].
-=== Links to Project Release Notes
+=== Project-specific Release Notes
-The following table provides links to the release notes that are currently available for the various projects that are part of the OpenDaylight Helium release. This table will be updated as more release notes become available.
+Project-specific release notes can be found on the OpenDaylight wiki. This table provides links to them by project.
-[option="headers"]
+[options="header",cols="1,4"]
|==============================================
| Project | Release Notes URL
| AAA | https://wiki.opendaylight.org/view/AAA:Helium_Release_Notes
== Getting and Installing OpenDaylight Helium
-This section should be reworked with content added.
-
=== Downloading the Karaf Distribution
// ==== Getting the Default Distribution
----
|===
-=== Installing Features
+=== Installing Components
The following table describes a list of components in OpenDaylight Helium and the relevant Karaf feature to install in order to enable that component. To install a feature use the +feature:install+ Karaf command, for example:
feature:install <feature1-name> <feature2-name> ... <featureN-name>
-----
-.Karaf features
+.Helium Components
[options="header",cols="18%,50%,18%,14%"]
|=======================
| Component Name | Component Description | Karaf feature name | Compatibility
Code Review / docs.git / commitdiff