VNF Onboarding Guidelines
=========================

.. note::

   This section is sourced from the OSM VNF Onboarding Task Force documentation.
   The original repository is no longer a primary reference; this user guide is
   the canonical location.

`Introduction <vnf-onboarding/00-introduction.html>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Overview of the VNF onboarding process and its lifecycle stages.

`Onboarding Requirements <vnf-onboarding/01-requirements.html>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Requirements for each lifecycle stage: Day-0 (instantiation), Day-1 (initialization), and Day-2 (runtime).

`Day 0: VNF Instantiation & Management Setup <vnf-onboarding/02-day0.html>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

How to model and package a VNF for successful instantiation with OSM.

`Day 1: VNF Services Initialization <vnf-onboarding/03-day1.html>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

How to configure VNF services automatically after instantiation using execution environments.

`Day 2: VNF Runtime Operations <vnf-onboarding/04-day2.html>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

How to implement runtime operations, monitoring primitives, and closed-loop actions.

`Quickstarts <vnf-onboarding/05-quickstarts.html>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Ready-to-run examples covering common VNF and CNF onboarding patterns.

`VNF Onboarding Walkthrough <vnf-onboarding/06-walkthrough.html>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

End-to-end walkthrough of onboarding a multi-VDU VNF with OSM.

`KNF Onboarding Walkthrough <vnf-onboarding/07-knfwalkthrough.html>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

End-to-end walkthrough of onboarding a Containerized Network Function (CNF) with OSM.

`Advanced Charms <vnf-onboarding/08-advanced-charms.html>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Advanced topics for Juju charm-based VNF configuration.

`Helm-chart based Execution Environments <vnf-onboarding/09-helm-ee.html>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Using Helm charts as execution environments for Day-1 and Day-2 VNF operations.

`Additional References <vnf-onboarding/10-references.html>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Known issues, migration tools, and supplementary resources.

.. toctree::
   :maxdepth: 2
   :hidden:

   vnf-onboarding/00-introduction
   vnf-onboarding/01-requirements
   vnf-onboarding/02-day0
   vnf-onboarding/03-day1
   vnf-onboarding/04-day2
   vnf-onboarding/05-quickstarts
   vnf-onboarding/06-walkthrough
   vnf-onboarding/07-knfwalkthrough
   vnf-onboarding/08-advanced-charms
   vnf-onboarding/09-helm-ee
   vnf-onboarding/10-references