docs/user-guide/of-config-user-guide.rst

   1 OF-CONFIG User Guide
   2 ====================
   3
   4 Overview
   5 --------
   6
   7 OF-CONFIG defines an OpenFlow switch as an abstraction called an
   8 OpenFlow Logical Switch. The OF-CONFIG protocol enables configuration of
   9 essential artifacts of an OpenFlow Logical Switch so that an OpenFlow
  10 controller can communicate and control the OpenFlow Logical switch via
  11 the OpenFlow protocol. OF-CONFIG introduces an operating context for one
  12 or more OpenFlow data paths called an OpenFlow Capable Switch for one or
  13 more switches. An OpenFlow Capable Switch is intended to be equivalent
  14 to an actual physical or virtual network element (e.g. an Ethernet
  15 switch) which is hosting one or more OpenFlow data paths by partitioning
  16 a set of OpenFlow related resources such as ports and queues among the
  17 hosted OpenFlow data paths. The OF-CONFIG protocol enables dynamic
  18 association of the OpenFlow related resources of an OpenFlow Capable
  19 Switch with specific OpenFlow Logical Switches which are being hosted on
  20 the OpenFlow Capable Switch. OF-CONFIG does not specify or report how
  21 the partitioning of resources on an OpenFlow Capable Switch is achieved.
  22 OF-CONFIG assumes that resources such as ports and queues are
  23 partitioned amongst multiple OpenFlow Logical Switches such that each
  24 OpenFlow Logical Switch can assume full control over the resources that
  25 is assigned to it.
  26
  27 How to start
  28 ------------
  29
  30 -  start OF-CONFIG feature as below:
  31
  32    ::
  33
  34        feature:install odl-of-config-all
  35
  36 Configuration on the OVS supporting OF-CONFIG
  37 ---------------------------------------------
  38
  39 .. note::
  40
  41     OVS is not supported by OF-CONFIG temporarily because the
  42     OpenDaylight version of OF-CONFIG is 1.2 while the OVS version of
  43     OF-CONFIG is not standard.
  44
  45 The introduction of configuring the OVS can be referred to:
  46
  47 *https://github.com/openvswitch/of-config.*
  48
  49 Connection Establishment between the Capable/Logical Switch and OF-CONFIG
  50 -------------------------------------------------------------------------
  51
  52 The OF-CONFIG protocol is based on NETCONF. So the switches supporting
  53 OF-CONFIG can also access OpenDaylight using the functions provided by
  54 NETCONF. This is the preparation step before connecting to OF-CONFIG.
  55 How to access the switch to OpenDaylight using the NETCONF can be
  56 referred to the `NETCONF Southbound User
  57 Guide <#_southbound_netconf_connector>`__ or `NETCONF Southbound
  58 examples on the
  59 wiki <https://wiki.opendaylight.org/view/OpenDaylight_Controller:Config:Examples:Netconf>`__.
  60
  61 Now the switches supporting OF-CONFIG and they have connected to the
  62 controller using NETCONF as described in preparation phase. OF-CONFIG
  63 can check whether the switch can support OF-CONFIG by reading the
  64 capability list in NETCONF.
  65
  66 The OF-CONFIG will get the information of the capable switch and logical
  67 switch via the NETCONF connection, and creates separate topologies for
  68 the capable and logical switches in the OpenDaylight Topology module.
  69
  70 The Connection between the capable/logical switches and OF-CONFIG is
  71 finished.
  72
  73 Configuration On Capable Switch
  74 -------------------------------
  75
  76 Here is an example showing how to make the configuration to
  77 modify-controller-connection on the capable switch using OF-CONFIG.
  78 Other configurations can follow the same way of the example.
  79
  80 -  Example: modify-controller-connection
  81
  82 .. note::
  83
  84     this configuration can execute via the NETCONF, which can be
  85     referred to the `NETCONF Southbound User
  86     Guide <#_southbound_netconf_connector>`__ or `NETCONF Southbound
  87     examples on the
  88     wiki <https://wiki.opendaylight.org/view/OpenDaylight_Controller:Config:Examples:Netconf>`__.
  89