ETSI GS NFV-SOL 004 V3.5.1 (2021-05)

Network Functions Virtualisation (NFV) Release 3; Protocols and Data Models; VNF Package and PNFD Archive specification

RGS/NFV-SOL004ed351

General Information

• Status: Not Published
• Technical Committee: NFV SOL - Solutions
• Current Stage: 12 - Completion
• Due Date: 02-Jun-2021
• Completion Date: 06-May-2021

Standards Content (Sample)

ETSI GS NFV-SOL 004 V3.5.1 (2021-05)






GROUP SPECIFICATION
Network Functions Virtualisation (NFV) Release 3;
Protocols and Data Models;
VNF Package and PNFD Archive specification
Disclaimer
The present document has been produced and approved by the Network Functions Virtualisation (NFV) ETSI Industry
Specification Group (ISG) and represents the views of those members who participated in this ISG.
It does not necessarily represent the views of the entire ETSI membership.

---------------------- Page: 1 ----------------------
2 ETSI GS NFV-SOL 004 V3.5.1 (2021-05)
Reference
RGS/NFV-SOL004ed351
Keywords
data, NFV, protocol, virtualisation
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: [phone]  Fax: [phone]
Siret N° 348 623 562 00017 - APE 7112B
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° w061004871
Important notice
The present document can be downloaded from:
http://www.etsi.org/standards-search
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
Notice of disclaimer & limitation of liability
The information provided in the present deliverable is directed solely to professionals who have the appropriate degree of
experience to understand and interpret its content in accordance with generally accepted engineering or
other professional standard and applicable regulations.
No recommendation as to products and services or vendors is made or should be implied.
No representation or warranty is made that this deliverable is technically accurate or sufficient or conforms to any law
and/or governmental rule and/or regulation and further, no representation or warranty is made of merchantability or fitness
for any particular purpose or against infringement of intellectual property rights.
In no event shall ETSI be held liable for loss of profits or any other incidental or consequential damages.
Any software contained in this deliverable is provided "AS IS" with no warranties, express or implied, including but not
limited to, the warranties of merchantability, fitness for a particular purpose and non-infringement of intellectual property
rights and ETSI shall not be held liable in any event for any damages whatsoever (including, without limitation, damages
for loss of profits, business interruption, loss of information, or any other pecuniary loss) arising out of or related to the use
of or inability to use the software.
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying and
microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.
© ETSI 2021.
All rights reserved.
ETSI

---------------------- Page: 2 ----------------------
3 ETSI GS NFV-SOL 004 V3.5.1 (2021-05)
Contents
Intellectual Property Rights . 5
Foreword . 5
Modal verbs terminology . 5
1 Scope . 6
2 References . 6
2.1 Normative references . 6
2.2 Informative references . 7
3 Definition of terms, symbols and abbreviations . 7
3.1 Terms . 7
3.2 Symbols . 7
3.3 Abbreviations . 8
4 VNF package . 8
4.1 TOSCA YAML Cloud Service Archive (CSAR) overview . 8
4.1.1 CSAR structure . 8
4.1.2 CSAR with TOSCA-Metadata directory . 8
4.1.2.1 General . 8
4.1.2.2 TOSCA.meta file extension . 9
4.1.2.3 TOSCA.meta file keynames extension . 9
4.1.3 CSAR without TOSCA-Metadata directory . 10
4.1.3.1 General . 10
4.1.3.2 TOSCA Entry definition file metadata extension for a YANG-based VNFD . 10
4.1.4 Void . 10
4.2 VNF package structure and format . 10
4.3 VNF package file contents . 11
4.3.1 General . 11
4.3.2 VNF package manifest file . 11
4.3.3 VNF package change history file . 13
4.3.4 VNF package testing files . 13
4.3.5 VNF package licensing information . 13
4.3.6 Certificate file . 13
4.3.7 Non-MANO artifact sets in a VNF package . 14
5 Adding security to TOSCA CSAR . 14
5.1 VNF package authenticity and integrity . 14
5.2 VNF package manifest and certificate files . 15
5.3 Conventions in the manifest file . 16
5.4 Signature of individual artifacts . 17
5.5 Support for security sensitive artifacts . 18
6 PNFD archive . 19
6.1 General . 19
6.2 Actors and roles . 19
6.3 PNFD archive file contents . 19
6.3.1 General . 19
6.3.2 PNFD archive manifest file . 19
6.3.3 Not applicable clauses . 20
Annex A (informative): TOSCA CSAR examples . 21
A.1 CSAR with the TOSCA-Metadata directory . 21
A.2 CSAR without the TOSCA-Metadata directory . 21
A.3 CSAR with the YANG VNFD without TOSCA.meta directory . 22
Annex B (normative): Non-MANO artifact sets registry . 23
ETSI

