Modified end to end user guide for onap-dublin CLI

Issue-ID: CLI-163 Signed-off-by: Itohan Ukponmwan <itohan.ukponmwan@intel.com> Change-Id: Ic403aba6959336731af34a42b1a0200ba619418b
author: Itohan Ukponmwan <itohan.ukponmwan@intel.com> 2019-05-31 18:58:04 +0000
committer: Itohan Ukponmwan <itohan.ukponmwan@intel.com> 2019-05-31 19:08:43 +0000
commit: 6829fe21ee084daeb41040c90937409841779eda (patch)
tree: 85f4e46d45521dc67e45defad9bf135ae2afa24f /docs
parent: 4a8c1b6d692207917ee61cd14eba3f9f522a9bd5 (diff)
1 files changed, 174 insertions, 248 deletions
diff --git a/docs/user_guide_end_to_end_onap_cli_commands.rst b/docs/user_guide_end_to_end_onap_cli_commands.rst
index 287f6f66..9b595092 100644
--- a/docs/user_guide_end_to_end_onap_cli_commands.rst
+++ b/docs/user_guide_end_to_end_onap_cli_commands.rst
@@ -24,15 +24,27 @@ CLI communicate with:
     - Create Vendor Software Product (VSP), VF and Service
     - Distribute service
 
+- Policy to
+    - Put HPA policies
+
 - AAI to create
+    - Complex
     - Cloud
     - Customer
     - Service-type
+	- Add customer subscription
+
+- Multicloud to
+    - register cloud with multicloud to discover HPA
 
 - SO to create
     - Service-instance
-    - VF
-    - VF module (deploy)
+    - VNF Instance
+    - VF module (deploys stack)
+
+- SDNC to
+    - Preload VF module parameters
+
 
 
 Creating Vendor License Model (VLM)
@@ -52,13 +64,9 @@ Run following command to create license.
 
 ::
 
-  onap>vlm-create -x htipl-vendor -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap>vlm-create -x ${vendor-name} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
 
-  +----------+----------------------------------+
-  |property  |value                             |
-  +----------+----------------------------------+
-  |ID        |d6da25894a1a470fa8357c15681b7a66  |
-  +----------+----------------------------------+
+**Output**: vlm-id, vlm-version
 
 Create license entitlement pool
 -------------------------------
@@ -67,13 +75,9 @@ Run following command to create license entitlement pool.
 
 ::
 
-  onap>vlm-entitlement-pool-create -x htipl-pool -y d6da25894a1a470fa8357c15681b7a66 -e 0.1 -z htipl-pool -k htipl-vendor -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap>vlm-entitlement-pool-create -x ${entitlement-pool-name} -y ${vlm-id} -e ${vlm-version} -z ${entitlement-pool-description} -k ${vendor-name} -g {license-expiry-date} -l {license-start-date} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
 
-  +----------+----------------------------------+
-  |property  |value                             |
-  +----------+----------------------------------+
-  |ID        |44743b88b7254d3aa8829d5fcb5a4b47  |
-  +----------+----------------------------------+
+**Output**: vlm-entitlement-pool-id
 
 Create license key group
 ------------------------
@@ -82,14 +86,9 @@ Run following command to crate license key group.
 
 ::
 
-  onap>vlm-key-group-create -c d6da25894a1a470fa8357c15681b7a66 -e 0.1 -x htipl-key-grp -y Universal -u cs0008 -p demo123456! -m http://192.168.17.5:8080
-
-  +----------+----------------------------------+
-  |property  |value                             |
-  +----------+----------------------------------+
-  |ID        |c8f9ba23d0414650907099ecbf960f3d  |
-  +----------+----------------------------------+
+  onap>vlm-key-group-create -c ${vlm-id} -e ${vlm-version} -x {key-group-name} -y {key-group-type} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
 
+**Output**: key-group-id
 
 Create license feature group
 ----------------------------
@@ -98,13 +97,9 @@ Run following command to create license feature group.
 
 ::
 
-  onap>vlm-feature-group-create -x htipl-feature-grp -y d6da25894a1a470fa8357c15681b7a66 -e 0.1 -z htipl-feature-grp -g c8f9ba23d0414650907099ecbf960f3d -b 44743b88b7254d3aa8829d5fcb5a4b47 -c htipl-part -k htipl-vendor -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap>vlm-feature-group-create -x ${feature-group-name} -y ${vlm-id} -e {vlm-version} -z {feature-grp-description} -g ${key-group-id} -b ${vlm-entitlement-pool-id} -c ${part-no} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
 
-  +----------+----------------------------------+
-  |property  |value                             |
-  +----------+----------------------------------+
-  |ID        |0ef91147b9904568942d4d3f5a8bbc96  |
-  +----------+----------------------------------+
+**Output**: feature-group-id
 
 
 Create license agreement
@@ -114,14 +109,9 @@ Run following command to create license agreement.
 
 ::
 
