Reference VNF and NS Descriptors - Revision history

Ramonsalguer at 16:54, 17 February 2021

2021-02-17T16:54:35Z

← Older revision		Revision as of 16:54, 17 February 2021
Line 1:		Line 1:
			'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''

			---

	= Reference NS#1: Testing an endpoint VNF =		= Reference NS#1: Testing an endpoint VNF =

Garciadeblas: Garciadeblas moved page Reference VNF and NS Descriptors (Release THREE) to Reference VNF and NS Descriptors: No need to specify the version. It will always be up-to-date

2018-09-26T09:27:03Z

Garciadeblas moved page Reference VNF and NS Descriptors (Release THREE) to Reference VNF and NS Descriptors: No need to specify the version. It will always be up-to-date

← Older revision	Revision as of 09:27, 26 September 2018
(No difference)

Garciadeblas at 09:26, 26 September 2018

2018-09-26T09:26:29Z

@@ Line 1: / Line 1: @@
 = Reference NS#1: Testing an endpoint VNF =
@@ Line 131: / Line 119: @@
 == OSM NS descriptor for NS#2 ==
 [https://osm.etsi.org/gitweb/?p=osm/devops.git;a=blob;f=descriptor-packages/nsd/ref2_ns/src/ref2_nsd.yaml NS2.yaml]
 = Resources =
 The template used to create these NS/VNF diagrams is available at:
 [https://drive.google.com/open?id=0B0IUJnTZzp2iUnJUb1JFSGpBRGs Reference_NS-VNF_diagrams.pptx]

Garciadeblas at 14:03, 7 June 2018

2018-06-07T14:03:50Z

← Older revision		Revision as of 14:03, 7 June 2018
Line 49:		Line 49:

	=== OSM VNF descriptor for VNF#11 ===		=== OSM VNF descriptor for VNF#11 ===
	[https://osm.etsi.org/gitweb/?p=osm/~~descriptor-packages~~.git;a=blob;f=~~src~~/vnfd/ref11_vnf/ref11_vnfd.yaml~~;h=f308282b4f3fab25161e780c084efd82bc0f42d2;hb=HEAD~~ VNF11.yaml]		[https://osm.etsi.org/gitweb/?p=osm/devops.git;a=blob;f=descriptor-packages/vnfd/ref11_vnf/src/ref11_vnfd.yaml VNF11.yaml]

	== Reference VNF#21: Generator 1 port ==		== Reference VNF#21: Generator 1 port ==
Line 63:		Line 63:

	=== OSM VNF descriptor for VNF#21 ===		=== OSM VNF descriptor for VNF#21 ===
	[https://osm.etsi.org/gitweb/?p=osm/~~descriptor-packages~~.git;a=blob;f=~~src~~/vnfd/ref21_vnf/ref21_vnfd.yaml~~;h=f308282b4f3fab25161e780c084efd82bc0f42d2;hb=HEAD~~ VNF21.yaml]		[https://osm.etsi.org/gitweb/?p=osm/devops.git;a=blob;f=descriptor-packages/vnfd/ref21_vnf/src/ref21_vnfd.yaml VNF21.yaml]

	== OSM NS descriptor for NS#1 ==		== OSM NS descriptor for NS#1 ==
	[https://osm.etsi.org/gitweb/?p=osm/~~descriptor-packages~~.git;a=blob;f=~~src~~/~~vnfd~~/ref1_ns/ref1_nsd.yaml~~;h=f308282b4f3fab25161e780c084efd82bc0f42d2;hb=HEAD~~ NS1.yaml]		[https://osm.etsi.org/gitweb/?p=osm/devops.git;a=blob;f=descriptor-packages/nsd/ref1_ns/src/ref1_nsd.yaml NS1.yaml]

	= Reference NS #2: Testing a middle point VNF =		= Reference NS #2: Testing a middle point VNF =
Line 108:		Line 108:

	=== OSM VNF descriptor for VNF#12 ===		=== OSM VNF descriptor for VNF#12 ===
	[https://osm.etsi.org/gitweb/?p=osm/~~descriptor-packages~~.git;a=blob;f=~~src~~/vnfd/ref12_vnf/ref12_vnfd.yaml~~;h=f308282b4f3fab25161e780c084efd82bc0f42d2;hb=HEAD~~ VNF12.yaml]		[https://osm.etsi.org/gitweb/?p=osm/devops.git;a=blob;f=descriptor-packages/vnfd/ref12_vnf/src/ref12_vnfd.yaml VNF12.yaml]

	== Reference VNF#22: Generator 2 ports ==		== Reference VNF#22: Generator 2 ports ==
Line 127:		Line 127:

	=== OSM VNF descriptor for VNF#22 ===		=== OSM VNF descriptor for VNF#22 ===
	[https://osm.etsi.org/gitweb/?p=osm/~~descriptor-packages~~.git;a=blob;f=~~src~~/vnfd/ref22_vnf/ref22_vnfd.yaml~~;h=f308282b4f3fab25161e780c084efd82bc0f42d2;hb=HEAD~~ VNF22.yaml]		[https://osm.etsi.org/gitweb/?p=osm/devops.git;a=blob;f=descriptor-packages/vnfd/ref22_vnf/src/ref22_vnfd.yaml VNF22.yaml]

	== OSM NS descriptor for NS#2 ==		== OSM NS descriptor for NS#2 ==
	[https://osm.etsi.org/gitweb/?p=osm/~~descriptor-packages~~.git;a=blob;f=~~src~~/~~vnfd~~/ref2_ns/ref2_nsd.yaml~~;h=f308282b4f3fab25161e780c084efd82bc0f42d2;hb=HEAD~~ NS2.yaml]		[https://osm.etsi.org/gitweb/?p=osm/devops.git;a=blob;f=descriptor-packages/nsd/ref2_ns/src/ref2_nsd.yaml NS2.yaml]

Almagia at 04:55, 5 October 2017

2017-10-05T04:55:49Z

← Older revision		Revision as of 04:55, 5 October 2017
Line 1:		Line 1:
	The following reference examples are provided to help VNF vendors to create their own descriptors (NSD, VNFD) usable in OSM. Please follow the below instruction to create descriptor packages		The following reference examples are provided to help VNF vendors to create their own descriptors (NSD, VNFD) usable in OSM. Please follow the below instruction to create descriptor packages

	* Clone the ~~descriptor-packages~~ repo:		* Clone the devops repo:
	git clone https://osm.etsi.org/gerrit/osm/descriptor-packages		git clone https://osm.etsi.org/gerrit/osm/devops
	* ~~Create a new VNF folder under src~~/vnfd and ~~copy~~ the VNF yaml descriptors in the new folder		* Install the required tools. See descriptor-packages/README
	* ~~Create a new NS folder under src~~/nsd and ~~copy~~ the NS yaml descriptors in the new folder		* Copy one of the existing examples folders in descriptor-packages/vnfd and modify the content of the VNF yaml descriptors in the new folder.
	* Build VNF and NS packages		* Copy one of the existing examples folders in descriptor-packages/nsd and modify the content of the NS yaml descriptors in the new folder
			* Build VNF and NS packages. Enter each new folder and run:
	make		make
	* Packages will be created under ~~build~~/~~vnfd_pkgs and~~ build~~/nsd_pkgs~~		* Packages (*.tar.gz) will be created under <new folder>/build

Garciadeblas: Created page with "The following reference examples are provided to help VNF vendors to create their own descriptors (NSD, VNFD) usable in OSM. Please follow the below instruction to create desc..."

2017-09-07T10:03:27Z

Created page with "The following reference examples are provided to help VNF vendors to create their own descriptors (NSD, VNFD) usable in OSM. Please follow the below instruction to create desc..."

New page

The following reference examples are provided to help VNF vendors to create their own descriptors (NSD, VNFD) usable in OSM. Please follow the below instruction to create descriptor packages

* Clone the descriptor-packages repo:
git clone https://osm.etsi.org/gerrit/osm/descriptor-packages
* Create a new VNF folder under src/vnfd and copy the VNF yaml descriptors in the new folder
* Create a new NS folder under src/nsd and copy the NS yaml descriptors in the new folder
* Build VNF and NS packages
make
* Packages will be created under build/vnfd_pkgs and build/nsd_pkgs

= Reference NS#1: Testing an endpoint VNF =

The following network service captures a simple test setup where a VNF is tested with a traffic generator VNF (or a simple VNF/VM with a basic client application). For simplicity, this network service assumes that the VNF under test is the endpoint of a given service (e.g. DNS, AAA, etc.) and does not require special conditions or resource allocation besides the usual in a standard cloud environments.

[[File:example_ns_1.png | 450px | right | Reference NS #1: Testing an endpoint VNF]]

In this example, unless otherwise specified in the description, the following defaults apply:
* CPs are regular para-virtualized interfaces (VirtIO or equivalent).
* VLs provide E-LAN connectivity via regular (overlay) networks provided by the VIM.
* VLs provide IP addressing via DHCP if applicable.
* Mapping between internal and external CPs may be either direct (as aliases) or via an intermediate VL.
* VIM+NFVI can guarantee predictable ordering of guest interfaces' virtual PCI addresses.

In the case of REF_NS_1:
* When deploying the NS, VL1 would be typically mapped to a pre-created VIM network intended to provide management IP address to VNFs via DHCP.
* DHCP in VL2 may be optional.

== Reference VNF#11: Endpoint VNF ==
[[File:ref_vnf_11.png | 350px | right | Reference VNF#11: Endpoint]]

=== Description in common language ===
* '''Name:''' Ref_VNF_11
** '''Component:''' Ref_VM1
*** '''Memory:''' 2 GB
*** '''CPU:''' 2 vCPU
*** '''Storage:''' 8 GB
*** '''Image:''' ref_vm1.qcow2
** '''Component:''' Ref_VM2
*** '''Memory:''' 4GB
*** '''CPU:''' 2 vCPU
*** '''Storage:''' 16GB
*** '''Image:''' ref_vm2.qcow2
** '''Internal Virtual Link:''' VL12
*** No DHCP server is enabled.
*** Static addressing may be used at CP iface11 and CP iface21.

=== OSM VNF descriptor for VNF#11 ===
[https://osm.etsi.org/gitweb/?p=osm/descriptor-packages.git;a=blob;f=src/vnfd/ref11_vnf/ref11_vnfd.yaml;h=f308282b4f3fab25161e780c084efd82bc0f42d2;hb=HEAD VNF11.yaml]

== Reference VNF#21: Generator 1 port ==
[[File:ref_vnf_21.png | 350px | right | Reference VNF#21: Generator 1 port]]

=== Description in common language ===
* '''Name:''' Ref_VNF_21
** '''Component:''' Ref_VM5
*** '''Memory:''' 1 GB
*** '''CPU:''' 1 vCPU
*** '''Storage:''' 16 GB
*** '''Image:''' ref_vm21.qcow2

=== OSM VNF descriptor for VNF#21 ===
[https://osm.etsi.org/gitweb/?p=osm/descriptor-packages.git;a=blob;f=src/vnfd/ref21_vnf/ref21_vnfd.yaml;h=f308282b4f3fab25161e780c084efd82bc0f42d2;hb=HEAD VNF21.yaml]

== OSM NS descriptor for NS#1 ==
[https://osm.etsi.org/gitweb/?p=osm/descriptor-packages.git;a=blob;f=src/vnfd/ref1_ns/ref1_nsd.yaml;h=f308282b4f3fab25161e780c084efd82bc0f42d2;hb=HEAD NS1.yaml]

= Reference NS #2: Testing a middle point VNF =
[[File:example_ns_2.png | 400px | right | Reference NS #2: Testing a middle point VNF]]

The following network service captures a more advanced test setup where the VNF under test is a middlepoint in the communication (e.g. router, EPC) and might require special conditions or resource allocation and connectivity foreseen in NFV ISG specs. In this case, the traffic generator VNF behaves as source and sink of traffic and might also require special resource allocation.

In this example, unless otherwise specified in the description, the following applies:
* Same defaults as in NS#1
* vCPUs must be pinned to dedicated physical CPUs, with no over subscription.
* CPUs, memory and interfaces (if applicable) to be assigned to a given VM should belong to the same socket (NUMA awareness).
* Memory assigned to VMs should be backed by host's huge pages memory.
* VL2 and VL3 are E-Line underlay connectivity. No DHCP is required.

== Reference VNF#12: Middle point VNF ==
[[File:ref_vnf_12.png | 400px | right | Reference VNF#12: Middle point]]

=== Description in common language ===
* '''Name:''' Ref_VNF_12
** '''Component:''' Ref_VM3
*** '''Memory:''' 2 GB huge pages
*** '''CPU:''' 2 vCPU (= CPU)
*** '''Storage:''' 8 GB
*** '''Image:''' ref_vm3.qcow2
** '''Component:''' Ref_VM4
*** '''Memory:''' 4GB
*** '''CPU:''' 2 vCPU
*** '''Storage:''' 16GB
*** '''Image:''' ref_vm4.qcow2
** '''Connection Point:''' iface42 (west)
*** '''Type:''' Passthrough
** '''Connection Point:''' iface43 (east)
*** '''Type:''' SR-IOV

=== OSM VNF descriptor for VNF#12 ===
[https://osm.etsi.org/gitweb/?p=osm/descriptor-packages.git;a=blob;f=src/vnfd/ref12_vnf/ref12_vnfd.yaml;h=f308282b4f3fab25161e780c084efd82bc0f42d2;hb=HEAD VNF12.yaml]

== Reference VNF#22: Generator 2 ports ==

[[File:ref_vnf_22.png | 400px | right | Reference VNF#22: Generator 2 ports]]

=== Description in common language ===
* '''Name:''' Ref_VNF_22
** '''Component:''' Ref_VM6
*** '''Memory:''' 1 GB huge pages
*** '''CPU:''' 1 vCPU (= CPU)
*** '''Storage:''' 16 GB
*** '''Image:''' ref_vm22.qcow2
** '''Connection Point:''' iface61 (west)
*** '''Type:''' Passthrough
** '''Connection Point:''' iface62 (east)
*** '''Type:''' SR-IOV

=== OSM VNF descriptor for VNF#22 ===
[https://osm.etsi.org/gitweb/?p=osm/descriptor-packages.git;a=blob;f=src/vnfd/ref22_vnf/ref22_vnfd.yaml;h=f308282b4f3fab25161e780c084efd82bc0f42d2;hb=HEAD VNF22.yaml]

== OSM NS descriptor for NS#2 ==
[https://osm.etsi.org/gitweb/?p=osm/descriptor-packages.git;a=blob;f=src/vnfd/ref2_ns/ref2_nsd.yaml;h=f308282b4f3fab25161e780c084efd82bc0f42d2;hb=HEAD NS2.yaml]

= Resources =

The template used to create these NS/VNF diagrams is available at:
[https://drive.google.com/open?id=0B0IUJnTZzp2iUnJUb1JFSGpBRGs Reference_NS-VNF_diagrams.pptx]