X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-user%2Fdesign%2Fresource-onboarding%2Findex.rst;h=63f588d2c74f269738093eacef6fd2ebea2850db;hb=8b0b1469562434b8b70ae14cfd02e7e94bee36cb;hp=592651ee2e74f7f1face42d4815d8c0a92f65a4c;hpb=add9addd81082edb87c69432c7345addad61c055;p=doc.git diff --git a/docs/guides/onap-user/design/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst index 592651ee2..63f588d2c 100644 --- a/docs/guides/onap-user/design/resource-onboarding/index.rst +++ b/docs/guides/onap-user/design/resource-onboarding/index.rst @@ -6,7 +6,8 @@ Resource Onboarding =================== -**Goal:** Add models and other artifacts required to create, configure, instantiate, and manage a VF and, optionally, a VFC. +**Goal:** Add models and other artifacts required to create, configure, + instantiate, and manage a VF/PNF and, optionally, a VFC. **Tool:** SDC @@ -25,113 +26,141 @@ Resource Onboarding * `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| +.. _doc_guide_user_des_res-onb_cre-lic: + Create a License Model ---------------------- -VSPs optionally require a license and entitlements to enable the service provider to track the usage. +VSPs optionally require a license and entitlements to enable the service +provider to track the usage. -Note: For interim saving while creating the license model and its components, click |image2| +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. +**Prerequisites:** To obtain license information, contact the service +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 `Create a License Key Group [Optional]`_). + #. Create 0 or more license key groups (see + `Create a License Key Group [Optional]`_). #. Create 1 or more entitlement pools (see `Create an Entitlement Pool`_). #. Create 1 or more feature groups (see `Create a Feature Group`_). #. Create 1 or more license agreements (see `Create a License Agreement`_). - Note: Perform all steps above before submitting the license model to the SDC catalog. + Note: Perform all steps above before submitting the license model to + the SDC catalog. + + |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. -#. 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. -#. After creating a license, complete `Create a Vendor Software Product`_ to add the VSP required for the associated VF. Create a License Key Group [Optional] ------------------------------------- -If required by the resource model, create one or more license key groups; otherwise the license key group is optional. +If required by the resource model, create one or more license key groups; +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*. -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*. + |image4| + +#. 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]`_). +**Prerequisites:** If required by the resource model, create one or more +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 ---------------------- **Prerequisites:** Create one or more: -* license key groups if required by the resource model (see `Create a License Key Group [optional]`_) +* license key groups if required by the resource model + (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 -------------------------- -**Prerequisites:** Create one or more feature groups (see `Create a Feature Group`_). +**Prerequisites:** Create one or more feature groups + (see `Create a Feature Group`_). + +#. Select the License Model in the Onboard section of the SDC. +#. In the Overview click the + behind the *License Agreements*. + + |image7| -|image7| +#. 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. -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. +.. _doc_guide_user_des_res-onb_cre-vsp: Create a Vendor Software Product -------------------------------- -Create one or more Vendor Software Products (VSPs) as the building blocks for VFs. +Create one or more Vendor Software Products (VSPs) as the building blocks +for VFs/PNFs. .. note:: For interim saving while creating a VSP, click |image2| @@ -139,94 +168,198 @@ Create one or more Vendor Software Products (VSPs) as the building blocks for VF **Prerequisites:** * `Create a License Model`_ -* Generate manifest and package artifacts. +* 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 `. #. 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. + 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. -#. 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*. -#. Locate a Heat .zip package and click *Open*. - 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. + |image23| + +#. [Optional] Complete other fields, such as Availability (high-availability + zones) and Storage Data Replication (requirement for storage replication), + as required. +#. 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*. +#. 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. Example Heat errors: |image9| -#. Click *Check In* to save the 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. -#. To configure VFCs associated with the VSP, see `Update VFCs in a VSP [optional]`_, below. + + 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 + `Update VFCs in a VSP [optional]`_, below. +.. _doc_guide_user_des_res-onb_upd-vfc: + Update VFCs in a VSP [optional] ------------------------------- -If required, configure Virtual Function Components (VFCs) associated with a VSP, such as the Hypervisor, VM recovery details, and cloning. VFCs are listed on the Components tab. +If required, configure Virtual Function Components (VFCs) associated with a +VSP, such as the Hypervisor, VM recovery details, and cloning. VFCs are listed +on the Components tab. .. note:: - All fields are optional. Answers to questionnaires are stored as metadata only on the SDC platform. + All fields are optional. Answers to questionnaires are stored as metadata + only on the SDC platform. -**Prerequisites:** Add one or more VSPs (see `Create a Vendor Software Product`_). +**Prerequisites:** Add one or more VSPs + (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. -#. 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 required for a VFC instance and persistent storage/volume size. -#. Click *High Availability & Load Balancing* to answer questions related to VM availability and load balancing. -#. Click *Networks* to view or edit parameters related to network capacity and interfaces. +#. 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 + required for a VFC instance and persistent storage/volume size. +#. Click *High Availability & Load Balancing* to answer questions related + to VM availability and load balancing. +#. Click *Networks* to view or edit parameters related to network capacity + and interfaces. .. note:: - Click an interface to view or edit it. A dialog box displays similar to the figure below. + Click an interface to view or edit it. A dialog box displays similar + to the figure below. |image10| -#. 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 processes and configuration associated with VFCs. +#. 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 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: 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`_). +**Prerequisites:** Add one or more VSPs + (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*. -#. Locate a Heat .zip package and click *Open*. +#. 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 warns that uploading a new package erases existing data. -#. Click *Continue* to upload the new Heat 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. +#. Click *Continue* to upload the new package. +#. 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. + |image24| -#. 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. +#. 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 (see steps 3 to 5 in (TBD)Update a VF [optional]). - #. Update the VF version in services that include the VF (see step 4 in (TBD) Update a service [optional]). + + #. 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:: + + /sdc/charts/sdc-onboarding-be/values.yaml .. |image0| image:: media/sdro-resource-onboarding-workflow.png @@ -250,3 +383,25 @@ Upload a new Heat package to a VSP. Afterward, update the VF and service. .. |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