-  onap>vlm-aggreement-create -x htipl-aggrement -y d6da25894a1a470fa8357c15681b7a66 -e 0.1 -z htipl-aggrement -g 0ef91147b9904568942d4d3f5a8bbc96 -u cs0008 -p demo123456\! -m http://192.168.17.5:8080
-  vlm-aggreement-create -x htipl-aggrement -y d6da25894a1a470fa8357c15681b7a66 -e 0.1 -z htipl-aggrement -g 0ef91147b9904568942d4d3f5a8bbc96 -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap>vlm-aggreement-create -x ${aggreement-name} -y ${vlm-id} -e ${vlm-version} -z ${agreement-description} -g ${feature-group-id} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
 
-  +----------+----------------------------------+
-  |property  |value                             |
-  +----------+----------------------------------+
-  |ID        |1909ee429dcd459aa0eb33e812981973  |
-  +----------+----------------------------------+
+**Output**: agreement-id
 
 
 Now, VLM is ready to submit.
@@ -133,9 +123,8 @@ Run following command to check-in and submit created VLM.
 
 ::
 
-  vlm-checkin -x d6da25894a1a470fa8357c15681b7a66 -y 0.1 -u cs0008 -p demo123456! -m http://192.168.17.5:8080
 
-  vlm-submit -x d6da25894a1a470fa8357c15681b7a66 -y 0.1 -u cs0008 -p demo123456\! -m http://192.168.17.5:8080
+  vlm-submit -x ${vlm-id} -y ${vlm-version} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
 
 
 Now, VLM is available in catalog to be used for VSP.
@@ -156,13 +145,10 @@ Run following command to create VSP.
 
 ::
 
-  onap>vsp-create -x htipl-vsp -c 0.1 -g d6da25894a1a470fa8357c15681b7a66 -e htipl-vendor  -i 1909ee429dcd459aa0eb33e812981973  -j 0ef91147b9904568942d4d3f5a8bbc96 -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap>vsp-create -j ${feature-group-id} -o ${onboarding-method} -e ${vendor-name} -x ${vsp-name} -y ${vsp-description} -i ${aggreement-id} -c ${vlm-version} -g ${vlm-id} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
 
-  +----------+----------------------------------+
-  |property  |value                             |
-  +----------+----------------------------------+
-  |ID        |044e3269503d4579b4bdd60d0231e4e6  |
-  +----------+----------------------------------+
+
+**Output**: vsp-id, vsp-version
 
 
 Add artifact to VSP
@@ -172,7 +158,7 @@ This command will associate artifacts to VSP.
 
 ::
 
-  onap>vsp-add-artifact -x 044e3269503d4579b4bdd60d0231e4e6 -y 0.1 -z vFW_100_20170608.zip -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap>vsp-add-artifact -x ${vsp-id} -y ${vsp-version}  -z ${csar-file} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
 
 Validate VSP
 ------------
@@ -181,49 +167,13 @@ After uploading artifacts to VSP you need to validate the VSP using following co
 
 ::
 
