docs/getting-started-guide/installing_opendaylight.rst

   1 Installing OpenDaylight
   2 =======================
   3
   4 You complete the following steps to install your networking environment, with
   5 specific instructions provided in the subsections below.
   6
   7 Before detailing the instructions for these, we address the following:
   8 Java Runtime Environment (JRE) and operating system information
   9 Target environment
  10 Known issues and limitations
  11
  12
  13 Install OpenDaylight
  14 --------------------
  15
  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::
  20
  21     feature:install <feature1>
  22
  23 You can install multiple features using the following command::
  24
  25
  26     feature:install <feature1> <feature2> ... <featureN-name>
  27
  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:
  31
  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.
  36
  37 Uninstalling features
  38 ^^^^^^^^^^^^^^^^^^^^^
  39 To uninstall a feature, you must shut down OpenDaylight, delete the data
  40 directory, and start OpenDaylight up again.
  41
  42 .. important:: Uninstalling a feature using the Karaf feature:uninstall command
  43    is not supported and can cause unexpected and undesirable behavior.
  44
  45 Listing available features
  46 ^^^^^^^^^^^^^^^^^^^^^^^^^^
  47 To find the complete list of Karaf features, run the following command::
  48
  49     feature:list
  50
  51 To list the installed Karaf features, run the following command::
  52
  53     feature:list -i
  54
  55 Features to implement networking functionality provide release notes you can
  56 access on the OpenDaylight Wiki: https://wiki.opendaylight.org/view/Project_list
  57
  58 * Authentication, Authorization and Accounting (AAA_)
  59 * ALTO_
  60 * BGPCEP_
  61 * Controller_
  62 * Control And Provisioning of Wireless Access Points (CAPWAP_)
  63 * Identification and Driver Management (DIDM_)
  64 * DLUX_
  65 * FaaS_
  66 * Group_Based_Policy_ (GPB)
  67 * Internet of Things Data Management (IoTDM_)
  68 * L2_Switch_
  69 * Link Aggregation Control Protocol (LACP_)
  70 * LISP_Flow_Mapping_
  71 * MDSAL_
  72 * NEMO_
  73 * NETCONF_
  74 * NetIDE_
  75 * NeXt_
  76 * Network Intent Composition (NIC_)
  77 * Neutron_Northbound_
  78 * OF-Config_
  79 * OpFlex_
  80 * OpenFlow_Plugin_
  81 * OpenFlow_Protocol_Library_
  82 * OVSDB_Netvirt_
  83 * Packet_Cable_ / PCMM
  84 * SDN_Interface_Application_
  85 * Secure Network Bootstrapping Infrastructure (SNBI_)
  86 * SNMP4SDN_
  87 * SNMP_Plugin_
  88 * Secure tag eXchange Protocol (SXP_)
  89 * Service Function Chaining (SFC_)
  90 * TCPMD5_
  91 * Time Series Data Repository (TSDR_)
  92 * Table Type Patterns (TTP_)
  93 * Topology_Processing_Framework_
  94 * Unified Secure Channel (USC_)
  95 * VPN_Service_
  96 * Virtual Tenant Network (VTN_)
  97 * YANG_Tools_
  98
  99 Projects without Release Notes
 100 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 101 The following projects participated in Beryllium, but intentionally do not have
 102 release notes:
 103
 104 * The Documentation Project produced this and the other downloadable
 105   documentation.
 106 * The Integration Group hosted the OpenDaylight-wide tests and main release
 107   distribution.
 108 * Controller Core Functionality Tutorials provided a single test suite
 109   (dsbenchmark) that was used as part of integration testing
 110 * Release Engineering used autorelease to build the Beryllium release artifacts,
 111   including the main release download.
 112
 113 Beryllium features
 114 ------------------
 115 .. image:: images/be-features-1.png
 116
 117 .. image:: images/be-features-2.png
 118
 119 .. image:: images/be-features-3.png
 120
 121 Other Beryllium features
 122 ------------------------
 123 .. image:: images/be-nonfeatures.png
 124
 125 Experimental Beryllium Features
 126 -------------------------------
 127 The following functionality is labeled as experimental in OpenDaylight
 128 Beryllium and should be used accordingly. In general, it is not supposed to be
 129 used in production unless its limitations are well understood by those
 130 deploying it.
 131
 132 .. image:: images/be-exp-features-1.png
 133
 134 .. image:: images/be-exp-features-2.png
 135
 136 Install support for REST APIs
 137 -----------------------------
 138 Most components that offer REST APIs will automatically load the RESTCONF API
 139 Support component, but if for whatever reason they seem to be missing, install
 140 the “odl-restconf” feature to activate this support.
 141
 142
 143 Install the DLUX interface
 144 --------------------------
 145 OpenDaylight’s DLUX web interface draws information from topology and host
 146 databases to display information about the topology of the network, flow
 147 statistics, and host locations.
 148
 149 To integrate with OpenDaylight you must enable the DLUX Karaf feature. Each
 150 feature can be enabled or disabled separately. Ensure that you have created a
 151 topology and enabled the MD-SAL feature in the Karaf distribution before you
 152 use DLUX for network management. For more information about enabling the Karaf
 153 features for DLUX, refer to Enable_DLUX_Feature_.
 154
 155 MD-SAL clustering
 156 -----------------
 157 In the Beryllium release and newer, the odl-mdsal-broker installs MD-SAL
 158 clustering automatically.
 159
 160 .. _Enable_DLUX_Feature: https://wiki.opendaylight.org/view/DLUX:Beryllium_System_Test_Plan#Enabling_The_Feature
 161
 162
 163 .. _AAA: https://wiki.opendaylight.org/view/AAA:Beryllium_Release_Notes
 164 .. _ALTO: https://wiki.opendaylight.org/view/ALTO:Beryllium:Release_Notes
 165 .. _BGPCEP: https://wiki.opendaylight.org/view/BGP_LS_PCEP:Beryllium_Release_Notes
 166 .. _CAPWAP: https://wiki.opendaylight.org/view/CAPWAP:Beryllium:Release_Notes
 167 .. _Controller: https://wiki.opendaylight.org/view/OpenDaylight_Controller:Beryllium:Release_Notes
 168 .. _DIDM: https://wiki.opendaylight.org/view/DIDM:_Beryllium_Release_Notes
 169 .. _DLUX: https://wiki.opendaylight.org/view/OpenDaylight_DLUX:Beryllium:Release_Notes
 170 .. _FaaS: https://wiki.opendaylight.org/view/FaaS:Beryllium_Release_Notes
 171 .. _Group_Based_Policy: https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Releases/Beryllium:Beryllium_Release_Notes
 172 .. _IoTDM: https://wiki.opendaylight.org/view/Iotdm:Beryllium_Release_Notes
 173 .. _L2_Switch: https://wiki.opendaylight.org/view/L2_Switch:Beryllium:Release_Notes
 174 .. _LACP: https://wiki.opendaylight.org/view/LACP:Beryllium:Release_Notes
 175 .. _LISP_Flow_Mapping: https://wiki.opendaylight.org/view/OpenDaylight_Lisp_Flow_Mapping:Beryllium_Release_Notes
 176 .. _MDSAL: https://wiki.opendaylight.org/view/MD-SAL:Beryllium:Release_Notes
 177 .. _NEMO: https://wiki.opendaylight.org/view/NEMO:Beryllium:Release_Notes
 178 .. _NETCONF: https://wiki.opendaylight.org/view/OpenDaylight_NETCONF:Beryllium_Release_Notes
 179 .. _NetIDE: https://wiki.opendaylight.org/view/NetIDE:Release_Notes
 180 .. _NeXt: https://wiki.opendaylight.org/view/NeXt:Beryllium_Release_Notes
 181 .. _NIC: https://wiki.opendaylight.org/view/Network_Intent_Composition:Release_Notes
 182 .. _Neutron_Northbound: https://wiki.opendaylight.org/view/NeutronNorthbound:Beryllium:Release_Notes
 183 .. _OF-Config: https://wiki.opendaylight.org/view/OF-CONFIG:Beryllium:Release_Notes
 184 .. _OpFlex: https://wiki.opendaylight.org/view/OpFlex:Beryllium_Release_Notes
 185 .. _OpenFlow_Plugin: https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:Beryllium_Release_Notes
 186 .. _OpenFlow_Protocol_Library: https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Release_Notes:Beryllium_Release_Notes
 187 .. _OVSDB_Netvirt: https://wiki.opendaylight.org/view/OpenDaylight_OVSDB:Beryllium_Release_Notes
 188 .. _Packet_Cable: https://wiki.opendaylight.org/view/PacketCablePCMM:BerylliumReleaseNotes
 189 .. _SDN_Interface_Application: https://wiki.opendaylight.org/view/ODL-SDNi:Beryllium_Release_Notes
 190 .. _SNBI: https://wiki.opendaylight.org/view/SNBI_Berrylium_Release_Notes
 191 .. _SNMP4SDN: https://wiki.opendaylight.org/view/SNMP4SDN:Beryllium_Release_Note
 192 .. _SNMP_Plugin: https://wiki.opendaylight.org/view/SNMP_Plugin:SNMP_Plugin:Beryllium_Release_Notes
 193 .. _SXP: https://wiki.opendaylight.org/view/SXP:Beryllium:Release_Notes
 194 .. _SFC: https://wiki.opendaylight.org/view/Service_Function_Chaining:Beryllium_Release_Notes
 195 .. _TCPMD5: https://wiki.opendaylight.org/view/TCPMD5:Beryllium_Release_Notes
 196 .. _TSDR: https://wiki.opendaylight.org/view/TSDR:Beryllium:Release_Notes
 197 .. _TTP: https://wiki.opendaylight.org/view/Table_Type_Patterns/Beryllium/Release_Notes
 198 .. _Topology_Processing_Framework: https://wiki.opendaylight.org/view/Topology_Processing_Framework:BERYLLIUM_Release_Notes
 199 .. _USC: https://wiki.opendaylight.org/view/USC:Beryllium:Release_Notes
 200 .. _VPN_Service: https://wiki.opendaylight.org/view/Vpnservice:Beryllium_Release_Notes
 201 .. _VTN: https://wiki.opendaylight.org/view/VTN:Beryllium:Release_Notes
 202 .. _YANG_Tools: https://wiki.opendaylight.org/view/YANG_Tools:Beryllium:Release_Notes