DRAFT PROPOSAL FOR COMMENTS

Table of Contents
outline true

Overview

...

• 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 to perform the different use cases identified for the release Amesterdam.

Minimum Viable Product

Describe the MVP for this release.Create the OPEN CLI framework

Provide required Linux Console commands

Run time environment with docker 

Standardise open-cli-schema 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.

...

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.

...

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

List the other ONAP projects your depends on.As CLI is critical in devops environment, in future, CLI will be extended to use in VNF boot scripts, OOM and Integration projects to make the ONAP integration point smoother and easier.

Release Deliverable

Sub-Components

NIL

ONAP Dependencies

1. AAF/Portal project
   1.  for Authentication and authorization
2. MSB/A&AI project
   1. for service discovery 
3. Integration project
   1. for creating the docker scripts, 
   2. Integration scripts
   3. Jenkins and sonar integration
4. To provide the require CLI for Following projects
   1. SO
   2. Policy
   3. Controllers (APPC/SDNC/VFC/Multi-VIM)

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.

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.

...

Image Added

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

Following table shows the list of API depends by CLI framework

NOTE: 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, DCAE, policy and SDC

CLI Outgoing Dependencies

NOTE: This project delivers CLI and not API

CLI this release is delivering to other releases.

Third Party Products Dependencies

...

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 32-bit/64-bit
Open JDK	For Java RTE	1.8

Testing and Integration Plans

...

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.

...

Resources

Fill out the Resources Committed to the Release centralized page.

Release Milestone

...

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

...

Each project must edit its project table available at Project FOSS.

Charter Compliance

The project team comply with the ONAP Charter.