manuals/developer-guide/src/main/asciidoc/vtn/vtn-overview.adoc

   1 === OpenDaylight Virtual Tenant Network (VTN) Overview
   2
   3 OpenDaylight Virtual Tenant Network (VTN) is an application that provides multi-tenant virtual network on an SDN controller.
   4
   5 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.
   6
   7 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.
   8
   9 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.
  10
  11 It is implemented as two major components
  12
  13 * <<_vtn_coordinator,VTN Coordinator>>
  14 * <<_vtn_manager,VTN Manager>>
  15
  16 .VTN Architecture
  17 image::vtn/vtn-overview.png[width=500]
  18
  19 ==== VTN Coordinator
  20
  21 The VTN Coordinator is an external application that provides a REST interface for a user to use the VTN Virtualization. It interacts with VTN Manager plugin to implement the user configuration. It is also capable of multiple controller orchestration. It realizes Virtual Tenant Network (VTN) provisioning in OpenDaylight Controllers (ODC). In the OpenDaylight architecture VTN Coordinator is part of the network application, orchestration and services layer. VTN Coordinator has been implemented as an external application to the OpenDaylight controller. This component is responsible for the VTN virtualization. VTN Coordinator will use the REST interface exposed by the VTN Manger to realize the virtual network using the OpenDaylight controller. It uses OpenDaylight APIs (REST) to construct the virtual network in ODCs. It provides REST APIs for northbound VTN applications and supports virtual networks spanning across multiple ODCs by coordinating across ODCs.
  22
  23 ===== OpenDaylight Virtual Tenant Network (VTN) API Overview
  24
  25 The VTN API module is a sub component of the VTN Coordinator and provides the north bound REST API interface for VTN applications. It consists of two subcomponents:
  26
  27 * <<_web_server,Web Server>>
  28 * <<_vtn_service_java_api_library,VTN Service Java API Library>>
  29
  30 .VTN Coordinator API Architecture
  31 image::vtn/vtn-coordinator-api-architecture.png[]
  32
  33 ====== Web Server
  34
  35 The Web Server module handles the REST APIs received from the VTN applications. It translates the REST APIs to the appropriate Java APIs.
  36
  37 The main functions of this module are:
  38
  39 * Starts via the startup script catalina.sh.
  40 * VTN Application sends HTTP request to Web server in XML or JSON format.
  41 * Creates a session and acquire a read/write lock.
  42 * Invokes the <<_vtn_service_java_api_library,VTN Service Java API Library>> corresponding to the specified URI.
  43 * Returns the response to the VTN Application.
  44
  45 *WebServer Class Details*
  46
  47 The table below lists the classes available for Web Server module and its descriptions:
  48
  49 [options="header",cols="30%,70%"]
  50 |===
  51 | Class Name | Description
  52 | InitManager |It is a singleton class for executing the acquisition of configuration information from properties file, log initialization, initialization of <<_vtn_service_java_api_library,VTN Service Java API Library>>. +
  53 Executed by init() of VtnServiceWebAPIServlet.
  54 | ConfigurationManager | Maintains the configuration information acquired from properties file.
  55 | VtnServiceCommonUtil | Utility class
  56 | VtnServiceWebUtil | Utility class
  57 | VtnServiceWebAPIServlet | Receives HTTP request from VTN Application and calls the method of corresponding VtnServiceWebAPIHandler. +
  58 Inherits class HttpServlet, and overrides doGet(), doPut(), doDelete(), doPost().
  59 | VtnServiceWebAPIHandler | Creates JsonObject(com.google.gson) from HTTP request, and calls method of corresponding VtnServiceWebAPIController.
  60 | VtnServiceWebAPIController | Creates RestResource() class and calls UPLL API/UPPL API through Java API.
  61 At the time of calling UPLL API/UPPL API, performs the creation/deletion of session, acquisition/release of configuration mode, acquisition/release of read lock by TC API through Java API.
  62 | DataConverter | Converts  HTTP request to JsonObject and JsonXML to JSON. |
  63 |===
  64
  65 ====== VTN Service Java API Library
  66
  67 It provides the Java API library to communicate with the lower layer modules in the VTN Coordinator.
  68
  69 The main functions of this library are: +
  70
  71 * Creates an IPC client session to the lower layer.
  72 * Converts the request to IPC framework format.
  73 * Invokes the lower layer API (i.e. UPPL API, UPLL API, TC API).
  74 * Returns the response from the lower layer to the web server
  75
  76 * VTN Service Java API Library Class Details
  77
  78 ===== Feature Overview
  79
  80 VTN Coordinator doesn't have Karaf features.
  81
  82 For VTN Coordinator REST API, please refer: https://wiki.opendaylight.org/view/OpenDaylight_Virtual_Tenant_Network_%28VTN%29:VTN_Coordinator:RestApi
  83
  84 ==== VTN Manager
  85 An OpenDaylight Controller 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 ODL controller. VTN Manager is implemented as one plugin to the OpenDaylight controller. 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 ODC Driver component. In addition to the above mentioned role, it also provides an implementation to the Openstack L2 Network Functions API.
  86
  87 ===== Function Outline
  88
  89 The table identifies the functions and the interface used by VTN Components:
  90
  91 [options="header"]
  92 |===
  93 | Component | Interface | Purpose
  94 | VTN Manager |RESTful API | Configure VTN Virtualization model components in OpenDaylight
  95 | VTN Manager | Neutron API implementation | Handle Networks API from OpenStack (Neutron Interface)
  96 | VTN Coordinator | RESTful API |
  97 (1) Uses the Restful interface of VTN Manager and configures VTN Virtualization model components in OpenDaylight. +
  98 (2) Handles multiple controller orchestration. +
  99 (3) Provides API to read the physical network details. See https://wiki.OpenDaylight.org/view/OpenDaylight_Virtual_Tenant_Network_(VTN):VTN_Coordinator:RestApi:L2_Network_Example_Using_VTN_Virtualization[samples] for usage.
 100
 101 |===
 102
 103 ===== Feature Overview
 104
 105 There are three features
 106
 107 * *odl-vtn-manager* provides VTN Manager's JAVA API.
 108 * *odl-vtn-manager-rest* provides VTN Manager's REST API.
 109 * *odl-vtn-manager-neutron* provides the integration with Neutron interface.
 110
 111 REST API documentation for VTN Manager, please refer: https://jenkins.opendaylight.org/releng/view/vtn/job/vtn-merge-master/lastSuccessfulBuild/artifact/manager/northbound/target/site/wsdocs/rest.html
 112
 113 For VTN Java API documentation, please visit: https://jenkins.opendaylight.org/releng/view/vtn/job/vtn-merge-master/lastSuccessfulBuild/artifact/manager/api/target/apidocs/index.html
 114
 115 VTN Manager API: https://wiki.opendaylight.org/view/OpenDaylight_Virtual_Tenant_Network_%28VTN%29:VTN_Manager:RestApi
 116
 117 === Usage Examples
 118 *  https://wiki.OpenDaylight.org/view/OpenDaylight_Virtual_Tenant_Network_(VTN):VTN_Coordinator:RestApi:How_to_configure_L2_Network_with_Single_Controller[L2 Network using Single Controller]