diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/OCLIP.rst | 2 | ||||
| -rw-r--r-- | docs/OOM_and_HEAT_based_deployment.rst | 15 | ||||
| -rw-r--r-- | docs/architecture.rst | 24 | ||||
| -rw-r--r-- | docs/cmd_help_onap_amsterdam.rst | 3 | ||||
| -rw-r--r-- | docs/cmd_help_onap_beijing.rst | 5 | ||||
| -rw-r--r-- | docs/cmd_sample_onap_amsterdam.rst | 1290 | ||||
| -rw-r--r-- | docs/conf.py | 6 | ||||
| -rw-r--r-- | docs/console.rst | 2 | ||||
| -rw-r--r-- | docs/open_cli_schema_version_1_0.rst | 10 | ||||
| -rw-r--r-- | docs/release-notes.rst | 20 | ||||
| -rw-r--r-- | docs/tox.ini | 8 | ||||
| -rw-r--r-- | docs/user_guide.rst | 1 |
12 files changed, 55 insertions, 1331 deletions
diff --git a/docs/OCLIP.rst b/docs/OCLIP.rst index de7d623f..13375b88 100644 --- a/docs/OCLIP.rst +++ b/docs/OCLIP.rst @@ -2,6 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 Huawei Technologies Co., Ltd. +:orphan: + .. _OCLIP: Open CLI Platform (OCLIP) diff --git a/docs/OOM_and_HEAT_based_deployment.rst b/docs/OOM_and_HEAT_based_deployment.rst index d7efdf16..b064f88b 100644 --- a/docs/OOM_and_HEAT_based_deployment.rst +++ b/docs/OOM_and_HEAT_based_deployment.rst @@ -10,18 +10,19 @@ CLI deployment using OOM and HEAT ONAP CLI deployment is enabled with OOM and HEAT based ONAP installation. OpenStack HEAT based deployment ------------------------------- +------------------------------- -As part of HEAT based deployment, ONAL CLI docker image is integrated into ONAP Portal and when portal_vm is -successfully installed, it will be available at http://portal.api.simpledemo.openecomp.org:8080 +As part of HEAT based deployment, ONAL CLI docker image is integrated into ONAP +Portal and when portal_vm is successfully installed, it will be available +at http://portal.api.simpledemo.openecomp.org:8080 -To troubleshoot any issues in CLI, please login to portal_vm and CLI docker runs with image onap/cli +To troubleshoot any issues in CLI, please login to portal_vm and CLI docker +runs with image onap/cli OOM based deployment -------------------- ONAL CLI docker image is integrated with OOM and is available under name 'cli' -Once successfully installed, CLI is available under onap-cli name-space. So user can access the CLI at -http://<k8s-host>:30260 - +Once successfully installed, CLI is available under onap-cli name-space. So +user can access the CLI at http://<k8s-host>:30260 diff --git a/docs/architecture.rst b/docs/architecture.rst index 95953b7b..99070a4a 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -12,22 +12,28 @@ Following diagram shows the high-level architecture of OCLIP. .. image:: images/portal-cli-arch.png -* **Command Registrar** : Registrar keeps track of the commands registered in OCLIP and when user invokes the command, -it identifies the corresponding command and helps to invoke the corresponding command plug-in. +* **Command Registrar** : Registrar keeps track of the commands registered in + OCLIP and when user invokes the command, it identifies the corresponding + command and helps to invoke the corresponding command plug-in. -* **Command Discoverer** : Discoverer discovers the commands both in plug-in format and YAML and automatically register -them into Registrar. +* **Command Discoverer** : Discoverer discovers the commands both in plug-in + format and YAML and automatically register them into Registrar. -* **Command Plug-in** : Implement the command as plug-in. More details :ref:`cli_developer_guide` +* **Command Plug-in** : Implement the command as plug-in. + More details :ref:`cli_developer_guide` -* **HTTP Command** : Plug-in for implementing all Rest based command as YAML without any coding. +* **HTTP Command** : Plug-in for implementing all Rest based command as YAML + without any coding. -* **SNMP Command** : Plug-in for implementing all SNMP based command as YAML without any coding. +* **SNMP Command** : Plug-in for implementing all SNMP based command as YAML + without any coding. * **Command Shell** : Provides the interactive command line console from Linux -* **Web Command Console** : Provides the interactive command line console from web-browser +* **Web Command Console** : Provides the interactive command line console from + web-browser -* **Cache** : Provides persistent storage for discoverer to store the meta-data about the discovered Commands. +* **Cache** : Provides persistent storage for discoverer to store the meta-data + about the discovered Commands. * **open cli schemas** : Set of command YAML provides the CLI definitions. diff --git a/docs/cmd_help_onap_amsterdam.rst b/docs/cmd_help_onap_amsterdam.rst index c18412d7..ce791598 100644 --- a/docs/cmd_help_onap_amsterdam.rst +++ b/docs/cmd_help_onap_amsterdam.rst @@ -2,11 +2,12 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 Huawei Technologies Co., Ltd. +:orphan: + .. toctree:: :maxdepth: 2 - .. _cli_cmd_help_onap_amsterdam: onap-amsterdam diff --git a/docs/cmd_help_onap_beijing.rst b/docs/cmd_help_onap_beijing.rst index bd572cdb..4be0db28 100644 --- a/docs/cmd_help_onap_beijing.rst +++ b/docs/cmd_help_onap_beijing.rst @@ -2,6 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 Huawei Technologies Co., Ltd. +:orphan: .. toctree:: :maxdepth: 2 @@ -1241,8 +1242,8 @@ Error:: - license-group-show ------------------------------------------------ +license-group-show +------------------ usage: oclip license-group-show diff --git a/docs/cmd_sample_onap_amsterdam.rst b/docs/cmd_sample_onap_amsterdam.rst deleted file mode 100644 index a77615e4..00000000 --- a/docs/cmd_sample_onap_amsterdam.rst +++ /dev/null @@ -1,1290 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2018 Huawei Technologies Co., Ltd. - -.. _cli_cmd_sample: - - -onap-amsterdam -============== - -NOTE: EOL 01-Aug-2018 - -cloud-delete ------------- - -input:: - - --cloud-name huawei-cloud-test --region-name bangalore-test --resource-version 1509027982352 - - -cloud-create ------------- - -input:: - - --cloud-name huawei-cloud --region-name bangalore - - -cloud-list ----------- - -output:: - - +--------------+------------+------------------+ - |cloud |region |resource-version | - +--------------+------------+------------------+ - |huawei-cloud |bangalore |1509027332165 | - +--------------+------------+------------------+ - |Rackspace |RegionOne |1508827902543 | - +--------------+------------+------------------+ - -vnfm-list ---------- - -output:: - - +--------------------------------------+--------------------------------------+------------------+------------------+ - |vnfm-id |vim-id |certificate-url |resource-version | - +--------------------------------------+--------------------------------------+------------------+------------------+ - |c0ecd788-22f4-49a4-a969-68051cd517e7 |acc5e14e-1320-4ab5-97fe-b7cc82ad03f2 | |1509094328901 | - +--------------------------------------+--------------------------------------+------------------+------------------+ - -vnfm-unregister ---------------- - -input:: - - --vnfm-id c0ecd788-22f4-49a4-a969-68051cd517e7 --resource-version 1509094328901 - - -vnfm-show ---------- - -input:: - - --vnfm-id c0ecd788-22f4-49a4-a969-68051cd517e7 - -output:: - - +----------+------------------+ - |property |value | - +----------+------------------+ - |name |vnfm1 | - +----------+------------------+ - |type |OpenStack | - +----------+------------------+ - |vendor |ONAP | - +----------+------------------+ - |version |1.0 | - +----------+------------------+ - |url |http://10.0.1.1 | - +----------+------------------+ - -vnfm-register -------------- - -input:: - - --vim-id acc5e14e-1320-4ab5-97fe-b7cc82ad03f2 --name vnfm1 --type OpenStack --vendor ONAP --vnfm-version 1.0 --url http://10.0.1.1 --username admin --password password - - -vim-list --------- - -input:: - - --cloud-name huawei-cloud --region-name bangalore --long - -output:: - - +--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+ - |vim-id |name |type |vendor |version |url |username |cloud-domain |default-tenant |resource-version | - +--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+ - |acc5e14e-1320-4ab5-97fe-b7cc82ad03f2 |RegionOne |OpenStack |Devstack |newton |http://192.168.16.149/identity |onap |default |onap |1509093477505 | - +--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+ - |810edb5a-42e9-462d-9587-96bc9272ac27 |vim1 |OpenStack |Devstack |newton |http://192.168.16.149/identity |onap |default |onap |1509093590932 | - +--------------------------------------+------------+------------+----------+----------+--------------------------------+----------+--------------+----------------+------------------+ - -vim-register ------------- - -input:: - - --cloud-name huawei-cloud --region-name bangalore --name vim1 --type OpenStack --vendor Devstack --vim-version newton --url http://192.168.16.149/identity --username onap --password onap --cloud-domain default --default-tenant onap - - -vim-unregister --------------- - -input:: - - --vim-id 810edb5a-42e9-462d-9587-96bc9272ac27 --cloud-name huawei-cloud --region-name bangalore --resource-version 1509093590932 - - -ems-register ------------- - -input:: - - --name ems1 --type ems --vendor boco --ems-version 1.0 --url http://10.0.0.1 --username admin --password password --remote-path sample - - -ems-unregister --------------- - -input:: - - --ems-id 51a480ed-649c-4c47-a84b-f966dc4f9554 --resource-version 1509095358658 - - -ems-list --------- - -output:: - - +--------------------------------------+------------------+ - |ems-id |resource-version | - +--------------------------------------+------------------+ - |51a480ed-649c-4c47-a84b-f966dc4f9554 |1509095358658 | - +--------------------------------------+------------------+ - -ems-show --------- - -input:: - - --ems-id 51a480ed-649c-4c47-a84b-f966dc4f9554 - -output:: - - +------+------+--------+----------+------------------+ - |name |type |vendor |version |url | - +------+------+--------+----------+------------------+ - |ems1 |ems |boco |1.0 |http://10.0.0.1 | - +------+------+--------+----------+------------------+ - -subscription-delete -------------------- - -input:: - - --customer-name kanag --service-type vFW-kanag --resource-version 1509079144326 - - -subscription-list ------------------ - -input:: - - --customer-name kanag - -output:: - - +--------------+------------------+ - |service-type |resource-version | - +--------------+------------------+ - |vFW-kanag |1509079144326 | - +--------------+------------------+ - -subscription-create -------------------- - -input:: - - --customer-name kanag --cloud-name huawei-cloud --cloud-region bangalore --cloud-tenant-id e18173e6-6a13-4614-a13c-3859e7321103 --service-type vFW-kanag - - -customer-delete ---------------- - -input:: - - --customer-name test --resource-version 1509029022293 - - -customer-show -------------- - -input:: - - --customer-name kanag --long - -output:: - - +--------+------------------+------------------+------------------+ - |name |subscriber-name |resource-version |subscriber-type | - +--------+------------------+------------------+------------------+ - |kanag |kanag |1509029007060 |INFRA | - +--------+------------------+------------------+------------------+ - -customer-create ---------------- - -input:: - - --customer-name test --subscriber-name test - - -customer-list -------------- - -output:: - - +----------------+------------------+ - |name |resource-version | - +----------------+------------------+ - |test |1509029022293 | - +----------------+------------------+ - |kanag |1509029007060 | - +----------------+------------------+ - |Demonstration |1508827908763 | - +----------------+------------------+ - -vf-show -------- - -input:: - - --vf-id 1a667ce8-8b8b-4f59-ba5c-b162ae462fef -m https://192.168.17.111:8443 -u AAI -p AAI - -output:: - - +------------------------+--------------------------------------+ - |property |value | - +------------------------+--------------------------------------+ - |vf-id |1a667ce8-8b8b-4f59-ba5c-b162ae462fef | - +------------------------+--------------------------------------+ - |vf-name |vlb-cli-sample-8 | - +------------------------+--------------------------------------+ - |vf-type |demoVLB/null | - +------------------------+--------------------------------------+ - |model-invariant-id |cc34cd54-dd7c-44cd-8847-f9577c6f1a49 | - +------------------------+--------------------------------------+ - |model-uuid |8b1f63f3-e0cc-4c27-8903-fafe2f25bfbe | - +------------------------+--------------------------------------+ - |model-customization-id |cf893f5a-1bb1-4e32-a92b-2456e12178f8 | - +------------------------+--------------------------------------+ - |service-id |2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee | - +------------------------+--------------------------------------+ - -service-list ------------- - -input:: - - -x Demonstration -y vLB --long - -output:: - - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |service-id |service-name |model-invariant-id |model-uuid |description | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |1db042a9-6b28-4290-baba-872d32eeecf2 |sample-instance |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |9244629b-4ae4-48a0-bac0-b76937105ec7 |demo-vlb-vid |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |912d6d8d-9534-41d0-9323-289e81d4e399 |sample-instance-3 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |26b4ea72-d119-4345-95c8-568b08a093aa |sample-service-onap-cli-2 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |b2ebdb88-cfa5-496f-93a5-d535accbf56a |sample-instance-1 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |01eb6e59-5c28-4c76-85c7-a6b1e48058b9 |sample-service-onap-cli-4 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |03acb854-647b-4cf9-bfd8-a76083bb7266 |sample-service-onap-cli-3 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |14a9d485-63de-4ce2-b763-133ec3ce3d23 |sample-service-onap-cli-8 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |fdb98970-9de8-48a3-a321-d02693d2d1ad |sample-service-onap-cli-9 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |50de14d5-73d6-458e-880e-de8278b6f944 |test |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee |sample-instance-cli-10 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - |4415727d-dc2a-4378-a3a7-bc4411d391c7 |sample-service-onap-cli-5 |1de901ed-17af-4b03-bc1f-41659cfa27cb |ace39141-09ec-4068-b06d-ac6b23bdc6e0 | | - +--------------------------------------+----------------------------+--------------------------------------+--------------------------------------+--------------+ - -vf-list -------- - -input:: - - -x Demonstration -y vLB --service-id 2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee - -output:: - - +--------------------------------------+--------------------+ - |vf-id |vf-name | - +--------------------------------------+--------------------+ - |1a667ce8-8b8b-4f59-ba5c-b162ae462fef |vlb-cli-sample-8 | - +--------------------------------------+--------------------+ - |048c2c4a-ee30-41a1-bb55-c4e7fe1a9a0d |vlb-cli-sample-11 | - +--------------------------------------+--------------------+ - |c37c401f-a839-4b6e-9c65-33e023c412ee |vlb-cli-sample-10 | - +--------------------------------------+--------------------+ - |b544f164-97c9-483a-98eb-eafd1f808e79 |vlb-cli-sample-5 | - +--------------------------------------+--------------------+ - |5ef95bd9-4d7a-4d06-879e-0c7964f9de65 |vlb-cli-sample-4 | - +--------------------------------------+--------------------+ - |eb29edb5-0a9f-4bc6-a7bf-3211341fffc2 |vlb-cli-sample-9 | - +--------------------------------------+--------------------+ - |2a152730-f6eb-4dc6-9b81-7a6f6f263d71 |vlb-cli-sample-1 | - +--------------------------------------+--------------------+ - |f53cd512-e172-410e-87b4-37064b5b5f8c |vlb-cli-sample-7 | - +--------------------------------------+--------------------+ - |f4bfcd6a-2ea1-42ab-853a-5d863b150c40 |vlb-cli-sample-3 | - +--------------------------------------+--------------------+ - |4bb4beaa-5b6b-414e-97d8-53949bbb5c5e |vlb-cli-sample-6 | - +--------------------------------------+--------------------+ - -service-type-list ------------------ - -output:: - - +--------------------------------------+--------------+------------------+ - |service-type-id |service-type |resource-version | - +--------------------------------------+--------------+------------------+ - |2733fe6f-8725-48fa-8609-092a34106dba |vIMS |1508827920395 | - +--------------------------------------+--------------+------------------+ - |bc549d9d-2335-4b07-9f03-3a85439c0bbb |vFW-kanag |1509029699189 | - +--------------------------------------+--------------+------------------+ - |de1fa33f-f676-42e5-b79a-a39825c19b1d |test |1509029708094 | - +--------------------------------------+--------------+------------------+ - |1482d2f2-b9e6-4421-a2f6-31959278db6f |vCPE |1508827919819 | - +--------------------------------------+--------------+------------------+ - |4426c557-e012-47eb-85cc-6128fa4f55c1 |vLB |1508827918467 | - +--------------------------------------+--------------+------------------+ - |dd04cc4b-6283-480d-8c5a-2c7bba8497ea |vFW |1508827917148 | - +--------------------------------------+--------------+------------------+ - -service-type-delete -------------------- - -input:: - - --service-type-id de1fa33f-f676-42e5-b79a-a39825c19b1d --resource-version 1509029708094 - - -service-type-create -------------------- - -input:: - - --service-type test - - -microservice-create -------------------- - -input:: - - --service-name test --service-version v1 --service-url /test --path /test 10.0.0.1 8080 - -output:: - - +----------+--------------+ - |property |value | - +----------+--------------+ - |name |test | - +----------+--------------+ - |version |v1 | - +----------+--------------+ - |url |/test | - +----------+--------------+ - |status |1 | - +----------+--------------+ - -microservice-list ------------------ - -input:: - - --long - -output:: - - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |name |version |url |status |nodes |enable-ssl |path | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-actions |v11 |/aai/v11/actions |1 |10.0.1.1:8443 |true | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-actions-deprecated |v11 |/aai/v11/actions |1 |10.0.1.1:8443 |true |/aai/v11/actions | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-business |v11 |/aai/v11/business |1 |10.0.1.1:8443 |true | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-business-deprecated |v11 |/aai/v11/business |1 |10.0.1.1:8443 |true |/aai/v11/business | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-cloudInfrastructure |v11 |/aai/v11/cloud-infrastructure |1 |10.0.1.1:8443 |true | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-cloudInfrastructure-deprecated |v11 |/aai/v11/cloud-infrastructure |1 |10.0.1.1:8443 |true |/aai/v11/cloud-infrastructure | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-esr-gui |v1 |/esr-gui |1 |10.0.14.1:9519 |false |/iui/aai-esr-gui | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-esr-server |v1 |/api/aai-esr-server/v1 |1 |172.17.0.5:9518 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-externalSystem |v11 |/aai/v11/external-system |1 |10.0.14.1:9518 |true | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-externalSystem-deprecated |v11 |/aai/v11/external-system |1 |10.0.1.1:8443 |true |/aai/v11/external-system | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-network |v11 |/aai/v11/network |1 |10.0.1.1:8443 |true | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-network-deprecated |v11 |/aai/v11/network |1 |10.0.1.1:8443 |true |/aai/v11/network | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-search |v11 |/aai/v11/search |1 |10.0.1.1:8443 |true | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-search-deprecated |v11 |/aai/v11/search |1 |10.0.1.1:8443 |true |/aai/v11/search | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-service-design-and-creation |v11 |/aai/v11/service-design-and-creation |1 |10.0.1.1:8443 |true | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |aai-service-design-and-creation-deprecated |v11 |/aai/v11/service-design-and-creation |1 |10.0.1.1:8443 |true |/aai/v11/service-design-and-creation | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |activiti |v1 |/api/activiti/v1 |1 |10.0.1.1:8443 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |activiti-rest |v1 |/activiti-rest |1 |10.0.14.1:8804 |false |/activiti-rest | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |catalog |v1 |/api/catalog/v1 |1 |10.0.14.1:8804 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |emsdriver |v1 |/api/emsdriver/v1 |1 |172.17.0.15:8806 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |gvnfmdriver |v1 |/api/gvnfmdriver/v1 |1 |10.0.14.1:8806 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |huaweivnfmdriver |v1 |/api/huaweivnfmdriver/v1 |1 |10.0.14.1:8206 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |jujuvnfmdriver |v1 |/api/jujuvnfmdriver/v1 |1 |172.17.0.17:8484 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |multicloud |v0 |/api/multicloud/v0 |1 |10.0.14.1:8484 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |multicloud-ocata |v0 |/api/multicloud-ocata/v0 |1 |10.0.14.1:8482 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |multicloud-titanium_cloud |v0 |/api/multicloud-titanium_cloud/v0 |1 |10.0.14.1:8483 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |multicloud-vio |v0 |/api/multicloud-vio/v0 |1 |10.0.14.1:9001 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |nokia-vnfm-driver |v1 |/api/nokiavnfmdriver/v1 |1 |10.0.14.1:9006 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |nokiavnfmdriver |v1 |/api/nokiavnfmdriver/v1 |1 |10.0.14.1:9005 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |nslcm |v1 |/api/nslcm/v1 |1 |10.0.14.1:9004 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |policy-pdp |v1 |/pdp |1 |172.17.0.27:8486 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |policy-pdp-deprecated |v1 |/pdp |1 |10.0.14.1:8485 |false |/pdp | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |portal |v2 |/ |1 |172.17.0.20:8403 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |resmgr |v1 |/api/resmgr/v1 |1 |10.0.14.1:8403 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |sdc |v1 |/sdc/v1 |1 |10.0.6.1:8081 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |sdc-deprecated |v1 |/sdc/v1 |1 |10.0.6.1:8081 |false |/sdc/v1 | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |sdnc |v1 |/restconf |1 |10.0.9.1:8989 |false |/restconf | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |so |v1 |/ecomp/mso/infra |1 |10.0.14.1:8480 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |so-deprecated |v1 |/ecomp/mso/infra |1 |10.0.3.1:8080 |false |/ecomp/mso/infra | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |usecase-ui |v1 |/usecase-ui |1 |10.0.3.1:8080 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |usecaseui |v1 |/api/usecaseui/server/v1 |1 |10.0.7.1:8282 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |usecaseui-gui |v1 |/iui/usecaseui |1 |10.0.5.1:8080 |false |/iui/usecaseui | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |vnflcm |v1 |/api/vnflcm/v1 |1 |10.0.5.1:8080 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |vnfmgr |v1 |/api/vnfmgr/v1 |1 |172.17.0.11:8080 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |vnfres |v1 |/api/vnfres/v1 |1 |10.0.14.1:8901 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |workflow |v1 |/api/workflow/v1 |1 |10.0.14.1:8900 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |ztesdncdriver |v1 |/api/ztesdncdriver/v1 |1 |10.0.14.1:8801 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - |ztevmanagerdriver |v1 |/api/ztevmanagerdriver/v1 |1 |172.17.0.22:8801 |false | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |172.17.0.23:8803 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |10.0.14.1:8803 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |172.17.0.24:8802 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |10.0.14.1:8802 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |10.0.14.1:8805 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |172.17.0.25:8411 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |10.0.14.1:8411 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |10.0.14.1:8410 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - | | | | |172.17.0.26:8410 | | | - +--------------------------------------------+----------+--------------------------------------+--------+------------------+------------+--------------------------------------+ - -microservice-show ------------------ - -input:: - - --service-name test --service-version v1 --long - -output:: - - +------------+----------------+ - |property |value | - +------------+----------------+ - |name |test | - +------------+----------------+ - |version |v1 | - +------------+----------------+ - |url |/test | - +------------+----------------+ - |status |1 | - +------------+----------------+ - |nodes |10.0.0.1:8080 | - +------------+----------------+ - |enable-ssl |false | - +------------+----------------+ - |path |/test | - +------------+----------------+ - -microservice-delete -------------------- - -input:: - - --service-name test --service-version v1 --host-url http://192.168.17.23:80 --node-ip 23.14.15.156 --node-port 80 - - -vlm-feature-group-list ----------------------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0 - -output:: - - +----------------------------------+--------------+ - |ID |name | - +----------------------------------+--------------+ - |3a2fb75b52a54e9c8093e7c154210f9e |kanag-cli-fg | - +----------------------------------+--------------+ - -vlm-submit ----------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 1.1 - - -vlm-revert ----------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 0.1 - - -vlm-entitlement-pool-list -------------------------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0 - -output:: - - +----------------------------------+--------------------------+ - |ID |name | - +----------------------------------+--------------------------+ - |dae0a02f2173444e82bfa765601abcc9 |797153a1-d8f6-4eb0-abfc | - +----------------------------------+--------------------------+ - |aa61080fd965455ba5edbf60f4e375ef |kanag-cli-ep | - +----------------------------------+--------------------------+ - -vlm-checkout ------------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 0.1 - - -vlm-aggreement-create ---------------------- - -input:: - - --name kanag-cli-la --description kanag cli la --vlm-feature-group-id 3a2fb75b52a54e9c8093e7c154210f9e --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 1.1 - -output:: - - +----------+----------------------------------+ - |property |value | - +----------+----------------------------------+ - |ID |77e151d0503b45ecb7e40f5f5f1a887e | - +----------+----------------------------------+ - -vlm-key-group-create --------------------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --name kanag-cli-kg --description Kanag CLI key group -d --vlm-version 0.1 - -output:: - - |property |value | - +----------+----------------------------------+ - |ID |c37a1f205f444161a573f55dfec5f170 | - +----------+----------------------------------+ - -vlm-feature-group-create ------------------------- - -input:: - - --name kanag-cli-fg --description Kanag cli feature group --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 0.1 --vlm-key-group-id c37a1f205f444161a573f55dfec5f170 --vlm-entitle-pool-id aa61080fd965455ba5edbf60f4e375ef --part-number 123455 --manufacture-reference-number mkr123456 - -output:: - - +----------+----------------------------------+ - |property |value | - +----------+----------------------------------+ - |ID |3a2fb75b52a54e9c8093e7c154210f9e | - +----------+----------------------------------+ - -vlm-create ----------- - -input:: - - --vendor-name kanag-cli --description First License created from CLI - -output:: - - +----------+----------------------------------+ - |property |value | - +----------+----------------------------------+ - |ID |cf2d907d998e44698ce3b4cded5f66a7 | - +----------+----------------------------------+ - -vlm-entitlement-pool-create ---------------------------- - -input:: - - --name kanag-cli-ep --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --description kanag vlm ep --manufacture-reference-number mkr123456 -d --vlm-version 0.1 - -output:: - - +----------+----------------------------------+ - |property |value | - +----------+----------------------------------+ - |ID |aa61080fd965455ba5edbf60f4e375ef | - +----------+----------------------------------+ - -vlm-checkin ------------ - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 1.1 - - -vlm-key-group-list ------------------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0 - -output:: - - +----------------------------------+----------------------+ - |ID |name | - +----------------------------------+----------------------+ - |c37a1f205f444161a573f55dfec5f170 |kanag-cli-kg | - +----------------------------------+----------------------+ - |f0a684fa680b44979edee03fcc12ca85 |kanag-cli-key-group | - +----------------------------------+----------------------+ - -vlm-aggreement-list -------------------- - -input:: - - --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-version 2.0 - -output:: - - +----------------------------------+--------------+ - |ID |name | - +----------------------------------+--------------+ - |1e2edfccaca847f896070d0fac26667a |sf | - +----------------------------------+--------------+ - |77e151d0503b45ecb7e40f5f5f1a887e |kanag-cli-la | - +----------------------------------+--------------+ - -vlm-list --------- - -input:: - - --long - -output:: - - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |id |vendor-name |vlm-version |status |description | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |b5ea95a60e3b483da03d0911968cd778 |ciLicensef008e06a |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |84352b5d014c4d5382ce856d7597aebf |ciLicense5c11752c |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |8e13a8b2e1f34374ad578edc9c912f11 |ciLicenseaf880546 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |9f7053ae1aa04b8c9fa3d991f944a49b |ciLicensecce293bb |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |3f47950121bf4e31a058b4870020bc2f |ciLicense7d28e221 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |6fc132eca87d4e49b56357b9d83843a5 |ciLicense02ddba7e |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |0094601590ec4e709e560e928c44232a |ciLicense9acc959f |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |8f82813eb6304957911955e077d9be6f |ciLicensee5394ee2 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |b620898b5e5e4231a30a2ccecd39927e |ciLicense3eed3665 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |12cce4998b874d5e8096070f9c5d7395 |ciLicense372060ea |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |78fd596a39534d51953e867adaef78f6 |ciLicense36e962a4 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |651180d666c54887880b673884e03481 |ciLicensef9a1b52b |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |dd10e18e3af54234a20897ad65bfa311 |ciLicense76f62092 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |cf2d907d998e44698ce3b4cded5f66a7 |kanag-cli |2.0 |Final |First License created from CLI | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |144497a1b7924e0fa73004573730e1b8 |Test |0.1 |Locked |test | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |9af398f516da4e63b4ec8d344866533b |4718de22-00d3-4607-b666 |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |1173c7be5fea4db799b1a5ef9512e57e |Kanag |4.0 |Final |Kanagaraj M @ HTIPL | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |fc0fdcc825a54ca3b08e40f473b72d05 |test-vendor |1.0 |Final |test | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |b66c5e1b4af3432ca2f6cd05adf72340 |0138a2e2-52bf-4f0b-81cd |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |34c2c72e992742e3b7ceb78bfcd21ebb |48fa02ef-e79b-4707-895e |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |4bbd11c581ce4bb187a0a37131e5bb60 |1e5d1422-1f5f-42fe-a98e |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |1329476d73014587839fd3ede08c3103 |3029be5e-9135-4083-bd2e |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |2ca684a9805b40f9993239e77b82fb52 |c6ba2ef6-fe82-4f32-ad50 |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |1a49df7b78654777a71f64f2c6c2468f |01eb54a1-f1ff-41a2-aafc |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |5e571e8a25c8404da04f2a0ec179f576 |a920b10d-c516-4380-835a |1.0 |Final |vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |4b1e1efd8bb944bdbc0c3e74a9402967 |ciLicense7d8bbcab |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |816c04fd4ee849f2b80435e0944189fa |ciLicense09c55d35 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |9408208f5b6d4eb997dff1b901f1fb95 |ciLicense6bfd9421 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |eda4e9d1cae14cad95befc1728629574 |ciLicense81acf730 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |022140c2dc4e40bbae096aa1fb5cfbe9 |ciLicensef3f5a4fa |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |19f92b345cae423ab4ea6c5527d55ef6 |ciLicense9fddd8db |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |492d9259fc3e493d8fa6afd488054508 |ciLicense9a46fd22 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |a5da3e50ed72483fbfb134bac84b31f6 |ciLicensed955b6d7 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - |9ff65b0b943141a7b99481bbcaedc294 |ciLicensef21d8db3 |1.0 |Final |new vendor license model | - +----------------------------------+--------------------------+--------------+--------+--------------------------------+ - -vsp-show --------- - -input:: - - --vsp-id a8cd007fa101470e98516cd4549c568f --vsp-version 1.0 --long - -output:: - - +--------------+----------------------------------+ - |property |value | - +--------------+----------------------------------+ - |name |847cb26a-59a6-475a-94dd | - +--------------+----------------------------------+ - |ID |a8cd007fa101470e98516cd4549c568f | - +--------------+----------------------------------+ - |description |vendor software product | - +--------------+----------------------------------+ - |vendor-name |01eb54a1-f1ff-41a2-aafc | - +--------------+----------------------------------+ - |vendor-id |1a49df7b78654777a71f64f2c6c2468f | - +--------------+----------------------------------+ - |version |1.0 | - +--------------+----------------------------------+ - |status |Final | - +--------------+----------------------------------+ - |license-id |99e3783033de443db69d05996341e28d | - +--------------+----------------------------------+ - -vsp-checkin ------------ - -input:: - - --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1 - - -vsp-submit ----------- - -input:: - - --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1 - - -vsp-create ----------- - -input:: - - --vsp-name kanag-cli-VLB --vsp-description VLB created from CLI --vlm-agreement-id 77e151d0503b45ecb7e40f5f5f1a887e --vlm-version 2.0 --vlm-feature-group-id 3a2fb75b52a54e9c8093e7c154210f9e --vlm-id cf2d907d998e44698ce3b4cded5f66a7 --vlm-vendor Kanag-cli - -output:: - - +----------+----------------------------------+ - |property |value | - +----------+----------------------------------+ - |ID |f19cad8343794e93acb9cda2e4126281 | - +----------+----------------------------------+ - -vsp-list --------- - -output:: - - +----------------------------------+----------------------------------------------------+----------+------------+ - |ID |name |version |status | - +----------------------------------+----------------------------------------------------+----------+------------+ - |f19cad8343794e93acb9cda2e4126281 |kanag-cli-VLB |2.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |ff5bba2672a44654b186d70cf6bc9d95 |kanagVLB |0.1 |Locked | - +----------------------------------+----------------------------------------------------+----------+------------+ - |aa1f969cf1ae4897aed5fe08d4d19a5a |ciVFOnboarded-vCSCF_aligned-08dc1256 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |f22e285e6b354033bd9a2c1cf9268a6e |ciVFOnboarded-Huawei_vMME-2b29f653 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |3430c70e504c45d59cd7ccb4a388f26d |ciVFOnboarded-Huawei_vPCRF_aligned_fixed-51f1da14 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |c1ec9ea4fbd240cd9e69070a7ac17ee8 |ciVFOnboarded-vSBC_aligned-7260da5f |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |4668d80cbca64beb98423c924b35d3ac |ciVFOnboarded-Huawei_vHSS-79402346 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |10e8667c8b3d4e86a406e806430b989e |ciVFOnboarded-vLB-6265cbc3 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |9de86126015f4349a41e5a5f5e3eacf4 |ciVFOnboarded-base_vfw-199667fb |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |9641f81b61504fa8af6885818b1ee34b |ciVFOnboarded-vgmux-a195f793 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |dea92da0ad90419c8f437222680a2333 |ciVFOnboarded-vgw-abaa9d6d |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |9e4654364fe04d9ebe2a2485d67d6676 |ciVFOnboarded-infra-fceb5908 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |93b5df6c2f3d4a7dae362b111b0ed047 |ciVFOnboarded-vbrgemu-bcfb002c |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |9c9a9000fc714e9d8a6baf495418ab96 |ciVFOnboarded-base_vvg-07839bb9 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |63898b542cdd46b6b15ac771abda86cb |ciVFOnboarded-vbng-008f4205 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |5ca119e2326045d1857ae3f04a816434 |kanag-cli-vfw |0.2 |Available | - +----------------------------------+----------------------------------------------------+----------+------------+ - |e65baf44883e4868ba96f9faed9ba97a |600a2ebf-1f94-4a4c-b18d |0.3 |Available | - +----------------------------------+----------------------------------------------------+----------+------------+ - |61bad2139ee742cf891ca6ecc5f39972 |test-vsp-123 |0.2 |Locked | - +----------------------------------+----------------------------------------------------+----------+------------+ - |77527347f94947589431cb7c1938da2e |05a0dd09-c3d0-4534-93ab |0.3 |Locked | - +----------------------------------+----------------------------------------------------+----------+------------+ - |8f08a17b9a4c4538b51a3064468baec0 |test-vsp |0.3 |Locked | - +----------------------------------+----------------------------------------------------+----------+------------+ - |b1caa2ec31ba4b738cbe5aab362b35aa |Kanag-VSP |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |03774c7cfcac4054bdab346142214533 |ef35d3c9-a8c6-457c-a115 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |54bc478b7a9847db82156edad5d1f79f |5d11dda4-fb32-4df6-86eb |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |5f5121f701df4fe588c966002a342fdf |136ab241-88ff-443a-88e8 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |0cefd6ef5ad84d2995d66d0a24d2e92e |8fd2e5c8-981d-4a14-ba77 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |c212437049004e74b4ef0afb25ba41b8 |74361ede-ef8c-43f1-9d82 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |a8cd007fa101470e98516cd4549c568f |847cb26a-59a6-475a-94dd |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |59c07e069c7642e9afbc6117965a6c2f |ciVFOnboarded-vLB-3fbbe6d0 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |65b7b4b564f34b5689b3786386600e5a |ciVFOnboarded-vCSCF_aligned-a5e83f2c |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |a75d123c802e465db80ae7c8e5a0b4d0 |ciVFOnboarded-base_vfw-548fb561 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |1f33fcc682cb484a952b96326f549aff |ciVFOnboarded-vgmux-5e7cab8c |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |bafdf7192a73436588044296aa225ed4 |ciVFOnboarded-vgw-8b2ea35e |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |c34167a92e5c4c3392badd5a2da2a267 |ciVFOnboarded-infra-0766a3d1 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |b160564a4b754a9e8a19d2fa924f3f96 |ciVFOnboarded-vbrgemu-806fb59e |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |c5ccbc48510240318b698a4f1e1cb620 |ciVFOnboarded-vbng-c9fa1c07 |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - |34ac9b3e990f4ce093d2dd1b8e0f73d6 |ciVFOnboarded-base_vvg-e8b8c6ca |1.0 |Final | - +----------------------------------+----------------------------------------------------+----------+------------+ - -vsp-upload ----------- - -input:: - - --vsp-id E563CB23A6BE49AF9A84CF579DAFB929 --vsp-file /home/user/vFW.zip - - -vsp-package ------------ - -input:: - - --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.2 - - -vsp-checkout ------------- - -input:: - - --onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929 - - -vsp-validate ------------- - -input:: - - --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1 - -output:: - - +----------+----------------------------------------------------+ - |property |value | - +----------+----------------------------------------------------+ - |status |Success | - +----------+----------------------------------------------------+ - |errors |{dnsscaling.yaml=[{"level":"WARNING","message":"WA | - | |RNING: Port 'Fixed_IPS' Parameter Name not | - | |aligned with Guidelines, Parameter Name | - | |[vlb_private_net_id], Resource ID | - | |[vdns_2_private_0_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 [onap_private_subnet_id], Resource | - | |ID [vdns_2_private_1_port]. As a result, VF\/VFC | - | |Profile may miss this information"},{"level":"WARN | - | |ING","message":"WARNING: Nova Server naming | - | |convention in image, flavor and name properties | - | |is not consistent, Resource ID [vdns_2]"}], base_v | - | |lb.yaml=[{"level":"WARNING","message":"WARNING: | - | |Port 'Fixed_IPS' Parameter Name not aligned with | - | |Guidelines, Parameter Name | - | |[onap_private_subnet_id], Resource ID | - | |[vlb_private_1_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 [onap_private_subnet_id], Resource | - | |ID [vdns_private_1_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 [onap_private_subnet_id], Resource | - | |ID [vpg_private_1_port]. As a result, VF\/VFC | - | |Profile may miss this information"},{"level":"WARN | - | |ING","message":"WARNING: A resource is connected | - | |twice to the same network role, Network Role | - | |[vdns_0], Resource ID [onap_private]"},{"level":"W | - | |ARNING","message":"WARNING: Nova Server naming | - | |convention in image, flavor and name properties | - | |is not consistent, Resource ID | - | |[vdns_0]"},{"level":"WARNING","message":"WARNING: | - | |Missing Nova Server Metadata property, Resource | - | |ID | - | |[vpg_0]"},{"level":"WARNING","message":"WARNING: | - | |A resource is connected twice to the same network | - | |role, Network Role [vpg_0], Resource ID [onap_priv | - | |ate]"},{"level":"WARNING","message":"WARNING: | - | |Nova Server naming convention in image, flavor | - | |and name properties is not consistent, Resource | - | |ID [vpg_0]"}]} | - +----------+----------------------------------------------------+ - -vsp-revert ----------- - -input:: - - --vsp-id e65baf44883e4868ba96f9faed9ba97a --vsp-version 0.2 - - -vsp-checkout ------------- - -input:: - - --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 0.1 - - -service-model-checkin ---------------------- - -input:: - - --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 - - -service-model-certify-request ------------------------------ - -input:: - - --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 - - -service2vf-model-list ---------------------- - -input:: - - --service-model-id 0f4203a8-a314-47bb-9a7d-28157652cec4 - -output:: - - +--------------------------------------+--------------------------+--------------------------------------+------------+ - |vf-uuid |vf-name |vf-customization-uuid |vf-version | - +--------------------------------------+--------------------------+--------------------------------------+------------+ - |047b9ff8-2414-45b7-b753-26342369f160 |847cb26a-59a6-475a-94dd |cf893f5a-1bb1-4e32-a92b-2456e12178f8 |1.0 | - +--------------------------------------+--------------------------+--------------------------------------+------------+ - -service-model-certify-start ---------------------------- - -input:: - - --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 - - -service-model-add-vf --------------------- - -input:: - - --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 --vf-id 828be6cf-c11b-4759-ac37-b1b79f86a4b4 --vf-name kanag-cli-VLB --vf-version 1.0 -d - -output:: - - +----------+----------------------------------------------------+ - |property |value | - +----------+----------------------------------------------------+ - |ID |7b427dbf-685b-4ba9-8838-a9b3b3c8e584.828be6cf-c11b | - | |-4759-ac37-b1b79f86a4b4.kanagclivlb0 | - +----------+----------------------------------------------------+ - -service-model-certify-complete ------------------------------- - -input:: - - --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 - - -service-model-list ------------------- - -output:: - - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |uuid |invariant-uuid |name |version |status |distribution-status | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |0f4203a8-a314-47bb-9a7d-28157652cec4 |1de901ed-17af-4b03-bc1f-41659cfa27cb |demoVLB |1.0 |CERTIFIED |DISTRIBUTED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |5ca7c6cb-78dc-4cf5-ab02-52c9ffb8c884 |9288833a-5dd6-4f9d-84ff-b34de06011c6 |kanagVLB |0.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |75caf010-9f14-424d-93c4-9f8fe8be7970 |b51013b7-e2bb-4abb-8f45-8e32113264b3 |demoVFW |1.0 |CERTIFIED |DISTRIBUTION_APPROVED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |fa9d6078-2d59-4c03-b97e-b57436680513 |5790901b-c109-4fc3-947a-ab71aa064251 |vLB-kanag |0.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |ba5a19b1-3219-4f30-bfd3-3b2f700c0157 |c4425f23-fc9a-4cbf-a3b7-12e69054806b |kanag-cli-VLB |1.0 |CERTIFIED |DISTRIBUTION_APPROVED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |5b054e09-9cc3-49bd-8962-e014465e295b |3a6a08c8-9bbe-4650-a1c5-687fb1012b98 |Kanag-vFW-Service |1.0 |CERTIFIED |DISTRIBUTED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |c9aa6a9c-dddd-4019-8f7b-70c09de68e96 |dd04c1c2-beb2-4b6c-997d-c94fae54fb57 |demoVCPE |1.0 |CERTIFIED |DISTRIBUTED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |f2a9f7e3-ead9-4585-8f5f-665acc6cff1c |b51013b7-e2bb-4abb-8f45-8e32113264b3 |demoVFW |1.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - |d2df45ed-89c1-4d23-a605-bae03ee1f14f |566c6ab2-f32e-4022-acd3-cf2bf17ae6fc |a6484bba-671f-49c2-92fc |0.1 |NOT_CERTIFIED_CHECKOUT |DISTRIBUTION_NOT_APPROVED | - +--------------------------------------+--------------------------------------+--------------------------+----------+------------------------+----------------------------+ - -service-model-create --------------------- - -input:: - - --name kanag-cli-VLB --description VLB created from CLI --project-code kanag-123456 - -output:: - - +----------+--------------------------------------+ - |property |value | - +----------+--------------------------------------+ - |ID |7b427dbf-685b-4ba9-8838-a9b3b3c8e584 | - +----------+--------------------------------------+ - -service-model-distribute ------------------------- - -input:: - - --service-model-id 7b427dbf-685b-4ba9-8838-a9b3b3c8e584 - - -vf2vfmodule-model-list ----------------------- - -input:: - - --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff - -output:: - - +----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+ - |vsp-uuid |vsp-version |module-uuid |module-invariant-uuid |module-name |module-version | - +----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+ - |f19cad8343794e93acb9cda2e4126281 |2.0 |f2fbc712-7adc-4a62-aa24-485ae076bdc7 |a610a6b9-adfb-4f9f-ada2-c054194092ad |KanagCliVlb..base_vlb..module-0 |1 | - +----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+ - | | |c420e361-900a-4705-9329-868e7fa6d9a5 |cde91552-bdb8-4cae-b4c2-c63069d77fe1 |KanagCliVlb..dnsscaling..module-1 |1 | - +----------------------------------+--------------+--------------------------------------+--------------------------------------+------------------------------------+----------------+ - -vf-model-certify-request ------------------------- - -input:: - - --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff - - -vf-model-create ---------------- - -input:: - - --name kanag-cli-VLB --description VF created from CLI --vendor-name Kanag-cli --vsp-id f19cad8343794e93acb9cda2e4126281 --vsp-version 2.0 - -output:: - - +----------+--------------------------------------+ - |property |value | - +----------+--------------------------------------+ - |ID |66269482-0b27-40e3-9c4d-6a26fb67d9ff | - +----------+--------------------------------------+ - -vf-model-certify-start ----------------------- - -input:: - - --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff - - -vf-model-list -------------- - -output:: - - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |uuid |uniqueid |invariant-uuid |name |version |status | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |9859e26c-2af2-427b-a837-04a47996d52a |dac5b070-e53b-44b3-8034-46c9cf797de3 |d3d50449-a81a-497f-97b3-4eb770ea67e7 |Kanag-VSP |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |8b1f63f3-e0cc-4c27-8903-fafe2f25bfbe |047b9ff8-2414-45b7-b753-26342369f160 |cc34cd54-dd7c-44cd-8847-f9577c6f1a49 |847cb26a-59a6-475a-94dd |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |46c89121-b37f-4192-8841-25c93165b843 |828be6cf-c11b-4759-ac37-b1b79f86a4b4 |2d455337-57eb-4edf-a8b9-9f87fd85bc0e |kanag-cli-VLB |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |c763b7f8-6bc3-42a2-afa7-04157f79b629 |6e29f979-6f36-4c0d-8605-e59da8d62cb7 |1bd7f899-01dc-4d7f-97d8-f38ba6b40dd9 |74361ede-ef8c-43f1-9d82 |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |94d78d38-d5ae-4a92-9d9e-fb79fc55195a |3a3fb778-1c0e-41a1-9a04-f7ddaaf93d73 |414da4ea-e482-4ed2-9941-bd90108376fa |136ab241-88ff-443a-88e8 |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |3575fbff-614c-4418-93c7-133dc4fc59b6 |f4be1629-c9a1-4f32-8f34-11eddabffc13 |7fd3788f-a065-4270-bb95-852eae3a94b3 |ef35d3c9-a8c6-457c-a115 |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |87c5f870-809f-4488-aae5-80ef0fd9e085 |372e2c66-ee59-4488-a6a6-546c28b3a151 |244b380b-acf1-4545-8d35-d6d01bc32fd6 |5d11dda4-fb32-4df6-86eb |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - |d49dd5ee-bc53-44d7-a067-e4cba9a3be1a |23018f7f-fbce-479e-a77b-6b98ebf03266 |6bc22345-395d-4358-8954-45963761f968 |8fd2e5c8-981d-4a14-ba77 |1.0 |CERTIFIED | - +--------------------------------------+--------------------------------------+--------------------------------------+--------------------------+----------+------------+ - -vf-model-certify-complete -------------------------- - -input:: - - --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff - - -vf-model-checkin ----------------- - -input:: - - --vf-id 66269482-0b27-40e3-9c4d-6a26fb67d9ff - - -service-create --------------- - -input:: - - --cloud-region RegionOne --tenant-id onap --model-invariant-id 1de901ed-17af-4b03-bc1f-41659cfa27cb --model-uuid ace39141-09ec-4068-b06d-ac6b23bdc6e0 --model-name demoVLB --model-version 1.0 -c Demonstration --instance-name sample-service-onap-cli-13 --service-type vLB - -output:: - - +--------------+--------------------------------------+ - |property |value | - +--------------+--------------------------------------+ - |service-id |957949b4-f857-497c-81b0-832ce7bb9434 | - +--------------+--------------------------------------+ - -vf-create ---------- - -input:: - - --cloud-region RegionOne --tenant-id onap --product-family vLB --instance-name vlb-cli-sample-11 --service-instance-id 2ad87511-4289-4bd7-ab0b-0b29d3d4c8ee --vf-model-invariant-id cc34cd54-dd7c-44cd-8847-f9577c6f1a49 --vf-model-uuid 8b1f63f3-e0cc-4c27-8903-fafe2f25bfbe --vf-model-name 847cb26a-59a6-475a-94dd --vf-model-version 1.0 --vf-model-customization-id cf893f5a-1bb1-4e32-a92b-2456e12178f8 --service-model-invariant-id 1de901ed-17af-4b03-bc1f-41659cfa27cb --service-model-uuid ace39141-09ec-4068-b06d-ac6b23bdc6e0 --service-model-name demoVLB --service-model-version 1.0 -m http://192.168.17.121:8080 -u InfraPortalClient -p password1$ - -output:: - - +--------------+--------------------------------------+ - |property |value | - +--------------+--------------------------------------+ - |vf-id |048c2c4a-ee30-41a1-bb55-c4e7fe1a9a0d | - +--------------+--------------------------------------+ - - - diff --git a/docs/conf.py b/docs/conf.py index 70937d74..372eadce 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ project = "onap" -release = "master" -version = "master" +release = "montreal" +version = "montreal" author = "Open Network Automation Platform" # yamllint disable-line rule:line-length @@ -30,7 +30,7 @@ extensions = [ # Change to {releasename} after you have created the new 'doc' branch. # -branch = 'latest' +branch = 'montreal' intersphinx_mapping = {} doc_url = 'https://docs.onap.org/projects' diff --git a/docs/console.rst b/docs/console.rst index acde93e8..ccff83c9 100644 --- a/docs/console.rst +++ b/docs/console.rst @@ -14,7 +14,7 @@ After installation, CLI can be used in following form: Linux Command Shell ------------------- It is available when user has access to the server where CLI is installed using zip or docker container. -In this mode, user can use CLI in scripting mode or interactive mode as mentioned in :ref:`user_guide` +In this mode, user can use CLI in scripting mode or interactive mode as mentioned in the User Guide. .. image:: images/portal-cli-shell.png diff --git a/docs/open_cli_schema_version_1_0.rst b/docs/open_cli_schema_version_1_0.rst index 634052ef..d927118d 100644 --- a/docs/open_cli_schema_version_1_0.rst +++ b/docs/open_cli_schema_version_1_0.rst @@ -2,6 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 Huawei Technologies Co., Ltd. +:orphan: + .. _open_cli_schema_version_1_0: Open Command Line Interface (CLI) Schema Version (OCS) 1.0 @@ -67,9 +69,10 @@ a line or a paragraph as given example here. use the command *service-list* info -------- +---- + product -~~~~~~~~ +~~~~~~~ *product* entry allows to tag the command template with the software product name and version, for which command is implemented and is recommended to use the following format: @@ -89,7 +92,7 @@ the following format: parameters ---------- +---------- Every command has set of arguments to provide the input values and *parameters* section allows to add the required arguments details such as name, description, etc as list of entries. @@ -702,6 +705,7 @@ value. So the none auth is defined by: section default_parameters -------------------- + request ~~~~~~~ *request* section captures all HTTP request information as: diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 19c04786..22412c9a 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -147,14 +147,14 @@ Version: 2.0.5 CLI code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The CLI open Critical security vulnerabilities and their risk assessment have been -documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45298770>`_. +documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45298770>`__. Quick Links: - - `CLI project page <https://wiki.onap.org/display/DW/Command+Line+Interface+Project>`_ + - `CLI project page <https://wiki.onap.org/display/DW/Command+Line+Interface+Project>`__ - - `Passing Badge information for CLI <https://bestpractices.coreinfrastructure.org/en/projects/1540>`_ + - `Passing Badge information for CLI <https://bestpractices.coreinfrastructure.org/en/projects/1540>`__ - - `Project Vulnerability Review Table for CLI <https://wiki.onap.org/pages/viewpage.action?pageId=45298770>`_ + - `Project Vulnerability Review Table for CLI <https://wiki.onap.org/pages/viewpage.action?pageId=45298770>`__ Version: 2.0.0 @@ -180,8 +180,8 @@ by using CLI as portal does not support. In addition, it made following changes to OCS 1.0 -* http profile is enabled with service section to capture micro-service catalog and auth information -and body section could be customized using context. +* http profile is enabled with service section to capture micro-service catalog + and auth information and body section could be customized using context. * New default parameters verify and context are added. @@ -202,14 +202,14 @@ and body section could be customized using context. CLI code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The CLI open Critical security vulnerabilities and their risk assessment have been -documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377287>`_. +documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377287>`__. Quick Links: - - `CLI project page <https://wiki.onap.org/display/DW/Command+Line+Interface+Project>`_ + - `CLI project page <https://wiki.onap.org/display/DW/Command+Line+Interface+Project>`__ - - `Passing Badge information for CLI <https://bestpractices.coreinfrastructure.org/en/projects/1540>`_ + - `Passing Badge information for CLI <https://bestpractices.coreinfrastructure.org/en/projects/1540>`__ - - `Project Vulnerability Review Table for CLI <https://wiki.onap.org/pages/viewpage.action?pageId=28377287>`_ + - `Project Vulnerability Review Table for CLI <https://wiki.onap.org/pages/viewpage.action?pageId=28377287>`__ Version: 1.1.0 -------------- diff --git a/docs/tox.ini b/docs/tox.ini index 4bbc6403..bf8bc4ab 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -8,11 +8,11 @@ basepython = python3.8 deps = -r{toxinidir}/requirements-docs.txt -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt - -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=montreal commands = sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html echo "Generated docs available in {toxinidir}/_build/html" -whitelist_externals = +allowlist_externals = echo git sh @@ -22,13 +22,13 @@ basepython = python3.8 #deps = -r{toxinidir}/requirements-docs.txt commands = echo "Link Checking not enforced" #commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck -whitelist_externals = echo +allowlist_externals = echo [testenv:docs-spellcheck] basepython = python3.8 deps = -r{toxinidir}/requirements-docs.txt -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt - -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=montreal commands = sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck diff --git a/docs/user_guide.rst b/docs/user_guide.rst index d267c10e..9f39966d 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -148,7 +148,6 @@ Following document provides the samples for every commands supported. :maxdepth: 1 cmd_sample.rst - cmd_sample_onap_amsterdam.rst End to end service creation tutorial ------------------------------------ |