From b2c75a1834f30a6e4ed08059aa0efebec8b38e1d Mon Sep 17 00:00:00 2001 From: Gildas Lanilis Date: Fri, 9 Nov 2018 10:45:50 -0800 Subject: Refactor VNFSDSK ReadTheDocs To facilite browsing and user experience Change-Id: Ic54d6f8a2779bd45a2765a61b694e17a231c9b07 Issue-ID: DOC-333 Signed-off-by: Gildas Lanilis --- docs/files/VNF SDK - Guide for Bundling VNFs.rst | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) (limited to 'docs/files/VNF SDK - Guide for Bundling VNFs.rst') diff --git a/docs/files/VNF SDK - Guide for Bundling VNFs.rst b/docs/files/VNF SDK - Guide for Bundling VNFs.rst index 99f3ccf..8bf2f31 100644 --- a/docs/files/VNF SDK - Guide for Bundling VNFs.rst +++ b/docs/files/VNF SDK - Guide for Bundling VNFs.rst @@ -2,12 +2,23 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 Huawei Technologies Co., Ltd. -VNF SDK - Guide for Bundling VNFs -================================= +VNF Package Tools User Guide +============================ + +VNF Package Designer, provides VNF product DevOps engineers with a graphical +tool to define the VNF product model and package content. It is made available +as part of the VNF Supplier SDK tools.The package designer makes use of the VNF +SDK command line interfaces (CLIs) and client-side API language bindings in +order to define the model and the package content. As such, it is functionally +equivalent to the VNF SDK tools. + +VNF SDK - Guide for Bundling VNFs +--------------------------------- + Step 1: Requirements --------------------- +~~~~~~~~~~~~~~~~~~~~ 1. Virtual machine images for each of your VDUs (likely in qcow2 format). 2. Scripts for installing and configuring each VDU per the standard TOSCA @@ -16,14 +27,14 @@ Step 1: Requirements 4. VNF SDK pkgtools Step 2: Start with the provided VNF blueprint as a template ------------------------------------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The VNF SDK comes with a "pingpong.yaml" template. Copy the file and rename it as is appropriate for your VNF. Step 3: Edit the VNF blueprint ------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You will need a node template for each VDU, which in turn has a "dependency" requirement on a host (a Compute node template). @@ -70,7 +81,7 @@ Otherwise, this is a standard TOSCA blueprint using the Simple Profile for NFV, and you may extend the blueprint as is required. Step 4: Bundle the VNF ----------------------- +~~~~~~~~~~~~~~~~~~~~~~ Arrange all your files (the TOSCA template, your scripts, and your virtual machine images) in the correct directory structure. File references provided in -- cgit 1.2.3-korg