Creating your own VNF package (Release ONE) - Revision history

Garciadeblas: /* VNF with primitives */

2017-02-21T10:52:24Z

VNF with primitives

← Older revision		Revision as of 10:52, 21 February 2017
Line 56:		Line 56:
	*Clone the descriptor-packages repo:		*Clone the descriptor-packages repo:
	git clone https://osm.etsi.org/gerrit/osm/juju-charms		git clone https://osm.etsi.org/gerrit/osm/juju-charms
	* Follow the instructions to create your own charm		* Follow the instructions to create your own charm: [[Creating your own VNF charm (Release ONE)\|Creating your own VNF charm]]
	~~https~~:~~//osm.etsi.org/wikipub/index.php/Creating_your_own_VNF_charm_~~(~~Release_ONE~~)
	You can then follow the ping-pong example in OSM descriptor packages to integrate the charm into VNF primitives		You can then follow the ping-pong example in OSM descriptor packages to integrate the charm into VNF primitives

Chamarty: Add link to Charm creation

2017-01-13T14:56:31Z

Add link to Charm creation

← Older revision		Revision as of 14:56, 13 January 2017
Line 51:		Line 51:

	==VNF with primitives==		==VNF with primitives==
	~~(Under elaboration)~~

	You will have to create a proxy charm for the VNF. You can follow the general instructions below:		You will have to create a proxy charm for the VNF. You can follow the general instructions below:
	*Clone the descriptor-packages repo:		*Clone the descriptor-packages repo:
	git clone https://osm.etsi.org/gerrit/osm/juju-charms		git clone https://osm.etsi.org/gerrit/osm/juju-charms
	*...		* Follow the instructions to create your own charm
			https://osm.etsi.org/wikipub/index.php/Creating_your_own_VNF_charm_(Release_ONE)
			You can then follow the ping-pong example in OSM descriptor packages to integrate the charm into VNF primitives

Velandy at 20:04, 3 November 2016

2016-11-03T20:04:11Z

← Older revision		Revision as of 20:04, 3 November 2016
Line 39:		Line 39:

	A descriptor that has been on-boarded (through package onboard or through the GUI composer) will be available for export to create a descriptor package.		A descriptor that has been on-boarded (through package onboard or through the GUI composer) will be available for export to create a descriptor package.
	#Note: ~~In release1 implementation~~ does not ~~preserve any~~ artifacts that was in the on-boarded package.		#Note: Release1 does not include the artifacts that was in the on-boarded package in the exported package.

	==== Adding additional artifacts to a VNF descriptor package ====		==== Adding additional artifacts to a VNF descriptor package ====

Garciadeblas: /* Exporting a VNF descriptor package */

2016-11-03T09:45:28Z

Exporting a VNF descriptor package

← Older revision		Revision as of 09:45, 3 November 2016
Line 39:		Line 39:

	A descriptor that has been on-boarded (through package onboard or through the GUI composer) will be available for export to create a descriptor package.		A descriptor that has been on-boarded (through package onboard or through the GUI composer) will be available for export to create a descriptor package.
	#Note: In release1 implementation does not preserve any artifacts that was in the on-boarded package.		#Note: In release1 implementation does not preserve any artifacts that was in the on-boarded package.

	==== Adding additional artifacts to a VNF descriptor package ====		==== Adding additional artifacts to a VNF descriptor package ====

Garciadeblas at 09:38, 3 November 2016

2016-11-03T09:38:32Z

Velandy at 22:57, 2 November 2016

2016-11-02T22:57:00Z

@@ Line 10: / Line 10: @@
 *A folder called <VNF_NAME>_vnfd will be created with all the files required for a VNF package.
 *Edit the file <VNF_NAME>_vnfd.yaml.
 *Once done, you can generate the tar.gz VNF package with the command:
   ./descriptor-packages/src/generate_descriptor_pkg.sh -t vnfd -N <VNF_NAME>_vnfd
   #Note: the argument -N is optional and is intended to keep the package files after creating the package
 ==VNF with primitives==

Garciadeblas: /* VNF with primitives */

2016-11-02T17:14:31Z

VNF with primitives

← Older revision		Revision as of 17:14, 2 November 2016
Line 16:		Line 16:
	==VNF with primitives==		==VNF with primitives==
	(Under elaboration)		(Under elaboration)

	You will have to create a proxy charm for the VNF. You can follow the general instructions below:		You will have to create a proxy charm for the VNF. You can follow the general instructions below:
	*Clone the descriptor-packages repo:		*Clone the descriptor-packages repo:
	git clone https://osm.etsi.org/gerrit/osm/juju-charms		git clone https://osm.etsi.org/gerrit/osm/juju-charms
	*...		*...

Garciadeblas: Created page with "==VNF without primitives== ===Using web form=== You can access this web page and follow the instructions: http://riftio.com/osm-vnf-package-generator/ ===Using the CLI tool==..."

2016-10-26T13:05:17Z

Created page with "==VNF without primitives== ===Using web form=== You can access this web page and follow the instructions: http://riftio.com/osm-vnf-package-generator/ ===Using the CLI tool==..."

New page

==VNF without primitives==
===Using web form===
You can access this web page and follow the instructions: http://riftio.com/osm-vnf-package-generator/

===Using the CLI tool===
*Clone the descriptor-packages repo:
git clone https://osm.etsi.org/gerrit/osm/descriptor-packages
*Run the following command to create a folder with all the files required for a single-VM VNF package:
./descriptor-packages/src/generate_descriptor_pkg.sh -t vnfd --image <IMAGE_PATH> -c <VNF_NAME>
*A folder called <VNF_NAME>_vnfd will be created with all the files required for a VNF package.
*Edit the file <VNF_NAME>_vnfd.yaml.
*Once done, you can generate the tar.gz VNF package with the command:
./descriptor-packages/src/generate_descriptor_pkg.sh -t vnfd -N <VNF_NAME>_vnfd
#Note: the argument -N is optional and is intended to keep the package files after creating the package

