OF-CONFIG release notes
[docs.git] / docs / getting-started-guide / installing_opendaylight.rst
index bcd809970d8dab120c2679ec8cb5405516aaa265..c65ebbc446ac30b91bf16c4223c88d61ac523996 100644 (file)
@@ -40,22 +40,22 @@ To run the Karaf distribution:
 
 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.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
    $ ./bin/karaf
 
        ________                       ________                .__  .__       .__     __
@@ -135,10 +135,10 @@ The workaround and further info are in this thread:
 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
 
@@ -346,27 +346,63 @@ Beryllium 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
@@ -379,11 +415,6 @@ Beryllium features
       - 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
@@ -395,10 +426,10 @@ Beryllium features
       - 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
 
@@ -420,14 +451,14 @@ Other Beryllium features
       - 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
 
@@ -477,11 +508,6 @@ deploying it.
       - 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