Docs update for Ocata features

Add VNFM user guide based on the current getting_started
document. Document the direct VNF creation (inline) feature
and rest of the VNFM lifecycle commands.

Update VNF Forwarding Graph doc to document paramter support
for VNFFGD templates.

Co-Authored-By: Sridhar Ramaswamy <srics.r@gmail.com>

Change-Id: I21fa1d5941808f3f7948b3b947675c5276f344e8

doc/source/devref/vnffg_usage_guide.rst

@@ -137,6 +137,33 @@ routed normally and does not enter the VNFFG.
    Enabling symmetrical is not currently supported by the OpenStack VIM
    driver
 
+Parameters for VNFFGD template
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Similar to TOSCA VNFD template, any value of VNFFGD template can be
+parameterized. Once parameterized different values can be passed while
+instantiating the forwarding graph using the same VNFFGD template.
+The value of a parameterized attribute can be specified like *{get_input foo}*
+in the TOSCA VNFFGD template. The corresponding param-file in the following
+YAML format can be provided in the vnffg-create command,
+
+::
+
+  {
+    foo: bar
+  }
+
+VNFFG command with parameter file:
+
+  **tacker vnffg-create --vnffgd-name myvnffgd**
+  **--vnf-mapping VNF1:'91e32c20-6d1f-47a4-9ba7-08f5e5effe07',**
+  **VNF2:'7168062e-9fa1-4203-8cb7-f5c99ff3ee1b'**
+  **--param-file cust-site-x-param.yaml**
+
+
+See `VNFFGD template samples with paramter support <https://github.com/
+openstack/tacker/tree/master/samples/tosca-templates/vnffgd>`_.
+
 Viewing a VNFFG
 ~~~~~~~~~~~~~~~
 

doc/source/devref/vnfm_usage_guide.rst

@@ -0,0 +1,134 @@
+..
+      Copyright 2014-2015 OpenStack Foundation
+      All Rights Reserved.
+
+      Licensed under the Apache License, Version 2.0 (the "License"); you may
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+======================
+VNF Manager User Guide
+======================
+
+Tacker VNF Manager (VNFM) component manages the life-cycle of a Virtual Network
+Function (VNF). VNFM takes care of deployment, monitoring, scaling and removal
+of VNFs on a Virtual Infrastructure Manager (VIM).
+
+
+Onboarding VNF
+==============
+
+TOSCA VNFD templates can be onboarded to Tacker VNFD Catalog using following
+command:
+
+.. code-block:: console
+
+   tacker vnfd-create --vnfd-file <yaml file path> <VNFD-NAME>
+
+.. note::
+
+   Users can find various sample TOSCA templates at https://github.com/openstack/tacker/tree/master/samples/tosca-templates/vnfd
+
+Deploying VNF
+=============
+
+There are two ways to create a VNF in Tacker.
+
+#. Using Tacker Catalog
+#. Direct VNF Instantiation
+
+Using Tacker Catalog
+--------------------
+
+In this method, a TOSCA VNFD template is first onboarded into Tacker VNFD
+catalog. This VNFD is then used to create VNF. This is most common way of
+creating VNFs in Tacker.
+
+   i). Onboard a TOSCA VNFD template.
+
+.. code-block:: console
+
+   tacker vnfd-create --vnfd-file <yaml file path> <VNFD-NAME>
+..
+
+  ii). Create a VNF.
+
+.. code-block:: console
+
+   tacker vnf-create --vnfd-name <VNFD-FILE-NAME> <VNF-NAME>
+
+
+Example
+~~~~~~~
+
+.. code-block:: console
+
+    tacker vnfd-create --vnfd-file sample-vnfd-hello-world.yaml hello-world-vnfd
+    tacker vnf-create --vnfd-name hello-world-vnfd hw-vnf
+
+Direct VNF Instantiation
+------------------------
+
+In this method, VNF is created directly from the TOSCA template without
+onboarding the template into Tacker VNFD Catalog.
+
+.. code-block:: console
+
+   tacker vnf-create --vnfd-template <VNFD-FILE-NAME> <VNF-NAME>
+
+This method is recommended when NFV Catalog is maintained outside Tacker and
+Tacker is primarily used as a NFV workflow engine.
+
+Example
+~~~~~~~
+
+.. code-block:: console
+
+    tacker vnf-create --vnfd-template sample-vnfd-hello-world.yaml hw-vnf
+
+.. note ::
+
+    vnfd-list command will show only the onboarded VNFDs. To list the VNFDs
+    created internally for direct VNF instantiation, use
+    '--template-source inline' flag. To list both onboarded and inline VNFDs,
+    use '--template-source all' flag. The default flag for vnfd-list command
+    is '--template-source onboarded'.
+
+    .. code-block:: console
+
+      tacker vnfd-list --template-source inline
+      tacker vnfd-list --template-source all
+
+Finding VNFM Status
+===================
+
+Status of various VNFM resources can be checked by following commands.
+
+.. code-block:: console
+
+   tacker vim-list
+   tacker vnfd-list
+   tacker vnf-list
+   tacker vnf-show <VNF_ID>
+   tacker vnfd-show <VNFD_ID>
+
+..
+
+Deleting VNF and VNFD
+=====================
+
+VNFs and VNFDs can be deleted as shown below.
+
+.. code-block:: console
+
+   tacker vnf-delete <VNF_ID/NAME>
+   tacker vnfd-delete <VNFD_ID/NAME>
+..

doc/source/index.rst

@@ -49,6 +49,7 @@ Feature Documentation
 .. toctree::
    :maxdepth: 1
 
+   devref/vnfm_usage_guide.rst
    devref/vnfd_template_description.rst
    devref/monitor-api.rst
    devref/vnfd_template_parameterization.rst