---------------------- Page: 3 ----------------------
4 ETSI GS NFV-SOL 004 V3.5.1 (2021-05)
B.1 General . 23
B.2 Non-MANO artifact set identifier format. 23
B.3 Registered information . 23
B.4 Initial registration . 24
B.4.1 Template . 24
B.4.2 Template . 24
B.5 Registration update . 25
Annex C (informative): Bibliography . 26
Annex D (informative): Change History . 27
History . 30


ETSI

---------------------- Page: 4 ----------------------
5 ETSI GS NFV-SOL 004 V3.5.1 (2021-05)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The declarations
pertaining to these essential IPRs, if any, are publicly available for ETSI members and non-members, and can be
found in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to
ETSI in respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the
ETSI Web server (https://ipr.etsi.org/).
Pursuant to the ETSI Directives including the ETSI IPR Policy, no investigation regarding the essentiality of IPRs,
including IPR searches, has been carried out by ETSI. No guarantee can be given as to the existence of other IPRs not
referenced in ETSI SR 000 314 (or the updates on the ETSI Web server) which are, or may be, or may become,
essential to the present document.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
DECT™, PLUGTESTS™, UMTS™ and the ETSI logo are trademarks of ETSI registered for the benefit of its

Members. 3GPP™ and LTE™ are trademarks of ETSI registered for the benefit of its Members and of the 3GPP
Organizational Partners. oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and of the
®
oneM2M Partners. GSM and the GSM logo are trademarks registered and owned by the GSM Association.
Foreword
This Group Specification (GS) has been produced by ETSI Industry Specification Group (ISG) Network Functions
Virtualisation (NFV).
Modal verbs terminology
In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and
"cannot" are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of
provisions).
"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.

ETSI

---------------------- Page: 5 ----------------------
6 ETSI GS NFV-SOL 004 V3.5.1 (2021-05)
1 Scope
The present document specifies the structure and format of a VNF package file and its constituents, fulfilling the
requirements specified in ETSI GS NFV-IFA 011 [1] for a VNF package.
The present document also specifies the structure and format of a PNFD archive file and its constituents, fulfilling the
requirements specified in ETSI GS NFV-IFA 014 [i.9] for a PNFD archive.
2 References
2.1 Normative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
Referenced documents which are not found to be publicly available in the expected location might be found at
https://docbox.etsi.org/Reference/.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are necessary for the application of the present document.
[1] ETSI GS NFV-IFA 011: "Network Functions Virtualisation (NFV) Release 3; Management and
Orchestration; VNF Descriptor and Packaging Specification".
[2] OASIS TOSCA-Simple-Profile-YAML-v1.1-csprd01: "TOSCA Simple Profile in YAML
Version 1.1".
NOTE: Available at http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.1/csprd01/TOSCA-
Simple-Profile-YAML-v1.1-csprd01.html.
[3] IETF RFC 3339: "Date and Time on the Internet: Timestamps".
[4] IANA register for Hash Function Textual Names.
NOTE: Available at https://www.iana.org/assignments/hash-function-text-names/hash-function-text-
names.xhtml.
[5] IETF RFC 5652 (September 2009): "Cryptographic Message Syntax (CMS)".
[6] IETF RFC 7468: "Textual Encodings of PKIX, PKCS, and CMS Structures".
[7] Void.
[8] Recommendation ITU-T X.509: "Information technology - Open Systems Interconnection - The
Directory: Public-key and attribute certificate frameworks".
[9] Void.
[10] IETF RFC 2315: "PKCS #7: Cryptographic Message Syntax Version 1.5".
[11] OASIS TOSCA-Simple-Profile-yaml-v1.3: "TOSCA Simple Profile in YAML Version 1.3".
NOTE: Available at https://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.3/TOSCA-Simple-
Profile-YAML-v1.3.html.
[12] ISO/IEC 21320-1: "Information technology -- Document Container File -- Part 1: Core".
ETSI

