Updating documentation on SDC onboarding package types in "Design" pages
Issue-ID: DOC-521
Change-Id: Ib1a50e40a50a3047f28fcb2a8694840c1c62bdce
Signed-off-by: dermot123 <dermot.melia@est.tech>
diff --git a/docs/guides/onap-user/design/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst
index 56f6b6e..a259838 100644
--- a/docs/guides/onap-user/design/resource-onboarding/index.rst
+++ b/docs/guides/onap-user/design/resource-onboarding/index.rst
@@ -7,7 +7,7 @@
Resource Onboarding
===================
**Goal:** Add models and other artifacts required to create, configure,
- instantiate, and manage a VF and, optionally, a VFC.
+ instantiate, and manage a VF/PNF and, optionally, a VFC.
**Tool:** SDC
@@ -26,8 +26,8 @@
* `Update a VSP [optional]`_
After updating the artifacts in a VSP, also update:
- * the VF created from the VSP
- * any services that include the VF
+ * the VF/PNF created from the VSP
+ * any services that include the VF/PNF
|image1|
@@ -69,7 +69,7 @@
#. Click *Submit* to add the license model to the catalog. A success message
displays.
#. After creating a license, complete `Create a Vendor Software Product`_ to
- add the VSP required for the associated VF.
+ add the VSP required for the associated VF/PNF.
Create a License Key Group [Optional]
-------------------------------------
@@ -151,7 +151,7 @@
--------------------------------
Create one or more Vendor Software Products (VSPs) as the building blocks
-for VFs.
+for VFs/PNFs.
.. note::
For interim saving while creating a VSP, click |image2|
@@ -159,7 +159,11 @@
**Prerequisites:**
* `Create a License Model`_
-* Existing VNF HEAT package or VNF/PNF CSAR/Zip package
+* VNF HEAT package or VNF/PNF CSAR/Zip package is available.
+
+ See :ref:`sdc_onboarding_package_types` for a description
+ of the onboarding package types.
+* If the package is a secure package then :ref:`pre-install the corresponding Root Certificate in SDC <doc_guide_user_des_res-onb_pre-install_root_certificate>`.
#. From the SDC HOME page, click *ONBOARD*.
#. Hover over Add and select New Vendor Software Product.
@@ -183,6 +187,7 @@
as required.
#. In Software Product Attachments (right pane), click *Select file*.
#. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*.
+
In case of a VNF or PNF CSAR file: Locate the VNF or PNF csar/.zip package
and click *Open*.
#. SDC validates the files in the package. After successful validation, SDC
@@ -251,7 +256,7 @@
Update a VSP [optional]
-----------------------
-Upload a new Heat package to a VSP. Afterward, update the VF and service.
+Upload a new onboarding package to a VSP. Afterward, update the VF/PNF and service.
**Prerequisites:** Add one or more VSPs
(see `Create a Vendor Software Product`_).
@@ -273,17 +278,42 @@
.. note::
If the Heat template contains errors, contact the Certification Group for
guidance on how to proceed.
-
#. Click *Check In* to save changes.
#. Click *Submit* to add the VSP to the catalog.
A success message is displayed. If the VSP attachments contain errors, an
error message is displayed instead. Fix the issue(s) and re-submit.
#. After updating the VSP:
- #. Upload the VSP to the VF
- (see steps 3 to 5 in :ref:`doc_guide_user_des_vf-cre`).
- #. Update the VF version in services that include the VF (see step 4
+
+ #. Upload the VSP to the Vf/PNF
+ (see steps 3 to 5 in :ref:`doc_guide_user_des_vf-cre`).
+ #. Update the VF/PNF version in services that include the VF/PNF (see step 4
in :ref:`doc_guide_user_des_ser-des`).
+.. _doc_guide_user_des_res-onb_pre-install_root_certificate:
+
+Pre-Install Root Certificate in SDC [only needed for secure package]
+--------------------------------------------------------------------
+SDC supports the onboarding of packages that are secured according to security option 2 in ETSI NFV-SOL 004v2.6.1.
+
+During onboarding, SDC will validate the authenticity and integrity of a secure package. To enable this validation,
+the root certificate corresponding to the certificate included in the package needs to be available to SDC.
+This is currently done by uploading the root certificate to the following default directory location::
+
+ /dockerdata-nfs/{{ .Release.Name }}/sdc/onbaording/cert
+
+.. note::
+ The directory listed above is mapped to the following directory in the onboarding pod (sdc-onboarding-be)
+ ::
+
+ /var/lib/jetty/cert
+
+ so it is also possible to copy the root certificate directly to this directory in the pod.
+
+The location where the root certificate is uploaded is configurable. The relevant parameters are described in
+the *cert* block in the following values file::
+
+ <path_to_oom_kubernetes>/sdc/charts/sdc-onboarding-be/values.yaml
+
.. |image0| image:: media/sdro-resource-onboarding-workflow.png
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png
index dcc3104..123cd6a 100644
--- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png
index 5a5ad94..7528c8a 100644
--- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png
Binary files differ
diff --git a/docs/guides/onap-user/design/vfcreation/index.rst b/docs/guides/onap-user/design/vfcreation/index.rst
index 1ca46bc..e3e259c 100644
--- a/docs/guides/onap-user/design/vfcreation/index.rst
+++ b/docs/guides/onap-user/design/vfcreation/index.rst
@@ -4,10 +4,10 @@
.. _doc_guide_user_des_vf-cre:
-VF Creation and Testing
-=======================
-**Goal**: Using VSPs, create one or more VFs as the building blocks for a
-service. Validate and certify the VFs.
+VF/PNF Creation and Testing
+===========================
+**Goal**: Using VSPs, create one or more VFs/PNFs as the building blocks for a
+service. Validate and certify the VFs/PNFs.
**ONAP Component**: SDC
@@ -40,13 +40,13 @@
|image2|
-#. From the *Import VF* box, expand a VSP name and click the *Import VSP* icon.
+#. From the *Import VSP* box, expand a VSP name and click the *Import VSP* icon.
|image3|
#. In the General section, complete all fields.
- .. note:: Use the letters "VF" or "PNF" in the name to indicate that the
+ .. note:: Use the letters "VF" or "PNF" in the name to indicate the
component type.
#. Click *Create*.
@@ -66,7 +66,7 @@
#. [Optional] At any time before submitting the VF/PNF for testing, click
these options to update VF/PNF information:
- .. note:: These tasks can be done only before submitting the VF for testing.
+ .. note:: These tasks can be done only before submitting the VF/PNF for testing.
- **Icon** change the icon associated with the VF/PNF (vendor-supplied icons
are preferred)
@@ -145,11 +145,11 @@
Update a VF/PNF [optional]
--------------------------
-- Update the VSP and other artifacts in a VF.
-- Upload a new version the VSP to the VF whenever the VSP is updated (see steps
- 3 to 5). Other reasons for updating a VF include:
+- Update the VSP and other artifacts in a VF/PNF.
+- Upload a new version the VSP to the VF/PNF whenever the VSP is updated (see steps
+ 3 to 5). Other reasons for updating a VF/PNF include:
- - artifact changes at the VF level that need be uploaded, for example,
+ - artifact changes at the VF/PNF level that need be uploaded, for example,
changes to ENV values (see step 6)
**Prerequisites:**
@@ -159,13 +159,13 @@
**Steps**
-#. From the SDC HOME page, click *CATALOG* and search for a VF.
+#. From the SDC HOME page, click *CATALOG* and search for a VF/PNF.
#. In the General section, click *Check Out*.
The Select VSP field is displays.
#. In the Select VSP field, click *Browse*.
- The Import VF box displays and shows the VSP that was used to create the VF.
+ The Import VSP box displays and shows the VSP that was used to create the VF/PNF.
#. Expand the VSP field and click.
@@ -182,10 +182,10 @@
#. Click *Check In* to save changes.
-#. After updating the VF:
+#. After updating the VF/PNF:
- - Submit the VF for testing (see `Submit for testing`_).
- - Update the VF version in any service that contains the VF
+ - Submit the VF/PNF for testing (see `Submit for testing`_).
+ - Update the VF/PNF version in any service that contains the VF/PNF
(see step 4 in Update a service [optional]).
.. _doc_guide_user_des_vf-cre_sub-tst:
@@ -227,9 +227,9 @@
#. Sign in to SDC as a *Tester*.
#. From the HOME page, select *Ready For Testing* under Active Projects.
-#. In the right pane, click the VF.
+#. In the right pane, click the VF/PNF.
#. Click *Start Testing*.
-#. Test the VF.
+#. Test the VF/PNF.
#. When testing is complete, click *Accept*.
.. |image1| image:: media/design_vf_workflow.png
diff --git a/docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png b/docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png
index d3e8312..d57365f 100644
--- a/docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png
+++ b/docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png
Binary files differ
