TSDR Installation Guide¶

Installing HSQLDB Data Store¶

Once OpenDaylight distribution is up, from karaf console install the HSQLDB data store using the following command:

feature:install odl-tsdr-hsqldb-all

This will install hsqldb related dependency features (and can take sometime) as well as OpenFlow statistics collector before returning control to the console.

Installing HBase Data Store¶

Installing TSDR HBase Data Store contains two steps:

1. Installing HBase server, and
2. Installing TSDR HBase Data Store features from ODL Karaf console.

In this release, we only support HBase single node running together on the same machine as OpenDaylight. Therefore, follow the steps to download and install HBase server onto the same machine as where OpenDaylight is running:

1. Create a folder in Linux operating system for the HBase server. For example, create an hbase directory under /usr/lib:

   mkdir /usr/lib/hbase
   

2. Unzip the downloaded HBase server tar file.

   Run the following command to unzip the installation package:

   tar xvf <hbase-installer-name>  /usr/lib/hbase
   

3. Make proper changes in hbase-site.xml

   1. Under <hbase-install-directory>/conf/, there is a hbase-site.xml. Although it is not recommended, an experienced user with HBase can modify the data directory for hbase server to store the data.

   2. Modify the value of the property with name “hbase.rootdir” in the file to reflect the desired file directory for storing hbase data.

      The following is an example of the file:

      <configuration>
        <property>
          <name>hbase.rootdir</name>
          <value>file:///usr/lib/hbase/data</value>
        </property>
        <property>
          <name>hbase.zookeeper.property.dataDir</name>
          <value>/usr/lib/hbase/zookeeper</value>
        </property>
      </configuration>
      

4. start hbase server:

   cd <hbase-installation-directory>
   ./start-hbase.sh
   

5. start hbase shell:

   cd <hbase-insatllation-directory>
   ./hbase shell
   

6. start Karaf console

7. install hbase data store feature from Karaf console:

   feature:install odl-tsdr-hbase
   

Installing Cassandra Data Store¶

Installing TSDR Cassandra Data Store contains two steps:

1. Installing Cassandra server, and
2. Installing TSDR Cassandra Data Store features from ODL Karaf console.

In this release, we only support Cassadra single node running together on the same machine as OpenDaylight. Therefore, follow these steps to download and install Cassandra server onto the same machine as where OpenDaylight is running:

1. Install Cassandra (latest stable version) by downloading the zip file and untar the tar ball to cassandra/ directory on the testing machine:

   mkdir cassandra
   wget http://www.eu.apache.org/dist/cassandra/2.1.10/apache-cassandra-2.1.10-bin.tar.gz[2.1.10 is current stable version, it can vary]
   mv apache-cassandra-2.1.10-bin.tar.gz cassandra/
   cd cassandra
   tar -xvzf apache-cassandra-2.1.10-bin.tar.gz
   

2. Start Cassandra from cassandra directory by running:

   ./apache-cassandra-2.1.10/bin/cassandra
   

3. Start cassandra shell by running:

   ./apache-cassandra-2.1.10/bin/cqlsh
   

4. Start Karaf according to the instructions above.

5. Install Cassandra data store feature from Karaf console:

   feature:install odl-tsdr-cassandra
   

Troubleshooting¶

Check the ../data/log/karaf.log for any exception related to TSDR features.

Post Installation Configuration¶

To uninstall TSDR HSQLDB data store¶

To uninstall the TSDR functionality with the default store, you need to do the following from karaf console:

feature:uninstall odl-tsdr-hsqldb-all
feature:uninstall odl-tsdr-core
feature:uninstall odl-tsdr-hsqldb
feature:uninstall odl-tsdr-openflow-statistics-collector

It is recommended to restart the Karaf container after the uninstallation of the TSDR functionality with the default store.

To uninstall TSDR HBase Data Store¶

To uninstall the TSDR functionality with the HBase data store,

• Uninstall HBase data store related features from karaf console:

  feature:uninstall odl-tsdr-hbase
  feature:uninstall odl-tsdr-core
  

• stop hbase server:

  cd <hbase-installation-directory>
  ./stop-hbase.sh
  

• remove the file directory that contains the HBase server installation:

  rm -r <hbase-installation-directory>
  

It is recommended to restart the Karaf container after the uninstallation of the TSDR data store.

To uninstall TSDR Cassandra Data Store¶

To uninstall the TSDR functionality with the Cassandra store,

• uninstall cassandra data store related features following from karaf console:

  feature:uninstall odl-tsdr-cassandra
  feature:uninstall odl-tsdr-core
  

• stop cassandra database:

  ps auwx | grep cassandra
  sudo kill pid
  

• remove the cassandra installation files:

  rm <cassandra-installation-directory>
  