---------------------- Page: 6 ----------------------
7 ETSI GS NFV-SOL 004 V3.5.1 (2021-05)
2.2 Informative references
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific. For specific references, only the cited version applies. For non-specific references, the latest version of the
referenced document (including any amendments) applies.
NOTE: While any hyperlinks included in this clause were valid at the time of publication, ETSI cannot guarantee
their long term validity.
The following referenced documents are not necessary for the application of the present document but they assist the
user with regard to a particular subject area.
[i.1] Void.
[i.2] Void.
[i.3] ETSI GS NFV 003: "Network Functions Virtualisation (NFV); Terminology for Main Concepts in
NFV".
[i.4] ETSI GS NFV-SOL 001: "Network Functions Virtualisation (NFV) Release 3; Protocols and Data
Models; NFV descriptors based on TOSCA specification".
[i.5] ETSI NFV registry of non-MANO artifact sets.
NOTE: Available at http://register.etsi.org/NFV.
[i.6] ETSI GS NFV-SOL 006: "Network Functions Virtualisation (NFV) Release 3; Protocols and Data
Models; NFV descriptors based on YANG specification".
[i.7] ETSI GS NFV-SOL 004 (V2.4.1): "Network Functions Virtualisation (NFV) Release 2; Protocols
and Data Models; VNF Package specification".
[i.8] ETSI GS NFV-SOL 004 (V2.5.1): "Network Functions Virtualisation (NFV) Release 2; Protocols
and Data Models; VNF Package specification".
[i.9] ETSI GS NFV-IFA 014: "Network Functions Virtualisation (NFV) Release 3; Management and
Orchestration; Network Service Templates Specification".
[i.10] ETSI GS NFV-SOL 005: "Network Functions Virtualisation (NFV) Release 3; Protocols and Data
Models; RESTful protocols specification for the Os-Ma-nfvo Reference Point".
3 Definition of terms, symbols and abbreviations
3.1 Terms
For the purposes of the present document, the terms given in ETSI GS NFV 003 [i.3] and the following apply:
non-MANO artifact: artifact for use by functional blocks beyond NFV-MANO
non-MANO artifact set: set of related non-MANO artifacts which are intended to be used together
3.2 Symbols
Void.
ETSI

---------------------- Page: 7 ----------------------
8 ETSI GS NFV-SOL 004 V3.5.1 (2021-05)
3.3 Abbreviations
For the purposes of the present document, the following abbreviations apply:
ASCII American Standard Code for Information Interchange
CA Certificate Authority
CMS Cryptographic Message Syntax
CSAR Cloud Service ARchive
IANA Internet Assigned Number Association
MANO Management and Orchestration
NFVI NFV Infrastructure
NFVO NFV Orchestrator
PKCS Public Key Cryptographic Standard
PNF Physical Network Function
PNFD PNF Descriptor
TOSCA Topology and Orchestration Specification for Cloud Applications
URI Universal Resource Identifier
UTF Unicode Transformation Format
VNF Virtualised Network Function
VNFD VNF Descriptor
YAML YAML Ain't Markup Language
YANG Yet Another Next Generation
4 VNF package
4.1 TOSCA YAML Cloud Service Archive (CSAR) overview
4.1.1 CSAR structure
TOSCA YAML CSAR file is an archive file using the ZIP file format whose structure complies with the TOSCA
Simple Profile YAML v1.1 [2] or the TOSCA Simple Profile in YAML v1.3 [11]. According to the TOSCA Simple
Profile YAML v1.1 [2], the CSAR file shall have one of the two following structures:
• CSAR containing a TOSCA-Metadata directory, which includes the TOSCA.meta metadata file providing an
entry information for processing a CSAR file.
• CSAR without a TOSCA-Metadata directory and containing a single yaml file with a .yml or .yaml extension
at the root of the archive. The yaml file is a TOSCA definition template that shall contain a metadata section
with template_name and template_version keyname.
In addition, the CSAR file may optionally contain other directories with bespoke names and contents.
4.1.2 CSAR with TOSCA-Metadata directory
4.1.2.1 General
The TOSCA.meta metadata file includes block_0 with the Entry-Definitions keyword pointing to a TOSCA definitions
YAML file and optionally the Other-Definitions keyword as specified in TOSCA Simple Profile YAML v1.3 [11]
pointing to other TOSCA definitions YAML files used as entries for parsing the contents of the overall CSAR archive.
Any TOSCA definitions files besides the one denoted by the Entry-Definitions and Other-Definitions keyword can be
found by processing respective imports statements in the entry definitions files (or in recursively imported files).
Any additional artifacts files (e.g. scripts, binaries, configuration files) can be either declared explicitly through blocks
in the TOSCA.meta file or pointed to by relative path names through artifact definitions in one of the TOSCA
definitions files contained in the CSAR file as described in TOSCA Simple Profile YAML v1.1 [2].
Extension of the TOSCA.meta file is described in clause 4.1.2.2.
ETSI

