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 d610ff695029cde9de3c122adf906f86e974c52a..1b62392ef67001cc0de7a3bc6af13b5f29c722f7 100644 (file)
--- a/docs/getting-started-guide/installing_opendaylight.rst
+++ b/docs/getting-started-guide/installing_opendaylight.rst
@@ -40,22 +40,22 @@ To run the Karaf distribution:
 
 For Example::
 
-   $ ls distribution-karaf-0.5.x-Boron.zip
-   distribution-karaf-0.5.x-Boron.zip
-   $ unzip distribution-karaf-0.5.x-Boron.zip
-   Archive:  distribution-karaf-0.5.x-Boron.zip
-      creating: distribution-karaf-0.5.x-Boron/
-      creating: distribution-karaf-0.5.x-Boron/configuration/
-      creating: distribution-karaf-0.5.x-Boron/data/
-      creating: distribution-karaf-0.5.x-Boron/data/tmp/
-      creating: distribution-karaf-0.5.x-Boron/deploy/
-      creating: distribution-karaf-0.5.x-Boron/etc/
-      creating: distribution-karaf-0.5.x-Boron/externalapps/
-   ...
-     inflating: distribution-karaf-0.5.x-Boron/bin/start.bat
-     inflating: distribution-karaf-0.5.x-Boron/bin/status.bat
-     inflating: distribution-karaf-0.5.x-Boron/bin/stop.bat
-   $ cd distribution-karaf-0.5.x-Boron
+   $ 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
 
        ________                       ________                .__  .__       .__     __
@@ -71,6 +71,11 @@ For Example::
 * 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
@@ -175,7 +180,7 @@ Karaf OpenDaylight Features
 
     * - 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
@@ -346,27 +351,63 @@ Karaf OpenDaylight Features
       - 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