Code Review / cli.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | patch | inline | side by side (parent: df20c73)
Documentation for end to end commands 13/26913/1
authorsubhash kumar singh <subhash.kumar.singh@huawei.com>
Tue, 26 Dec 2017 14:04:31 +0000 (14:04 +0000)
committersubhash kumar singh <subhash.kumar.singh@huawei.com>
Tue, 26 Dec 2017 14:04:31 +0000 (14:04 +0000)
Add documentation for end to end cli commands

Change-Id: I374b02c8b4bc1c3aa8c955b763c92e997047da01
Issue-ID: CLI-86
Signed-off-by: subhash kumar singh <subhash.kumar.singh@huawei.com>
docs/end_to_end_onap_cli_commands.rst [new file with mode: 0644] patch | blob

diff --git a/docs/end_to_end_onap_cli_commands.rst b/docs/end_to_end_onap_cli_commands.rst
new file mode 100644 (file)
index 0000000..9df8ace
--- /dev/null
+++ b/docs/end_to_end_onap_cli_commands.rst
@@ -0,0 +1,462 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
+.. _end_to_end_onap_cli_commands:
+
+
+<style>div {
+  background-color: black;
+  color: white;
+  width: 100%;
+}</style>
+
+
+End-to-End command guide for working with ONAP
+==============================================
+
+This document demonstrates to use ONAP end to end system using CLI.
+
+
+Create license
+==============
+<pre>
+<div>
+onap>vlm-create -x htipl-vendor -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+
++----------+----------------------------------+
+|property  |value                             |
++----------+----------------------------------+
+|ID        |d6da25894a1a470fa8357c15681b7a66  |
++----------+----------------------------------+
+</div>
+</pre>
+
+Create license entitlement pool
+===============================
+
+<pre>
+<div>
+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
+
++----------+----------------------------------+
+|property  |value                             |
++----------+----------------------------------+
+|ID        |44743b88b7254d3aa8829d5fcb5a4b47  |
++----------+----------------------------------+
+</div>
+</pre>
+
+
+Create license key group
+========================
+<pre>
+<div>
+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  |
++----------+----------------------------------+
+</div>
+</pre>
+
+Create license feature group
+============================
+<pre>
+<div>
+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
+
++----------+----------------------------------+
+|property  |value                             |
++----------+----------------------------------+
+|ID        |0ef91147b9904568942d4d3f5a8bbc96  |
++----------+----------------------------------+
+</div>
+</pre>
+
+Create license agreement
+========================
+<pre>
+<div>
+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
+
++----------+----------------------------------+
+|property  |value                             |
++----------+----------------------------------+
+|ID        |1909ee429dcd459aa0eb33e812981973  |
++----------+----------------------------------+
+</div>
+</pre>
+
+Checkin and submin vlm
+======================
+<pre>
+<div>
+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
+</div>
+</pre>
+
+Create VSP
+==========
+<pre>
+<div>
+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
+
++----------+----------------------------------+
+|property  |value                             |
++----------+----------------------------------+
+|ID        |044e3269503d4579b4bdd60d0231e4e6  |
++----------+----------------------------------+
+</div>
+</pre>
+
+Add artifact to VSP
+===================
+<pre>
+<div>
+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
+</div>
+</pre>
+
+Validate VSP
+============
+<pre>
+<div>
+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"}]}       |
++----------+----------------------------------------------------+
+</div>
+</pre>
+
+
+Submit and checkin VSP for testing
+==================================
+<pre>
+<div>
+onap>vsp-checkin -x 044e3269503d4579b4bdd60d0231e4e6 -y 0.1 -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+
+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
+
++----------------------------------+------------+----------+--------+
+|ID                                |name        |version   |status  |
++----------------------------------+------------+----------+--------+
+|044e3269503d4579b4bdd60d0231e4e6  |htipl-vsp   |1.0       |Final   |
++----------------------------------+------------+----------+--------+
+</div>
+</pre>
+
+package the VSP
+===============
+<pre>
+<div>
+onap>vsp-package -x 044e3269503d4579b4bdd60d0231e4e6 -y 1.0 -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+</div>
+</pre>
+
+Create vf model for VSP
+=======================
+<pre>
+<div>
+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
+
++----------+--------------------------------------+
+|property  |value                                 |
++----------+--------------------------------------+
+|ID        |f1a75427-1379-4976-abca-91a00f8b118a  |
++----------+--------------------------------------+
+</div>
+</pre>
+
+Submint VF for certification
+============================
+<pre>
+<div>
+onap>vf-model-certify-request -b f1a75427-1379-4976-abca-91a00f8b118a -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+</div>
+</pre>
+
+Certify VF
+==========
+<pre>
+<div>
+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  |
++--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+
+</div>
+</pre>
+
+Create service model
+====================
+<pre>
+<div>
+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
+
++----------+--------------------------------------+
+|property  |value                                 |
++----------+--------------------------------------+
+|ID        |3f8ff680-6b71-45e9-8bee-72628d7f443b  |
++----------+--------------------------------------+
+</div>
+</pre>
+
+Add VF to service model
+=======================
+<pre>
+<div>
+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
+
++----------+----------------------------------------------------+
+|property  |value                                               |
++----------+----------------------------------------------------+
+|ID        |3f8ff680-6b71-45e9-8bee-72628d7f443b.da9d92e5-ca04  |
+|          |-4101-bad0-bdc17cf6f089.htiplvf0                    |
++----------+----------------------------------------------------+
+</div>
+</pre>
+
+
+Submit Service for certification
+================================
+<pre>
+<div>
+onap>service-model-certify-request -b 3f8ff680-6b71-45e9-8bee-72628d7f443b -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+
+</div>
+</pre>
+
+Certify service
+===============
+<pre>
+<div>
+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-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 http://192.168.17.5:8080
+
++--------------------------------------+--------------------------------------+----------------+----------+------------+----------------------------+
+|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   |
++--------------------------------------+--------------------------------------+----------------+----------+------------+----------------------------+
+</div>
+</pre>
+
+Approve service model
+=====================
+<pre>
+<div>
+onap>service-model-approve -b fc5e1e81-786d-49e5-acfd-e933e291b1a4 -u gv0001 -p demo123456! -m http://192.168.17.5:8080
+
+
+onap>service-model-list -u cs0008 -p demo123456\! -m http://192.168.17.5:8080
+service-model-list -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+
++--------------------------------------+--------------------------------------+----------------+----------+------------+------------------------+
+|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   |
++--------------------------------------+--------------------------------------+----------------+----------+------------+------------------------+
+</div>
+</pre>
+
+Distribute service model
+========================
+<pre>
+<div>
+onap>service-model-distribute -b fc5e1e81-786d-49e5-acfd-e933e291b1a4 -u op0001 -p demo123456! -m http://192.168.17.5:8080
+
+
+onap>service-model-list -u cs0008 -p demo123456! -m http://192.168.17.5:8080
+
++--------------------------------------+--------------------------------------+----------------+----------+------------+----------------------+
+|uuid                                  |invariant-uuid                        |name            |version   |status      |distribution-status   |
++--------------------------------------+--------------------------------------+----------------+----------+------------+----------------------+
+|fc5e1e81-786d-49e5-acfd-e933e291b1a4  |02258f88-2d84-4503-bd8e-2e3988e65e54  |htipl-service   |1.0       |CERTIFIED   |DISTRIBUTED           |
++--------------------------------------+--------------------------------------+----------------+----------+------------+----------------------+
+</div>
+</pre>
+
+
+Create Cloud
+============
+<pre>
+<div>
+onap>cloud-create -x htipl-cloud -y htipl-region -u AAI -p AAI -m https://192.168.17.13:8447
+
+
+onap>cloud-list -u AAI -p AAI -m https://192.168.17.13:8447
+
++--------------+--------------+------------------+
+|cloud         |region        |resource-version  |
++--------------+--------------+------------------+
+|htipl-cloud   |htipl-region  |1514263912528     |
++--------------+--------------+------------------+
+|pod25dns      |RegionOne     |1513659267169     |
++--------------+--------------+------------------+
+|pod25         |RegionOne     |1513659266151     |
++--------------+--------------+------------------+
+</div>
+</pre>
+
+Create Customer
+===============
+<pre>
+<div>
+onap>customer-create -x htipl-customer -y htipl-customer -u AAI -p AAI -m https://192.168.17.13:8447
+
+onap>customer-list -u AAI -p AAI -m https://192.168.17.13:8447
+
++----------------+------------------+
+|name            |resource-version  |
++----------------+------------------+
+|htipl-customer  |1514264928457     |
++----------------+------------------+
+</div>
+</pre>
+
+Create tenant
+=============
+<pre>
+<div>
+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>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     |
++--------------+--------------+------------------+
+</div>
+</pre>
+
+Create service type
+===================
+<pre>
+<div>
+onap>service-type-create -x htipl-service -u AAI -p AAI -m https://192.168.17.13:8447
+
+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     |
++--------------------------------------+----------------+------------------+
+</div>
+</pre>
+
+Create subscription
+===================
+<pre>
+<div>
+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-list --customer-name htipl-customer -u AAI -p AAI -m https://192.168.17.13:8447
+
++----------------+------------------+
+|service-type    |resource-version  |
++----------------+------------------+
+|htipl-service   |1514265923244     |
++----------------+------------------+
+</div>
+</pre>
+
+
+Create service instance
+=======================
+<pre>
+<div>
+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
+
++------------+--------------------------------------+
+|property    |value                                 |
++------------+--------------------------------------+
+|service-id  |1561a325-a64b-47ab-86f4-459e334292f0  |
++------------+--------------------------------------+
+</div>
+</pre>
+
+Create VNF
+==========
+<pre>
+<div>
+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$
+
++----------+--------------------------------------+
+|property  |value                                 |
++----------+--------------------------------------+
+|vf-id     |addb80ab-8c95-49b3-a2b7-907a02553319  |
++----------+--------------------------------------+
+
+</div>
+</pre>
+
+
Provides required Command Line Interface for ONAP