---------------------- Page: 8 ----------------------
9 ETSI GS NFV-SOL 004 V3.5.1 (2021-05)
In order to indicate that the simplified structure (i.e. not all files need to be declared explicitly) of TOSCA.meta file
allowed by TOSCA Simple profile YAML 1.1 [2] is used, the CSAR-Version keyword listed in block_0 of the meta-file
denotes the version 1.1 as described in the below example.
EXAMPLE:
TOSCA-Meta-File-Version: 1.0
CSAR-Version: 1.1
Created-by: Onboarding portal
Entry-Definitions: Definitions/MainServiceTemplate.yaml

END OF EXAMPLE.
4.1.2.2 TOSCA.meta file extension
The TOSCA.meta file structure extension is used when files defined in clauses 4.3.2 to 4.3.6 of the present document
are included in the VNF package and when using CSAR with TOSCA-Metadata directory, as described in
clause 4.1.2.1.
NOTE: TOSCA Simple Profile YAML v1.1 [2] does not preclude the TOSCA.meta file block _0 to be extended
with key value pairs.
4.1.2.3 TOSCA.meta file keynames extension
Table 4.1.2.3-1 specifies an extension of the list of recognized TOSCA.meta file keynames as specified in the present
document for the TOSCA.meta file. The keynames represents the entries for artifacts defined in clauses 4.3.2 to 4.3.6 of
the present document and shall be located in the block_0.
Table 4.1.2.3-1: List of TOSCA-meta file keynames extensions
Keyname Required Type Description
ETSI-Entry-Manifest yes string Location of the Manifest file as defined in clause 4.3.2
ETSI-Entry-Change-Log yes string Location of the Change history file as defined in clause 4.3.3
ETSI-Entry-Tests no string Location of the Testing files as defined in clause 4.3.4
ETSI-Entry-Licenses yes string Location of the Licensing information as defined in clause 4.3.5
ETSI-Entry-Certificate no string Location of the Certificate file as defined in clause 4.3.6

Use of the Entry-Manifest, Entry-Change-Log, Entry-Tests, Entry-Licenses and Entry-Certificate keynames defined in
ETSI GS NFV-SOL 004 versions 2.4.1 [i.7] to 2.5.1 [i.8] of the present document is deprecated. These keynames are
only provided for backward compatibility with legacy VNF Package consumers; VNF package providers are warned
that support of these keynames can be removed in subsequent versions of the present document. The key with and
without the ETSI-prefix should not be both present in the TOSCA.meta. If both are present they shall point to the same
value.
EXAMPLE:
TOSCA-Meta-File-Version: 1.0
CSAR-Version: 1.1
Created-By: MyCompany
Entry-Definitions: MRF.yaml
ETSI-Entry-Manifest: MRF.mf
ETSI-Entry-Licenses: Files/Licenses
ETSI-Entry-Change-Log: Files/ChangeLog.txt

