1 Installing OpenDaylight
2 =======================
4 You complete the following steps to install your networking environment, with
5 specific instructions provided in the subsections below.
7 Before detailing the instructions for these, we address the following:
8 Java Runtime Environment (JRE) and operating system information
10 Known issues and limitations
16 Install the Karaf features
17 --------------------------
18 To install a feature, use the following command, where feature1 is the feature
19 name listed in the table below::
21 feature:install <feature1>
23 You can install multiple features using the following command::
26 feature:install <feature1> <feature2> ... <featureN-name>
28 .. note:: For compatibility reasons, you cannot enable all Karaf features
29 simultaneously. The table below documents feature installation names and
30 known incompatibilities.Compatibility values indicate the following:
32 * *all* - the feature can be run with other features.
33 * *self+all* - the feature can be installed with other features with a value of
34 *all*, but may interact badly with other features that have a value of
35 *self+all*. Not every combination has been tested.
39 To uninstall a feature, you must shut down OpenDaylight, delete the data
40 directory, and start OpenDaylight up again.
42 .. important:: Uninstalling a feature using the Karaf feature:uninstall command
43 is not supported and can cause unexpected and undesirable behavior.
45 Listing available features
46 ^^^^^^^^^^^^^^^^^^^^^^^^^^
47 To find the complete list of Karaf features, run the following command::
51 To list the installed Karaf features, run the following command::
55 Features to implement networking functionality provide release notes, which
56 you can find in the :ref:`proj_rel_notes` section.
61 .. list-table:: Beryllium features
71 - Enables authentication with support for federation using Apache Shiro
76 - Provides support for Border Gateway Protocol (including Link-State
77 Distribution) as a source of L3 topology information
82 - Provides support for BGP Monitoring Protocol as a monitoring station
87 - Device Identification and Driver Management
92 - Provides interfaces for streaming analytics
97 - Provides an intuitive graphical user interface for OpenDaylight
100 * - Fabric as a Service (Faas)
101 - Creates a common abstraction layer on top of a physical network so
102 northbound APIs or services can be more easiliy mapped onto the
103 physical network as a concrete device configuration
107 * - Group Based Policy
108 - Enables Endpoint Registry and Policy Repository REST APIs and associated
109 functionality for Group Based Policy with the default renderer for
111 - odl-groupbasedpolicy-ofoverlay
114 * - GBP User Interface
115 - Enables a web-based user interface for Group Based Policy
116 - odl-groupbasedpolicyi-ui
119 * - GBP FaaS renderer
120 - Enables the Fabric as a Service renderer for Group Based Policy
121 - odl-groupbasedpolicy-faas
124 * - GBP Neutron Support
125 - Provides OpenStack Neutron support using Group Based Policy
126 - odl-groupbasedpolicy-neutronmapper
130 - Provides L2 (Ethernet) forwarding across connected OpenFlow switches and
131 support for host tracking
132 - odl-l2switch-switch-ui
136 - Enables support for the Link Aggregation Control Protocol
140 * - LISP Flow Mapping
141 - Enables LISP control plane services including the mapping system
142 services REST API and LISP protocol SB plugin
143 - odl-lispflowmapping-msmr
147 - Provides intent mappings and implementation with CLI for legacy devices
148 - odl-nemo-cli-renderer
152 - Provides intent mapping and implementation for OpenFlow devices
153 - odl-nemo-openflow-renderer
157 - Enables portabilty and cooperation inside a single network by using a
158 client/server multi-controller architecture
163 - Provides support to manage NETCONF-enabled devices over SSH
164 - odl-netconf-connector-ssh
168 - Enables remote configuration of OpenFlow datapaths
172 * - OVSDB OpenStack Neutron
173 - OpenStack Network Virtualization using OpenDaylight's OVSDB support
174 - odl-ovsdb-openstack
178 - OVSDB MDSAL southbound plugin for Open_vSwitch schema
179 - odl-ovsdb-southbound-impl-ui
182 * - OVSDB HWVTEP Southbound
183 - OVSDB MDSAL hwvtep southbound plugin for the hw_vtep schema
184 - odl-ovsdb-hwvtepsouthbound-ui
187 * - OVSDB NetVirt SFC
188 - OVSDB NetVirt support for SFC
192 * - OpenFlow Flow Programming
193 - Enables discovery and control of OpenFlow switches and the topoology
195 - odl-openflowplugin-flow-services-ui
198 * - OpenFlow Table Type Patterns
199 - Allows OpenFlow Table Type Patterns to be manually associated with
205 - Enables flow-based dynamic QoS management of CMTS use in the DOCSIS
206 infrastructure and a policy server
207 - odl-packetcable-policy-server
211 - Enables support for PCEP
215 * - RESTCONF API Support
216 - Enables REST API access to the MD-SAL including the data store
221 - Provides support for interaction and sharing of state between
222 (non-clustered) OpenDaylight instances
223 - odl-sdninterfaceapp-all
227 - Supports implementing Service Function Chaining using Layer 2
233 - Supports implementing Service Function Chaining using LISP
238 - Supports implementing Service Function Chaining using REST CRUD
239 operations on network elements
244 - Supports implementing Service Function Chaining using VXLAN tunnels
249 - Enables monitoring and control of network elements via SNMP
254 - Enables OpenFlow-like control of network elements via SNMP
258 * - SSSD Federated Authentication
259 - Enables support for federated authentication using SSSD
260 - odl-aaa-sssd-plugin
263 * - Secure tag eXchange Protocol (SXP)
264 - Enables distribution of shared tags to network devices
268 * - Time Series Data Repository (TSDR)
269 - Enables support for storing and querying time series data with the
270 default data collector for OpenFlow statistics the default data store
272 - odl-tsdr-hsqldb-all
275 * - TSDR Data Collectors
276 - Enables support for various TSDR data sources (collectors) including
277 OpenFlow statistics, NetFlow statistics, NetFlow statistics, SNMP data,
278 Syslog, and OpenDaylight (controller) metrics
279 - odl-tsdr-openflow-statistics-collector,
280 odl-tsdr-netflow-statistics-collector,
281 odl-tsdr-snmp-data-collector,
282 odl-tsdr-syslog-collector,
283 odl-tsdr-controller-metrics-collector
287 - Enables support for TSDR data stores including HSQLDB, HBase, and
289 - odl-tsdr-hsqldb, odl-tsdr-hbase, or odl-tsdr-cassandra
292 * - Topology Processing Framework
293 - Enables merged and filtered views of network topologies
294 - odl-topoprocessing-framework
297 * - Unified Secure Channel (USC)
298 - Enables support for secure, remote connections to network devices
303 - Enables support for OpenStack VPNaaS
304 - odl-vpnservice-core
308 - Enables Virtual Tenant Network support
309 - odl-vtn-manager-rest
312 * - VTN Manager Neutron
313 - Enables OpenStack Neutron support of VTN Manager
314 - odl-vtn-manager-neutron
318 Other Beryllium features
319 ------------------------
321 .. list-table:: Other Beryllium features
326 - Feature Description
331 - Provides OpFlex agent for Open vSwitch to enforce network policy, such
332 as GBP, for locally-attached virtual machines or containers
337 - Provides a developer toolkit for designing network-centric topology
343 Experimental Beryllium Features
344 -------------------------------
345 The following functionality is labeled as experimental in OpenDaylight
346 Beryllium and should be used accordingly. In general, it is not supposed to be
347 used in production unless its limitations are well understood by those
350 .. list-table:: Other Beryllium features
355 - Feature Description
360 - Enables configurable role-based authorization
365 - Enables support for Application-Layer Traffic Optimization
370 - Enables control of supported wireless APs
374 * - Clustered Authentication
375 - Enables the use of the MD-SAL clustered data store for the
376 authentication database
377 - odl-aaa-authn-mdsal-cluster
380 * - Controller Shield
381 - Provides controller security information to northbound applications
385 * - GBP IO Visor Renderer
386 - Provides support for rendering Group Based Policy to IO Visor
387 - odl-groupbasedpolicy-iovisor
390 * - Internet of Things Data Management
391 - Enables support for the oneM2M specification
395 * - LISP Flow Mapping OpenStack Network Virtualization
396 - Experimental support for OpenStack Neutron virtualization
397 - odl-lispflowmapping-neutron
400 * - Messaging4Transport
401 - Introduces an AMQP Northbound to MD-SAL
402 - odl-messaging4transport
405 * - Network Intent Composition (NIC)
406 - Provides abstraction layer for communcating network intents (including
407 a distributed intent mapping service REST API) using either Hazelcast
408 or the MD-SAL as the backing data store for intents
409 - odl-nic-core-hazelcast or odl-nic-core-mdsal
413 - Provides a Karaf CLI extension for intent CRUD operations and mapping
419 - Virtual Tenant Network renderer for Network Intent Composition
420 - odl-nic-renderer-vtn
424 - Group Based Policy renderer for Network Intent Composition
425 - odl-nic-renderer-gbp
428 * - NIC OpenFlow renderer
429 - OpenFlow renderer for Network Intent Composition
430 - odl-nic-renderer-of
433 * - NIC NEMO renderer
434 - NEtwork MOdeling renderer for Network Intent Composition
435 - odl-nic-renderer-nemo
443 * - Secure Networking Bootstrap
444 - Defines a SNBi domain and associated white lists of devices to be
445 accommodated to the domain
450 - Initiates the development of data models and APIs to facilitate
451 configuration and provisioning connectivity services for OpenDaylight
452 applications and services
457 - Allows subscriptions to be placed on targeted subtrees of YANG
458 datastores residing on remote devices to obviate the need for
459 OpenDaylight to make continuous fetch requests
463 Install support for REST APIs
464 -----------------------------
465 Most components that offer REST APIs will automatically load the RESTCONF API
466 Support component, but if for whatever reason they seem to be missing, install
467 the “odl-restconf” feature to activate this support.
470 Install the DLUX interface
471 --------------------------
472 OpenDaylight’s DLUX web interface draws information from topology and host
473 databases to display information about the topology of the network, flow
474 statistics, and host locations.
476 To integrate with OpenDaylight you must enable the DLUX Karaf feature. Each
477 feature can be enabled or disabled separately. Ensure that you have created a
478 topology and enabled the MD-SAL feature in the Karaf distribution before you
479 use DLUX for network management. For more information about enabling the Karaf
480 features for DLUX, refer to Enable_DLUX_Feature_.
484 In the Beryllium release and newer, the odl-mdsal-broker installs MD-SAL
485 clustering automatically.
487 .. _Enable_DLUX_Feature: https://wiki.opendaylight.org/view/DLUX:Beryllium_System_Test_Plan#Enabling_The_Feature