Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

One Command to command whole ONAP !
Model-driven CLI

Project Name:

  • Proposed name for the project: Portal
  • Proposed name for the repository: onap-cli

Project description:

  • Both carrier and enterprise customers prefer commands over GUI on many situations such as automation, CI, etc. so this project is launched to provide required Command-Line Interface(CLI) as commands to operate ONAP functionalities from Unix or windows shell.
  • Different type of Users like end-user, admin, operator could operate ONAP functionalities.

Scope:

  • Provide a Model driven framework to help ONAP community and ONAP end-user to develop the required commands 
    • By using YAML file and without writing any source code
    • By implementing plug-ins for specific commands
  • Mode
    • Provide direct command mode (useful in scripting based automation) like in CI, docker, etc
    • Provide interactive mode, where user login once and operate ONAP and exit
  • Provide consistent commands schematics across different ONAP functionalities. 
  • Provide an download option from the ONAP portal to download the CLI
  • Provide Docker container to luanch CLI out of the box. In addition provide daily build or release builds via Nexus

Architecture Alignment:

  • Dependencies
    • ONAP CLI uses REST API to communicate with ONAP, so it depends on the ONAP API documentation project
      • ONAP portal authendicationservice REST API
    • Different ONAP projects like SDC, VID, Policy, etc should provide list of functioanlities expose thru CLI
  • Integration project (CI & docker) would depends on this project ONAP CLI for automation

High Level Architecture of OPEN CLI Framework


Open CLI framework is developed in Open-O to create the CLI commands using YAML and above diagram shows the high level architecture of it.

Please find More details about this framework from Open-O wiki

Resources:

  • Primary Contact Person: kanagaraj.manickam@huawei.com
  • Kanagaraj Manickam, mkr1481, Huawei

Other Information:

Use the above information to create a key project facts section on your project page

Key Project Facts

Project Name:

  • JIRA project name: PORTAL
  • JIRA project prefix: ONAP CLI

Repo name: onap-cli
Lifecycle State: Copy from Open-O
Primary Contact: kanagaraj.manickam@huawei.com
Sub Project Lead:
mailing list tag onap-cli
Committers:

kanagaraj.manickam@huawei.com

 talasila@research.att.com


*Link to TSC approval: 
Link to approval of additional submitters:

  • No labels