...
- 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
Describe the use case this release is targeted for (better if reference to customer use case)Provide required ONAP Commands to operate the ONAP from Linux Operating system console & Docker.
Minimum Viable Product
Describe the MVP for this release.Create the OPEN CLI framework and provide required Linux Console commands for ONAP 1.0
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.
...
Jira Legacy server System Jira columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=cli and issuetype in (story) serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
Longer term roadmap
Indicate at a high level the longer term roadmap. This is to put things into the big perspective.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
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 |
---|---|
To fill out | To fill out |
Sub-Components
List all sub-components part of this release.
Activities related to sub-component must be in sync with the overall release.
Sub-components are repositories are consolidate in a single centralized place. Edit the Release Components name for your project in the centralized page.
ONAP Dependencies
...
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
At that stage within the Release, the team is expected to provide more Architecture details describing how the functional modules are interacting.
Block and sequence diagrams showing relation within the project as well as relation with external components are expected.
Anyone reading this section should have a good understanding of all the interacting modules.
More details, please find in the attachment CLI architecture.pptx
API Incoming Dependencies
List the API this release is expecting from other releases.
Prior to Release Planning review, Team Leads must agreed on the date by which the API will be fully defined. The API Delivery date must not be later than the release API Freeze date.Prior to the delivery date, it is a good practice to organize an API review with the API consumers.
API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) | |
---|---|---|---|---|---|
To fill out | High level description of the AAF/Portal user API | For user authentication and authorization, CLI uses AAF/Portal user API | Date for which the API is reviewed and agreed To fill outTBD : 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 | API CLI Description | API CLI Definition Date | API CLI Delivery date | API CLI Definition link (i.e.swagger) | ||
---|---|---|---|---|---|---|
To fill out by M2 | High level description of the API | Date for which the API is reviewed and agreed | To fill outCLI | M2 (as per the release plan) | M2 (as per the release plan) | Link toward the detailed API CPI description |
Third Party Products Dependencies
Third Party Products mean products that are mandatory to provide services for your components. Development of new functionality in third party product may or not be expected.
List the Third Party Products (OpenStack, ODL, RabbitMQ, ElasticSearch,Crystal Reports, ...).
Name | Description | Version |
---|---|---|
To fill out | To fill out | To fill out |
...
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
...