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

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