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

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