+.. _install_odl:
+
+***********************
Installing OpenDaylight
-=======================
+***********************
You complete the following steps to install your networking environment, with
specific instructions provided in the subsections below.
Install OpenDaylight
---------------------
+====================
+
+Downloading and installing OpenDaylight
+---------------------------------------
+
+The default distribution can be found on the OpenDaylight software
+download page: http://www.opendaylight.org/software/downloads
+
+The Karaf distribution has no features enabled by default. However, all
+of the features are available to be installed.
+
+.. note:: For compatibility reasons, you cannot enable all the features
+ simultaneously. We try to document known incompatibilities in
+ the `Install the Karaf features`_ section below.
+
+Running the karaf distribution
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To run the Karaf distribution:
+
+#. Unzip the zip file.
+#. Navigate to the directory.
+#. run ``./bin/karaf``.
+
+For Example::
+
+ $ ls distribution-karaf-0.7.x-Nitrogen.zip
+ distribution-karaf-0.7.x-Nitrogen.zip
+ $ unzip distribution-karaf-0.7.x-Nitrogen.zip
+ Archive: distribution-karaf-0.7.x-Nitrogen.zip
+ creating: distribution-karaf-0.7.x-Nitrogen/
+ creating: distribution-karaf-0.7.x-Nitrogen/configuration/
+ creating: distribution-karaf-0.7.x-Nitrogen/data/
+ creating: distribution-karaf-0.7.x-Nitrogen/data/tmp/
+ creating: distribution-karaf-0.7.x-Nitrogen/deploy/
+ creating: distribution-karaf-0.7.x-Nitrogen/etc/
+ creating: distribution-karaf-0.7.x-Nitrogen/externalapps/
+ ...
+ inflating: distribution-karaf-0.7.x-Nitrogen/bin/start.bat
+ inflating: distribution-karaf-0.7.x-Nitrogen/bin/status.bat
+ inflating: distribution-karaf-0.7.x-Nitrogen/bin/stop.bat
+ $ cd distribution-karaf-0.7.x-Nitrogen
+ $ ./bin/karaf
+
+ ________ ________ .__ .__ .__ __
+ \_____ \ ______ ____ ____ \______ \ _____ ___.__.\| \| \|__\| ____ \| \|___/ \|_
+ / \| \\____ \_/ __ \ / \ \| \| \\__ \< \| \|\| \| \| \|/ ___\\| \| \ __\
+ / \| \ \|_> > ___/\| \| \\| ` \/ __ \\___ \|\| \|_\| / /_/ > Y \ \|
+ \_______ / __/ \___ >___\| /_______ (____ / ____\|\|____/__\___ /\|___\| /__\|
+ \/\|__\| \/ \/ \/ \/\/ /_____/ \/
+
+
+
+* Press ``tab`` for a list of available commands
+* Typing ``[cmd] --help`` will show help for a specific command.
+* Press ``ctrl-d`` or type ``system:shutdown`` or ``logout`` to shutdown OpenDaylight.
+
+.. note:: Please take a look at the :ref:`security_deployment_recommendations`
+ and following sections under :ref:`security_considerations` if you're
+ planning on running OpenDaylight outside of an isolated test lab
+ environment.
Install the Karaf features
---------------------------
+==========================
To install a feature, use the following command, where feature1 is the feature
name listed in the table below::
simultaneously. The table below documents feature installation names and
known incompatibilities.Compatibility values indicate the following:
-* *all* - the feature can be run with other features.
-* *self+all* - the feature can be installed with other features with a value of
- *all*, but may interact badly with other features that have a value of
- *self+all*. Not every combination has been tested.
+* **all** - the feature can be run with other features.
+* **self+all** - the feature can be installed with other features with a value of
+ **all**, but may interact badly with other features that have a value of
+ **self+all**. Not every combination has been tested.
Uninstalling features
-^^^^^^^^^^^^^^^^^^^^^
+---------------------
To uninstall a feature, you must shut down OpenDaylight, delete the data
directory, and start OpenDaylight up again.
is not supported and can cause unexpected and undesirable behavior.
Listing available features
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+--------------------------
To find the complete list of Karaf features, run the following command::
feature:list
feature:list -i
-Features to implement networking functionality provide release notes you can
-access on the OpenDaylight Wiki: https://wiki.opendaylight.org/view/Project_list
-
-* Authentication, Authorization and Accounting (AAA_)
-* ALTO_
-* BGPCEP_
-* Controller_
-* Control And Provisioning of Wireless Access Points (CAPWAP_)
-* Identification and Driver Management (DIDM_)
-* DLUX_
-* FaaS_
-* Group_Based_Policy_ (GPB)
-* Internet of Things Data Management (IoTDM_)
-* L2_Switch_
-* Link Aggregation Control Protocol (LACP_)
-* LISP_Flow_Mapping_
-* MDSAL_
-* NEMO_
-* NETCONF_
-* NetIDE_
-* NeXt_
-* Network Intent Composition (NIC_)
-* Neutron_Northbound_
-* OF-Config_
-* OpFlex_
-* OpenFlow_Plugin_
-* OpenFlow_Protocol_Library_
-* OVSDB_Netvirt_
-* Packet_Cable_ / PCMM
-* SDN_Interface_Application_
-* Secure Network Bootstrapping Infrastructure (SNBI_)
-* SNMP4SDN_
-* SNMP_Plugin_
-* Secure tag eXchange Protocol (SXP_)
-* Service Function Chaining (SFC_)
-* TCPMD5_
-* Time Series Data Repository (TSDR_)
-* Table Type Patterns (TTP_)
-* Topology_Processing_Framework_
-* Unified Secure Channel (USC_)
-* VPN_Service_
-* Virtual Tenant Network (VTN_)
-* YANG_Tools_
-
-Projects without Release Notes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The following projects participated in Beryllium, but intentionally do not have
-release notes:
-
-* The Documentation Project produced this and the other downloadable
- documentation.
-* The Integration Group hosted the OpenDaylight-wide tests and main release
- distribution.
-* Controller Core Functionality Tutorials provided a single test suite
- (dsbenchmark) that was used as part of integration testing
-* Release Engineering used autorelease to build the Beryllium release artifacts,
- including the main release download.
-
-Beryllium features
-------------------
-
-.. list-table:: Beryllium features
+Features to implement networking functionality provide release notes, which
+you can find in the :ref:`proj_rel_notes` section.
+
+Karaf running on Windows 10
+---------------------------
+
+Windows 10 cannot be identify by Karaf (equinox).
+Issue occurs during installation of karaf features e.g.::
+
+ opendaylight-user@root>feature:install odl-restconf
+ Error executing command: Can't install feature odl-restconf/0.0.0:
+ Could not start bundle mvn:org.fusesource.leveldbjni/leveldbjni-all/1.8-odl in feature(s) odl-akka-leveldb-0.7: The bundle "org.fusesource.leveldbjni.leveldbjni-all_1.8.0 [300]" could not be resolved. Reason: No match found for native code: META-INF/native/windows32/leveldbjni.dll; processor=x86; osname=Win32, META-INF/native/windows64/leveldbjni.dll; processor=x86-64; osname=Win32, META-INF/native/osx/libleveldbjni.jnilib; processor=x86; osname=macosx, META-INF/native/osx/libleveldbjni.jnilib; processor=x86-64; osname=macosx, META-INF/native/linux32/libleveldbjni.so; processor=x86; osname=Linux, META-INF/native/linux64/libleveldbjni.so; processor=x86-64; osname=Linux, META-INF/native/sunos64/amd64/libleveldbjni.so; processor=x86-64; osname=SunOS, META-INF/native/sunos64/sparcv9/libleveldbjni.so; processor=sparcv9; osname=SunOS
+
+Workaround is to add
+
+ org.osgi.framework.os.name = Win32
+
+to the karaf file
+
+ etc/system.properties
+
+The workaround and further info are in this thread:
+http://stackoverflow.com/questions/35679852/karaf-exception-is-thrown-while-installing-org-fusesource-leveldbjni
+
+
+Karaf OpenDaylight Features
+===========================
+
+.. list-table:: Karaf OpenDaylight features
:widths: 10 25 10 5
:header-rows: 1
* - DLUX
- Provides an intuitive graphical user interface for OpenDaylight
- - odl-dlux-all
+ - odl-dluxapps-applications
- all
* - Fabric as a Service (Faas)
- Creates a common abstraction layer on top of a physical network so
- all
* - Time Series Data Repository (TSDR)
- - Enables support for storing and querying time series data with the
- default data collector for OpenFlow statistics the default data store
- for HSQLDB
- - odl-tsdr-hsqldb-all
+ - Enables support for collecting, storing and querying time series data.
+ TSDR supports the following collection data:
+
+ * OpenFlow statistics
+ * NETFLOW statistics
+ * sFlow statistics
+ * OpenFlow Controller metrics
+ * SNMP data
+ * SysLog data
+ * RestConf data
+
+ TSDR supports the following data stores:
+
+ * HSQLDB
+ * HBase
+ * Cassandra
+
+ TSDR supports the default OpenDaylight RESTCONF and API interfaces and an
+ ElasticSearch interface for all data stores.
+ - odl-tsdr-core, odl-tsdr-hsqldb
- all
* - TSDR Data Collectors
- - Enables support for various TSDR data sources (collectors) including
- OpenFlow statistics, NetFlow statistics, NetFlow statistics, SNMP data,
- Syslog, and OpenDaylight (controller) metrics
- - odl-tsdr-openflow-statistics-collector,
- odl-tsdr-netflow-statistics-collector,
- odl-tsdr-snmp-data-collector,
- odl-tsdr-syslog-collector,
- odl-tsdr-controller-metrics-collector
+ - TSDR collector features include support for collecting the following
+ data:
+
+ * OpenFlow statistics
+ * NETFLOW statistics
+ * sFlow statistics
+ * OpenFlow Controller metrics
+ * SNMP data
+ * SysLog data
+ * RESTCONF data.
+
+ - * odl-tsdr-openflow-statistics-collector
+ * odl-tsdr-netflow-statistics-collector
+ * odl-tsdr-sflow-statistics-collector
+ * odl-tsdr-controller-metrics-collector
+ * odl-tsdr-snmp-data-collector
+ * odl-tsdr-syslog-collector
+ * odl-tsdr-restconf-collector
- all
* - TSDR Data Stores
- - Enables support for TSDR data stores including HSQLDB, HBase, and
- Cassandra
- - odl-tsdr-hsqldb, odl-tsdr-hbase, or odl-tsdr-cassandra
+ - TSDR enables support for the following data stores:
+ * HSQLDB
+ * HBase
+ * Cassandra
+ - * odl-tsdr-hsqldb
+ * odl-tsdr-hbase
+ * odl-tsdr-cassandra
+ - all
+
+ * - TSDR Data Query
+ - TSDR supports the default OpenDaylight RESTCONF and ODL API interfaces
+ for queries to all data stores. It also supports an integrated ElasticSearch query.
+ - odl-tsdr-elasticsearch
- all
* - Topology Processing Framework
- odl-usc-channel-ui
- all
- * - VPN Service
- - Enables support for OpenStack VPNaaS
- - odl-vpnservice-core
- - all
-
* - VTN Manager
- Enables Virtual Tenant Network support
- odl-vtn-manager-rest
- self+all
-Other Beryllium features
-------------------------
+Other OpenDaylight features
+===========================
-.. list-table:: Other Beryllium features
+.. list-table:: Other OpenDaylight features
:widths: 10 25 10 5
:header-rows: 1
- all
-Experimental Beryllium Features
--------------------------------
-The following functionality is labeled as experimental in OpenDaylight
-Beryllium and should be used accordingly. In general, it is not supposed to be
+Experimental OpenDaylight Features
+==================================
+The following functionality is labeled as experimental in this OpenDaylight
+release and should be used accordingly. In general, it is not supposed to be
used in production unless its limitations are well understood by those
deploying it.
-.. list-table:: Other Beryllium features
+.. list-table:: Other features
:widths: 10 25 10 5
:header-rows: 1
- odl-lispflowmapping-neutron
- self+all
- * - Messaging4Transport
- - Introduces an AMQP Northbound to MD-SAL
- - odl-messaging4transport
- - all
-
* - Network Intent Composition (NIC)
- Provides abstraction layer for communcating network intents (including
a distributed intent mapping service REST API) using either Hazelcast
- all
Install support for REST APIs
------------------------------
+=============================
Most components that offer REST APIs will automatically load the RESTCONF API
Support component, but if for whatever reason they seem to be missing, install
the “odl-restconf” feature to activate this support.
-
-
-Install the DLUX interface
---------------------------
-OpenDaylight’s DLUX web interface draws information from topology and host
-databases to display information about the topology of the network, flow
-statistics, and host locations.
-
-To integrate with OpenDaylight you must enable the DLUX Karaf feature. Each
-feature can be enabled or disabled separately. Ensure that you have created a
-topology and enabled the MD-SAL feature in the Karaf distribution before you
-use DLUX for network management. For more information about enabling the Karaf
-features for DLUX, refer to Enable_DLUX_Feature_.
-
-MD-SAL clustering
------------------
-In the Beryllium release and newer, the odl-mdsal-broker installs MD-SAL
-clustering automatically.
-
-.. _Enable_DLUX_Feature: https://wiki.opendaylight.org/view/DLUX:Beryllium_System_Test_Plan#Enabling_The_Feature
-
-
-.. _AAA: https://wiki.opendaylight.org/view/AAA:Beryllium_Release_Notes
-.. _ALTO: https://wiki.opendaylight.org/view/ALTO:Beryllium:Release_Notes
-.. _BGPCEP: https://wiki.opendaylight.org/view/BGP_LS_PCEP:Beryllium_Release_Notes
-.. _CAPWAP: https://wiki.opendaylight.org/view/CAPWAP:Beryllium:Release_Notes
-.. _Controller: https://wiki.opendaylight.org/view/OpenDaylight_Controller:Beryllium:Release_Notes
-.. _DIDM: https://wiki.opendaylight.org/view/DIDM:_Beryllium_Release_Notes
-.. _DLUX: https://wiki.opendaylight.org/view/OpenDaylight_DLUX:Beryllium:Release_Notes
-.. _FaaS: https://wiki.opendaylight.org/view/FaaS:Beryllium_Release_Notes
-.. _Group_Based_Policy: https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Releases/Beryllium:Beryllium_Release_Notes
-.. _IoTDM: https://wiki.opendaylight.org/view/Iotdm:Beryllium_Release_Notes
-.. _L2_Switch: https://wiki.opendaylight.org/view/L2_Switch:Beryllium:Release_Notes
-.. _LACP: https://wiki.opendaylight.org/view/LACP:Beryllium:Release_Notes
-.. _LISP_Flow_Mapping: https://wiki.opendaylight.org/view/OpenDaylight_Lisp_Flow_Mapping:Beryllium_Release_Notes
-.. _MDSAL: https://wiki.opendaylight.org/view/MD-SAL:Beryllium:Release_Notes
-.. _NEMO: https://wiki.opendaylight.org/view/NEMO:Beryllium:Release_Notes
-.. _NETCONF: https://wiki.opendaylight.org/view/OpenDaylight_NETCONF:Beryllium_Release_Notes
-.. _NetIDE: https://wiki.opendaylight.org/view/NetIDE:Release_Notes
-.. _NeXt: https://wiki.opendaylight.org/view/NeXt:Beryllium_Release_Notes
-.. _NIC: https://wiki.opendaylight.org/view/Network_Intent_Composition:Release_Notes
-.. _Neutron_Northbound: https://wiki.opendaylight.org/view/NeutronNorthbound:Beryllium:Release_Notes
-.. _OF-Config: https://wiki.opendaylight.org/view/OF-CONFIG:Beryllium:Release_Notes
-.. _OpFlex: https://wiki.opendaylight.org/view/OpFlex:Beryllium_Release_Notes
-.. _OpenFlow_Plugin: https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:Beryllium_Release_Notes
-.. _OpenFlow_Protocol_Library: https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Release_Notes:Beryllium_Release_Notes
-.. _OVSDB_Netvirt: https://wiki.opendaylight.org/view/OpenDaylight_OVSDB:Beryllium_Release_Notes
-.. _Packet_Cable: https://wiki.opendaylight.org/view/PacketCablePCMM:BerylliumReleaseNotes
-.. _SDN_Interface_Application: https://wiki.opendaylight.org/view/ODL-SDNi:Beryllium_Release_Notes
-.. _SNBI: https://wiki.opendaylight.org/view/SNBI_Berrylium_Release_Notes
-.. _SNMP4SDN: https://wiki.opendaylight.org/view/SNMP4SDN:Beryllium_Release_Note
-.. _SNMP_Plugin: https://wiki.opendaylight.org/view/SNMP_Plugin:SNMP_Plugin:Beryllium_Release_Notes
-.. _SXP: https://wiki.opendaylight.org/view/SXP:Beryllium:Release_Notes
-.. _SFC: https://wiki.opendaylight.org/view/Service_Function_Chaining:Beryllium_Release_Notes
-.. _TCPMD5: https://wiki.opendaylight.org/view/TCPMD5:Beryllium_Release_Notes
-.. _TSDR: https://wiki.opendaylight.org/view/TSDR:Beryllium:Release_Notes
-.. _TTP: https://wiki.opendaylight.org/view/Table_Type_Patterns/Beryllium/Release_Notes
-.. _Topology_Processing_Framework: https://wiki.opendaylight.org/view/Topology_Processing_Framework:BERYLLIUM_Release_Notes
-.. _USC: https://wiki.opendaylight.org/view/USC:Beryllium:Release_Notes
-.. _VPN_Service: https://wiki.opendaylight.org/view/Vpnservice:Beryllium_Release_Notes
-.. _VTN: https://wiki.opendaylight.org/view/VTN:Beryllium:Release_Notes
-.. _YANG_Tools: https://wiki.opendaylight.org/view/YANG_Tools:Beryllium:Release_Notes
Code Review / docs.git / blobdiff