summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/guides/onap-developer/developing/index.rst6
-rw-r--r--docs/guides/onap-developer/use-cases/index.rst15
-rw-r--r--docs/guides/onap-developer/use-cases/vfw.rst74
-rw-r--r--docs/guides/onap-user/design/pre-onboarding/index.rst2
-rw-r--r--docs/guides/onap-user/design/resource-onboarding/index.rst45
-rw-r--r--docs/guides/onap-user/design/vfcreation/index.rst13
-rw-r--r--docs/use-cases/index.rst14
-rw-r--r--docs/use-cases/vfw.rst74
8 files changed, 36 insertions, 207 deletions
diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst
index f34e2576a..93e8daed1 100644
--- a/docs/guides/onap-developer/developing/index.rst
+++ b/docs/guides/onap-developer/developing/index.rst
@@ -85,7 +85,7 @@ AAI - Active and Available Inventory
- External System Registry GUI Documentation
* - (in Maintenance) `ESR Server (Latest) <https://docs.onap.org/projects/onap-aai-esr-server/en/latest/>`_
- External System Registry Server Documentation
- * - (in Maintenance) :ref:`Model<onap-aai-sparky-be:master_index>`
+ * - (in Maintenance) :ref:`AAI UI<onap-aai-sparky-be:master_index>`
- Sparky - AAI Inventory UI Documentation
>>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
@@ -370,7 +370,7 @@ SDNC - Software Defined Network Controller
* - Document
- Description
- * - :ref:`SDCN<onap-sdnc-oam:master_index>`
+ * - :ref:`SDNC<onap-sdnc-oam:master_index>`
- SDNC Architecture, APIs and Guides
SDNR - Software Defined Network Controller for Radio
@@ -382,7 +382,7 @@ SDNR - Software Defined Network Controller for Radio
* - Document
- Description
- * - :ref:`SDNR<onap-ccsdk-features:master_index>`
+ * - :ref:`SDN-R<onap-ccsdk-features:master_index>`
- SDN-R Documentation (part of CCSDK)
SO - Service Orchestration
diff --git a/docs/guides/onap-developer/use-cases/index.rst b/docs/guides/onap-developer/use-cases/index.rst
deleted file mode 100644
index d9dc0d202..000000000
--- a/docs/guides/onap-developer/use-cases/index.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
-
-Use Cases
-=========
-
-Example uses case descriptions and sequence diagrams illustrating
-interactions between platform components.
-
-.. toctree::
- :maxdepth: 1
-
- vfw.rst
- volte.rst
diff --git a/docs/guides/onap-developer/use-cases/vfw.rst b/docs/guides/onap-developer/use-cases/vfw.rst
deleted file mode 100644
index 2f83102a9..000000000
--- a/docs/guides/onap-developer/use-cases/vfw.rst
+++ /dev/null
@@ -1,74 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
-
-vFirewall Use Case
-==================
-
-Description
------------
-
-Onboarding
-----------
-
-
-.. uml::
-
- @startuml
- title vFW/vFWCL and vDNS VNF Onboarding (R1)\nVFW/vFWCL and vDNS use the same flows but they are separate VNFs/Services
- ONAP_User -> SDC : vFW_vDNS resource onboarding (HEAT)
- note right : vFWCL (vpg & vfw,vsn)\nvFW (vpg, vfw, vsn)\nvDNS (vpg, vlb,vdns) + DNSScaling (vdns)\
- ONAP_User -> SDC : vFW_vDNS service onboarding
- ONAP_User -> SDC : vFW_vDNS distribution
- |||
- SDC -> SO : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
- SDC -> AAI : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
- SDC -> SDNC : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
- @enduml
-
-Instantiation
--------------
-
-.. uml::
-
- @startuml
- title vFW vDNS Instantiation (R1)\nvFW and vDNS use the same flows but they are separate VNFs/Services
- participant ONAP_User
- participant Robot
- Participant SDC
- Participant VID
- Participant SO
- ONAP_User -> AAI : populate cloud inventory
- note left of AAI: manual via curl or POSTMAN
- |||
- ONAP_User -> VID : vFW_vDNS deployment
- VID -> SDC : Lookup VNF artifacts
- VID -> AAI : Lookup cloud locations, subscriber
- VID -> SO : vFW_vDNS Service \nInstantiation\n(base modules)
- SO -> AAI : inventory update
- VID -> SO : vFW_vDNS VNF Instantiation\n(base modules)
- note left of AAI : VFWCL is two VNFs in one service\nso VNF instantiate occurs twice
- SO -> AAI : inventory update
- ONAP_User -> SDNC : VNF API Preload VNF/VF data
- VID -> SO : vFW_vDNS VF Instantiation\n(base modules)
- SO -> AAI : inventory update
- SO -> SDNC : Generic VNF API\n(assign)
- SO -> Multi_VIM : vFW_vDNS Heat template, \nENV file, preload parameters
- Multi_VIM -> CloudAPI : vFW_vDNS Heat template,\nENV file, preload parameters or
- CloudAPI -> Hypervisor : vFW_vDNS Infrastructure instantiation
- Hypervisor -> vFW_vDNS : Nova/Neutron Instantiation
- Hypervisor -> CloudAPI : complete
- CloudAPI -> Multi_VIM : complete
- Multi_VIM -> SO : complete
- note right : SO may poll for completion
- SO -> SDNC: Generic VNF API\n(activated)
- note left : on failure from Openstack SO issues rollback to SDNC
- SDNC -> AAI : L3 Network resource update
- SO -> VID : complete
- note right : VID will poll for completion
- ONAP_User -> Robot : run Heat Bridge
- Robot -> CloudAPI : retrieve cloud data
- Robot -> AAI : Update with cloud data
- |||
- @enduml
-
diff --git a/docs/guides/onap-user/design/pre-onboarding/index.rst b/docs/guides/onap-user/design/pre-onboarding/index.rst
index 063ba3c4e..b712958aa 100644
--- a/docs/guides/onap-user/design/pre-onboarding/index.rst
+++ b/docs/guides/onap-user/design/pre-onboarding/index.rst
@@ -114,4 +114,4 @@ No VF functionality testing is performed at this stage.
.. _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
+.. _example-packages: https://git.onap.org/sdc/tree/integration-tests/src/test/resources/Files/VNFs
diff --git a/docs/guides/onap-user/design/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst
index 067d77a94..2c7020d7d 100644
--- a/docs/guides/onap-user/design/resource-onboarding/index.rst
+++ b/docs/guides/onap-user/design/resource-onboarding/index.rst
@@ -39,14 +39,14 @@ Create a License Model [Optional]
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.
-#. From the SDC HOME page, click *ONBOARD*.
+#. From the SDC HOME page, navigate to the ONBOARD Tab.
|image11|
@@ -56,7 +56,7 @@ provider's Supply Chain Management (SCM) group.
#. Complete all fields.
#. Click *Create*.
-#. In the Overview Dialog.
+#. After creation of the VLM, you should be presented with the “Overview” tab of the VLM.
|image13|
@@ -73,8 +73,7 @@ provider's Supply Chain Management (SCM) group.
|image14|
-#. Click *Submit* to add the license model to the catalog.
-After filling a comment, press *Commit&Submit*.
+#. Click *Submit* to add the license model to the catalog.After filling a comment, press *Commit&Submit*.
|image15|
@@ -91,7 +90,7 @@ otherwise the license key group is optional.
**Prerequisites:** `Create a License Model`_
#. Select the License Model in the Onboard section of the SDC.
-#. In the Overview click the + behind the *License Key Groups*.
+#. In the Overview click the + inside the License Key Groups OR Navigate to License Key Groups and click on “+ ADD LICENSE KEY GROUP”
|image4|
@@ -106,7 +105,7 @@ 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*.
+#. In the Overview click the + sign inside the Entitlement Pools OR Navigate to Entitlement Pools and click on “+ ADD ENTITLEMENT POOL”
|image5|
@@ -123,17 +122,17 @@ Create a Feature Group
* entitlement pools (see `Create an Entitlement Pool`_)
#. Select the License Model in the Onboard section of the SDC.
-#. In the Overview click the + behind the *Feature Groups*.
+#. In the Overview click the + sign inside the Feature Groups OR Navigate to Feature Groups and click on “+ ADD FEATURE GROUP”
|image6|
#. 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.
+#. Navigate to the *Entitlement Pools*. Tab
+ * In the Available Entitlement Pools, select one or more entitlement pools and click on the “>” sign.
+ * Selected pools should now be seen under the Selected Entitlements Pools.
+#. Navigate to the *License Key Groups*. Tab
+ * In the Available License Key Groups, select one or more license key groups and click on the “>” sign.
+ * Selected pools should now be seen under the Selected License Key Groups.
#. Click *Save*.
Create a License Agreement
@@ -143,14 +142,15 @@ Create a License Agreement
(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*.
+#. In the Overview click the + sign inside the License Agreements OR Navigate to License Agreements and click on “+ Add FEATURE GROUP”
|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.
+#. If not selected, click Available *Feature Groups*.
+ * Select one or more groups in the Available Feature Groups, select one or more feature groups and click on the “>” sign.
+ * Selected feature groups should now be seen under the Selected Feature Groups.
#. Click *Save*.
#. Return to step 6 of `Create a License Model`_ to complete the license model.
@@ -174,6 +174,9 @@ for VFs/PNFs.
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>`.
+.. note::
+ Example packages can be found in the SDC project: `example-packages`_
+
#. From the SDC HOME page, click *ONBOARD*.
|image11|
@@ -212,7 +215,7 @@ for VFs/PNFs.
|image24|
-#. Press the Button *Procees to Validation*. After successful validation, SDC
+#. Press the Button *Proceed to Validation*. After successful validation, SDC
displays the files and a success message. If validation fails, SDC displays
the errors in the files.
@@ -318,7 +321,7 @@ Upload a new onboarding package to a VSP. Afterward, update the VF/PNF and servi
|image24|
-#. Press the Button *Procees to Validation*. After successful validation, SDC
+#. Press the Button *Proceed to Validation*. After successful validation, SDC
displays the files and a success message. If validation fails, SDC displays
the errors in the files.
@@ -404,4 +407,4 @@ the *cert* block in the following values file::
.. |image25| image:: media/sdro-vsp-version.png
-.. |image26| image:: media/sdro-vsp-version-dialog.png \ No newline at end of file
+.. |image26| image:: media/sdro-vsp-version-dialog.png
diff --git a/docs/guides/onap-user/design/vfcreation/index.rst b/docs/guides/onap-user/design/vfcreation/index.rst
index 14928bbe7..0eacd40dd 100644
--- a/docs/guides/onap-user/design/vfcreation/index.rst
+++ b/docs/guides/onap-user/design/vfcreation/index.rst
@@ -35,7 +35,7 @@ Create a VF/PNF by VSP import
**Steps**
-#. From the SDC HOME page, click the *Import VSP*
+#. From the SDC HOME page, hover over *Import*, then click on *IMPORT VSP*
|image2|
@@ -94,7 +94,7 @@ Create a VF/PNF manually
**Steps**
-#. From the SDC HOME page, click the *ADD VF* or *ADD PNF*
+#. From the SDC HOME page, hover over *Add*, then click on *ADD VF* or *ADD PNF*.
|image2|
@@ -160,7 +160,7 @@ Update a VF/PNF [optional]
**Steps**
-#. From the SDC HOME page, click *CATALOG* and search for the VF/PNF.
+#. From the SDC HOME page, click *CATALOG* and search for the VF/PNF, click on selected VF/PNF to update.
#. In the General section, click *Check Out*.
The *VSP* field is displays.
@@ -173,7 +173,8 @@ Update a VF/PNF [optional]
|image4|
#. Click *Update VSP*
- A progress bar displays.|image5|
+ A progress bar displays.
+ |image5|
#. Click *Deployment Artifact* to edit, upload, or delete associated [Optional]
deployment artifacts.
@@ -206,7 +207,9 @@ Certify VF/PNF
**Steps**
#. When a VF/PNF is ready for certification,
- click *CATALOG* and search for the checked-in VF/PNF.
+ On the SDC HOME page, click *CATALOG* and search for the checked-in VF/PNF.
+ Bottom half of the VN/PNF will say “In Design Check In”.
+
#. Click the VF/PNF and click *Certify*.
|image7|
diff --git a/docs/use-cases/index.rst b/docs/use-cases/index.rst
deleted file mode 100644
index cc076b1c5..000000000
--- a/docs/use-cases/index.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
-
-ONAP Use Cases
-==============
-
-Example uses case descriptions and sequence diagrams illustrating
-interactions between platform components.
-
-.. toctree::
- :maxdepth: 1
-
- vfw.rst
diff --git a/docs/use-cases/vfw.rst b/docs/use-cases/vfw.rst
deleted file mode 100644
index beef17caa..000000000
--- a/docs/use-cases/vfw.rst
+++ /dev/null
@@ -1,74 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
-
-.. _vfirewall_usecase:
-
-vFirewall
-=========
-
-Description
------------
-
-Onboarding
-----------
-
-.. uml::
-
- @startuml
- title vFW/vFWCL and vDNS VNF Onboarding (R1)\nVFW/vFWCL and vDNS use the same flows but they are separate VNFs/Services
- ONAP_User -> SDC : vFW_vDNS resource onboarding (HEAT)
- note right : vFWCL (vpg & vfw,vsn)\nvFW (vpg, vfw, vsn)\nvDNS (vpg, vlb,vdns) + DNSScaling (vdns)\
- ONAP_User -> SDC : vFW_vDNS service onboarding
- ONAP_User -> SDC : vFW_vDNS distribution
- |||
- SDC -> SO : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
- SDC -> AAI : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
- SDC -> SDNC : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK
- @enduml
-
-Instantiation
--------------
-
-.. uml::
-
- @startuml
- title vFW vDNS Instantiation (R1)\nvFW and vDNS use the same flows but they are separate VNFs/Services
- participant ONAP_User
- participant Robot
- Participant SDC
- Participant VID
- Participant SO
- ONAP_User -> AAI : populate cloud inventory
- note left of AAI: manual via curl or POSTMAN
- |||
- ONAP_User -> VID : vFW_vDNS deployment
- VID -> SDC : Lookup VNF artifacts
- VID -> AAI : Lookup cloud locations, subscriber
- VID -> SO : vFW_vDNS Service \nInstantiation\n(base modules)
- SO -> AAI : inventory update
- VID -> SO : vFW_vDNS VNF Instantiation\n(base modules)
- note left of AAI : VFWCL is two VNFs in one service\nso VNF instantiate occurs twice
- SO -> AAI : inventory update
- ONAP_User -> SDNC : VNF API Preload VNF/VF data
- VID -> SO : vFW_vDNS VF Instantiation\n(base modules)
- SO -> AAI : inventory update
- SO -> SDNC : Generic VNF API\n(assign)
- SO -> Multi_VIM : vFW_vDNS Heat template, \nENV file, preload parameters
- Multi_VIM -> CloudAPI : vFW_vDNS Heat template,\nENV file, preload parameters or
- CloudAPI -> Hypervisor : vFW_vDNS Infrastructure instantiation
- Hypervisor -> vFW_vDNS : Nova/Neutron Instantiation
- Hypervisor -> CloudAPI : complete
- CloudAPI -> Multi_VIM : complete
- Multi_VIM -> SO : complete
- note right : SO may poll for completion
- SO -> SDNC: Generic VNF API\n(activated)
- note left : on failure from Openstack SO issues rollback to SDNC
- SDNC -> AAI : L3 Network resource update
- SO -> VID : complete
- note right : VID will poll for completion
- ONAP_User -> Robot : run Heat Bridge
- Robot -> CloudAPI : retrieve cloud data
- Robot -> AAI : Update with cloud data
- |||
- @enduml