Fix for Heat requirements reference link issue

[doc.git] / docs / guides / onap-user / design / pre-onboarding / index.rst

diff --git a/docs/guides/onap-user/design/pre-onboarding/index.rst b/docs/guides/onap-user/design/pre-onboarding/index.rst
index b11fa5c..7279693 100644 (file)
--- a/docs/guides/onap-user/design/pre-onboarding/index.rst
+++ b/docs/guides/onap-user/design/pre-onboarding/index.rst
@@ -7,63 +7,9 @@
 Pre-Onboarding
 ==============
 
 Pre-Onboarding
 ==============
 

-    * `Create a Tenant`_ (will be moved to "Service Deployment")

     * `Generate Manifest and Package Artifacts`_ (for HEAT based VNFs)
     * `Validate xNF Package (VNF/PNF)`_
 
     * `Generate Manifest and Package Artifacts`_ (for HEAT based VNFs)
     * `Validate xNF Package (VNF/PNF)`_
 

-.. _doc_guide_user_des_pre-onb_cre-ten:
-
-Create a Tenant
----------------
-
-.. note::
-   This section is not really belonging to the "Design" phase,
-   but to the preparation of the "Service Deployment" and will be
-   moved in the next release
-
-Each service requires a tenant_ (a group of users who share a common access)
-in which resources are stored in the cloud. This process is performed using
-facilities of the network cloud, outside of ONAP. Confirm that the tenant is
-created and note the tenant ID.
-
-ONAP admin users can configure a cloud-owner to add new cloud resources.
-These are the computing and networking resources, that will support
-running VNFs. A cloud-owner holds a keystone URL, login, region and
-password, in the case of an Openstack cluster. A cloud-owner also
-belongs to a region. The region name should be the same as the Openstack
-region. Prior to creation of a cloud-owner, its region must be created
-first. Multiple tenants can share the same cloud-owner. Note that these
-tenants are ONAP tenants, not Openstack tenants. Tenant register
-services that customers are allowed to deploy. Finally, the customer is
-like an instance of the tenant.
-
-Note: there is no GUI (yet) to configure these objects. REST requests
-are sent to AAI to achieve the configuration. For a detailed list of
-required REST commands see:
-
-https://wiki.onap.org/display/DW/running+vFW+Demo+on+ONAP+Amsterdam+Release
-
-The overall process is as follows:
-
- #. Create a region and a cloud-owner. This steps registers Openstack
-    credentials. This is the only step requiring entering Openstack specific
-    parameters.
-
- #. Create a complex. The complex describes the coverage of the region with
-    a street address etc.
-
- #. Create a service. The service name should match the name of the service
-    onboarded in SDC.
-
- #. Create a tenant. Tenant in ONAP stores a design for a generic customer.
-
- #. Associate tenants with their allowed services.
-
- #. Create an instance of the tenant or customer. The customer is visible in
-    VID. A VID user can deploy allowed services on this new customer.
-
-   |image1|
-

 
 .. _doc_guide_user_des_pre-onb_gen-man:
 
 
 .. _doc_guide_user_des_pre-onb_gen-man:
 


@@ -76,20 +22,20 @@ Generate Manifest and Package Artifacts
    to create TOSCA based VNF or PNF Onboarding Packages are not described
    here
 
    to create TOSCA based VNF or PNF Onboarding Packages are not described
    here
 

-Before onboarding resources, run generate-manifest.py to generate a
-MANIFEST file. These steps are performed outside SDC.
+The for onboarding the zip-file requires besides the HEAT template also a MANIFEST.json file, which describes the content of the package.
+To generate a MANIFEST.json file a script can be used offered by the SDC project:
+`generate-manifest.py`_
+
+These steps are performed outside SDC.

 
 **Prerequisites:** Obtain Heat/ENV files and other files required for
 onboarding. The requirements are found in the following document.
 
 
 **Prerequisites:** Obtain Heat/ENV files and other files required for
 onboarding. The requirements are found in the following document.
 

-.. toctree::
-   :maxdepth: 1
-   :titlesonly:

 
 

-   Heat requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter5/Heat/index.rst>
+:ref:`Heat requirements<onap-vnfrqts-requirements:heat_requirements>`

 
 #. Put the Heat, ENV, nested Heat, and other files used by get-file in templates
 
 #. Put the Heat, ENV, nested Heat, and other files used by get-file in templates

-   in a directory.
+   in a directory on a host, which supports python.

 
    Naming guidelines:
 
 
    Naming guidelines:
 


@@ -106,7 +52,7 @@ onboarding. The requirements are found in the following document.
     - [dir y] contains the Heat/ENV files and other files
     - [dir x] contains the python script
 
     - [dir y] contains the Heat/ENV files and other files
     - [dir x] contains the python script
 

-#. Run the script on the Windows command line (not valid anymore):
+#. Run the script via command line:

 
    .. code-block:: python
 
 
    .. code-block:: python
 


@@ -117,6 +63,8 @@ onboarding. The requirements are found in the following document.
 #. Package all Heat/ENV files, all other files, and the MANIFEST.json
    into one .zip file.
 
 #. Package all Heat/ENV files, all other files, and the MANIFEST.json
    into one .zip file.
 

+Example packages can be found in the SDC poject: `example-packages`_
+

 .. _doc_guide_user_des_pre-onb_val:
 
 Validate xNF Package (VNF/PNF)
 .. _doc_guide_user_des_pre-onb_val:
 
 Validate xNF Package (VNF/PNF)


@@ -124,21 +72,14 @@ Validate xNF Package (VNF/PNF)
 
 VNF and PNF packages have to follow the requirements described in:
 
 
 VNF and PNF packages have to follow the requirements described in:
 

-.. toctree::
-   :maxdepth: 1
-   :titlesonly:
+:ref:`VNF and PNF Modeling Requirements<vnfrqts-requirements:master_index>`

 
 

-   VNF and PNF Modeling Requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter5/index.rst>
-   ONAP Management Requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter7/index.rst>
+:ref:`ONAP Management Requirements<vnfrqts-requirements:master_index>`

 
 For Validation of VNF and PNF packages the tools delivered by VNFSDK can be
 used:
 
 
 For Validation of VNF and PNF packages the tools delivered by VNFSDK can be
 used:
 

-.. toctree::
-   :maxdepth: 1
-   :titlesonly:
-
-   ../../../onap-provider/vnfvalidator.rst
+`VNF Validation Documentation <../../../onap-provider/vnfvalidator.rst>`_

 
 Prior to resource onboarding, the Certification Group does the following:
 
 
 Prior to resource onboarding, the Certification Group does the following:
 


@@ -165,5 +106,5 @@ Cloud.
 No VF functionality testing is performed at this stage.
 
 
 No VF functionality testing is performed at this stage.
 
 

-.. |image1| image:: media/tenant.png
-.. _tenant: https://wiki.onap.org/display/DW/Glossary#Glossary-tenant
+.. _generate-manifest.py: https://git.onap.org/sdc/tree/openecomp-be/tools/scripts/generate-manifest.py
+.. _example-packages: https://git.onap.org/sdc/tree/test-apis-ci/sdc-api-tests/chef-repo/cookbooks/sdc-api-tests/files/default/Files