76ca9d7fbdae38db435e5332b5fea05a533b843c
[docs.git] / manuals / user-guide / src / main / asciidoc / vtn / VTN_How_To_Troubleshoot_Coordinator_Installation.adoc
1 ==== VTN Coordinator(Troubleshooting HowTo)
2
3 ===== Overview
4
5 This page demonstrates Installation troubleshooting steps of VTN Coordinator.
6 OpenDaylight VTN provides multi-tenant virtual network functions on OpenDaylight controllers. OpenDaylight VTN consists of two parts:
7
8 * VTN Coordinator.
9 * VTN Manager.
10
11 VTN Coordinator orchestrates multiple VTN Managers running in OpenDaylight Controllers, and provides VTN Applications with VTN API.
12 VTN Manager is OSGi bundles running in OpenDaylight Controller. Current VTN Manager supports only OpenFlow switches. It handles PACKET_IN messages, sends PACKET_OUT messages, manages host information, and installs flow entries into OpenFlow switches to provide VTN Coordinator with virtual network functions.
13 The requirements for installing these two are different.Therefore, we recommend that you install VTN Manager and VTN Coordinator in different machines.
14
15 ===== List of installation Troubleshooting How to's
16 .How to install VTN Coordinator?
17
18 * https://wiki.opendaylight.org/view/OpenDaylight_Virtual_Tenant_Network_(VTN):Installation:VTN_Coordinator
19
20 *After executing db_setup, you have encountered the error "Failed to setup database"?*
21
22 The error could be due to the below reasons
23 * Access Restriction
24
25 The user who owns /usr/local/vtn/ directory and installs VTN Coordinator, can only start db_setup.
26 Example :
27
28 ----
29   The directory should appear as below (assuming the user as "vtn"):
30   # ls -l /usr/local/
31     drwxr-xr-x. 12 vtn  vtn  4096 Mar 14 21:53 vtn
32   If the user doesnot own /usr/local/vtn/ then, please run the below command (assuming the username as vtn),
33               chown -R vtn:vtn /usr/local/vtn
34 ----
35 * Postgres not Present
36
37 ----
38 1. In case of Fedora/CentOS/RHEL, please check if /usr/pgsql/<version> directory is present and also ensure the commands initdb, createdb,pg_ctl,psql are working. If, not please re-install postgres packages
39 2. In case of Ubuntu, check if /usr/lib/postgres/<version> directory is present and check for the commands as in the previous step.
40 ----
41 * Not enough space to create tables
42
43 ----
44 Please check df -k and ensure enough free space is available.
45 ----
46 * If the above steps do not solve the problem, please refer to the log file for the exact problem
47
48 ----
49 /usr/local/vtn/var/dbm/unc_setup_db.log for the exact error.
50 ----
51
52 .What are the things to check after vtn_start?
53
54 * list of VTN Coordinator processes
55 * Run the below command ensure the Coordinator daemons are running.
56
57 ----
58        Command:     /usr/local/vtn/bin/unc_dmctl status
59        Name              Type           IPC Channel       PID
60     -----------       -----------      --------------     ------
61         drvodcd         DRIVER           drvodcd           15972
62         lgcnwd         LOGICAL           lgcnwd            16010
63         phynwd         PHYSICAL          phynwd            15996
64 ----
65 * Issue the curl command to fetch version and ensure the process is able to respond.
66
67 .How to debug a startup failure?
68
69 The following activities take place in order during startup
70
71 * Database server is started after setting virtual memory to required value,Any database startup errors will be reflected in any of the below logs.
72
73 ----
74          /usr/local/vtn/var/dbm/unc_db_script.log.
75          /usr/local/vtn/var/db/pg_log/postgresql-*.log (the pattern will have the date)
76 ----
77 * uncd daemon is kicked off, The daemon in turn kicks off the rest of the daemons.
78
79 ----
80   Any  uncd startup failures will be reflected in /usr/local/vtn/var/uncd/uncd_start.err.
81 ----
82
83 ====== After setting up the apache tomcat server, what are the aspects that should be checked.
84 .Please check if catalina is running.
85
86 ----
87     The command ps -ef | grep catalina | grep -v grep should list a catalina process
88 ----
89
90 .If you encounter an erroneous situation where the REST API is always failing.
91
92 ----
93   Please ensure the firewall settings for port:8282(Lithium release) or port:8083(Post Lithium release) and enable the same.
94 ----
95 .How to debug a REST API returning a failure message?
96 Please check the /usr/share/java/apache-tomcat-7.0.39/logs/core/core.log for failure details.
97
98 .REST API for VTN configuration fails, how to debug?
99
100 The default log level for all daemons is "INFO", to debug the situation TRACE or DEBUG logs may be needed. To increase the log level for individual daemons, please use the commands suggested below
101
102 ----
103   /usr/local/vtn/bin/lgcnw_control loglevel trace -- upll daemon log
104    /usr/local/vtn/bin/phynw_control loglevel trace -- uppl daemon log
105    /usr/local/vtn/bin/unc_control loglevel trace -- uncd daemon log
106    /usr/local/vtn/bin/drvodc_control loglevel trace -- Driver daemon log
107 ----
108 After setting the log levels, the operation can be repeated and the log files can be referred for debugging.
109
110 .Problems while Installing PostgreSQL due to openssl
111
112 Errors may occur when trying to install postgreSQL rpms. Recently PostgreSQL has upgraded all their binaries to use the latest openssl versions with fix for http://en.wikipedia.org/wiki/Heartbleed Please upgrade the openssl package to the latest version and re-install.
113 For RHEL 6.1/6.4 : If you have subscription, Please use the same and update the rpms. The details are available in the following link
114 https://access.redhat.com/site/solutions/781793 ACCESS-REDHAT
115
116 ----
117   rpm -Uvh http://mirrors.kernel.org/centos/6/os/x86_64/Packages/openssl-1.0.1e-15.el6.x86_64.rpm
118   rpm -ivh http://mirrors.kernel.org/centos/6/os/x86_64/Packages/openssl-devel-1.0.1e-15.el6.x86_64.rpm
119 ----
120
121 For other linux platforms, Please do yum update, the public respositroes will have the latest openssl, please install the same.