3 Installing OpenDaylight
4 =======================
6 You complete the following steps to install your networking environment, with
7 specific instructions provided in the subsections below.
9 Before detailing the instructions for these, we address the following:
10 Java Runtime Environment (JRE) and operating system information
12 Known issues and limitations
18 Install the Karaf features
19 --------------------------
20 To install a feature, use the following command, where feature1 is the feature
21 name listed in the table below::
23 feature:install <feature1>
25 You can install multiple features using the following command::
28 feature:install <feature1> <feature2> ... <featureN-name>
30 .. note:: For compatibility reasons, you cannot enable all Karaf features
31 simultaneously. The table below documents feature installation names and
32 known incompatibilities.Compatibility values indicate the following:
34 * *all* - the feature can be run with other features.
35 * *self+all* - the feature can be installed with other features with a value of
36 *all*, but may interact badly with other features that have a value of
37 *self+all*. Not every combination has been tested.
41 To uninstall a feature, you must shut down OpenDaylight, delete the data
42 directory, and start OpenDaylight up again.
44 .. important:: Uninstalling a feature using the Karaf feature:uninstall command
45 is not supported and can cause unexpected and undesirable behavior.
47 Listing available features
48 ^^^^^^^^^^^^^^^^^^^^^^^^^^
49 To find the complete list of Karaf features, run the following command::
53 To list the installed Karaf features, run the following command::
57 Features to implement networking functionality provide release notes, which
58 you can find in the :ref:`proj_rel_notes` section.
63 .. list-table:: Beryllium features
73 - Enables authentication with support for federation using Apache Shiro
78 - Provides support for Border Gateway Protocol (including Link-State
79 Distribution) as a source of L3 topology information
84 - Provides support for BGP Monitoring Protocol as a monitoring station
89 - Device Identification and Driver Management
94 - Provides interfaces for streaming analytics
99 - Provides an intuitive graphical user interface for OpenDaylight
102 * - Fabric as a Service (Faas)
103 - Creates a common abstraction layer on top of a physical network so
104 northbound APIs or services can be more easiliy mapped onto the
105 physical network as a concrete device configuration
109 * - Group Based Policy
110 - Enables Endpoint Registry and Policy Repository REST APIs and associated
111 functionality for Group Based Policy with the default renderer for
113 - odl-groupbasedpolicy-ofoverlay
116 * - GBP User Interface
117 - Enables a web-based user interface for Group Based Policy
118 - odl-groupbasedpolicyi-ui
121 * - GBP FaaS renderer
122 - Enables the Fabric as a Service renderer for Group Based Policy
123 - odl-groupbasedpolicy-faas
126 * - GBP Neutron Support
127 - Provides OpenStack Neutron support using Group Based Policy
128 - odl-groupbasedpolicy-neutronmapper
132 - Provides L2 (Ethernet) forwarding across connected OpenFlow switches and
133 support for host tracking
134 - odl-l2switch-switch-ui
138 - Enables support for the Link Aggregation Control Protocol
142 * - LISP Flow Mapping
143 - Enables LISP control plane services including the mapping system
144 services REST API and LISP protocol SB plugin
145 - odl-lispflowmapping-msmr
149 - Provides intent mappings and implementation with CLI for legacy devices
150 - odl-nemo-cli-renderer
154 - Provides intent mapping and implementation for OpenFlow devices
155 - odl-nemo-openflow-renderer
159 - Enables portabilty and cooperation inside a single network by using a
160 client/server multi-controller architecture
165 - Provides support to manage NETCONF-enabled devices over SSH
166 - odl-netconf-connector-ssh
170 - Enables remote configuration of OpenFlow datapaths
174 * - OVSDB OpenStack Neutron
175 - OpenStack Network Virtualization using OpenDaylight's OVSDB support
176 - odl-ovsdb-openstack
180 - OVSDB MDSAL southbound plugin for Open_vSwitch schema
181 - odl-ovsdb-southbound-impl-ui
184 * - OVSDB HWVTEP Southbound
185 - OVSDB MDSAL hwvtep southbound plugin for the hw_vtep schema
186 - odl-ovsdb-hwvtepsouthbound-ui
189 * - OVSDB NetVirt SFC
190 - OVSDB NetVirt support for SFC
194 * - OpenFlow Flow Programming
195 - Enables discovery and control of OpenFlow switches and the topoology
197 - odl-openflowplugin-flow-services-ui
200 * - OpenFlow Table Type Patterns
201 - Allows OpenFlow Table Type Patterns to be manually associated with
207 - Enables flow-based dynamic QoS management of CMTS use in the DOCSIS
208 infrastructure and a policy server
209 - odl-packetcable-policy-server
213 - Enables support for PCEP
217 * - RESTCONF API Support
218 - Enables REST API access to the MD-SAL including the data store
223 - Provides support for interaction and sharing of state between
224 (non-clustered) OpenDaylight instances
225 - odl-sdninterfaceapp-all
229 - Supports implementing Service Function Chaining using Layer 2
235 - Supports implementing Service Function Chaining using LISP
240 - Supports implementing Service Function Chaining using REST CRUD
241 operations on network elements
246 - Supports implementing Service Function Chaining using VXLAN tunnels
251 - Enables monitoring and control of network elements via SNMP
256 - Enables OpenFlow-like control of network elements via SNMP
260 * - SSSD Federated Authentication
261 - Enables support for federated authentication using SSSD
262 - odl-aaa-sssd-plugin
265 * - Secure tag eXchange Protocol (SXP)
266 - Enables distribution of shared tags to network devices
270 * - Time Series Data Repository (TSDR)
271 - Enables support for storing and querying time series data with the
272 default data collector for OpenFlow statistics the default data store
274 - odl-tsdr-hsqldb-all
277 * - TSDR Data Collectors
278 - Enables support for various TSDR data sources (collectors) including
279 OpenFlow statistics, NetFlow statistics, NetFlow statistics, SNMP data,
280 Syslog, and OpenDaylight (controller) metrics
281 - odl-tsdr-openflow-statistics-collector,
282 odl-tsdr-netflow-statistics-collector,
283 odl-tsdr-snmp-data-collector,
284 odl-tsdr-syslog-collector,
285 odl-tsdr-controller-metrics-collector
289 - Enables support for TSDR data stores including HSQLDB, HBase, and
291 - odl-tsdr-hsqldb, odl-tsdr-hbase, or odl-tsdr-cassandra
294 * - Topology Processing Framework
295 - Enables merged and filtered views of network topologies
296 - odl-topoprocessing-framework
299 * - Unified Secure Channel (USC)
300 - Enables support for secure, remote connections to network devices
305 - Enables support for OpenStack VPNaaS
306 - odl-vpnservice-core
310 - Enables Virtual Tenant Network support
311 - odl-vtn-manager-rest
314 * - VTN Manager Neutron
315 - Enables OpenStack Neutron support of VTN Manager
316 - odl-vtn-manager-neutron
320 Other Beryllium features
321 ------------------------
323 .. list-table:: Other Beryllium features
328 - Feature Description
333 - Provides OpFlex agent for Open vSwitch to enforce network policy, such
334 as GBP, for locally-attached virtual machines or containers
339 - Provides a developer toolkit for designing network-centric topology
345 Experimental Beryllium Features
346 -------------------------------
347 The following functionality is labeled as experimental in OpenDaylight
348 Beryllium and should be used accordingly. In general, it is not supposed to be
349 used in production unless its limitations are well understood by those
352 .. list-table:: Other Beryllium features
357 - Feature Description
362 - Enables configurable role-based authorization
367 - Enables support for Application-Layer Traffic Optimization
372 - Enables control of supported wireless APs
376 * - Clustered Authentication
377 - Enables the use of the MD-SAL clustered data store for the
378 authentication database
379 - odl-aaa-authn-mdsal-cluster
382 * - Controller Shield
383 - Provides controller security information to northbound applications
387 * - GBP IO Visor Renderer
388 - Provides support for rendering Group Based Policy to IO Visor
389 - odl-groupbasedpolicy-iovisor
392 * - Internet of Things Data Management
393 - Enables support for the oneM2M specification
397 * - LISP Flow Mapping OpenStack Network Virtualization
398 - Experimental support for OpenStack Neutron virtualization
399 - odl-lispflowmapping-neutron
402 * - Messaging4Transport
403 - Introduces an AMQP Northbound to MD-SAL
404 - odl-messaging4transport
407 * - Network Intent Composition (NIC)
408 - Provides abstraction layer for communcating network intents (including
409 a distributed intent mapping service REST API) using either Hazelcast
410 or the MD-SAL as the backing data store for intents
411 - odl-nic-core-hazelcast or odl-nic-core-mdsal
415 - Provides a Karaf CLI extension for intent CRUD operations and mapping
421 - Virtual Tenant Network renderer for Network Intent Composition
422 - odl-nic-renderer-vtn
426 - Group Based Policy renderer for Network Intent Composition
427 - odl-nic-renderer-gbp
430 * - NIC OpenFlow renderer
431 - OpenFlow renderer for Network Intent Composition
432 - odl-nic-renderer-of
435 * - NIC NEMO renderer
436 - NEtwork MOdeling renderer for Network Intent Composition
437 - odl-nic-renderer-nemo
445 * - Secure Networking Bootstrap
446 - Defines a SNBi domain and associated white lists of devices to be
447 accommodated to the domain
452 - Initiates the development of data models and APIs to facilitate
453 configuration and provisioning connectivity services for OpenDaylight
454 applications and services
459 - Allows subscriptions to be placed on targeted subtrees of YANG
460 datastores residing on remote devices to obviate the need for
461 OpenDaylight to make continuous fetch requests
465 Install support for REST APIs
466 -----------------------------
467 Most components that offer REST APIs will automatically load the RESTCONF API
468 Support component, but if for whatever reason they seem to be missing, install
469 the “odl-restconf” feature to activate this support.
472 Install the DLUX interface
473 --------------------------
474 OpenDaylight’s DLUX web interface draws information from topology and host
475 databases to display information about the topology of the network, flow
476 statistics, and host locations.
478 To integrate with OpenDaylight you must enable the DLUX Karaf feature. Each
479 feature can be enabled or disabled separately. Ensure that you have created a
480 topology and enabled the MD-SAL feature in the Karaf distribution before you
481 use DLUX for network management. For more information about enabling the Karaf
482 features for DLUX, refer to Enable_DLUX_Feature_.
486 In the Beryllium release and newer, the odl-mdsal-broker installs MD-SAL
487 clustering automatically.
489 .. _Enable_DLUX_Feature: https://wiki.opendaylight.org/view/DLUX:Beryllium_System_Test_Plan#Enabling_The_Feature