summaryrefslogtreecommitdiffstats
path: root/docs/Chapter2/index.rst
blob: f8d490aae5e18d7643bd83b6600cd7498f5544fa (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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
.. Modifications Copyright © 2017-2018 AT&T Intellectual Property.

.. Licensed under the Creative Commons License, Attribution 4.0 Intl.
   (the "License"); you may not use this documentation except in compliance
   with the License. You may obtain a copy of the License at

.. https://creativecommons.org/licenses/by/4.0/

.. Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.


Scope
=====

- The audience for this document are xNF providers, NCSPs and other
  interested 3rd parties who need to know the design, build and lifecycle
  management requirements for xNFs to be compliant with ONAP.
- These requirements are strictly from a standpoint of what the xNF
  developer needs to know to operate and be compliant with ONAP.
- Requirements that are not applicable to xNF providers such as those
  that applicable to service providers are not included in this document.
- These requirements are applicable to the current release of ONAP.
- Scope of the ONAP versions/release and future functionality
- The VNF Requirements should include support for the functionality of the
  ONAP E-E use cases.
- These requirements apply to xNFs at both ONAP Design-Time and ONAP Run-Time.
- Network Service Descriptions are beyond the scope of these requirements.

References
-----------------------

This section contains a list of normative and informative references along
with information on acquiring the identified references.  Normative references
are required to be implemented by this document. Informative references are
for informational purposes only.

Glossary
-----------------------

.. glossary::

    ACL
        Access Control List

    ACME
        Automated Certificate Management

    API
        Application Programming Interface

    BGP
        Border Gateway Protocol

    CA
        Certificate Authority

    CCL
        Commerce Control List

    CLLI
        Common Language Location Identification

    CMOS
        Complementary metal-oxide-semiconductor

    CMP
        Certificate Management Protocol

    CRL
        Certificate Revocation List

    CSAR
        Cloud Service Archive

    DBaaS
        Database as a Service

    DDOS
        Distributer Denial-of-Service

    DNS
        Domain Name System

    DPDK
        Data Plane Development Kit

    DPI
        Deep Packet Inspection

    DPM
        Data Position Measurement

    DSS
        Digital Signature Services

    ECCN
        Export Control Classification Number

    EMS
        Element Management Systems

    EVC
        Ethernet Virtual Connection

    FIPS
        Federal Information Processing Standards

    FQDN
        Fully Qualified Domain Name

    FTPES
        File Transfer Protocol Secure

    GPB
        Google Protocol Buffers

    GUI
        Graphical User Interface

    GVNFM
        Generic Virtualized Network Function Manager

    HSM
        Hardware Security Module

    IDAM
        Identity and Access Management

    IPSec
        IP Security 

    JMS
        Java Message Service

    JSON
        JavaScript Object Notation

    KPI
        Key Performance Indicator

    LCM
        Life Cycle Management

    LCP
        Link Control Protocol

    LDAP
        Lightweight Directory Access Protocol

    LTE
        Long-Term Evolution 

    MD5
        Message-Digest Algorithm

    MIME
        Multipurpose Internet Mail Extensions

    MTTI
        Mean Time to Identify

    MTTR
        Mean Time to Repair

    NCSP
        Network Cloud Service Providers

    NFS
        Network File System

    NFV
        Network Functions Virtualization

    NIC
        Network Interface Controller

    NIST
        National Institute of Standards and Technology

    NTP
        Network Time Protocol

    OA&M
        Operations, administration and management

    OAuth
        Open Authorization

    OID
        Object Identifier

    OPNFV
        Open Platform for Network Functions Virtualization

    OWASP
        Open Web Application Security Project 

    PCEF
        Policy and Charging Enforcement Function

    PCRF
        Policy and Charging Rules Function

    PKI
        Public Key Infrastructure

    PM
        Performance Monitoring

    PNF
        Physical Network Function

    PnP
        Plug and Play

    QoS
        Quality of Service

    RAN
        Radio Access Network

    RBAC
        Role-Based Access Control

    RTPM
        Real Time Performance Monitoring

    RFC
        Remote Function Call

    RFP
        Request For Proposal

    RPC
        Remote Procedure Call

    SAML
        Security Assertion Markup Language

    SCEP
        Simple Certificate Enrollment Protocol 

    SDN
        Software-Defined Networking

    SFTP
        SSH File Transfer Protocol

    SHA
        Secure Hash Algorithm

    SLA
        Service Level Agreement 

    SNMP
        Simple Network Management Protocol

    SP
        Service Provider

    SPI
        Sensitive Personal Information

    SR-IOV
        Single-Root Input/Output Virtualization

    SSL
        Secure Sockets Layer

    SSH
        Secure Shell

    TACACS
        Terminal Access Controller Access Control System

    TCA
        Threshold Crossing Alert

    TLS
        Transport Layer Security 

    TOSCA
        Topology and Orchestration Specification for Cloud Applications

    TPM
        Trusted Platform Module

    UUID
        Universally Unique Identifier

    VDU
        Virtualization Deployment Unit

    VES
        VNF Event Streaming

    VLAN
        Virtual LAN

    VM
        Virtual Machine

    VNF
        Virtual Network Function

    VNFC
        Virtual Network Function Component

    VNF-D
        Virtual Network Function Descriptor

    VPN
        Virtual Private Network

    XML
        eXtensible Markup Language

    YAML
        YAML Ain't Markup Languag

    YANG
        Yet Another Next Generation

    NFVI
        Network Function Virtualization Infrastructure

    VNFC
        Virtualized Network Function Components

    MANO
        Management And Network Orchestration

    VNFM
        Virtualized Network Function Manager

    BUM
        Broadcast, Unknown-Unicast and Multicast traffic



Normative References
^^^^^^^^^^^^^^^^^^^^^^^
+---------------+-----------------------------------------------------+
| Reference     | Description                                         |
+===============+=====================================================+
| [RFC 2119]    | IETF RFC2119, Key words for use in RFCs to Indicate |
|               | Requirement Levels, S. Bradner, March 1997.         |
+---------------+-----------------------------------------------------+

Informative References
^^^^^^^^^^^^^^^^^^^^^^^^
+---------------+-----------------------------------------------------+
| Reference     | Description                                         |
+===============+=====================================================+
|               |                                                     |
+---------------+-----------------------------------------------------+

Reference Acquisition
^^^^^^^^^^^^^^^^^^^^^^^
IETF Specifications:

- Internet Engineering Task Force (IETF) Secretariat, 48377 Fremont Blvd.,
  Suite 117, Fremont, California 94538, USA; Phone: +1-510-492-4080,
  Fax: +1-510-492-4001.

Submitting Feedback
------------------------------------
Please refer to the `VNF Requirements - How to Contribute <https://wiki.onap.org/display/DW/VNFRQTS+How+to+Contribute>`__
guide for instructions on how to create issues or contribute changes to the
VNF Requirements project.