END OF EXAMPLE.
ETSI

---------------------- Page: 9 ----------------------
10 ETSI GS NFV-SOL 004 V3.5.1 (2021-05)
4.1.3 CSAR without TOSCA-Metadata directory
4.1.3.1 General
This CSAR structure is only applicable if a YANG-based VNFD as defined in ETSI GS NFV-SOL 006 [i.6] or a
TOSCA-based VNFD with single deployment flavour design as defined in clause 6.11.3 in ETSI
GS NFV-SOL 001 [i.4] is included in the VNF Package. The yaml file at the root of the archive is the CSAR Entry-
Definition file. The CSAR-Version is defined by the template_version metadata as can be seen in the below example.
The value of template_version shall be set to 1.1.
EXAMPLE:
tosca_definitions_version: tosca_simple_yaml_1_2
metadata:
  template_name: MainServiceTemplate
  template_author: Onboarding portal
  template_version: 1.1

END OF EXAMPLE.
4.1.3.2 TOSCA Entry definition file metadata extension for a YANG-based VNFD
Table 4.1.3.2-1 specifies an extension of the list of recognized metadata keynames as specified in TOSCA-Simple-
Profile-YAML-v1.1 [2] for the main TOSCA Service Template.
Table 4.1.3.2-1: List of metadata keynames extensions
Keyname Required Type Description
yang_definitions no string Reference to a YANG definition file representing the VNFD within a VNF
Package

If a YANG-based VNFD is included in the VNF Package, the main TOSCA definitions YAML file shall include a
metadata section with an additional metadata entry, where the keyname is ''yang_definitions'' and the value is the path to
the YANG file representing the VNFD within the VNF Package. No additional contents shall be included in the main
TOSCA definitions YAML file.
NOTE: The above requirement ensures that there cannot be both a YANG-based and a TOSCA-based
representation of a VNFD in the same package.
EXAMPLE:
tosca_definitions_version: tosca_simple_yaml_1_1
metadata:
template_name: MainServiceTemplate
template_author: Onboarding portal
template_version: 1.1
yang_definitions: Definitions/myvnfd.xml

END OF EXAMPLE.
4.1.4 Void
4.2 VNF package structure and format
The structure and format of a VNF package shall conform to the TOSCA Simple Profile YAML v1.1 Specification of
the CSAR format [2]. The zip file format shall conform to Document Container Format File [12].
NOTE: This implies that the VNF package can be structured according to any of the two options described in
clause 4.1.
ETSI

---------------------- Page: 10 ----------------------
11 ETSI GS NFV-SOL 004 V3.5.1 (2021-05)
The consumer of a VNF package complying with the present document shall be able to process a CSAR file structured
according to any of the two options described in clause 4.1. If the CSAR file contains a TOSCA-Metadata directory and
a single yaml file with a .yml or .yaml extension at the root of the archive, the TOSCA.meta file contained in the
TOSCA-Metadata directory shall be used as an entry information for processing the CSAR file.
4.3 VNF package file contents
4.3.1 General
A VNF Package shall contain a main TOSCA definitions YAML file representing all or part of the VNFD, and
additional files. It shall be structured according to one of the CSAR structure options described in clause 4.1.
NOTE 1: ETSI GS NFV-SOL 001 [i.4] specifies the structure and format of the VNFD based on TOSCA
specifications.
NOTE 2: ETSI GS NFV-SOL 006 [i.6] specifies the structure and format of the VNFD based on YANG
specifications.
Examples of VNF package options are described in annex A.
4.3.2 VNF package manifest file
A CSAR VNF package shall have a manifest file. In the case of a CSAR VNF package with a TOSCA-Metadata
directory, the location, name, and extension of the manifest file shall be specified by means of the "ETSI-Entry-
Manifest" keyname in the TOSCA.meta file. In the case of a CSAR VNF package without TOSCA-Metadata directory,
the manifest file shall have an extension .mf, the same name as the main TOSCA definitions YAML file and be located
at the root of the archive.
The manifest file shall start with the VNF package metadata in the form of a name-value pairs. Each p
...