Overview

Scope

• Stabilise ONAP commands and CLI platform to meet S3P
• Provides Commands for VNF (netconf) & VNF-SDK 
  • Standardise CLI for VNF
• Closed-loop supporting commands (Stretch goal)
• ONAP command console (OCC) 
• Standardise Open Command Specification (OCS). 

Use Cases

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

Minimum Viable Product

Provide OCC to to operate ONAP environment from Portal & OOM.

Provides required commands for SO, SDC, MSB and AAI for performing Beijing use case from command line.

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 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

Sub-Components

NIL

ONAP Dependencies

1. AAF project
   1.  for Authentication and authorization
2. MSB project
   1. for service discovery 
3. AAI
   1. for customer, subscription, cloud managment
   2. external system managment
4. SO
   1. Service life cycle management
5. SDC
   1. Service and resource model management

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.

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

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

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.

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).

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.

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
  • ...

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.