| Table of Contents |
|---|
Introduction
ONAP CLI helps to operate the ONAP functionalities from the Linux Operating system consoles. And this page provides the details of the minimum-required-functionalities for release B
As part of this release, CLI will focus on following functionalities, It will continue the support for those functionalities supported in Amsterdam release and in addition, it aims to cover VNF
and closed-loop support, PNF support.
Model: Open Command Spec (OCS)
in Beijing release, following updates are made in OCS:
- context param is provided to make the communication channel between commands , which can share the run-time details from one command to another
- info is provided for CLI author to provide details about product, service and versions.
- service is moved under http profile
- snmp profile is added
- restconf profile is planned
Service Management
Helps to check the list of ONAP service deployed on a given setup and retrieve the health status.
Discovery
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Report registered services | Reports the registered service details such as name, type, version, Root context URI. In addition, it provides deployment deatils like host/ip, port. | MSB | Amsterdam Beijing |
| 2 | Register a service | Helps to register a service into MSB, when that service is started. | MSB | Amsterdam Beijing |
| 3 | Unregister a service | Helps to unregister a service into MSB, after that service is stopped. | MSB | Amsterdam Beijing |
Health Check
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Report health of registered services | Reports each service whether its up/down. | MSBAmsterdam | Beijing |
| 2 | Enable/Disable a registered services | Helps to disable/enable a registered services for various situations such as maintenance. | MSB | Amsterdam Beijing |
External Resource Management
Helps to on-board the external system such as VIM, VNFM, EMS and SDNC and retrieve the current state of these resources.
VIM management
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Register cloud | Helps to register a cloud such as OpenStack, VMWare, etc | A&AI/ESR | Amsterdam Beijing |
| 2 | Un-register cloud | Helps to un-register the cloud from ONAP | A&AI/ESR | Amsterdam Beijing |
| 3 | Report registered clouds | Reports the complete details of cloud including endpoint, version username, tenant, Region, etc. | A&AI/ESR | Amsterdam Beijing |
VNFM management
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Register VNFM | Helps to register a cloud such as vendor's VNFM | A&AI/ESR | Amsterdam Beijing |
| 2 | Un-register VNFM | Helps to un-register the VNFM from ONAP | A&AI/ESR | Amsterdam Beijing |
| 3 | Report registered VNFMs | Reports the complete details of VNFM including username, endpoint, etc. | A&AI/ESR | Amsterdam Beijing |
EMS management
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Register EMS | Helps to register a EMS such as Vendors EMS | A&AI/ESR | Amsterdam Beijing |
| 2 | Un-register EMS | Helps to un-register the EMS from ONAP | A&AI/ESR | Amsterdam Beijing |
| 3 | Report registered EMSs | Reports complete deatils of EMS including version, endpoint, etc | A&AI/ESR | Amsterdam Beijing |
PNF management
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Register PNF | Helps to register a PNFsuch as Vendors PNF | A&AI/ESR | Beijing |
| 2 | Un-register PNF | Helps to un-register the PNF from ONAP | A&AI/ESR | Beijing |
| 3 | Report registered PNF | Reports complete deatils of PNF including version, endpoint, etc | A&AI/ESR | Beijing |
| 4 | attach PNF | associate PNF with service instance, add appropriate link between PNF, interfaces and logical link | A&AI | Beijing |
Service Orchestration
Helps to deploy, instantiate and destroy a given services such as VoLTE and vCPE services
Service Life-cycle management
Deploy → Launch → Delete → Undeploy
...
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Create Service Type | Helps to create a service like type like vFw | AAI | Amsterdam Beijing |
| 2 | Deploy Service | Helps to deploy the service artifacts into various ONAP services. (like SDC distribute all the service artifacts) | SO | Amsterdam Beijing |
| 3 | Report deployed services | Reports the deployed services details | SO | Amsterdam Beijing |
| 4 | Launch Service | Helps to launch the deployed service | SO | Amsterdam Beijing |
| 5 | Report active services | Reports the services which are running/idel | SO | Amsterdam Beijing |
| 6 | Undeploy service | Helps to undeploy all the service artifacts from the ONAP services. | SO | Amsterdam Beijing |
| 7 | Remove service type | Helps to remove the service type from AAI | AAI | Amsterdam Beijing |
Closed loop Management
Helps to report the policy, alarm and analytics aspect of an given service in ONAP for auto-scaling and healing of them.
Policy management
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Report policies | Helps to retrieve the details of policies defined for a given service/VNF | Policy | Beijing |
Alarm management
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Report Alarms | Helps to retrieve the alarms generated for a given service/VNF. (Strech goal) | DCAE | Beijing |
Analytics management
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Report metrics | Helps to retrieve the collected metrics for a given service/VNF (Strech goal) | DCAE | Beijing |
Limitation
It does not support designing of the services as it involves studio. so its expected that design time artifact should be readily available for using the feature like service management.
Customer Management
Helps to manage the subscriber, who like to use the services provided by ONAP.
Customer management
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Add customer | Creates subscriber | A&AI | Amsterdam Beijing |
| 2 | Delete Customer | Removes subscriber from ONAP | A&AI | Amsterdam Beijing |
| 3 | Reports registered customer | Helps to find out the details of registered subscriber | A&AI | Amsterdam Beijing |
Subscription management
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Create Subscription | Subscribe a customer for a service type | A&AI | Amsterdam Beijing |
| 2 | Delete Subscription | Un-Subscribe a customer for a service type | A&AI | Amsterdam Beijing |
VSP Distribution
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Manage Catalog service | Helps to add, list and delete a catalog service | SDC | Amsterdam Beijing |
| 2 | Manage resource of catalog service | Helps to add, update and delete VNF packages of service | SDC | Amsterdam Beijing |
| 3 | Manage service certification | Certify/uncertify the given service | SDC | Amsterdam Beijing |
| 4 | Manage service distribution | Approve/Disapprove distribution of a service | SDC | Amsterdam Beijing |
Command management
Helps to discover/validate the installed ONAP Commands/schema
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Open CLI schema validation | ONAP CLI provides onap-cli-schema v1.0 for writing the YAML template for each command and this feature helps to validate such YAML template | CLI | Amsterdam Beijing |
| 2 | CLI Helper | Helps to find the details of all supported commands by CLI project | CLI | Amsterdam Beijing |
| 3 | Dynamic Command discovery | Helps to dynamically discover the installed ONAL CLI commands | CLI | Amsterdam Beijing |
Deployment support
Helps to discover/validate the installed ONAP Commands/schema
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Distribute CLI as docker container | Launch the CLI from OOM & demo using docker container | OOM / Integration /demo | Beijing |
| 2 | Distribute CLI from nexus | To install CLI manually, provides the required installer from onap nexus | CLI | Amsterdam Beijing |
| 3 | Access from ONAP portal | Provides the download option from ONAP portal Also enable CLI app as integral portal application | CLI/Portal | Amsterdam Beijing |
User Authentication support
Helps to login/logout user. (Based on other services supporting with AAF)
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | Login | Login a user (Strech goal) | AAF | Beijing |
| 2 | Logout | Logout current user (Strech goal) | AAF | Beijing |
VNF support
Helps to login/logout user.
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | SNMP | Provides unified CLI for supporting SNMP to VNF | VNF/APPC | Beijing |
| 2 | Restconf | Provides unified CLI for supporting Restconf to VNF. | VNF/APPC | Beijing |
| 3 | VES | Provides unified CLI for supporting VES to VNF. (Strech goal) | VNF | Beijing |
| 4 | Standardizing CLI | Bring up an standard CLI for VNF, which every VNF could adopt to provide (Strech goal) | CLI/VNF | Beijing |
PNF support
Helps to login/logout user.
on board PNF into ONAP
| Beijing |
S3P
Each of the feature defined above would be having the details of each command with following details
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | CII | Provide CII badging with 'passing' | CLI | Beijing |
| 2 | HTTPS | Enable CLI OCC with https | CLI | Beijing |
| 3 | Horizontal scaling | Validate Multiple simulatneous OCC session (with profile management) | CLI | Beijing |
| 4 | logging | Enable loggine for debugging purpose | CLI | Beijing |
CLI User management support
Helps to login/logout user.
| s.no | Feature | Description | Depends-on Project | Release |
|---|---|---|---|---|
| 1 | CLI user level support | In CLI, users want to provide access control to those who wants to provides rights to read, execute and author new CLI YAML. its kind of command center where Operators are looking for it like AT&T. (streach goal) | CLI | Beijing |