==VNF with primitives==
(Under elaboration)
You will have to create a proxy charm for the VNF. You can follow the general instructions below:
*Clone the descriptor-packages repo:
git clone https://osm.etsi.org/gerrit/osm/juju-charms
*...

← Older revision		Revision as of 09:38, 3 November 2016
Line 9:		Line 9:
	./descriptor-packages/src/generate_descriptor_pkg.sh -t vnfd --image <IMAGE_PATH> -c <VNF_NAME>		./descriptor-packages/src/generate_descriptor_pkg.sh -t vnfd --image <IMAGE_PATH> -c <VNF_NAME>
	*A folder called <VNF_NAME>_vnfd will be created with all the files required for a VNF package.		*A folder called <VNF_NAME>_vnfd will be created with all the files required for a VNF package.
	*Edit the file <VNF_NAME>_vnfd.yaml.		*Edit the descriptor file <VNF_NAME>_vnfd.yaml.
	* Add any artifacts needed by the VNF (eg, charm, icons, images etc ...) to the appropriate folder and make sure it is referenced in the descriptor.		**By default, the descriptor is prepared for a single-VM VNF.
			**Add as many VMs as required.
			**Add also Internal VLDs as required.
			*Add any artifacts needed by the VNF (eg, charm, icons, images etc ...) to the appropriate folder and make sure it is referenced in the descriptor.
	*Once done, you can generate the tar.gz VNF package with the command:		*Once done, you can generate the tar.gz VNF package with the command:
	./descriptor-packages/src/generate_descriptor_pkg.sh -t vnfd -N <VNF_NAME>_vnfd		./descriptor-packages/src/generate_descriptor_pkg.sh -t vnfd -N <VNF_NAME>_vnfd
Line 20:		Line 23:
	===Using the GUI based composer ===		===Using the GUI based composer ===

	==== Creating and ~~Onboarding~~ a VNF descriptor ====		==== Creating and onboarding a VNF descriptor ====

	The GUI composer tool is recommended for editing complex VNFs such as multi-vm VNFs		The GUI composer tool is recommended for editing complex VNFs such as multi-VM VNFs
	* Bring up the OSM GUI.		* Bring up the OSM GUI.
	* Navigate to the "catalog" page and click on the "+" sign to choose "ADD VNFD" option.		* Navigate to the "catalog" page and click on the "+" sign to choose "ADD VNFD" option.
	* A new VNF will be added to the canvas. By default the VNF will contain a single VDU.		* A new VNF will be added to the canvas. By default the VNF will contain a single VM/VDU.
	* Use the "model driven" editor on the right most side of the page to update the various fields in the VNF descriptor.		* Use the "model driven" editor on the right most side of the page to update the various fields in the VNF descriptor.
	* Use the "ADD VDU" and "ADD IVLD" buttons to add additional VDUs and Internal VLDs needed by the VNF.		* Use the "ADD VDU" and "ADD IVLD" buttons to add additional VDUs and Internal VLDs needed by the VNF.
	* Select the VDUs and VLDs created and update the fields as needed using the model driven editor on the right.		* Select the VDUs and VLDs created and update the fields as needed using the model driven editor on the right.
	* For VDUs that need connection to an Internal VLD, add internal connection points to the VDU. Once added, the connection points will be visible on the canvas.		* For VDUs that need connection to an Internal VLD, add internal connection points to the VDU. Once added, the connection points will be visible on the canvas.
	* Make the connection to Internal VLD and VDU by clicking and drawing a line to the VLD.		* Make the connection to Internal VLD and VDU by clicking in the VDU and drawing a line to the VLD.
	* Once all the edits to the descriptor are completed, click "ONBOARD" to onboard the descriptor.		* Once all the edits to the descriptor are completed, click "ONBOARD" to onboard the descriptor.

	==== Exporting a VNF descriptor package ====		==== Exporting a VNF descriptor package ====

	A descriptor that has been on-boarded (through package onboard or through the GUI composer) will be available for export to create a descriptor package.		A descriptor that has been on-boarded (through package onboard or through the GUI composer) will be available for export to create a descriptor package.
	#Note: In release1 implementation does not preserve any artifacts that was in the on-boarded package.		#Note: In release1 implementation does not preserve any artifacts that was in the on-boarded package.

	==== Adding additional artifacts to a VNF descriptor package ====		==== Adding additional artifacts to a VNF descriptor package ====

	The release1 implementation does not allow the editing of artifacts within a VNF package. So only descriptors can be generated using the GUI composer tool.		The release1 implementation does not allow the editing of artifacts within a VNF package. So only descriptors can be generated using the GUI composer tool.
	If additional artifacts need to be included in the VNF package,		If additional artifacts need to be included in the VNF package, then:
	* Export the VNF package to myvnf.tar.gz.		*Export the VNF package to myvnf.tar.gz.
	* Untar ~~and~~ using tar -zxvf myvnf.tar.gz.		*Untar the package using tar -zxvf myvnf.tar.gz.
	* Copy the needed artifacts to the appropriate directory and update the descriptor to refer to them.		*Copy the needed artifacts to the appropriate directory and update the descriptor to refer to them.
	* Recreate the package using the CLI tool		*Recreate the package using the CLI tool

	==VNF with primitives==		==VNF with primitives==