-  onap>vsp-validate -x 044e3269503d4579b4bdd60d0231e4e6 -y 0.1 -u cs0008 -p demo123456! -m http://192.168.17.5:8080
-
-  +----------+----------------------------------------------------+
-  |property  |value                                               |
-  +----------+----------------------------------------------------+
-  |status    |Success                                             |
-  +----------+----------------------------------------------------+
-  |errors    |{base_vfw.yaml=[{"level":"WARNING","message":"WARN  |
-  |          |ING: A resource is connected twice to the same      |
-  |          |network role, Network Role [vpg_0], Resource ID [e  |
-  |          |comp_private]"},{"level":"WARNING","message":"WARN  |
-  |          |ING: Nova Server naming convention in image,        |
-  |          |flavor and name properties is not consistent,       |
-  |          |Resource ID                                         |
-  |          |[vpg_0]"},{"level":"WARNING","message":"WARNING:    |
-  |          |A resource is connected twice to the same network   |
-  |          |role, Network Role [vsn_0], Resource ID [ecomp_pri  |
-  |          |vate]"},{"level":"WARNING","message":"WARNING:      |
-  |          |Nova Server naming convention in image, flavor      |
-  |          |and name properties is not consistent, Resource     |
-  |          |ID                                                  |
-  |          |[vsn_0]"},{"level":"WARNING","message":"WARNING:    |
-  |          |Port 'Fixed_IPS' Parameter Name not aligned with    |
-  |          |Guidelines, Parameter Name                          |
-  |          |[ecomp_private_subnet_id], Resource ID              |
-  |          |[vfw_private_2_port]. As a result, VF\/VFC          |
-  |          |Profile may miss this information"},{"level":"WARN  |
-  |          |ING","message":"WARNING: Port 'Fixed_IPS'           |
-  |          |Parameter Name not aligned with Guidelines,         |
-  |          |Parameter Name [ecomp_private_subnet_id],           |
-  |          |Resource ID [vpg_private_1_port]. As a result,      |
-  |          |VF\/VFC Profile may miss this information"},{"leve  |
-  |          |l":"WARNING","message":"WARNING: Port 'Fixed_IPS'   |
-  |          |Parameter Name not aligned with Guidelines,         |
-  |          |Parameter Name [ecomp_private_subnet_id],           |
-  |          |Resource ID [vsn_private_1_port]. As a result,      |
-  |          |VF\/VFC Profile may miss this information"}]}       |
-  +----------+----------------------------------------------------+
-
-
-NOTE: here `warning` is reported for VSP validation which we are ignoring.
-
-Submit and checkin VSP
+  onap>vsp-validate -x ${vsp-id} -y ${vsp-version} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
+
+
+
+NOTE: In most cases `warning` is reported for VSP validation, this can be ignored.
+
+Submit VSP
 ----------------------
 
 After VSP validation it can be checked in and submit. Run following command to
@@ -231,17 +181,14 @@ complete check-in and VSP submission.
 
 ::
 
-  onap>vsp-checkin -x 044e3269503d4579b4bdd60d0231e4e6 -y 0.1 -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap>vsp-submit -x ${vsp-id} -y ${vsp-version} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
+
+To list created VSPs, run the following command;
 
-  onap>vsp-submit -x 044e3269503d4579b4bdd60d0231e4e6 -y 0.1 -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+::
 
-  onap>vsp-list -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap>vsp-list -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
 
-  +----------------------------------+------------+----------+--------+
-  |ID                                |name        |version   |status  |
-  +----------------------------------+------------+----------+--------+
-  |044e3269503d4579b4bdd60d0231e4e6  |htipl-vsp   |1.0       |Final   |
-  +----------------------------------+------------+----------+--------+
 
 package VSP
 -----------
@@ -251,7 +198,7 @@ following command.
 
 ::
 
-  onap>vsp-package -x 044e3269503d4579b4bdd60d0231e4e6 -y 1.0 -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap>vsp-package -x ${vsp-id} -y ${vsp-version} -u cs0008 -p demo123456! -m ${sdc-onboarding-url}
 
 Now, you can proceed for defining VF.
 
@@ -262,24 +209,19 @@ Run following command to create VF by specifying correct VSP id.
 
 ::
 
-  onap>vf-model-create -x htipl-vf -y htipl-vf-desc -z htipl-vendor -b 044e3269503d4579b4bdd60d0231e4e6  -g 1.0 -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap> vf-model-create -x ${vf-model-name} -y ${vf-model-description} -g ${vsp-version} -z ${vlm-vendor-name} -b ${vsp-id} -u cs0008 -p demo123456! -m ${sdc-catalog-url}
 
-  +----------+--------------------------------------+
-  |property  |value                                 |
-  +----------+--------------------------------------+
-  |ID        |f1a75427-1379-4976-abca-91a00f8b118a  |
-  +----------+--------------------------------------+
+Output: vf-model-id
 
-Now, VF is ready for certification.
+To view newly created vf;
+::
 
-Submit VF for certification
----------------------------
+ onap> vf-model-list -u cs0008 -p demo123456! -m ${sdc-catalog-url}
 
-Initiate VF certification request using following command.
+Save the **vf-unique-id** , it will be used for certification
 
-::
+Now, VF is ready for certification.
 
-  onap>vf-model-certify-request -b f1a75427-1379-4976-abca-91a00f8b118a -u cs0008 -p demo123456! -m http://192.168.17.5:8080
 
 Certify VF
 ----------
@@ -289,34 +231,9 @@ to mark VF certification start and complete.
 
 ::
 
-  onap>vf-model-certify-start -b f1a75427-1379-4976-abca-91a00f8b118a -u jm0007 -p demo123456! -m http://192.168.17.5:8080
-
-  onap>vf-model-certify-complete -b f1a75427-1379-4976-abca-91a00f8b118a -u jm0007 -p demo123456! -m http://192.168.17.5:8080
-
-  onap>vf-model-list -u cs0008 -p demo123456! -m http://192.168.17.5:8080
-
-  +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
-  |uuid                                  |uniqueid                              |invariant-uuid                        |name                      |version   |status  |
-  +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
-  |328bd996-5edc-4677-92c4-f50a39411f13  |d4212714-2fd0-4396-bef6-3864e267be06  |b77ac5f7-f524-4076-995b-e3781fda1e7e  |e3b2cebf-c72b-4b0f-b6af   |1.0       |CERTIFIED  |
-  +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
-  |83e79e9f-f021-4356-ab97-a0f03d926311  |389a8234-23ed-4396-a9b4-ea65669a0d30  |b21eff2e-aa99-4284-a59f-baea1dcf77c6  |fcffa69b-52ce-4139-92ba   |1.0       |CERTIFIED  |
-  +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
-  |e4fa86fd-04ab-4faa-8351-3196e6b33c13  |0d9894d8-df48-4245-a52f-9437443908f0  |03f63ce4-dbb0-446c-87dc-fab9c5d09ec9  |cdb3ebd4-0c81-4e60-8184   |1.0       |CERTIFIED  |
-  +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
-  |67c96cda-2035-413d-96de-9ea4aa206423  |c933ceb2-d68b-4bc1-962d-5e5073648fe5  |c3daf439-fa2a-4144-add5-9b543083d24e  |a146fd50-ed50-4444-a859   |1.0       |CERTIFIED  |
-  +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
-  |b2a40a03-c85e-4b6c-8ade-f90e5f2ce2d4  |6d040eb4-9fc7-42a7-b1c0-7959418eca1d  |4982d10b-09af-46b9-8317-c92d2658ae68  |2932d051-6aad-4c0d-ac2d   |1.0       |CERTIFIED  |
-  +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
-  |6bddc881-0538-4ca0-933d-bbf1abc83d07  |45ae036e-8b6b-4130-81c6-451ba020653e  |2398ce72-99c6-4995-b19c-ccbc9f57144c  |b032e3b2-5ab0-4b14-b88f   |1.0       |CERTIFIED  |
-  +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
-  |848865b6-d9f0-4767-a5bf-c240fb832a46  |da9d92e5-ca04-4101-bad0-bdc17cf6f089  |6ae8e80c-c814-45fe-ba97-4d94d98c645f  |htipl-vf                  |1.0       |CERTIFIED  |
-  +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
-  |b1b6e4d0-8043-49b4-917e-3d2a762b5a56  |017aa6b7-60c9-457a-b593-8cef623dbe3b  |7819f9f0-cbdb-40b6-acd0-edcdbdab119c  |21b8a269-6377-42f9-9a98   |1.0       |CERTIFIED  |
-  +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
-  |c7131963-1bbf-474d-a773-4f201a3480d3  |cba595e5-3a0f-482b-ba74-078a15d96756  |1a15a0a0-b040-47b5-adbd-e0c3b2e52417  |fe631a9d-99c1-4b7c-8a06   |1.0       |CERTIFIED  |
-  +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
+  onap> vf-model-certify -b ${vf-unique-id} -r ${vf-remarks} -u cs0008 -p demo123456! -m ${sdc-catalog-url}
 
+After certifications, the id values change so run the above vf-model-list command to see the new values which will be used in the next steps.
 After successful VF creation you can proceed for service model creation.
 
 Create service model
@@ -326,13 +243,11 @@ Run following command to create service model.
 
 ::
 
-  onap>service-model-create -x htipl-service -y htipl-serv-desc -z htipl-123456 -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap>service-model-create -x ${service-model-name} -y ${service-model-description} -z ${project-code} -e ${icon-id} -c ${category-display} -b ${category} -u cs0008 -p demo123456! -m ${sdc-catalog-url}
+
+**project code can be a random string**
 
-  +----------+--------------------------------------+
-  |property  |value                                 |
-  +----------+--------------------------------------+
-  |ID        |3f8ff680-6b71-45e9-8bee-72628d7f443b  |
-  +----------+--------------------------------------+
+**Output**: service-model-id
 
 Add VF to service model
 -----------------------
@@ -341,63 +256,47 @@ Associate VF to service model using following command.
 
 ::
 
-  onap>service-model-add-vf -x 3f8ff680-6b71-45e9-8bee-72628d7f443b -y da9d92e5-ca04-4101-bad0-bdc17cf6f089 -z htipl-vf -b 1.0 -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap>service-model-add-vf -x ${service-model-id} -b ${vf-version} -y ${vf-model-unique-id} -z ${vf-model-name} -u cs0008 -p demo123456! -m ${sdc-catalog-url}
 
-  +----------+----------------------------------------------------+
-  |property  |value                                               |
-  +----------+----------------------------------------------------+
-  |ID        |3f8ff680-6b71-45e9-8bee-72628d7f443b.da9d92e5-ca04  |
-  |          |-4101-bad0-bdc17cf6f089.htiplvf0                    |
-  +----------+----------------------------------------------------+
 
-Submit Service for certification
+Submit Service for Testing
 --------------------------------
 
-Now, service is ready for initializing certification request. Use following command
-to initiate service certification request.
+Now, service is ready for Testing. Use following command
+to initiate service test request.
 
 ::
 
-  onap>service-model-certify-request -b 3f8ff680-6b71-45e9-8bee-72628d7f443b -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap>service-model-test-request -b ${service-model-id} -u cs0008 -p demo123456! -m ${sdc-catalog-url}
 
-Certify service
+Test service
 ---------------
 
-Now, tester(jm0007) can see service in his dashboard and he can start with service
-certification. Tester can use following command to mark certification start and
-complete.
+Now, tester(jm0007) can see service in his dashboard and he can start testing. Tester can use following command to start test and complete test
 
 ::
 
-  onap>service-model-certify-start -b 3f8ff680-6b71-45e9-8bee-72628d7f443b -u jm0007 -p demo123456! -m http://192.168.17.5:8080
+  onap>service-model-test-start -b ${service-model-id} -u jm0007 -p demo123456! -m ${sdc-catalog-url}
+
+  onap>service-model-test-accept -b ${service-model-id} -r ${test-remarks} -u jm0007 -p demo123456! -m ${sdc-catalog-url}
 
-  onap>service-model-certify-complete -b 3f8ff680-6b71-45e9-8bee-72628d7f443b -u jm0007 -p demo123456! -m http://192.168.17.5:8080
+  onap>service-model-list -u cs0008 -p demo123456! -m ${sdc-catalog-url}
 
-  onap>service-model-list -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+Run the above list command to get the service-model-unique-id, it will be used to approve the service model
 
-  +--------------------------------------+--------------------------------------+----------------+----------+------------+----------------------------+
-  |uuid                                  |invariant-uuid                        |name            |version   |status      |distribution-status         |
-  +--------------------------------------+--------------------------------------+----------------+----------+------------+----------------------------+
-  |fc5e1e81-786d-49e5-acfd-e933e291b1a4  |02258f88-2d84-4503-bd8e-2e3988e65e54  |htipl-service   |1.0       |CERTIFIED   |DISTRIBUTION_NOT_APPROVED   |
-  +--------------------------------------+--------------------------------------+----------------+----------+------------+----------------------------+
 
 Approve service model
 ---------------------
 
-After successful certification, service will be submitted to governor(gv001) to
+After successful Testing, service will be submitted to governor(gv0001) to
 approve service model.
 
 ::
 
-  onap>service-model-approve -b fc5e1e81-786d-49e5-acfd-e933e291b1a4 -u gv0001 -p demo123456! -m http://192.168.17.5:8080
+  onap>service-model-approve -b ${service-model-unique-id} -r ${approval-remarks} -u gv0001 -p demo123456! -m ${sdc-catalog-url}
 
-  onap>service-model-list -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap>service-model-list -u cs0008 -p demo123456! -m ${sdc-catalog-url}
 
-  +--------------------------------------+--------------------------------------+----------------+----------+------------+------------------------+
-  |uuid                                  |invariant-uuid                        |name            |version   |status      |distribution-status     |
-  +--------------------------------------+--------------------------------------+----------------+----------+------------+------------------------+
-  |fc5e1e81-786d-49e5-acfd-e933e291b1a4  |02258f88-2d84-4503-bd8e-2e3988e65e54  |htipl-service   |1.0       |CERTIFIED   |DISTRIBUTION_APPROVED   |
-  +--------------------------------------+--------------------------------------+----------------+----------+------------+------------------------+
 
 Distribute service model
 ------------------------
@@ -406,23 +305,44 @@ Now operator can distribute the service and it will be available in VID dashboar
 
 ::
 
-  onap>service-model-distribute -b fc5e1e81-786d-49e5-acfd-e933e291b1a4 -u op0001 -p demo123456! -m http://192.168.17.5:8080
+  onap>service-model-distribute -b ${service-model-unique-id} -u op0001 -p demo123456! -m ${sdc-catalog-url}
 
-  onap>service-model-list -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+  onap>service-model-list -u cs0008 -p demo123456! -m ${sdc-catalog-url}
+
+Creating Policies (Only Required if HPA is being Used)
+======================================================
+Before Running these commands to create policies, you must have uploaded policy models. See Method 2 (Manual upload) `here <https://wiki.onap.org/display/DW/OOF+-+HPA+guide+for+integration+testing>`_
+
+::
+
+  onap> policy-create-outdated -m ${pdp-url} -u testpdp -p alpha123 -x ${policy-name} -S ${policy-scope} -T ${policy-config-type} -o ${policy-onap-name} -b ${policy}
+
+  onap> policy-push-outdated -m ${pdp-url} -u testpdp -p alpha123 -x ${policy-name} -b ${policy-config-type} -c ${policy-pdp-group}
+
+When creating policies, the resource-module-name of the vf-model is required. This can be gotten by running the following command;
+
+::
+
+  onap> get-resource-module-name -u cs0008 -p demo123456! -m ${sdc-catalog-url}
+
+**Note:** See Step 16 in `vFW with HPA Tutorial: Setting Up and Configuration <https://onap.readthedocs.io/en/casablanca/submodules/integration.git/docs/docs_vfwHPA.html#docs-vfw-hpa>`_
+for sample policies as well as example values for policy-scope, config-type ...etc.
 
-  +--------------------------------------+--------------------------------------+----------------+----------+------------+----------------------+
-  |uuid                                  |invariant-uuid                        |name            |version   |status      |distribution-status   |
-  +--------------------------------------+--------------------------------------+----------------+----------+------------+----------------------+
-  |fc5e1e81-786d-49e5-acfd-e933e291b1a4  |02258f88-2d84-4503-bd8e-2e3988e65e54  |htipl-service   |1.0       |CERTIFIED   |DISTRIBUTED           |
-  +--------------------------------------+--------------------------------------+----------------+----------+------------+----------------------+
 
 Creating Cloud, Customer and Service-type
 =========================================
 
-It is required to specify the cloud configuration in AAI system before deploying
+It is required to specify the complex and cloud configuration in AAI system before deploying
 the service. Following are the steps to configure cloud and related information
 for service deployment.
 
+
+Create Complex
+--------------
+::
+
+  onap>complex-create -x ${complex-name} -r ${physical-location} -y ${data-center-code} -l ${region} -i ${street-1-name} -j ${street-2-name}  -lt ${latitude} -lo ${longitude} -S ${state}  -la ${lata} -g ${city} -w ${postal-code} -z ${complex-name} -k ${country} -o ${elevation} -q ${identity-url} -m ${aai-url} -u AAI -p AAI
+
 Create Cloud
 ------------
 
@@ -430,37 +350,30 @@ Use following command to create cloud and region in AAI system.
 
 ::
 
-  onap>cloud-create -x htipl-cloud -y htipl-region -u AAI -p AAI -m https://192.168.17.13:8447
-
+  onap>cloud-create -x ${cloud-owner-name} -y ${cloud-region-name} -e ${esr-system-info-id} -b ${cloud-user-name} -j ${cloud-user-password} -I ${extra-info} -w ${cloud-region-version} -l ${default-tenant} -url ${keystone-url} -n ${complex-name} -q ${cloud-type} -r ${owner-defined-type} -Q ${system-type} -i ${identity-url} -g ${cloud-zone} -z ${ssl-insecure-boolean} -k ${system-status} -c ${cloud-domain} -m ${aai-url} -u AAI -p AAI
 
-  onap>cloud-list -u AAI -p AAI -m https://192.168.17.13:8447
+**Sample Command**
+::
 
-  +--------------+--------------+------------------+
-  |cloud         |region        |resource-version  |
-  +--------------+--------------+------------------+
-  |htipl-cloud   |htipl-region  |1514263912528     |
-  +--------------+--------------+------------------+
-  |pod25dns      |RegionOne     |1513659267169     |
-  +--------------+--------------+------------------+
-  |pod25         |RegionOne     |1513659266151     |
-  +--------------+--------------+------------------+
+ onap> cloud-create -e 5c85ce1f-aa78-4ebf-8d6f-4b62773e9ade -b ${cloud-username} -I {\\"openstack-region-id\\":\\"ONAP-POD-01-Rail-06\\"} -x CloudOwner -y ONAP-POD-01-Rail-06 -j ${cloud-password} -w titanium_cloud -l Integration-HPA -url http://10.12.11.1:5000/v3 -n clli1 -q openstack -r t1 -Q VIM -i url -g CloudZone -z true -k active -c Default
 
-Create tenant
--------------
 
-Create tenant within region. Following is command to create tenant.
 
+Associate Cloud Region with complex
+-----------------------------------
 ::
 
-  onap>tenant-create -x htipl-cloud -y htipl-region -z htipl-tenant -r htipl-tenant -u AAI -p AAI -m https://192.168.17.13:8447
+  onap> complex-associate -x ${complex-name} -y ${cloud-region} -z ${cloud-owner} -m ${aai-url} -u AAI -p AAI
+  onap> cloud-list -u AAI -p AAI -m ${aai-url}
 
-  onap>tenant-list --cloud htipl-cloud --region htipl-region -u AAI -p AAI -m https://192.168.17.13:8447
 
-  +--------------+--------------+------------------+
-  |tenant-id     |tenant-name   |resource-version  |
-  +--------------+--------------+------------------+
-  |htipl-tenant  |htipl-tenant  |1514265496768     |
-  +--------------+--------------+------------------+
+Register Cloud Region with Multicloud (only required for HPA)
+-------------------------------------------------------------
+
+::
+
+  onap> multicloud-register-cloud -y ${cloud-owner} -x ${cloud-region} -m ${multicloud-url}
+
 
 Create Customer
 ---------------
@@ -469,15 +382,10 @@ A customer subscribes for the service. Use follwing command to create customer.
 
 ::
 
-  onap>customer-create -x htipl-customer -y htipl-customer -u AAI -p AAI -m https://192.168.17.13:8447
+  onap>customer-create -x ${customer-name} -y ${subscriber-name} -u AAI -p AAI -m ${aai-url}
 
-  onap>customer-list -u AAI -p AAI -m https://192.168.17.13:8447
+  onap>customer-list -u AAI -p AAI -m ${aai-url}
 
-  +----------------+------------------+
-  |name            |resource-version  |
-  +----------------+------------------+
-  |htipl-customer  |1514264928457     |
-  +----------------+------------------+
 
 Create service type
 -------------------
@@ -486,39 +394,32 @@ Use following command to create service type.
 
 ::
 
-  onap>service-type-create -x htipl-service -u AAI -p AAI -m https://192.168.17.13:8447
+  onap>service-type-create -x ${service-name} -u AAI -p AAI -m ${aai-url}
 
-  onap>service-type-list -u AAI -p AAI -m https://192.168.17.13:8447
-
-  +--------------------------------------+----------------+------------------+
-  |service-type-id                       |service-type    |resource-version  |
-  +--------------------------------------+----------------+------------------+
-  |f96017b1-9fcb-4d3c-ae17-d9b1fdef4415  |htipl-service   |1514265655713     |
-  +--------------------------------------+----------------+------------------+
+  onap>service-type-list -u AAI -p AAI -m ${aai-url}
 
 Create subscription
 -------------------
 
-Use following command to create subscription for a customer. It requires cloud
-information and service-type information.
+Use the following command to create subscription for a customer.
 
 ::
 
-  onap>subscription-create -x htipl-customer -z htipl-cloud -r htipl-region -c htipl-tenant -e htipl-service  -u AAI -p AAI -m https://192.168.17.13:8447
+  onap>subscription-create -x ${customer-name} -z ${cloud-owner} -c ${tenant-id} -e ${service-name} -y ${default-tenant} -r ${cloud-region} -m ${aai-url} -u AAI -p AAI
 
-  onap>subscription-list --customer-name htipl-customer -u AAI -p AAI -m https://192.168.17.13:8447
 
-  +----------------+------------------+
-  |service-type    |resource-version  |
-  +----------------+------------------+
-  |htipl-service   |1514265923244     |
-  +----------------+------------------+
+If the subscription has already been created, you can add more clouds to it using the following command;
+
+::
+
+  onap>subscription-cloud-add -x ${customer-name} -z ${cloud-owner} -c ${tenant-id} -e ${service-name} -y ${default-tenant} -r ${cloud-region} -m ${aai-url} -u AAI -p AAI
 
-Create Service-instance, VF and deploy VF
-=========================================
 
-Now, all the required configuration and artifacts are available to SO service to
-create service-instance and VF.
+Create Service-instance, VNF Instance and deploy VFMODULE
+=========================================================
+
+Now, all the required configuration and artifacts are available for the SO service to
+create a service-instance, VNF-Instance and VFMODULE.
 
 Create service instance
 -----------------------
@@ -529,35 +430,60 @@ used CLIs for creating and listing service model.
 
 ::
 
-  onap>service-create --cloud-region RegionOne --tenant-id 60817ff9baa547d5857a6b7ff0dc567b --model-invariant-id f812e618-3abf-4c7a-901e-f2820a73eb2e --model-uuid 84ad850a-3d0b-451d-b97b-083bbf39890d --model-name demoVLB --model-version 1.0 -c Demonstration --instance-name service-vlb-instance-1 --service-type vLB -u InfraPortalClient -p password1$ -m http://192.168.17.7:8080
+  onap> service-create -w ${service-name} -la ${customer-latitude} -lo ${customer-longitude} -o ${orchestrator} -A {alacart-boolean} -i ${service-model-name} -y ${company-name} -x ${project-name} -q ${requestor-id} -O ${owning-entity-name} -k ${service-instance-name} -P ${test-api} -H ${homing-solution} -n ${service-model-uuid} -e ${service-model-invariant-uuid} -j ${service-model-version} -S ${subscriber-name} -g ${service-model-uuid} -z ${owning-entity-id} -c ${customer-name} -u InfraPortalClient -p password1$ -m ${so-url}
 
-  +------------+--------------------------------------+
-  |property    |value                                 |
-  +------------+--------------------------------------+
-  |service-id  |1561a325-a64b-47ab-86f4-459e334292f0  |
-  +------------+--------------------------------------+
+When Homing and HPA are not being used, you do not need to specify longitude, latitude, homing-solution, orchestator
 
-Create VF
----------
+**Sample service-create commands**
 
-Using following command you can create VF in specified cloud region.
-Command requires VF model identifier which can be obtained from previously
-used CLIs for creating and listing VF model.
+**Without Homing**
+::
 
+  onap> service-create -w vFW -o multicloud -A true -i vfw-demo-service -y some_company  -x Project-Demonstration -q demo -O OE-Demonstration -k rand-2 -P VNF_API -n 545bca3c-8cc0-4dac-b464-1720894e0213 -e 41d0ebba-4b89-4437-9b22-4d83d2183aaa -j 1.0 -S Demonstration -g 545bca3c-8cc0-4dac-b464-1720894e0213 -z d005274f-d295-4538-a6b0-a090a7807dae -c Demonstration -u InfraPortalClient -p password1$ -m http://192.168.1.147:30277
+
+**With Homing**
 ::
 
-  onap>vf-create --cloud-region RegionOne --tenant-id onap --product-family vLB --instance-name service-vlb-instance-1-vnf-1 --service-instance-id 1561a325-a64b-47ab-86f4-459e334292f0 --vf-model-invariant-id 4982d10b-09af-46b9-8317-c92d2658ae68 --vf-model-uuid b2a40a03-c85e-4b6c-8ade-f90e5f2ce2d4 --vf-model-name 2932d051-6aad-4c0d-ac2d --vf-model-version 1.0 --vf-model-customization-id 3741acf1-5929-42e6-b234-4b9051d09a54 --service-model-invariant-id f812e618-3abf-4c7a-901e-f2820a73eb2e --service-model-uuid 84ad850a-3d0b-451d-b97b-083bbf39890d --service-model-name demoVLB --service-model-version 1.0 -m http://192.168.17.7:8080 -u InfraPortalClient -p password1$
+  onap> service-create -w vFW -la 32.897480 -lo 97.040443 -o multicloud -A true -i vfw-demo-service -y some_company  -x Project-Demonstration -q demo -O OE-Demonstration -k cli-instance-new -P VNF_API -H oof -n 545bca3c-8cc0-4dac-b464-1720894e0213 -e 41d0ebba-4b89-4437-9b22-4d83d2183aaa -j 1.0 -S Demonstration -g 545bca3c-8cc0-4dac-b464-1720894e0213 -z d005274f-d295-4538-a6b0-a090a7807dae -c Demonstration -u InfraPortalClient -p password1$ -m http://192.168.1.147:30277
+
+You can get the values for the owning entity by running the following command;
+::
 
-  +----------+--------------------------------------+
-  |property  |value                                 |
-  +----------+--------------------------------------+
-  |vf-id     |addb80ab-8c95-49b3-a2b7-907a02553319  |
-  +----------+--------------------------------------+
+  onap> owning-entity-list -u AAI -p AAI -m ${aai-url}
+
+Create VNF Instance
+-------------------
+
+Use the following command to create the VNF instance, Do a Preload and create the VFModule in a particular cloud region
+
+::
+
+   onap> vnf-create -j ${service-model-invariant-uuid} -q ${service-model-name} -k ${service-model-id} -l ${cloud-region} -y ${service-instance-id} -z ${tenant-id} -r ${requestor-id} -c ${vf-model-uuid} -o ${generic-vnf-name} -e ${vf-model-name} -g ${vf-model-version} -b ${vf-model-invariant-uuid} -n ${service-version} -i ${vf-model-customization-id} -vn ${vf-model-customization-name} -w ${service-name} -pn ${platform-name} -lob ${lob-name} -u InfraPortalClient -p password1$ -m ${so-url}
+
+**Output:** vnf-id
+
+
+**Sample vnf-create command**
+::
+
+  onap>  vnf-create -j 41d0ebba-4b89-4437-9b22-4d83d2183aaa -q vfw-demo-service -k 545bca3c-8cc0-4dac-b464-1720894e0213 -l cloud-two -y 43143a2c-f0e1-499d-b042-97fb0c05166b -z a0ea4cfd751e40e0a093848dd9e03e6c -r demo  -c 04ffd583-5625-4471-b20b-38394b513efd -o cli-vnf-test -e vfw-hpa-sriov_v2 -g 1.0 -b b7d993a3-3870-4096-a16c-90110d402349 -n 1.0 -i 123f896f-c6a4-4560-8786-7607e832bb6f -vn "vfw-hpa-sriov_v2 0" -w vFW -pn Platform-Demonstration -lob LOB-Demonstration -u InfraPortalClient -p password1$ -m http://192.168.1.147:30277
+
+
+Preload VF-Module
+-----------------
+::
+
+  onap> vf-preload -y ${preload-file} -u admin -p Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U -m ${sdnc-url}
+
+See Step 20 of `vFW with HPA Tutorial: Setting Up and Configuration <https://onap.readthedocs.io/en/casablanca/submodules/integration.git/docs/docs_vfwHPA.html#docs-vfw-hpa>`_ for sample preload file.
 
 Create VF-module
 ----------------
+::
 
-This command is not yet verified with ONAP stack but you can go ahed by referring :ref:`vf-module-create` for vf module creation.
-On success of above command you can see VNF is deployed in given cloud.
+  onap>  vf-module-create -w ${tenant-id} -mn ${vf-model-customization-name} -x ${service-instance-id} -l ${cloud-region} -sv ${service-version} -vc ${vf-module-customization-id} -vm ${v-module-model-version} -mv ${vf-model-version} -i ${vf-module-name} -vf ${vf-model-name} -vi ${vf-module-model-invariant-id} -r ${suppress-rollback-boolean} -mc ${vf-model-customization-id} -api ${test-api} -mi ${vf-model-invariant-id} -vid ${vf-model-id} -y ${vnf-instance-id} -R ${requestor-id} -si ${service-uuid} -up ${use-preload} -sd ${service-invariat-id} -z ${service-model-name} -vn ${vf-module-model-name} -vv ${vf-module-model-version-id} -co ${cloud-owner} -u InfraPortalClient -p password1$ -m ${so-url}
 
+**Sample vf-module-create command**
+::
 
+  onap> vf-module-create -w a0ea4cfd751e40e0a093848dd9e03e6c -mn "vfw-hpa-sriov_v2 0" -x d353ace3-52e9-4c79-b3c8-63c97e15cc29 -l cloud-two -sv 1.0 -vc 0f837829-0dbb-4768-88d4-3cdf01e073f6 -vm 1 -mv 1.0 -i vfw-sriov-cli -vf vfw-hpa-sriov_v2 -vi 8d3071e4-0d4e-4520-aa92-c01b9a019142 -r false -mc 123f896f-c6a4-4560-8786-7607e832bb6f -api VNF_API -mi b7d993a3-3870-4096-a16c-90110d402349 -vid 04ffd583-5625-4471-b20b-38394b513efd -y dad645a3-7e01-47cd-8e70-cdc8b5e880ec -R demo -si 545bca3c-8cc0-4dac-b464-1720894e0213 -up true -sd 41d0ebba-4b89-4437-9b22-4d83d2183aaa -z vfw-demo-service -vn VfwHpaSriovV2..base_vfw..module-0 -vv d5c83591-0f22-4543-ada2-24197847b7d2 -u InfraPortalClient -p password1$ -m http://192.168.1.147:30277
author	Itohan Ukponmwan <itohan.ukponmwan@intel.com>	2019-05-31 18:58:04 +0000
committer	Itohan Ukponmwan <itohan.ukponmwan@intel.com>	2019-05-31 19:08:43 +0000
commit	6829fe21ee084daeb41040c90937409841779eda (patch)
tree	85f4e46d45521dc67e45defad9bf135ae2afa24f /docs
parent	4a8c1b6d692207917ee61cd14eba3f9f522a9bd5 (diff)