Code Review / docs.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Merge "Fix formatting in DAEXIM chapter"
[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 f45b47348d12e33fdd7f007c6e8de0bd7af6b66d..1b62392ef67001cc0de7a3bc6af13b5f29c722f7 100644 (file)
--- a/docs/getting-started-guide/installing_opendaylight.rst
+++ b/docs/getting-started-guide/installing_opendaylight.rst
@@ -1,7 +1,8 @@
 .. _install_odl:
 
 .. _install_odl:
 
+***********************
 Installing OpenDaylight
 Installing OpenDaylight
-=======================
+***********************
 
 You complete the following steps to install your networking environment, with
 specific instructions provided in the subsections below.
 
 You complete the following steps to install your networking environment, with
 specific instructions provided in the subsections below.
@@ -13,10 +14,10 @@ Known issues and limitations
 
 
 Install OpenDaylight
 
 
 Install OpenDaylight
---------------------
+====================
 
 Downloading and installing OpenDaylight
 
 Downloading and installing OpenDaylight
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------------------------------
 
 The default distribution can be found on the OpenDaylight software
 download page: http://www.opendaylight.org/software/downloads
 
 The default distribution can be found on the OpenDaylight software
 download page: http://www.opendaylight.org/software/downloads
@@ -29,7 +30,7 @@ of the features are available to be installed.
           the `Install the Karaf features`_ section below.
 
 Running the karaf distribution
           the `Install the Karaf features`_ section below.
 
 Running the karaf distribution
-""""""""""""""""""""""""""""""
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 To run the Karaf distribution:
 
 
 To run the Karaf distribution:
 
@@ -39,24 +40,24 @@ To run the Karaf distribution:
 
 For Example::
 
 
 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
+   $ 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
    $ ./bin/karaf
-   
+
        ________                       ________                .__  .__       .__     __
        \_____  \ ______   ____   ____ \______ \ _____  ___.__.\|  \| \|__\| ____ \|  \|___/  \|_
         /   \|   \\____ \_/ __ \ /    \ \|    \|  \\__  \<   \|  \|\|  \| \|  \|/ ___\\|  \|  \   __\
        ________                       ________                .__  .__       .__     __
        \_____  \ ______   ____   ____ \______ \ _____  ___.__.\|  \| \|__\| ____ \|  \|___/  \|_
         /   \|   \\____ \_/ __ \ /    \ \|    \|  \\__  \<   \|  \|\|  \| \|  \|/ ___\\|  \|  \   __\
@@ -70,8 +71,13 @@ For Example::
 * Typing ``[cmd] --help`` will show help for a specific command.
 * Press ``ctrl-d`` or type ``system:shutdown`` or ``logout`` to shutdown OpenDaylight.
 
 * 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
 Install the Karaf features
---------------------------
+==========================
 To install a feature, use the following command, where feature1 is the feature
 name listed in the table below::
 
 To install a feature, use the following command, where feature1 is the feature
 name listed in the table below::
 
@@ -92,7 +98,7 @@ You can install multiple features using the following command::
   **self+all**. Not every combination has been tested.
 
 Uninstalling features
   **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.
 
 To uninstall a feature, you must shut down OpenDaylight, delete the data
 directory, and start OpenDaylight up again.
 
@@ -100,7 +106,7 @@ directory, and start OpenDaylight up again.
    is not supported and can cause unexpected and undesirable behavior.
 
 Listing available features
    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
 To find the complete list of Karaf features, run the following command::
 
     feature:list
@@ -113,7 +119,7 @@ Features to implement networking functionality provide release notes, which
 you can find in the :ref:`proj_rel_notes` section.
 
 Karaf running on Windows 10
 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.::
 
 Windows 10 cannot be identify by Karaf (equinox).
 Issue occurs during installation of karaf features e.g.::
@@ -122,7 +128,7 @@ Issue occurs during installation of karaf features e.g.::
    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
 
    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 
+Workaround is to add
 
    org.osgi.framework.os.name = Win32
 
 
    org.osgi.framework.os.name = Win32
 
@@ -134,10 +140,10 @@ The workaround and further info are in this thread:
 http://stackoverflow.com/questions/35679852/karaf-exception-is-thrown-while-installing-org-fusesource-leveldbjni
 
 
 http://stackoverflow.com/questions/35679852/karaf-exception-is-thrown-while-installing-org-fusesource-leveldbjni
 
 
-Beryllium features
-------------------
+Karaf OpenDaylight Features
+===========================
 
 
-.. list-table:: Beryllium features
+.. list-table:: Karaf OpenDaylight features
     :widths: 10 25 10 5
     :header-rows: 1
 
     :widths: 10 25 10 5
     :header-rows: 1
 
@@ -174,7 +180,7 @@ Beryllium features
 
     * - DLUX
       - Provides an intuitive graphical user interface for OpenDaylight
 
     * - 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
     * - Fabric as a Service (Faas)
       - Creates a common abstraction layer on top of a physical network so
@@ -345,27 +351,63 @@ Beryllium features
       - all
 
     * - Time Series Data Repository (TSDR)
       - 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
       - 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
       - 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
       - all
 
     * - Topology Processing Framework
@@ -378,11 +420,6 @@ Beryllium features
       - odl-usc-channel-ui
       - all
 
       - 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
     * - VTN Manager
       - Enables Virtual Tenant Network support
       - odl-vtn-manager-rest
@@ -394,10 +431,10 @@ Beryllium features
       - self+all
 
 
       - 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
 
     :widths: 10 25 10 5
     :header-rows: 1
 
@@ -419,14 +456,14 @@ Other Beryllium features
       - all
 
 
       - 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.
 
 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
 
     :widths: 10 25 10 5
     :header-rows: 1
 
@@ -476,11 +513,6 @@ deploying it.
       - odl-lispflowmapping-neutron
       - self+all
 
       - 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
     * - Network Intent Composition (NIC)
       - Provides abstraction layer for communcating network intents (including
         a distributed intent mapping service REST API) using either Hazelcast
@@ -540,7 +572,7 @@ deploying it.
       - all
 
 Install support for REST APIs
       - 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.
 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.
OpenDaylight Documentation