manuals/getting-started-guide/src/main/asciidoc/vtn/vtn-install.adoc

   1 == VTN Installation Guide
   2
   3 === Overview
   4
   5 OpenDaylight Virtual Tenant Network (VTN) is an application that provides multi-tenant virtual network on an SDN controller.
   6
   7 Conventionally, huge investment in the network systems and operating expenses are needed because the network is configured as a silo for each department and system. Therefore various network appliances must be installed for each tenant and those boxes cannot be shared with others. It is a heavy work to design, implement and operate the entire complex network.
   8
   9 The uniqueness of VTN is a logical abstraction plane. This enables the complete separation of logical plane from physical plane. Users can design and deploy any desired network without knowing the physical network topology or bandwidth restrictions.
  10
  11 VTN allows the users to define the network with a look and feel of conventional L2/L3 network. Once the network is designed on VTN, it will automatically be mapped into underlying physical network, and then configured on the individual switch leverage SDN control protocol. The definition of logical plane makes it possible not only to hide the complexity of the underlying network but also to better manage network resources. It achieves reducing reconfiguration time of network services and minimizing network configuration errors. OpenDaylight Virtual Tenant Network (VTN) is an application that provides multi-tenant virtual network on an SDN controller. It provides API for creating a common virtual network irrespective of the physical network.
  12
  13 It is implemented as two major components
  14
  15 * <<_vtn_manager,VTN Manager>>
  16 * <<_vtn_coordinator,VTN Coordinator>>
  17
  18 ==== VTN Manager
  19 An OpenDaylight Plugin that interacts with other modules to implement the components of the VTN model. It also provides a REST interface to configure VTN components in OpenDaylight. VTN Manager is implemented as one plugin to the OpenDaylight. This provides a REST interface to create/update/delete VTN components. The user command in VTN Coordinator is translated as REST API to VTN Manager by the OpenDaylight Driver component. In addition to the above mentioned role, it also provides an implementation to the OpenStack L2 Network Functions API.
  20
  21 ==== VTN Coordinator
  22
  23 The VTN Coordinator is an external application that provides a REST interface for an user to use OpenDaylight VTN Virtualization. It interacts with VTN Manager plugin to implement the user configuration. It is also capable of multiple OpenDaylight orchestration. It realizes VTN provisioning in OpenDaylight instances. In the OpenDaylight architecture VTN Coordinator is part of the network application, orchestration and services layer. VTN Coordinator will use the REST interface exposed by the VTN Manger to realize the virtual network using OpenDaylight. It uses OpenDaylight APIs (REST) to construct the virtual network in OpenDaylight instances. It provides REST APIs for northbound VTN applications and supports virtual networks spanning across multiple OpenDaylight by coordinating across OpenDaylight.
  24
  25 === Preparing for Installation
  26
  27 ==== VTN Manager
  28
  29 ===== Running the Karaf distribution
  30
  31 Follow the instructions in <<_getting_and_installing_opendaylight,Getting and Installing OpenDaylight>>.
  32
  33 ==== VTN Coordinator
  34
  35 * Arrange a physical/virtual server with any one of the supported 64-bit OS environment.
  36 ** RHEL 7
  37 ** CentOS 7
  38 ** Fedora 20 / 21 / 22
  39
  40 * Install these packages
  41
  42   yum install perl-Digest-SHA uuid libxslt libcurl unixODBC json-c bzip2
  43
  44   rpm -ivh http://yum.postgresql.org/9.3/redhat/rhel-6-x86_64/pgdg-redhat93-9.3-1.noarch.rpm
  45
  46   yum install postgresql93-libs postgresql93 postgresql93-server postgresql93-contrib postgresql93-odbc
  47
  48 === Installing VTN
  49
  50 ==== VTN Manager
  51
  52 Install Feature
  53
  54   feature:install odl-vtn-manager-neutron odl-vtn-manager-rest
  55
  56 NOTE: The above command will install all features of VTN Manager.
  57       You can install only REST or Neutron also.
  58
  59 ==== VTN Coordinator
  60
  61 * Enter into the externalapps directory in the top directory of Beryllium
  62
  63   cd distribution-karaf-0.4.0-Beryllium/externalapps
  64
  65 * Run the below command to extract VTN Coordinator from the tar.bz2 file in the externalapps directory.
  66
  67   tar –C/ -jxvf distribution.vtn-coordinator-6.2.0-Beryllium-bin.tar.bz2
  68
  69 This will install VTN Coordinator to /usr/local/vtn directory.
  70 The name of the tar.bz2 file name varies depending on the version. Please give the same tar.bz2 file name which is there in your directory.
  71
  72 * Configuring database for VTN Coordinator
  73
  74   /usr/local/vtn/sbin/db_setup
  75
  76 * To start the Coordinator
  77
  78   /usr/local/vtn/bin/vtn_start
  79
  80 Using VTN REST API:
  81
  82 Get the version of VTN REST API using the below command, and make sure the setup is working.
  83
  84   curl --user admin:adminpass -H 'content-type: application/json' -X GET http://<VTN_COORDINATOR_IP_ADDRESS>:8083/vtn-webapi/api_version.json
  85
  86 The response should be like this, but version might differ:
  87
  88   {"api_version":{"version":"V1.2"}}
  89
  90 === Verifying your Installation
  91
  92 ==== VTN Manager
  93
  94 * In the karaf prompt, type the below command to ensure that vtn packages are installed.
  95
  96   feature:list | grep vtn
  97
  98 * Run any VTN Manager REST API
  99
 100   curl --user "admin":"admin" -H "Accept: application/json" -H "Content-type: application/json" -X GET http://localhost:8181/restconf/operational/vtn:vtns
 101
 102 ==== VTN Coordinator
 103
 104 * ps –ef | grep unc will list all the vtn apps
 105 * Run any REST API for VTN Coordinator version
 106
 107 === Uninstalling VTN
 108
 109 ==== VTN Manager
 110
 111   Feature:uninstall odl-vtnmanager-all
 112
 113 ==== VTN Coordinator
 114
 115   /usr/local/vtn/bin/vtn_stop
 116
 117   Remove the usr/local/vtn folder