summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-user/design/resource-onboarding
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/onap-user/design/resource-onboarding')
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/index.rst225
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.pngbin9770 -> 51410 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-edit-nic.pngbin43369 -> 23077 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.pngbin22319 -> 29394 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-feature-group.pngbin21118 -> 17913 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-license-agreement.pngbin47854 -> 17362 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.pngbin21986 -> 31652 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-license-model-submit.pngbin0 -> 11149 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-license-model.pngbin0 -> 37633 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm-dialog.pngbin0 -> 9041 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm-overview.pngbin0 -> 23782 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm.pngbin0 -> 14475 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-attachments.pngbin0 -> 30431 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-general.pngbin0 -> 25789 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-overview.pngbin0 -> 29668 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp.pngbin0 -> 18397 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-version-dialog.pngbin0 -> 8032 bytes
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-version.pngbin0 -> 22405 bytes
18 files changed, 147 insertions, 78 deletions
diff --git a/docs/guides/onap-user/design/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst
index a25983856..63f588d2c 100644
--- a/docs/guides/onap-user/design/resource-onboarding/index.rst
+++ b/docs/guides/onap-user/design/resource-onboarding/index.rst
@@ -43,16 +43,23 @@ Note: For interim saving while creating the license model and its components,
click |image2|
**Prerequisites:** To obtain license information, contact the service
- provider's Supply Chain Management (SCM) group.
+provider's Supply Chain Management (SCM) group.
-|image3|
#. From the SDC HOME page, click *ONBOARD*.
-#. Hover over Add and select New License Model.
+
+ |image11|
+
+#. In the Workspace select *CREATE NEW VLM*.
+
+ |image12|
+
#. Complete all fields.
-#. Click *Save*.
-#. In the ONBOARD header, hover over the arrow after License Agreements to
- reveal a menu.
+#. Click *Create*.
+#. In the Overview Dialog.
+
+ |image13|
+
Select the following options in order:
#. Create 0 or more license key groups (see
@@ -64,13 +71,17 @@ click |image2|
Note: Perform all steps above before submitting the license model to
the SDC catalog.
-#. In the header, click the license model created in steps 1 to 4.
-#. Click *Check In* to save changes.
-#. Click *Submit* to add the license model to the catalog. A success message
- displays.
+ |image14|
+
+#. Click *Submit* to add the license model to the catalog.
+After filling a comment, press *Commit&Submit*.
+
+ |image15|
+
#. After creating a license, complete `Create a Vendor Software Product`_ to
add the VSP required for the associated VF/PNF.
+
Create a License Key Group [Optional]
-------------------------------------
@@ -79,29 +90,28 @@ otherwise the license key group is optional.
**Prerequisites:** `Create a License Model`_
-|image4|
+#. Select the License Model in the Onboard section of the SDC.
+#. In the Overview click the + behind the *License Key Groups*.
+
+ |image4|
-1. From the drop-down menu, select License Key Groups.
-2. Click *Add License Key Group*.
- The Create New License Key Group box displays.
-3. Complete all fields.
- Note: Enter the manufacturer reference number in the Name field.
-4. Click *Save*.
+#. Complete all fields (mandatory fields are marked by a red asterisk).
+#. Click *Save*.
Create an Entitlement Pool
--------------------------
**Prerequisites:** If required by the resource model, create one or more
- license key groups (see
- `Create a License Key Group [Optional]`_).
+license key groups (see
+`Create a License Key Group [Optional]`_).
+
+#. Select the License Model in the Onboard section of the SDC.
+#. In the Overview click the + behind the *Entitlement Pools*.
-|image5|
+ |image5|
-1. From the drop-down menu, select Entitlement Pools.
-2. Click *Add Entitlement Pool*.
- The Create New Entitlement Pool box displays.
-3. Complete required fields (mandatory fields are marked by a red asterisk).
-4. Click *Save*.
+#. Complete required fields (mandatory fields are marked by a red asterisk).
+#. Click *Save*.
Create a Feature Group
----------------------
@@ -112,19 +122,19 @@ Create a Feature Group
(see `Create a License Key Group [optional]`_)
* entitlement pools (see `Create an Entitlement Pool`_)
-|image6|
+#. Select the License Model in the Onboard section of the SDC.
+#. In the Overview click the + behind the *Feature Groups*.
+
+ |image6|
-1. From the drop-down menu, select Feature Groups.
-2. Click *Add Feature Group*.
- The Create New Feature Group box displays.
-3. On the General tab, complete all fields.
-4. Click *Entitlement Pools*.
-5. Click *Available Entitlement Pools*.
-6. Select one or more entitlement pools and click the right arrow.
-7. Click *License Key Groups*.
-8. Click *Available License Key Groups*.
-9. Select one or more license key groups and click the right arrow.
-10. Click *Save*.
+#. On the General tab, complete all fields.
+#. Click *Entitlement Pools*.
+#. Click *Available Entitlement Pools*.
+#. Select one or more entitlement pools and click the right arrow.
+#. Click *License Key Groups*.
+#. Click *Available License Key Groups*.
+#. Select one or more license key groups and click the right arrow.
+#. Click *Save*.
Create a License Agreement
--------------------------
@@ -132,18 +142,17 @@ Create a License Agreement
**Prerequisites:** Create one or more feature groups
(see `Create a Feature Group`_).
-|image7|
+#. Select the License Model in the Onboard section of the SDC.
+#. In the Overview click the + behind the *License Agreements*.
+
+ |image7|
-1. From the drop-down menu, select License Agreements.
-2. Click *Add License Agreement*.
- The Create New License Agreement box displays.
-3. On the General tab, complete required fields (mandatory fields are marked
- by a red asterisk).
-4. Click *Feature Groups*.
-5. If not selected, click *Available Feature Groups*.
-6. Select one or more groups and click the right arrow.
-7. Click *Save*.
-8. Return to step 5 of `Create a License Model`_ to complete the license model.
+#. On the General tab, complete required fields.
+#. Click *Feature Groups*.
+#. If not selected, click *Available Feature Groups*.
+#. Select one or more groups and click the right arrow.
+#. Click *Save*.
+#. Return to step 6 of `Create a License Model`_ to complete the license model.
.. _doc_guide_user_des_res-onb_cre-vsp:
@@ -166,31 +175,44 @@ for VFs/PNFs.
* 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.
-#. The New Software Product box is displayed.
- Complete all fields.
-#. Click *Save*.
- The Overview section is displayed.
+
+ |image11|
+
+#. In the Workspace select *CREATE NEW VSP*.
+
+ |image21|
+
+#. Complete all fields.
+#. Click *Create*.
+ The Overview page is shown
+
+ |image22|
.. note::
A warning is displayed under License Agreement if the VSP does not have
an associated license.
-#. Click *Software Product Details* (left pane).
+#. Click *General* in the left section.
- |image8|
+#. For the defined Vendor, select a licensing version, a license agreement,
+ and one or more feature groups.
+
+ |image23|
-#. In order, select a licensing version, a license agreement, and one or more
- feature groups.
#. [Optional] Complete other fields, such as Availability (high-availability
zones) and Storage Data Replication (requirement for storage replication),
as required.
-#. In Software Product Attachments (right pane), click *Select file*.
+#. In the *Overview* section, select *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
+#. The file is loaded and the attachments page opens
+
+ |image24|
+
+#. Press the Button *Procees to Validation*. After successful validation, SDC
displays the files and a success message. If validation fails, SDC displays
the errors in the files.
@@ -198,8 +220,9 @@ for VFs/PNFs.
|image9|
-#. Click *Check In* to save the changes.
#. Click *Submit* to add the VSP to the catalog.
+
+ After filling a comment, press *Commit&Submit*.
#. A success message is displayed. If the VSP attachments contain errors, an
error message is displayed instead. Fix the issue(s) and re-submit.
#. To configure VFCs associated with the VSP, see
@@ -223,9 +246,18 @@ on the Components tab.
(see `Create a Vendor Software Product`_).
#. From the SDC HOME page, click *ONBOARD* and search for a VSP.
-#. In the Overview section, click *Check Out*.
-#. In Components (bottom pane), click a VFC (VSP component).
- The component links display in the left pane.
+#. Selecting the VSP opens the *Versions* page.
+
+ |image25|
+
+#. Press the + at *Create New Version* on the version to update
+
+ |image26|
+
+#. Fill the fields and press *Create*
+#. In Components , click a VFC (VSP component).
+
+ The component links display in the left pane.
#. Click *General* to view and edit general parameters such as hypervisor,
image format, VM recovery details, and DNS configuration.
#. Click *Compute* to view and edit VM parameters such as the number of VMs
@@ -244,12 +276,15 @@ on the Components tab.
#. Click *Storage* to configure storage information, such as backup type,
storage size, and logging.
#. Click *Process Details*, click *Add Component Process Details*, and complete
- the Create New Process Details dialog box. Use Process Details to identify
+ the *Create New Process Details* dialog box.
+
+ Use Process Details to identify
the processes and configuration associated with VFCs.
#. Click *Monitoring* to upload MIB or JSON files for SNMP traps and polling.
-#. Click *Overview* and click *Check In* to save changes.
-#. If updating a VSP, click *Submit*. If this procedure is performed during the
- workflow to create a VSP, there is no need to click *Submit* now.
+#. To update the VSP, click *Submit*
+
+ After filling a comment, press *Commit&Submit* and the
+ new version is certified.
.. _doc_guide_user_des_res-onb_upd-vsp:
@@ -262,7 +297,15 @@ Upload a new onboarding package to a VSP. Afterward, update the VF/PNF and servi
(see `Create a Vendor Software Product`_).
#. From the SDC HOME page, click *ONBOARD* and search for a VSP.
-#. In the Overview section, click *Check Out*.
+#. Selecting the VSP opens the *Versions* page.
+
+ |image25|
+
+#. Press the + at *Create New Version* on the version to update
+
+ |image26|
+
+#. Fill the fields and press *Create*
#. In Software Product Attachments (right pane), click *Select file*.
#. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*.
@@ -271,17 +314,21 @@ Upload a new onboarding package to a VSP. Afterward, update the VF/PNF and servi
SDC warns that uploading a new package erases existing data.
#. Click *Continue* to upload the new package.
- SDC validates the files in the package. After successful validation, SDC
- displays the files and a success message. If validation fails, SDC displays
- the errors in the files.
+#. The file is loaded and the attachments page opens
- .. 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.
+ |image24|
+
+#. Press the Button *Procees to Validation*. After successful validation, SDC
+ displays the files and a success message. If validation fails, SDC displays
+ the errors in the files.
+
+ Example Heat errors:
+
+ |image9|
+
+#. Click *Submit* to add the new VSP version to the catalog.
+ After filling a comment, press *Commit&Submit* and the
+ new version is certified.
#. After updating the VSP:
#. Upload the VSP to the Vf/PNF
@@ -336,3 +383,25 @@ the *cert* block in the following values file::
.. |image9| image:: media/sdro-design_onboardvsp_heaterrors.png
.. |image10| image:: media/sdro-edit-nic.png
+
+.. |image11| image:: media/sdro-new-vlm.png
+
+.. |image12| image:: media/sdro-new-vlm-dialog.png
+
+.. |image13| image:: media/sdro-new-vlm-overview.png
+
+.. |image14| image:: media/sdro-license-model.png
+
+.. |image15| image:: media/sdro-license-model-submit.png
+
+.. |image21| image:: media/sdro-new-vsp.png
+
+.. |image22| image:: media/sdro-new-vsp-overview.png
+
+.. |image23| image:: media/sdro-new-vsp-general.png
+
+.. |image24| image:: media/sdro-new-vsp-attachments.png
+
+.. |image25| image:: media/sdro-vsp-version.png
+
+.. |image26| image:: media/sdro-vsp-version-dialog.png \ No newline at end of file
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png
index 94a6743ed..9429683b0 100644
--- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-edit-nic.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-edit-nic.png
index 2db64c40b..28d361b45 100644
--- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-edit-nic.png
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-edit-nic.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png
index 20fee24c0..db56087f7 100644
--- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-feature-group.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-feature-group.png
index 9f4f1b408..fcc194d49 100644
--- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-feature-group.png
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-feature-group.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-agreement.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-agreement.png
index ef99406d9..a1cd74d5c 100644
--- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-agreement.png
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-agreement.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png
index c8f293401..ed1e7ac35 100644
--- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-model-submit.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-model-submit.png
new file mode 100644
index 000000000..382fca684
--- /dev/null
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-model-submit.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-model.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-model.png
new file mode 100644
index 000000000..cbc5a0e8a
--- /dev/null
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-model.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm-dialog.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm-dialog.png
new file mode 100644
index 000000000..91a1cf041
--- /dev/null
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm-dialog.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm-overview.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm-overview.png
new file mode 100644
index 000000000..09dba66b7
--- /dev/null
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm-overview.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm.png
new file mode 100644
index 000000000..141f7b2dd
--- /dev/null
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vlm.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-attachments.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-attachments.png
new file mode 100644
index 000000000..ae986acf8
--- /dev/null
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-attachments.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-general.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-general.png
new file mode 100644
index 000000000..11bc97862
--- /dev/null
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-general.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-overview.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-overview.png
new file mode 100644
index 000000000..03684e548
--- /dev/null
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp-overview.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp.png
new file mode 100644
index 000000000..04841577c
--- /dev/null
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-new-vsp.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-version-dialog.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-version-dialog.png
new file mode 100644
index 000000000..be2901016
--- /dev/null
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-version-dialog.png
Binary files differ
diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-version.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-version.png
new file mode 100644
index 000000000..e73ddf151
--- /dev/null
+++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-version.png
Binary files differ