Dublin-M1-CLI Release planning

Owned by Former user (Deleted)
Last updated: Jan 23, 2019
6 min read


Overview

Project Name

Enter the name of the project

Project Name

Enter the name of the project

Target Release Name

Dublin

Project Lifecycle State

incubation

Participating Company 

Huawei, Intel

Scope

  • Support VTP for LFN CVC

  • Support ONAP for enabling service specific CLI

Use Cases

As a user/operator, i should be able to perform the ONAP operations from OCC/Linux console, required for Dublin release.



Minimum Viable Product

  • Enable required features in OCLIP for LFN CVC VTP





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

key summary type created updated due assignee reporter priority status resolution
Refresh

Stories

key summary type created updated due assignee reporter priority status resolution
Refresh



Longer term road map

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

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

  1. VNFSDK

    1. API to conduct tests, verification and market places

Platform Maturity

Refering to CII Badging Security Program and Platform Maturity Requirements, fill out the table below by indicating the actual level , the targeted level for the current release and the evidences on how you plan to achieve the targeted level.

Area

Actual Level

Targeted Level for current Release

How, Evidences

Comments

Area

Actual Level

Targeted Level for current Release

How, Evidences

Comments

Performance

1

1



  • 0 -- none

  • 1 – baseline performance criteria identified and measured

  • 2 & 3 – performance improvement plans created & implemented



Stability

1

1



  • 0 – none

  • 1 – 72 hours component level soak w/random transactions

  • 2 – 72 hours platform level soak w/random transactions

  • 3 – 6 months track record of reduced defect rate



Resiliency

2

2



  • 0 – none

  • 1 – manual failure and recovery (< 30 minutes)

  • 2 – automated detection and recovery (single site)

  • 3 – automated detection and recovery (geo redundancy)

Security

1

1



  • 0 – none

  • 1 – CII Passing badge + 50% Test Coverage

  • 2 – CII Silver badge; internal communication encrypted; role-based access control and authorization for all calls

  • 3 – CII Gold

Scalability

1

1



  • 0 – no ability to scale

  • 1 – single site horizontal scaling

  • 2 – geographic scaling

  • 3 – scaling across multiple ONAP instances

Manageability

1

1



  • 1 – single logging system across components; instantiation in < 1 hour

  • 2 – ability to upgrade a single component; tracing across components; externalized configuration management

Usability

2

2



  • 1 – user guide; deployment documentation; API documentation

  • 2 – UI consistency; usability testing; tutorial documentation

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
open_cli_schema_version: 1.0 name: microservice-create description: Register microservice into Open-O service: name: msb version: v1 parameters: - name: service-name description: Open-O service name type: string short_option: x long_option: service-name is_optional: false - name: service-version description: Open-O service version type: string short_option: y long_option: service-version is_optional: false - name: service-url description: Open-O service base url type: url short_option: r long_option: service-url is_optional: false - name: node-ip description: Open-O service running node IP type: string - name: node-port description: Open-O service running node port type: string - name: create-or-update description: Open-O service create or update type: bool default_value: true results: direction: portrait attributes: - name: name description: Open-O service name scope: short type: string - name: version description: Open-O service version scope: short type: string - name: url description: Open-O service base url scope: short type: url - name: status description: Open-O service status scope: short type: long - name: nodes description: Open-O service running nodes scope: long type: string - name: location description: Open-O service location scope: long type: url http: request: uri: /services method: POST body: '{"serviceName":"${service-name}","version":"${service-version}","url":"${service-url}","protocol":"REST","visualRange":"1","lb_policy":"hash","nodes":[{"ip":"${node-ip}","port":"${node-port}","ttl":0}]}' headers: queries: createOrUpdate: ${create-or-update} success_codes: - 201 - 200 result_map: name: $b{$.serviceName} version: $b{$.version} url: $b{$.url} status: $b{$.status} nodes: $b{$.nodes[*].ip}:$b{$.nodes[*].port} location: $h{Location}



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




Third Party Products Dependencies

Name

Description

Version

Name

Description

Version

Docker

Docker container for CLI

Aligned with existing Docker version of ONAP

Ubuntu

For running CLI manually

14.04 / 16.04 32-bit/64-bit

Open JDK

For Java RTE

1.8



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

Gaps identified

Impact

NIL

NIL

Known Defects and Issues

Provide a link toward the list of all known project bugs.

key summary type created updated due assignee reporter priority status resolution
Refresh

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

Risk identified

Mitigation Plan

Contingency Plan

NONE



-

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

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.