summaryrefslogtreecommitdiffstats
path: root/docs/ONAP release 2 spec/im/vnfdf.rst
blob: c78de9f2f23f351351ca1e8fe9497c2147c51fe6 (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
.. 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

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                |
|                            |                             |                  | instantiation         |                          |
|                            |                             |                  | data for              |                          |
|                            |                             |                  | the VDUs              |                          |
|                            |                             |                  | used in               |                          |
|                            |                             |                  | this                  |                          |
|                            |                             |                  | flavor.               |                          |
+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
| virtualLinkProfile         | VirtualLinkProfile          | 0..N             | Defines the           | support:                 |
|                            |                             |                  | 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.           |                          |
+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
| instantiationLevel         | InstantiationLevel          | 1..N             | Describes             | support:                 |
|                            |                             |                  | 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              |                          |
|                            |                             |                  | "instantiationLevel"  |                          |
|                            |                             |                  | entry, it             |                          |
|                            |                             |                  | shall be              |                          |
|                            |                             |                  | treated as            |                          |
|                            |                             |                  | the default           |                          |
|                            |                             |                  | instantiation         |                          |
|                            |                             |                  | level for             |                          |
|                            |                             |                  | this DF.              |                          |
+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
| affinityOrAntiAffinityGroup| AffinityOrAntiAffinityGroup | 0..N             | Specifies             | support:                 |
|                            |                             |                  | affinity or           | MANDATORY                |
|                            |                             |                  | anti-affinity         |                          |
|                            |                             |                  | relationship          |                          |
|                            |                             |                  | applicable            |                          |
|                            |                             |                  | between the           |                          |
|                            |                             |                  | virtualisation        |                          |
|                            |                             |                  | containers            |                          |
|                            |                             |                  | (e.g.                 |                          |
|                            |                             |                  | virtual               |                          |
|                            |                             |                  | machines)             |                          |
|                            |                             |                  | to be                 |                          |
|                            |                             |                  | created               |                          |
|                            |                             |                  | using                 |                          |
|                            |                             |                  | different             |                          |
|                            |                             |                  | VDUs or               |                          |
|                            |                             |                  | internal              |                          |
|                            |                             |                  | VLs to be             |                          |
|                            |                             |                  | created               |                          |
|                            |                             |                  | using                 |                          |
|                            |                             |                  | different             |                          |
|                            |                             |                  | VnfVirtualLinkDesc(s) |                          |
|                            |                             |                  | in the same           |                          |
|                            |                             |                  | affinity or           |                          |
|                            |                             |                  | anti-affinity         |                          |
|                            |                             |                  | group.                |                          |
|                            |                             |                  |                       |                          |
|                            |                             |                  | NOTE:                 |                          |
|                            |                             |                  | In the                |                          |
|                            |                             |                  | present               |                          |
|                            |                             |                  | specification,        |                          |
|                            |                             |                  | including             |                          |
|                            |                             |                  | either                |                          |
|                            |                             |                  | VDU(s) or             |                          |
|                            |                             |                  | VnfVirtualLinkDesc(s) |                          |
|                            |                             |                  | into the              |                          |
|                            |                             |                  | same                  |                          |
|                            |                             |                  | affinity or           |                          |
|                            |                             |                  | anti-affinity         |                          |
|                            |                             |                  | group is              |                          |
|                            |                             |                  | supported.            |                          |
|                            |                             |                  | Extension             |                          |
|                            |                             |                  | to support            |                          |
|                            |                             |                  | including             |                          |
|                            |                             |                  | both VDU(s)           |                          |
|                            |                             |                  | and                   |                          |
|                            |                             |                  | VnfVirtualLinkDesc(s) |                          |
|                            |                             |                  | into the              |                          |
|                            |                             |                  | same                  |                          |
|                            |                             |                  | affinity or           |                          |
|                            |                             |                  | anti-affinity         |                          |
|                            |                             |                  | group is              |                          |
|                            |                             |                  | left for              |                          |
|                            |                             |                  | future                |                          |
|                            |                             |                  | specification.        |                          |
+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
| scalingAspect              | ScalingAspect               | 0..N             | The scaling           | support:                 |
|                            |                             |                  | aspects               | MANDATORY                |
|                            |                             |                  | supported             |                          |
|                            |                             |                  | by this DF            |                          |
|                            |                             |                  | of the VNF.           |                          |
|                            |                             |                  | scalingAspect         |                          |
|                            |                             |                  | shall be              |                          |
|                            |                             |                  | present if            |                          |
|                            |                             |                  | the VNF               |                          |
|                            |                             |                  | supports              |                          |
|                            |                             |                  | scaling.              |                          |
+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
| placementGroup             | PlacementGroup              | 0..N             | Determine             | support:                 |
|                            |                             |                  | where                 | EXPERIMENTAL             |
|                            |                             |                  | VNFC's                |                          |
|                            |                             |                  | (VDU's) are           |                          |
|                            |                             |                  | placed with           |                          |
|                            |                             |                  | respect to            |                          |
|                            |                             |                  | the VNF               |                          |
+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
| baseConfigGroup            | BaseConfigGroup             | 0..1             |- BaseConfigGroup      | support:                 |
|                            |                             |                  |  may set              | EXPERIMENTAL             |
|                            |                             |                  |  Access               |                          |
|                            |                             |                  |  Control              |                          |
|                            |                             |                  |  Lists                |                          |
|                            |                             |                  |  (ACL's)              |                          |
|                            |                             |                  |  and                  |                          |
|                            |                             |                  |  establish            |                          |
|                            |                             |                  |  security             |                          |
|                            |                             |                  |  groups               |                          |
|                            |                             |                  |  and                  |                          |
|                            |                             |                  |  server               |                          |
|                            |                             |                  |  groups.              |                          |
|                            |                             |                  |                       |                          |
|                            |                             |                  |- BaseConfigGroup      |                          |
|                            |                             |                  |  creates/establishs   |                          |
|                            |                             |                  |  storage for the      |                          |
|                            |                             |                  |  VM's (OpenStack      |                          |
|                            |                             |                  |  Cinder).             |                          |
|                            |                             |                  |                       |                          |
|                            |                             |                  |- BaseConfigGroup      |                          |
|                            |                             |                  |  may                  |                          |
|                            |                             |                  |  establish            |                          |
|                            |                             |                  |  internal             |                          |
|                            |                             |                  |  networks             |                          |
|                            |                             |                  |  such as              |                          |
|                            |                             |                  |  OAM (VNF             |                          |
|                            |                             |                  |  Mgmt) or             |                          |
|                            |                             |                  |  MNS                  |                          |
|                            |                             |                  |  (Maintenance &       |                          |
|                            |                             |                  |  Surveillance)        |                          |
|                            |                             |                  |  established.         |                          |
+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+
| deploymentGroup            | DeploymentGroup             | 1..N             | DeploymentGroup       | support:                 |
|                            |                             |                  | provides              | EXPERIMENTAL             |
|                            |                             |                  | the minimum           |                          |
|                            |                             |                  | viable VDU            |                          |
|                            |                             |                  | and                   |                          |
|                            |                             |                  | associated            |                          |
|                            |                             |                  | VNFC                  |                          |
|                            |                             |                  | configuration         |                          |
|                            |                             |                  | for a                 |                          |
|                            |                             |                  | useable               |                          |
|                            |                             |                  | VNF.                  |                          |
+----------------------------+-----------------------------+------------------+-----------------------+--------------------------+