It is recommended to restart the Karaf container after uninstallation of the TSDR data store.

Setting Up the environment¶

To setup and run the TSDR data store ElasticSearch feature, you need to have an ElasticSearch node (or a cluster of such nodes) running. You can use a customized ElasticSearch docker image for this purpose.

Your ElasticSearch (ES) setup must have the “Delete By Query Plugin” installed. Without this, some of the ES functionality won’t work properly.

Creating a custom ElasticSearch docker image¶

(You can skip this section if you already have an instance of ElasticSearch running)

Run the following set of commands:

cat << EOF > Dockerfile
FROM elasticsearch:2
RUN /usr/share/elasticsearch/bin/plugin install --batch delete-by-query
EOF

To build the image, run the following command in the directory where the Dockerfile was created:

docker build . -t elasticsearch-dd

You can check whether the image was properly created by running:

docker images

This should print all your container images including the elasticsearch-dd.

Now we can create and run a container from our image by typing:

docker run -d -p 9200:9200 -p 9300:9300 --name elasticsearch-dd elasticsearch-dd

To see whether the container is running, run the following command:

docker ps

The output should include a row with elasticsearch-dd in the NAMES column. To check the std out of this container use

docker logs elasticsearch-dd

Testing the setup¶

We can now test whether the setup is correct by downloading and installing mininet, which we use to send some data to the running ElasticSearch instance.

Installing the necessary features:

start OpenDaylight
feature:install odl-restconf odl-l2switch-switch odl-tsdr-core odl-tsdr-openflow-statistics-collector
feature:install odl-tsdr-elasticsearch

We can check whether the distribution is now listening on port 6653:

netstat -an | grep 6653

Run mininet

sudo mn --topo single,3 --controller 'remote,ip=distro_ip,port=6653' --switch ovsk,protocols=OpenFlow13

where the distro_ip is the IP address of the machine where the OpenDaylight distribution is running. This command will create three hosts connected to one OpenFlow capable switch.

We can check if data was stored by ElasticSearch in TSDR by running the following command:

tsdr:list FLOWTABLESTATS

The output should look similar to the following:

[NID=openflow:1][DC=FLOWTABLESTATS][MN=ActiveFlows][RK=Node:openflow:1,Table:50][TS=1473427383598][3]
[NID=openflow:1][DC=FLOWTABLESTATS][MN=PacketMatch][RK=Node:openflow:1,Table:50][TS=1473427383598][12]
[NID=openflow:1][DC=FLOWTABLESTATS][MN=PacketLookup][RK=Node:openflow:1,Table:50][TS=1473427383598][12]
[NID=openflow:1][DC=FLOWTABLESTATS][MN=ActiveFlows][RK=Node:openflow:1,Table:80][TS=1473427383598][3]
[NID=openflow:1][DC=FLOWTABLESTATS][MN=PacketMatch][RK=Node:openflow:1,Table:80][TS=1473427383598][17]
[NID=openflow:1][DC=FLOWTABLESTATS][MN=PacketMatch][RK=Node:openflow:1,Table:246][TS=1473427383598][19]
...

Or you can query your ElasticSearch instance:

curl -XPOST "http://elasticseach_ip:9200/_search?pretty" -d'{ "from": 0, "size": 10000, "query": { "match_all": {} } }'

The elasticseach_ip is the IP address of the server where the ElasticSearch is running.

How to test the RESTCONF Collector¶

• Install some other feature that has a RESTCONF interface, for example. “odl-tsdr-syslog-collector”

• Issue a RESTCONF command that uses either POST,PUT or DELETE. For example, you could call the register-filter RPC of tsdr-syslog-collector.

• Look up data in TSDR database from Karaf.

  tsdr:list RESTCONF
  

• You should see the request that you have sent, along with its information (URL, HTTP method, requesting IP address and request body)

• Try to send a GET request, then check again, your request should not be registered, because the collector does not register GET requests by default.

• Open the file: “etc/tsdr.restconf.collector.cfg”, and add GET to the list of METHODS_TO_LOG, so that it becomes:

  METHODS_TO_LOG=POST,PUT,DELETE,GET
  

  • Try again to issue your GET request, and check if it was recorded this time, it should be recorder.
  • Try manipulating the other properties (PATHS_TO_LOG (which URLs do we want to log from), REMOTE_ADDRESSES_TO_LOG (which requesting IP addresses do we want to log from) and CONTENT_TO_LOG (what should be in the request’s body in order to log it)), and see if the requests are getting logged.
  • Try providing invalid properties (unknown methods for the METHODS_TO_LOG parameter, or the same method repeated multiple times, and invalid regular expressions for the other parameters), then check karaf’s log using “log:display”. It should tell you that the value is invalid, and that it will use the default value instead.