Merge "Changes to Getting-Started-Guide karaf_features.rst for the TSDR Boron release."

[docs.git] / docs / getting-started-guide / installing_opendaylight.rst

diff --git a/docs/getting-started-guide/installing_opendaylight.rst b/docs/getting-started-guide/installing_opendaylight.rst
index a690a89e6d52cf940507e3035ce71a33c88c682f..dbf99c64a93a0ff739964797bdb6821d1fad4f1d 100644 (file)
--- a/docs/getting-started-guide/installing_opendaylight.rst
+++ b/docs/getting-started-guide/installing_opendaylight.rst
@@ -15,6 +15,61 @@ Known issues and limitations
 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.4.0-Beryllium.zip
+   distribution-karaf-0.4.0-Beryllium.zip
+   $ unzip distribution-karaf-0.4.0-Beryllium.zip
+   Archive:  distribution-karaf-0.4.0-Beryllium.zip
+      creating: distribution-karaf-0.4.0-Beryllium/
+      creating: distribution-karaf-0.4.0-Beryllium/configuration/
+      creating: distribution-karaf-0.4.0-Beryllium/data/
+      creating: distribution-karaf-0.4.0-Beryllium/data/tmp/
+      creating: distribution-karaf-0.4.0-Beryllium/deploy/
+      creating: distribution-karaf-0.4.0-Beryllium/etc/
+      creating: distribution-karaf-0.4.0-Beryllium/externalapps/
+   ...
+     inflating: distribution-karaf-0.4.0-Beryllium/bin/start.bat
+     inflating: distribution-karaf-0.4.0-Beryllium/bin/status.bat
+     inflating: distribution-karaf-0.4.0-Beryllium/bin/stop.bat
+   $ cd distribution-karaf-0.4.0-Beryllium
+   $ ./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.
+
 Install the Karaf features
 --------------------------
 To install a feature, use the following command, where feature1 is the feature
@@ -31,10 +86,10 @@ You can install multiple features using the following command::
    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
 ^^^^^^^^^^^^^^^^^^^^^
@@ -467,23 +522,3 @@ 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