docs/getting-started-guide/installing_opendaylight.rst

   1 .. _install_odl:
   2
   3 ***********************
   4 Installing OpenDaylight
   5 ***********************
   6
   7 You complete the following steps to install your networking environment, with
   8 specific instructions provided in the subsections below.
   9
  10 Before detailing the instructions for these, we address the following:
  11 Java Runtime Environment (JRE) and operating system information
  12 Target environment
  13 Known issues and limitations
  14
  15
  16 Install OpenDaylight
  17 ====================
  18
  19 Downloading and installing OpenDaylight
  20 ---------------------------------------
  21
  22 The default distribution can be found on the OpenDaylight software
  23 download page: https://docs.opendaylight.org/en/latest/downloads.html
  24
  25 The Karaf distribution has no features enabled by default. However, all
  26 of the features are available to be installed.
  27
  28 .. note:: For compatibility reasons, you cannot enable all the features
  29           simultaneously. We try to document known incompatibilities in
  30           the `Install the Karaf features`_ section below.
  31
  32 Running the karaf distribution
  33 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  34
  35 To run the Karaf distribution:
  36
  37 #. Unzip the zip file.
  38 #. Navigate to the directory.
  39 #. run ``./bin/karaf``.
  40
  41 For Example::
  42
  43    $ ls karaf-0.8.x-Oxygen.zip
  44    karaf-0.8.x-Oxygen.zip
  45    $ unzip karaf-0.8.x-Oxygen.zip
  46    Archive:  karaf-0.8.x-Oxygen.zip
  47       creating: karaf-0.8.x-Oxygen/
  48       creating: karaf-0.8.x-Oxygen/configuration/
  49       creating: karaf-0.8.x-Oxygen/data/
  50       creating: karaf-0.8.x-Oxygen/data/tmp/
  51       creating: karaf-0.8.x-Oxygen/deploy/
  52       creating: karaf-0.8.x-Oxygen/etc/
  53       creating: karaf-0.8.x-Oxygen/externalapps/
  54       ...
  55       inflating: karaf-0.8.x-Oxygen/bin/start.bat
  56       inflating: karaf-0.8.x-Oxygen/bin/status.bat
  57       inflating: karaf-0.8.x-Oxygen/bin/stop.bat
  58    $ cd distribution-karaf-0.8.x-Oxygen
  59    $ ./bin/karaf
  60
  61        ________                       ________                .__  .__       .__     __
  62        \_____  \ ______   ____   ____ \______ \ _____  ___.__.\|  \| \|__\| ____ \|  \|___/  \|_
  63         /   \|   \\____ \_/ __ \ /    \ \|    \|  \\__  \<   \|  \|\|  \| \|  \|/ ___\\|  \|  \   __\
  64        /    \|    \  \|_> >  ___/\|   \|  \\|    `   \/ __ \\___  \|\|  \|_\|  / /_/  >   Y  \  \|
  65        \_______  /   __/ \___  >___\|  /_______  (____  / ____\|\|____/__\___  /\|___\|  /__\|
  66                \/\|__\|        \/     \/        \/     \/\/            /_____/      \/
  67
  68
  69
  70 * Press ``tab`` for a list of available commands
  71 * Typing ``[cmd] --help`` will show help for a specific command.
  72 * Press ``ctrl-d`` or type ``system:shutdown`` or ``logout`` to shutdown OpenDaylight.
  73
  74 .. note:: Please take a look at the :ref:`security_deployment_recommendations`
  75           and following sections under :ref:`security_considerations` if you're
  76           planning on running OpenDaylight outside of an isolated test lab
  77           environment.
  78
  79 Install the Karaf features
  80 ==========================
  81 To install a feature, use the following command, where feature1 is the feature
  82 name listed in the table below::
  83
  84     feature:install <feature1>
  85
  86 You can install multiple features using the following command::
  87
  88
  89     feature:install <feature1> <feature2> ... <featureN-name>
  90
  91 .. note:: For compatibility reasons, you cannot enable all Karaf features
  92    simultaneously. The table below documents feature installation names and
  93    known incompatibilities.Compatibility values indicate the following:
  94
  95 * **all** - the feature can be run with other features.
  96 * **self+all** - the feature can be installed with other features with a value of
  97   **all**, but may interact badly with other features that have a value of
  98   **self+all**. Not every combination has been tested.
  99
 100 Uninstalling features
 101 ---------------------
 102 To uninstall a feature, you must shut down OpenDaylight, delete the data
 103 directory, and start OpenDaylight up again.
 104
 105 .. important:: Uninstalling a feature using the Karaf feature:uninstall command
 106    is not supported and can cause unexpected and undesirable behavior.
 107
 108 Listing available features
 109 --------------------------
 110 To find the complete list of Karaf features, run the following command::
 111
 112     feature:list
 113
 114 To list the installed Karaf features, run the following command::
 115
 116     feature:list -i
 117
 118 The description of these features is in the project specific
 119 release notes :ref:`proj_rel_notes` section.
 120
 121 Karaf running on Windows 10
 122 ---------------------------
 123
 124 Windows 10 cannot be identify by Karaf (equinox).
 125 Issue occurs during installation of karaf features e.g.::
 126
 127    opendaylight-user@root>feature:install odl-restconf
 128    Error executing command: Can't install feature odl-restconf/0.0.0:
 129    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
 130
 131 Workaround is to add::
 132
 133    org.osgi.framework.os.name = Win32
 134
 135 to the karaf file::
 136
 137    etc/system.properties
 138
 139 The workaround and further info are in this thread:
 140 https://stackoverflow.com/questions/35679852/karaf-exception-is-thrown-while-installing-org-fusesource-leveldbjni
 141