docs/developer-guide/opflex-agent-ovs-developer-guide.rst

   1 OpFlex agent-ovs Developer Guide
   2 ================================
   3
   4 Overview
   5 --------
   6
   7 agent-ovs is a policy agent that works with OVS to enforce a group-based
   8 policy networking model with locally attached virtual machines or
   9 containers. The policy agent is designed to work well with orchestration
  10 tools like OpenStack.
  11
  12 agent-ovs Architecture
  13 ----------------------
  14
  15 agent-ovs uses libopflex to communicate with an OpFlex-based policy
  16 repository to enforce policy on network endpoints attached to OVS by an
  17 orchestration system.
  18
  19 The key components are:
  20
  21 -  Agent - coordinates startup and configuration
  22
  23 -  Renderers - Renderers are responsible for rendering policy. This is a
  24    very general mechanism but the currently-implemented renderer is the
  25    stitched-mode renderer that can work along with with hardware fabrics
  26    such as ACI that support policy enforcement.
  27
  28 -  EndpointManager - Keep track of network endpoints and declare them to
  29    the endpoint repository
  30
  31 -  PolicyManager - Keep track of and index policies
  32
  33 -  FlowManager - render policies to OVS
  34
  35 API Reference Documentation
  36 ---------------------------
  37
  38 Internal API documentation can be found here:
  39 https://jenkins.opendaylight.org/opflex/job/opflex-merge/ws/agent-ovs/doc/html/index.html
  40