summaryrefslogtreecommitdiffstats
path: root/docs/ONAP release 2 spec/im/vnfdf.rst
blob: f3ce578b679a4241c79520d0486ba0574d86f54f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
.. Copyright 2018 (China Mobile)
.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode

.. contents::
   :depth: 3
..

Class: VnfDf
============

+--------------------+-------------+------------------+-------------------+--------------------------+
| **Attribute Name** | **Type**    | **Multiplicity** | **Description**   | **Applied Stereotypes**  |
+====================+=============+==================+===================+==========================+
| flavorId           | Identifier  | 1                | Identifier        | support:                 |
|                    |             |                  | of this DF        | MANDATORY                |
|                    |             |                  | within the        |                          |
|                    |             |                  | VNFD.             |                          |
+--------------------+-------------+------------------+-------------------+--------------------------+
| description        | String      | 1                | Human             | support:                 |
|                    |             |                  | readable          | MANDATORY                |
|                    |             |                  | description       |                          |
|                    |             |                  | of the DF.        |                          |
+--------------------+-------------+------------------+-------------------+--------------------------+
| vduProfile         | VduProfile  | 1..N             | Describes         | support:                 |
|                    |             |                  | additional        | MANDATORY                |
|                    |             |                  | instantiati       |                          |
|                    |             |                  | on                |                          |
|                    |             |                  | data for          |                          |
|                    |             |                  | the VDUs          |                          |
|                    |             |                  | used in           |                          |
|                    |             |                  | this              |                          |
|                    |             |                  | flavor.           |                          |
+--------------------+-------------+------------------+-------------------+--------------------------+
| virtualLink        | VirtualLink | 0..N             | Defines the       | support:                 |
| Profile            | Profile     |                  | internal          | MANDATORY                |
|                    |             |                  | VLD along         |                          |
|                    |             |                  | with              |                          |
|                    |             |                  | additional        |                          |
|                    |             |                  | data which        |                          |
|                    |             |                  | is used in        |                          |
|                    |             |                  | this DF.          |                          |
|                    |             |                  |                   |                          |
|                    |             |                  | NOTE 1:           |                          |
|                    |             |                  | This allows       |                          |
|                    |             |                  | for               |                          |
|                    |             |                  | different         |                          |
|                    |             |                  | VNF               |                          |
|                    |             |                  | internal          |                          |
|                    |             |                  | topologies        |                          |
|                    |             |                  | between           |                          |
|                    |             |                  | DFs.              |                          |
|                    |             |                  |                   |                          |
|                    |             |                  | NOTE 2:           |                          |
|                    |             |                  | virtualLink       |                          |
|                    |             |                  | Profile           |                          |
|                    |             |                  | needs to be       |                          |
|                    |             |                  | provided          |                          |
|                    |             |                  | for all VLs       |                          |
|                    |             |                  | that the          |                          |
|                    |             |                  | CPs of the        |                          |
|                    |             |                  | VDUs in the       |                          |
|                    |             |                  | VDU               |                          |
|                    |             |                  | profiles          |                          |
|                    |             |                  | connect to.       |                          |
+--------------------+-------------+------------------+-------------------+--------------------------+
| instantiati        | Instantiati | 1..N             | Describes         | support:                 |
| onLevel            | onLevel     |                  | the various       | MANDATORY                |
|                    |             |                  | levels of         |                          |
|                    |             |                  | resources         |                          |
|                    |             |                  | that can be       |                          |
|                    |             |                  | used to           |                          |
|                    |             |                  | instantiate       |                          |
|                    |             |                  | the VNF           |                          |
|                    |             |                  | using this        |                          |
|                    |             |                  | flavour.          |                          |
|                    |             |                  |                   |                          |
|                    |             |                  | Examples:         |                          |
|                    |             |                  | Small,            |                          |
|                    |             |                  | Medium,           |                          |
|                    |             |                  | Large.            |                          |
|                    |             |                  |                   |                          |
|                    |             |                  | If there is       |                          |
|                    |             |                  | only one          |                          |
|                    |             |                  | "instantiat       |                          |
|                    |             |                  | ionLevel"         |                          |
|                    |             |                  | entry, it         |                          |
|                    |             |                  | shall be          |                          |
|                    |             |                  | treated as        |                          |
|                    |             |                  | the default       |                          |
|                    |             |                  | instantiati       |                          |
|                    |             |                  | on                |                          |
|                    |             |                  | level for         |                          |
|                    |             |                  | this DF.          |                          |
+--------------------+-------------+------------------+-------------------+--------------------------+
| affinityOrA        | AffinityOrA | 0..N             | Specifies         | support:                 |
| ntiAffinity        | ntiAffinity |                  | affinity or       |                          |
| Group              | Group       |                  | anti-affini       | MANDATORY                |
|                    |             |                  | ty                |                          |
|                    |             |                  | relationshi       |                          |
|                    |             |                  | p                 |                          |
|                    |             |                  | applicable        |                          |
|                    |             |                  | between the       |                          |
|                    |             |                  | virtualisat       |                          |
|                    |             |                  | ion               |                          |
|                    |             |                  | containers        |                          |
|                    |             |                  | (e.g.             |                          |
|                    |             |                  | virtual           |                          |
|                    |             |                  | machines)         |                          |
|                    |             |                  | to be             |                          |
|                    |             |                  | created           |                          |
|                    |             |                  | using             |                          |
|                    |             |                  | different         |                          |
|                    |             |                  | VDUs or           |                          |
|                    |             |                  | internal          |                          |
|                    |             |                  | VLs to be         |                          |
|                    |             |                  | created           |                          |
|                    |             |                  | using             |                          |
|                    |             |                  | different         |                          |
|                    |             |                  | VnfVirtualL       |                          |
|                    |             |                  | inkDesc(s)        |                          |
|                    |             |                  | in the same       |                          |
|                    |             |                  | affinity or       |                          |
|                    |             |                  | anti-affini       |                          |
|                    |             |                  | ty                |                          |
|                    |             |                  | group.            |                          |
|                    |             |                  |                   |                          |
|                    |             |                  | NOTE:             |                          |
|                    |             |                  | In the            |                          |
|                    |             |                  | present           |                          |
|                    |             |                  | specificati       |                          |
|                    |             |                  | on,               |                          |
|                    |             |                  | including         |                          |
|                    |             |                  | either            |                          |
|                    |             |                  | VDU(s) or         |                          |
|                    |             |                  | VnfVirtualL       |                          |
|                    |             |                  | inkDesc(s)        |                          |
|                    |             |                  | into the          |                          |
|                    |             |                  | same              |                          |
|                    |             |                  | affinity or       |                          |
|                    |             |                  | anti-affini       |                          |
|                    |             |                  | ty                |                          |
|                    |             |                  | group is          |                          |
|                    |             |                  | supported.        |                          |
|                    |             |                  | Extension         |                          |
|                    |             |                  | to support        |                          |
|                    |             |                  | including         |                          |
|                    |             |                  | both VDU(s)       |                          |
|                    |             |                  | and               |                          |
|                    |             |                  | VnfVirtualL       |                          |
|                    |             |                  | inkDesc(s)        |                          |
|                    |             |                  | into the          |                          |
|                    |             |                  | same              |                          |
|                    |             |                  | affinity or       |                          |
|                    |             |                  | anti-affini       |                          |
|                    |             |                  | ty                |                          |
|                    |             |                  | group is          |                          |
|                    |             |                  | left for          |                          |
|                    |             |                  | future            |                          |
|                    |             |                  | specificati       |                          |
|                    |             |                  | on.               |                          |
+--------------------+-------------+------------------+-------------------+--------------------------+
| scalingAspe        | ScalingAspe | 0..N             | The scaling       | support:                 |
| ct                 | ct          |                  | aspects           |                          |
|                    |             |                  | supported         | MANDATORY                |
|                    |             |                  | by this DF        |                          |
|                    |             |                  | of the VNF.       |                          |
|                    |             |                  | scalingAspe       |                          |
|                    |             |                  | ct                |                          |
|                    |             |                  | shall be          |                          |
|                    |             |                  | present if        |                          |
|                    |             |                  | the VNF           |                          |
|                    |             |                  | supports          |                          |
|                    |             |                  | scaling.          |                          |
+--------------------+-------------+------------------+-------------------+--------------------------+
| placementGr        | PlacementGr | 0..N             | Determine         | support:                 |
| oup                | oup         |                  | where             | EXPERIMENTA              |
|                    |             |                  | VNFC's            | L                        |
|                    |             |                  | (VDU's) are       |                          |
|                    |             |                  | placed with       |                          |
|                    |             |                  | respect to        |                          |
|                    |             |                  | the VNF           |                          |
+--------------------+-------------+------------------+-------------------+--------------------------+
| baseConfigG        | BaseConfigG | 0..1             |- BaseConfigGroup  | support:                 |
| roup               | roup        |                  |  may set          | EXPERIMENTA              |
|                    |             |                  |  Access           | L                        |
|                    |             |                  |  Control          |                          |
|                    |             |                  |  Lists            |                          |
|                    |             |                  |  (ACL's)          |                          |
|                    |             |                  |  and              |                          |
|                    |             |                  |  establish        |                          |
|                    |             |                  |  security         |                          |
|                    |             |                  |  groups           |                          |
|                    |             |                  |  and              |                          |
|                    |             |                  |  server           |                          |
|                    |             |                  |  groups.          |                          |
|                    |             |                  |                   |                          |
|                    |             |                  |- BaseConfigGroup  |                          |
|                    |             |                  |  creates/estab    |                          |
|                    |             |                  |  lishslishs       |                          |
|                    |             |                  |  storage for the  |                          |
|                    |             |                  |  VM's (OpenStack  |                          |
|                    |             |                  |  Cinder).         |                          |
|                    |             |                  |                   |                          |
|                    |             |                  |- BaseConfigGroup  |                          |
|                    |             |                  |  may              |                          |
|                    |             |                  |  establish        |                          |
|                    |             |                  |  internal         |                          |
|                    |             |                  |  networks         |                          |
|                    |             |                  |  such as          |                          |
|                    |             |                  |  OAM (VNF         |                          |
|                    |             |                  |  Mgmt) or         |                          |
|                    |             |                  |  MNS              |                          |
|                    |             |                  |  (Maintenance &   |                          |
|                    |             |                  |  Surveillance)    |                          |
|                    |             |                  |  established.     |                          |
+--------------------+-------------+------------------+-------------------+--------------------------+
| deploymentG        | DeploymentG | 1..N             | DeploymentG       | support:                 |
| roup               | roup        |                  | roup              | EXPERIMENTA              |
|                    |             |                  | provides          | L                        |
|                    |             |                  | the minimum       |                          |
|                    |             |                  | viable VDU        |                          |
|                    |             |                  | and               |                          |
|                    |             |                  | associated        |                          |
|                    |             |                  | VNFC              |                          |
|                    |             |                  | configurati       |                          |
|                    |             |                  | on                |                          |
|                    |             |                  | for a             |                          |
|                    |             |                  | useable           |                          |
|                    |             |                  | VNF.              |                          |
+--------------------+-------------+------------------+-------------------+--------------------------+