Skip to content

Commit 53d66bb

Browse files
readamsnilok
authored andcommitted
Format Opflex project documentation as asciidoc
Change-Id: I49c3b19e32d6ebe067aa9335d94321077aa4cb22 Signed-off-by: Rob Adams <[email protected]>
1 parent 2129e50 commit 53d66bb

File tree

8 files changed

+1125
-0
lines changed

8 files changed

+1125
-0
lines changed

manuals/developer-guide/src/main/asciidoc/bk-developers-guide.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,12 @@ include::neutron/neutron.adoc[]
6868

6969
include::openflowjava/odl-openflowjava-protocol-dev.adoc[]
7070

71+
include::opflex/libopflex-dev.adoc[]
72+
73+
include::opflex/genie-dev.adoc[]
74+
75+
include::opflex/agent-ovs-dev.adoc[]
76+
7177
include::ovsdb/ovsdb-developer.adoc[]
7278

7379
include::reservation/reservation-dev.adoc[]
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
== OpFlex agent-ovs Developer Guide
2+
3+
=== Overview
4+
agent-ovs is a policy agent that works with OVS to enforce a
5+
group-based policy networking model with locally attached virtual
6+
machines or containers. The policy agent is designed to work well with
7+
orchestration tools like OpenStack.
8+
9+
=== agent-ovs Architecture
10+
agent-ovs uses libopflex to communicate with an OpFlex-based policy
11+
repository to enforce policy on network endpoints attached to OVS by
12+
an orchestration system.
13+
14+
The key components are:
15+
16+
* Agent - coordinates startup and configuration
17+
* Renderers - Renderers are responsible for rendering policy. This is
18+
a very general mechanism but the currently-implemented renderer is
19+
the stitched-mode renderer that can work along with with hardware
20+
fabrics such as ACI that support policy enforcement.
21+
* EndpointManager - Keep track of network endpoints and declare them
22+
to the endpoint repository
23+
* PolicyManager - Keep track of and index policies
24+
* FlowManager - render policies to OVS
25+
26+
=== API Reference Documentation
27+
Internal API documentation can be found here:
28+
https://jenkins.opendaylight.org/opflex/job/opflex-merge/ws/agent-ovs/doc/html/index.html
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
== OpFlex genie Developer Guide
2+
3+
=== Overview
4+
Genie is a tool for code generation from a model. It supports
5+
generating C\++ and Java code. C++ can be generated suitable for use
6+
with libopflex. C++ and Java can be generated as a plain set of
7+
objects.
8+
9+
=== Group-based Policy Model
10+
The group-based policy model is included with the genie tool and can
11+
be found under the MODEL directory. By running mvn exec:java,
12+
libmodelgbp will be generated as a library project that, when built
13+
and installed, will work with libopflex. This model is used by the
14+
OVS agent.
15+
16+
=== API Reference Documentation
17+
Complete API documentation for the generated libmodelgbp can be found here:
18+
https://jenkins.opendaylight.org/opflex/job/opflex-merge/ws/libopflex/doc/html/index.html

0 commit comments

Comments
 (0)