README.md 1.47 KiB
Newer Older
lavado's avatar
lavado committed
# VNF Onboarding Guidelines

lavado's avatar
lavado committed
This is the main document that collect procedures and best practices to onboard VNFs in OSM.

## Contents

lavado's avatar
lavado committed
The complete onboarding process implies producing a VNF Package that will be part of the OSM catalogue for its inclusion in a Network Service. 
lavado's avatar
lavado committed

lavado's avatar
lavado committed
The onboarded VNF should aim to fulfill the lifecycle stages that the NFV MANO layer should be able to automate. Hence, the resulting package, should include all the requirements, instructions and elements to achieve basic instantiation (a.k.a. "Day-0"), service initialization (a.k.a. "Day-1") and runtime operations (a.k.a. "Day-2").
lavado's avatar
lavado committed

lavado's avatar
lavado committed
More information on the delimitation of these stages can be found in the [*OSM Scope and Functionality*](https://osm.etsi.org/wikipub/index.php/OSM_Scope_and_Functionality) document.

As such, the document is structured in the following three parts, providing guidelines for building the VNF Package to achieve each lifecycle stage sucessfully.

1. Day 0: VNF Instantiation & management setup
lavado's avatar
lavado committed
1. Day 1: VNF Services initialization
lavado's avatar
lavado committed
1. Day 2: VNF Runtime operations
lavado's avatar
lavado committed

## Guidelines for contributors

* General OSM documentation guidelines must be followed, as detailed in [this document](https://osm.etsi.org/gitlab/osm-doc/documentation-how-to/blob/master/Workflow%20for%20documentation%20production%20in%20OSM.md#guide-for-contributors)
lavado's avatar
lavado committed
* Every section of this document, under a "H1" tag (single #), is contained in a single file, and formatted according to the following [sample document](#)