Descriptions of affinity objects.
[affinity.git] / affinity / yang / src / main / yang / descriptions-open.txt
1 Affinity endpoint: 
2 =================
3
4 This identifies an application endpoint, and may be one of the
5 following. This is a stationary location wthin the combined physical +
6 virtual network which does not move as VMs are migrated.
7
8  (a) Reference to VM or PM object in the database. In a controller
9  that tracks data center compute resources (such as Open Stack or
10  vCenter) this represents a reference to the database object such as
11  Uuid for that object. A controller such as Open Daylight does not
12  track external compute resource objects and therefore will not
13  support this type of affinity endpoint.
14
15  (b) Node connector, which is a combination of switch + port in an ODL
16  network.  This may represent either a physical network interface or a
17  virtual network interface.
18
19 Affinity address domain: 
20 =======================
21
22 This represents a domain (i.e, set) of one or more addresses. An
23 affinity address may not have a corresponding endpoint on the network,
24 for example, for traffic from a set of external addresses (north-south
25 traffic in a data center), the source IP address domain is not
26 required to map exactly to endpoints or node connectors on the
27 network.
28
29 Affinity address specifies one or more of the following: 
30
31  (a) VLAN + MAC address, or range of MAC addresses.
32
33  (b) Network layer address, IP address, or range of addresses, or
34  prefix/mask representing multiple sources. 
35
36  (c) Transport layer address, which is the transport protocol type and
37  port number.
38
39 Affinity Group: 
40 ==============
41 Affinity group which is an enumeration of one or more items where each
42 item is an affinity endpoint or affinity address domain. An affintiy
43 group may also contain other affinity groups in addition to endpoints
44 and address domains.
45
46 Affinity Link:
47 ============= 
48 Affinity link connects one group (from group) to another (to
49 group). It represents a set of flows that start from the source group
50 and end in the destination group.  An affinity link has attributes
51 (policies) attached to it that represent how these flows must be
52 handled. An affinity link also has directionality associated with
53 it. A bidirectional affinity link is equivalent to two unidirectional
54 affinity links, one in each direction.
55
56 Affinity attribute: 
57 ==================
58 An affinity attribute is assigned to an affinity link. An attribute is
59 one of the following:
60  
61  (a) Path affinity. Path affinities may be one of the following types
62  -- latency sensitive, bandwidth sensitive, or isolate.
63  
64  (b) Access control affinity. This is an attribute that specifies that
65  the application flow must either be permitted (PERMIT) or denied (DENY). 
66
67  (c) Network service chain. This affinity link must traverse specified
68  chain of application gateways. This is called the network service chain.
69
70 Note that the attribute may be a goal (not strict) -- latency or
71 bandwidth sensitive, or an action (strict) -- forward to this port,
72 tunnel to this endpoint.
73