From: Suchi Raman <suchi.raman@plexxi.com>
Date: Wed, 23 Oct 2013 14:32:45 +0000 (-0400)
Subject: Descriptions of affinity objects.
X-Git-Tag: jenkins-affinity-bulk-release-prepare-only-1~43
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=commitdiff_plain;h=4f5b3f411956296e8ef64cd4da280a7df9f8e002;p=affinity.git

Descriptions of affinity objects.
Signed-off-by: Suchi Raman <suchi.raman@plexxi.com>
---

diff --git a/affinity/yang/src/main/yang/descriptions-open.txt b/affinity/yang/src/main/yang/descriptions-open.txt
new file mode 100644
index 0000000..b1e9d1d
--- /dev/null
+++ b/affinity/yang/src/main/yang/descriptions-open.txt
@@ -0,0 +1,73 @@
+Affinity endpoint: 
+=================
+
+This identifies an application endpoint, and may be one of the
+following. This is a stationary location wthin the combined physical +
+virtual network which does not move as VMs are migrated.
+
+ (a) Reference to VM or PM object in the database. In a controller
+ that tracks data center compute resources (such as Open Stack or
+ vCenter) this represents a reference to the database object such as
+ Uuid for that object. A controller such as Open Daylight does not
+ track external compute resource objects and therefore will not
+ support this type of affinity endpoint.
+
+ (b) Node connector, which is a combination of switch + port in an ODL
+ network.  This may represent either a physical network interface or a
+ virtual network interface.
+
+Affinity address domain: 
+=======================
+
+This represents a domain (i.e, set) of one or more addresses. An
+affinity address may not have a corresponding endpoint on the network,
+for example, for traffic from a set of external addresses (north-south
+traffic in a data center), the source IP address domain is not
+required to map exactly to endpoints or node connectors on the
+network.
+
+Affinity address specifies one or more of the following: 
+
+ (a) VLAN + MAC address, or range of MAC addresses.
+
+ (b) Network layer address, IP address, or range of addresses, or
+ prefix/mask representing multiple sources. 
+
+ (c) Transport layer address, which is the transport protocol type and
+ port number.
+
+Affinity Group: 
+==============
+Affinity group which is an enumeration of one or more items where each
+item is an affinity endpoint or affinity address domain. An affintiy
+group may also contain other affinity groups in addition to endpoints
+and address domains.
+
+Affinity Link:
+============= 
+Affinity link connects one group (from group) to another (to
+group). It represents a set of flows that start from the source group
+and end in the destination group.  An affinity link has attributes
+(policies) attached to it that represent how these flows must be
+handled. An affinity link also has directionality associated with
+it. A bidirectional affinity link is equivalent to two unidirectional
+affinity links, one in each direction.
+
+Affinity attribute: 
+==================
+An affinity attribute is assigned to an affinity link. An attribute is
+one of the following:
+ 
+ (a) Path affinity. Path affinities may be one of the following types
+ -- latency sensitive, bandwidth sensitive, or isolate.
+ 
+ (b) Access control affinity. This is an attribute that specifies that
+ the application flow must either be permitted (PERMIT) or denied (DENY). 
+
+ (c) Network service chain. This affinity link must traverse specified
+ chain of application gateways. This is called the network service chain.
+
+Note that the attribute may be a goal (not strict) -- latency or
+bandwidth sensitive, or an action (strict) -- forward to this port,
+tunnel to this endpoint.
+