One Command to command whole ONAP !
Model-driven CLI
This is a potential draft of a project proposal template. It is not final or to be used until the TSC approves it.
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
Architecture Alignment:
- Dependencies
- ONAP CLI uses REST API to communicate with ONAP, so it depends on the ONAP API documentation project
- ONAP portal authendication service REST API
- Different ONAP projects like SDC, VID, Policy, etc should provide list of functioanlities expose thru CLI
- ONAP CLI uses REST API to communicate with ONAP, so it depends on the ONAP API documentation project
- Integration project (CI & docker) would depends on this project ONAP CLI for automation
Resources:
- Primary Contact Person: kanagaraj.manickam@huawei.com
- Kanagaraj Manickam, mkr1481, Huawei
Other Information:
- OPEN-O CLI https://wiki.open-o.org/display/CLIEN/Open-O+CLI
- OPEN-O GERRIT: https://gerrit.open-o.org/r/client-cli
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:
*Link to TSC approval:
Link to approval of additional submitters: