CLI K Release Planning
- Former user (Deleted)
The content of this template is expected to be fill out for M1 Release Planning Milestone.
Overview
Project Name | Enter the name of the project |
|---|---|
Target Release Name | K |
Project Lifecycle State | Incubation |
Participating Company | Huawei |
Scope
Address Global Requirements
Minimum Viable Product
Make more secured
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 is critical in devops environment, in future, CLI will be extended to use in VNF boot scripts 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
Architecture
High level architecture diagram
CLI Components
•Open Command – Models the most of the requirements of CLI and it’s the CLI schema engine, understands the OPEN-CLI 1.0 schema and make it as Command
–Command Plug-in : Provides extensibility support to implement any commands which are depends on java api
–HTTP Command : An special command plug-in provided by framework to implement the Command on top of REST API without writing any java code. (only YAML template is sufficient)
•Command Discoverer – Discovers the available CLI templates (YAML file created by using OPEN-CLI 1.0 schema) placed under OPEN_CLI_HOME directory or its sub-directories and register them into Command Registrar.
•Command Registrar – Maintains the map of command name vs actual command executable
•Main – Provides the interactive/direct command mode to run the commands from Linux OS console
Sample YAML CLI template
Following sample YAML shows the YAML file used to create the microservice in Open-O using CLI
openo microservice-create Expand source
Platform Maturity
Please fill out the centralized wiki page: Khon Release Platform Maturity
API Incoming Dependencies
To provide the required commands for each of the ONAP services, this project will depends on the REST API provided by every other services such as SO, AAI, etc
CLI Outgoing Dependencies
NOTE: This project delivers CLI and not API
Testing and Integration Plans
Verify the metadata section
Verify the help section of each command is able to provide the required details about medatdata
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
RISKS
NO
RESOURCES
Pls refer the INFO.YAML for committers. refer. https://gerrit.onap.org/r/admin/repos/q/filter:cli
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 |
|---|---|---|
To fill out | To fill out | To fill out |
DOCUMENTATION, TRAINING
Team contributions to the specific document related to he project (Config guide, installation guide...).
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.