diff options
Diffstat (limited to 'docs')
52 files changed, 260 insertions, 3 deletions
diff --git a/docs/guides/onap-user/resource-onboarding/index.rst b/docs/guides/onap-user/resource-onboarding/index.rst new file mode 100644 index 000000000..4a3cbc1e3 --- /dev/null +++ b/docs/guides/onap-user/resource-onboarding/index.rst @@ -0,0 +1,250 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2019 ONAP Contributors. All rights reserved. + +Resource Onboarding +=================== +**Goal:** Add models and other artifacts required to create, configure, instantiate, and manage a VF and, optionally, a VFC. + +**Tool:** SDC + +**SDC user role:** Designer + +|image0| + +**Steps** + * `Create a License Model`_ + * `Create a License Key Group [Optional]`_ + * `Create an Entitlement Pool`_ + * `Create a Feature Group`_ + * `Create a License Agreement`_ + * `Create a Vendor Software Product`_ + * `Update VFCs in a VSP [optional]`_ + * `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 + +|image1| + +Create a License Model +---------------------- + +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| + +**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. +#. Complete all fields. +#. Click *Save*. +#. In the ONBOARD header, hover over the arrow after License Agreements to reveal a menu. + Select the following options in order: + + #. 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. + +#. 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. + +**Prerequisites:** `Create a License Model`_ + +|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*. + +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]`_). + +|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*. + +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]`_) +* entitlement pools (see `Create an Entitlement Pool`_) + +|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*. + +Create a License Agreement +-------------------------- + +**Prerequisites:** Create one or more feature groups (see `Create a Feature Group`_). + +|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. + +Create a Vendor Software Product +-------------------------------- + +Create one or more Vendor Software Products (VSPs) as the building blocks for VFs. + +.. note:: + For interim saving while creating a VSP, click |image2| + +**Prerequisites:** + +* `Create a License Model`_ +* Generate manifest and package artifacts. + +#. 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. + + .. note:: + A warning is displayed under License Agreement if the VSP does not have an associated license. + +#. Click *Software Product Details* (left pane). + + |image8| + +#. 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. + + 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. + + +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. + +.. note:: + 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`_). + +#. 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. + + .. note:: + 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 *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. + +Update a VSP [optional] +----------------------- + +Upload a new Heat package to a VSP. Afterward, update the VF and service. + +**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 Software Product Attachments (right pane), click *Select file*. +#. Locate a Heat .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. + + .. 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 (TBD)Update a VF [optional]). + #. Update the VF version in services that include the VF (see step 4 in (TBD) Update a service [optional]). + + +.. |image0| image:: media/sdro-resource-onboarding-workflow.png + +.. |image1| image:: media/sdro-vsp-service-workflow.png + +.. |image2| image:: media/sdro-sdc_vsp_save.png + +.. |image3| image:: media/sdro-license-creation.png + +.. |image4| image:: media/sdro-license-keygroup.png + +.. |image5| image:: media/sdro-entitlement-pool.png + +.. |image6| image:: media/sdro-feature-group.png + +.. |image7| image:: media/sdro-license-agreement.png + +.. |image8| image:: media/sdro-software-product.png + +.. |image9| image:: media/sdro-design_onboardvsp_heaterrors.png + +.. |image10| image:: media/sdro-edit-nic.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png b/docs/guides/onap-user/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png Binary files differnew file mode 100644 index 000000000..27c8986e5 --- /dev/null +++ b/docs/guides/onap-user/resource-onboarding/media/sdro-design_asdccanvas_connect_elements.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png b/docs/guides/onap-user/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png Binary files differnew file mode 100644 index 000000000..94a6743ed --- /dev/null +++ b/docs/guides/onap-user/resource-onboarding/media/sdro-design_onboardvsp_heaterrors.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-edit-nic.png b/docs/guides/onap-user/resource-onboarding/media/sdro-edit-nic.png Binary files differnew file mode 100644 index 000000000..2db64c40b --- /dev/null +++ b/docs/guides/onap-user/resource-onboarding/media/sdro-edit-nic.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-entitlement-pool.png b/docs/guides/onap-user/resource-onboarding/media/sdro-entitlement-pool.png Binary files differnew file mode 100644 index 000000000..20fee24c0 --- /dev/null +++ b/docs/guides/onap-user/resource-onboarding/media/sdro-entitlement-pool.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-feature-group.png b/docs/guides/onap-user/resource-onboarding/media/sdro-feature-group.png Binary files differnew file mode 100644 index 000000000..9f4f1b408 --- /dev/null +++ b/docs/guides/onap-user/resource-onboarding/media/sdro-feature-group.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-license-agreement.png b/docs/guides/onap-user/resource-onboarding/media/sdro-license-agreement.png Binary files differnew file mode 100644 index 000000000..ef99406d9 --- /dev/null +++ b/docs/guides/onap-user/resource-onboarding/media/sdro-license-agreement.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-license-creation.png b/docs/guides/onap-user/resource-onboarding/media/sdro-license-creation.png Binary files differnew file mode 100644 index 000000000..a358d03a4 --- /dev/null +++ b/docs/guides/onap-user/resource-onboarding/media/sdro-license-creation.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-license-keygroup.png b/docs/guides/onap-user/resource-onboarding/media/sdro-license-keygroup.png Binary files differnew file mode 100644 index 000000000..c8f293401 --- /dev/null +++ b/docs/guides/onap-user/resource-onboarding/media/sdro-license-keygroup.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-resource-onboarding-workflow.png b/docs/guides/onap-user/resource-onboarding/media/sdro-resource-onboarding-workflow.png Binary files differnew file mode 100644 index 000000000..dcc3104e4 --- /dev/null +++ b/docs/guides/onap-user/resource-onboarding/media/sdro-resource-onboarding-workflow.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-sdc_vsp_save.png b/docs/guides/onap-user/resource-onboarding/media/sdro-sdc_vsp_save.png Binary files differnew file mode 100644 index 000000000..81f1df634 --- /dev/null +++ b/docs/guides/onap-user/resource-onboarding/media/sdro-sdc_vsp_save.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-software-product.png b/docs/guides/onap-user/resource-onboarding/media/sdro-software-product.png Binary files differnew file mode 100644 index 000000000..457baa8cf --- /dev/null +++ b/docs/guides/onap-user/resource-onboarding/media/sdro-software-product.png diff --git a/docs/guides/onap-user/resource-onboarding/media/sdro-vsp-service-workflow.png b/docs/guides/onap-user/resource-onboarding/media/sdro-vsp-service-workflow.png Binary files differnew file mode 100644 index 000000000..5a5ad9496 --- /dev/null +++ b/docs/guides/onap-user/resource-onboarding/media/sdro-vsp-service-workflow.png diff --git a/docs/guides/onap-user/servicedesigner.rst b/docs/guides/onap-user/servicedesigner.rst index 823fccdc1..560cbf490 100644 --- a/docs/guides/onap-user/servicedesigner.rst +++ b/docs/guides/onap-user/servicedesigner.rst @@ -2,6 +2,8 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. _user-guides-service-design: + Service Design ============== The goal of the service design process is to create all artifacts @@ -22,7 +24,11 @@ Design includes the following topics: * `Pre-Onboarding <https://wiki.onap.org/x/Y4AP>`_ -* `Resource Onboarding <https://wiki.onap.org/x/YIAP>`_ +.. toctree:: + :maxdepth: 1 + :titlesonly: + + Resourse-Onboarding <./resource-onboarding/index.rst> * `VF Creation and Testing <https://wiki.onap.org/x/PoAP>`_ diff --git a/docs/release/repolist.rst b/docs/release/repolist.rst index 9871c8ffc..c7e4cd892 100644 --- a/docs/release/repolist.rst +++ b/docs/release/repolist.rst @@ -91,3 +91,4 @@ Project/Components cds <../submodules/ccsdk/cds.git/docs/index> oom/offline-installer <../submodules/oom/offline-installer.git/docs/index> ccsdk/features <../submodules/ccsdk/features.git/docs/index> + parent <../submodules/parent.git/docs/index> diff --git a/docs/submodules/aaf/authz.git b/docs/submodules/aaf/authz.git -Subproject 5c01796be69ed71c360dade8a080a4fd22c0644 +Subproject 096803ce0a8f4a57cc2f78f7d969cab18cb7a93 diff --git a/docs/submodules/appc.git b/docs/submodules/appc.git -Subproject 2df69f9fc6a46476c8600c31ef1905e9ed8035f +Subproject 38a4d515a8414e83a3724bccbb5ab83cd50d7df diff --git a/docs/submodules/ccsdk/cds.git b/docs/submodules/ccsdk/cds.git -Subproject fd1b737ed86163f20edaf606e28357025cc63e2 +Subproject 6ab49d0f6bedcbc2ccd817df113265d32f42141 diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git -Subproject 6c64ce6d8be0d03ddc9d940cc5caeb7000b1f39 +Subproject c6e85bc88f2dd3427360523270c7ed92c12abdc diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git -Subproject f8e82299060058a9f101a520dfa87c6357522f9 +Subproject 338c218458d6a671dd754ee5c151517685376bd diff --git a/docs/submodules/cli.git b/docs/submodules/cli.git -Subproject 34605c95ea7a9af4c4b86a4b5dee81a40d60686 +Subproject 26fc3d01a9be64e10cbeb814559fd98fefbd7ba diff --git a/docs/submodules/dcaegen2.git b/docs/submodules/dcaegen2.git -Subproject 09dab76658142089c222c7ce200cfbbf378080a +Subproject 701110ba1719151a20393ced327e4e935d991ad diff --git a/docs/submodules/dmaap/buscontroller.git b/docs/submodules/dmaap/buscontroller.git -Subproject a433b642cff989aabc4c3f918daaa90377a9245 +Subproject 0494603a4624d391af8b5a3918555ea7e47ffa1 diff --git a/docs/submodules/dmaap/datarouter.git b/docs/submodules/dmaap/datarouter.git -Subproject 1c11ab87dd4954903734c8a95a17a56aefea475 +Subproject bceb18df30982e2ace538baf5c49336fe0e45b0 diff --git a/docs/submodules/externalapi/nbi.git b/docs/submodules/externalapi/nbi.git -Subproject ff5433e350678f5f45e8b2aa14cdb00f9cecfce +Subproject 0095af54a51619546e6ab9783adff625b696f4e diff --git a/docs/submodules/holmes/engine-management.git b/docs/submodules/holmes/engine-management.git -Subproject 7e8d80c1c033b636c5816fd5e67c661d7ef0a2b +Subproject 691870a10f5401c9561fbe1494294d519188941 diff --git a/docs/submodules/holmes/rule-management.git b/docs/submodules/holmes/rule-management.git -Subproject d296bb5ab9332c53572af7f479f3501fa964d84 +Subproject e50f6e8abddad4e2ad7fa83f32ab55af184d951 diff --git a/docs/submodules/integration.git b/docs/submodules/integration.git -Subproject 4ed92c896fe8457ca511b72b334bac6ca000bc2 +Subproject 6eaaedc4d320b4e032beb958123ee00f5cf9a7a diff --git a/docs/submodules/modeling/modelspec.git b/docs/submodules/modeling/modelspec.git -Subproject 4c4d74aefb57554a8353e47a039f8351d13af32 +Subproject 4c9735f80c983573c08c708307e1d03c84140d6 diff --git a/docs/submodules/multicloud/azure.git b/docs/submodules/multicloud/azure.git -Subproject 658602b4808bd093b75adb6a151982a7b44c7f0 +Subproject 2fbd078605c199e49118037747325e833318ef5 diff --git a/docs/submodules/multicloud/framework.git b/docs/submodules/multicloud/framework.git -Subproject e8697face7909927a9ddb418f116c76e3c6d8c8 +Subproject 388ef1f2943d5fb581cd6533e1fc225a0309df7 diff --git a/docs/submodules/multicloud/k8s.git b/docs/submodules/multicloud/k8s.git -Subproject bf49d552b003072c6bc64ae838a4699c1f4028b +Subproject 63933b0cf304cfdd49fc73278d9c64dcb48f90e diff --git a/docs/submodules/oom.git b/docs/submodules/oom.git -Subproject 06c335c76f158f02f9a655877e2fc00bf3e45c9 +Subproject 906595fd0986f3be0733116edb312a5d7aa4547 diff --git a/docs/submodules/oom/offline-installer.git b/docs/submodules/oom/offline-installer.git -Subproject 45fa0030abb4c013722f68c1ef23d53ba1d1620 +Subproject cb94aefb4ef22fdf435578e676823a6b9600cbb diff --git a/docs/submodules/optf/cmso.git b/docs/submodules/optf/cmso.git -Subproject 58871ba77f801f4794fed5573feefc3004cc55e +Subproject d4014abb85d839c14c9a2572098571e7a852310 diff --git a/docs/submodules/optf/has.git b/docs/submodules/optf/has.git -Subproject 2ee99cbaf0c827ecb02b9c11061750aa675044c +Subproject d6be402c0765aee388bc5dc64882696a0a23be2 diff --git a/docs/submodules/optf/osdf.git b/docs/submodules/optf/osdf.git -Subproject e1f6d80752920a7ef990134f02abb3db9b5a623 +Subproject 0a358ab8f3f546f11c36f913018edef63ff17ed diff --git a/docs/submodules/policy/apex-pdp.git b/docs/submodules/policy/apex-pdp.git -Subproject e5f139e3c865eb429dc11a987ad7a01b759c669 +Subproject f6da9a3bafb6f4c30e7bb3accd4e17fdaaf5ce9 diff --git a/docs/submodules/policy/distribution.git b/docs/submodules/policy/distribution.git -Subproject e0936d1bf5b7241eb1543c762b86bf72951870b +Subproject 39bac7ed034c56eeb2b19a1b274fab35dbc9818 diff --git a/docs/submodules/policy/engine.git b/docs/submodules/policy/engine.git -Subproject 070d3f11f482486d89f426a141652b281e06764 +Subproject b38e59b1f797b15d0a3e1170e43a0db92216bbd diff --git a/docs/submodules/policy/parent.git b/docs/submodules/policy/parent.git new file mode 160000 +Subproject 541f83b8b97f1d3c33401e1cbe9436aa31d7fa7 diff --git a/docs/submodules/portal.git b/docs/submodules/portal.git -Subproject 9c152c3c93793fb15e7ba9a311de4f3974f712f +Subproject b04f71de6f585687eb81333ab1fd909df0d8b71 diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git -Subproject 8fa77ad4d4c2498e40a4c23e6826d9ad73a1dab +Subproject 50552ece388dc60d15ed743f06afc477635f721 diff --git a/docs/submodules/sdnc/oam.git b/docs/submodules/sdnc/oam.git -Subproject 15c6cfe1990346af373968693fd7c568003bea1 +Subproject 570153b334e64246b2eff459d18d6eac6df70e2 diff --git a/docs/submodules/so.git b/docs/submodules/so.git -Subproject 074c0ebe9c1a0db0a5e0cc936898c35569ff402 +Subproject 71e617b9e2fcd24c05579bf41e65db4273f05e7 diff --git a/docs/submodules/so/libs.git b/docs/submodules/so/libs.git -Subproject f31f8ce722efcb2465d290cc3755c258ef2857a +Subproject 25990a8c079094f906414c4583ec7b0dd81b4d3 diff --git a/docs/submodules/usecase-ui.git b/docs/submodules/usecase-ui.git -Subproject 1482020a3dbb4bef55eb0c4c80d6ae0694075de +Subproject 8aff6d8cbc022cbe4db09cabe096f463aa98b00 diff --git a/docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git b/docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git -Subproject f424e7777ea76929ed5d8d28ac67d872bf9a08e +Subproject 1b4498ef13c935ff94e7d4520bd3dbd0fe71ee8 diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git -Subproject 81f56408de3b059b8345d3d1aeef084eaa5e8f4 +Subproject 22631f12c6029a38be6cb3acdc21e6f8f6400f6 diff --git a/docs/submodules/vid.git b/docs/submodules/vid.git -Subproject e6571c6df02776c335b156b0fb44e31d723ffa0 +Subproject f3b31fe846630953923844ed3ab7defea9ac444 diff --git a/docs/submodules/vnfrqts/requirements.git b/docs/submodules/vnfrqts/requirements.git -Subproject 4613a4a72d55172655d33a61b42e322988ce376 +Subproject 3422870a179cdeed4df9631faa08357d28da5c7 diff --git a/docs/validwords.txt b/docs/validwords.txt index ea1daa962..c860d4aa0 100644 --- a/docs/validwords.txt +++ b/docs/validwords.txt @@ -126,7 +126,7 @@ javascript Javascript jboss JBoss -Jenkin +Jenkins Jira jpath json @@ -297,7 +297,7 @@ SDN sdnc Sdnc SDNC -Seleniunm +Selenium servlet Servlet Skynet |
