Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Release A(mesterdam) |
| Project Lifecycle State | Incubation |
| Participating Company | Huawei, AT&T |
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, nexus to download the CLI
- Provide Docker container to luanch CLI out of the box.
Use Cases
Provide required ONAP Commands to operate the ONAP from Linux Operating system console & Docker.
Minimum Viable Product
Create the OPEN CLI framework and provide required Linux Console commands for ONAP 1.0 and docker environment
Functionalities
List the functionalities that this release is committing to deliver by providing a link to JIRA Epics and Stories. In the JIRA Priority field, specify the priority (either High, Medium, Low). The priority will be used in case de-scoping is required. Don't assign High priority to all functionalities.
Epics
Stories
Longer term roadmap
As CLI plays a major role in devops environment, in future, CLI will be extended to use in VNF boot scripts, ONAP components integrations, OOM and Integration projects to make the ONAP integration point smoother and easier.
Release Deliverable
| Deliverable Name | Deliverable Description |
|---|---|
| CLI Nexus zip archive | ZIP archive used to install the CLI manually |
| CLI docker container | Docker container to run the ONAP command and will integrate into demo environment |
| Documentation | Developer guide User guide Release notes Architecture open-cli-schema-1.0 specification |
Sub-Components
NIL
ONAP Dependencies
- AAF/Portal project
- for Authentication and authorization
- Integration project
- for creating the docker scripts,
- Integration scripts
- Jenkins and sonar integration
Architecture
High level architecture diagram
More details, please find in the attachment CLI architecture.pptx
API Incoming Dependencies
List the API this release is expecting from other releases.
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
| AAF/Portal user API | For user authentication and authorization, CLI uses AAF/Portal user API | Date for which the API is reviewed and agreed TBD : after discussion with respective team | TBD : after discussion with respective team | Link toward the detailed API description TBD : after discussion with respective team |
CLI Outgoing Dependencies
NOTE: This project delivers CLI and not API
CLI this release is delivering to other releases.
| API Name | CLI Description | CLI Definition Date | CLI Delivery date | CLI Definition link |
|---|---|---|---|---|
| To fill out by M2 | High level description of the CLI | M2 (as per the release plan) | M2 (as per the release plan) | Link toward the detailed CPI description |
Third Party Products Dependencies
| Name | Description | Version |
|---|---|---|
| Docker | Docker container for CLI | Aligned with existing Docker version of ONAP |
| Ubuntu | For running CLI manually | 14.04 / 16.04 |
Testing and Integration Plans
Provide a description of the testing activities (unit test, functional test, automation,...) that will be performed by the team within the scope of this release.
Describe the plan to integrate and test the release deliverables within the overall ONAP system.
Confirm that resources have been allocated to perform such activities.
Gaps
This section is used to document a limitation on a functionality or platform support. We are currently aware of this limitation and it will be delivered in a future Release.
List identified release gaps (if any), and its impact.
| Gaps identified | Impact |
|---|---|
| NIL | NIL |
Known Defects and Issues
Provide a link toward the list of all known project bugs.
Risks
List the risks identified for this release along with the plan to prevent the risk to occur (mitigation) and the plan of action in the case the risk would materialized (contingency).
| Risk identified | Mitigation Plan | Contingency Plan |
|---|---|---|
| AAF availability | CLI is depending on the AAF for user authorization as AAF is approved project. In the mean time, it would try to use Portal API for the same. | - |
Resources
Fill out the Resources Committed to the Release centralized page.
Release Milestone
The milestones are defined at the Release Level and all the supporting project agreed to comply with these dates.
Team Internal Milestone
This section is optional and may be used to document internal milestones within a project team or multiple project teams. For instance, in the case the team has made agreement with other team to deliver some artifacts on a certain date that are not in the release milestone, it is erecommended to provide these agreements and dates in this section.
It is not expected to have a detailed project plan.
| Date | Project | Deliverable |
|---|---|---|
| NIL | NIL | NIL |
Documentation, Training
- Highlight the team contributions to the specific document related to he project (Config guide, installation guide...).
- Highlight the team contributions to the overall Release Documentation and training asset
- High level list of documentation, training and tutorials necessary to understand the release capabilities, configuration and operation.
- Documentation includes items such as:
- Installation instructions
- Configuration instructions
- Developer guide
- End User guide
- Admin guide
- ...
Note
The Documentation project will provide the Documentation Tool Chain to edit, configure, store and publish all Documentation asset.
Other Information
Vendor Neutral
If this project is coming from an existing proprietary codebase, ensure that all proprietary trademarks, logos, product names, etc. have been removed. All ONAP deliverables must comply with this rule and be agnostic of any proprietary symbols.
Free and Open Source Software
FOSS activities are critical to the delivery of the whole ONAP initiative. The information may not be fully available at Release Planning, however to avoid late refactoring, it is critical to accomplish this task as early as possible.
List all third party Free and Open Source Software used within the release and provide License type (BSD, MIT, Apache, GNU GPL,... ).
In the case non Apache License are found inform immediately the TSC and the Release Manager and document your reasoning on why you believe we can use a non Apache version 2 license.
Each project must edit its project table available at Project FOSS.
Charter Compliance
The project team comply with the ONAP Charter.