DRAFT PROPOSAL FOR COMMENTS

The content of this template is expected to be fill out for M1 Release Planning Milestone.

Overview

Scope

What is this release trying to address?

ONAP Operations Manager will be used to efficiently Deploy, Manage, Operate the ONAP platform and its components (e.g. MSO, DCAE, SDC, etc.) and infrastructure (VMs, Containers). The OOM addresses the current lack of consistent platform-wide method in managing software components, their health, resiliency and other lifecycle management functions.  With OOM, service providers will have a single dashboard/UI to deploy & un-deploy the entire (or partial) ONAP platform, view the different instances being managed and the state of each component, monitor actions that have been taken as part of a control loop (e.g., scale in-out, self-heal), and trigger other control actions like capacity augments across data centers. 

In the Amsterdam release, OOM will be used to automatically deploy and re-deploy all ONAP platform components using containers technology, to monitor components state and to automatically heal broken platform components when required. 

Use Cases

OOM functionality is platform wide and is therefore not directly tied to specific use cases. However the vFW use case will be used as the test bed for OOM. 

Minimum Viable Product

• ONAP platform 1-click deployment on kubernetes for key components:
  
  

  • onap-aai

    • aai-service

    • hbase

    • model-loader-service

  • onap-appc

    • dbhost

    • dgbuilder

    • sdnctldb01

    • sdnctldb02

    • sdnhost

  • onap-message-router

    • dmaap

    • global-kafka

    • zookeeper

  • onap-mso

    • mariadb

    • mso

  • onap-policy

    • brmsgw

    • drools

    • mariadb

    • nexus

    • pap

    • pdp

    • pypdp

    • portalapps

    • portaldb

    • vnc-portal

  • onap-robot

    • robot

  • onap-sdc

    • sdc-be

    • sdc-cs

    • sdc-es

    • sdc-fe

    • sdc-kb

  • onap-sdnc

    • dbhost

    • sdnc-dgbuilder

    • sdnc-portal

    • sdnctldb01

    • sdnctldb02

    • sdnhost

  • onap-vid

    • vid-mariadb

    • vid-server

  • AAF

  • DCAE

  • MSB

  • Multi-VIM

  • VFC

• vFirewall demo on docker/kubernetes

• OOM Guidelines: 

  • Provide guidelines to the community teams for bringing components to oom/kubernetes (all component teams can bring themselves their components to OOM). 

• Platform containers monitoring:  provide visibility to the state of each components

• Platform components auto-healing mvp: auto-restart of platform containers on shutdown (may require a second level of policies on top of kubernetes to avoid infinite restarts)

• Platform Configuration management to deploy on different environments
  
  

  • Technical architecture & technology POCs for tools like Ansible, Chef, Cloudify for config management

  • Platform configuration parameters externalization to enable custom deployments (i.e. remove all hardcoded parameters). 

    • Critical parameters like openstack deployments and etc in an environment file. 

  • Component-level configuration & version management: allow to easily change configurations and manage different versions of the configuration files for each component.

  • Platform configuration management examples/demos so that the community knows how to use oom. Would require 2 examples

    • 1 would be for lab deployment

    • 1 for a production deployment

• Platform Upgradability:

  • Teams must expose endpoints for rollbacks and ensure backward compability. We need to provide requirements to each component teams.

  • Ability to deploy multiple instances of ONAP on different versions.

  • Manage individual components versions - Ability to upgrade 1 component at the time. 

• Platform infrastructure & multi-deployment options support (TBD)

  • Orchestrating infrastructure deployment and more deployment options with Cloudify - will determine if it is MVP or stretch or M2 scope. Maybe we lay the foundation in M1 Amsterdam and then grow. 

  
  
  

Stretch goal

• ONAP platform 1-click deployment on kubernetes for additional components:
  
  

  • CLI (Stretch)

  • CLAMP (Stretch)

  • Holmes (Stretch)

• Platform Configuration management - Scaled deployment
  
  

  • Distributed platform deployment using config management to determine where to deploy each individual components across geographies (stretch)

  • Advanced Multi-data-center platform deployment policies, e.g. applying anti-affinity rules for different components.

Out of scope

• Platform components/containers auto-scaling auto scaling

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

ONAP Platform OOM (ONAP Operations Manager)will be used to efficiently Deploy, Manage, Operate the ONAP platform and its components (e.g. MSO, DCAE, SDC, etc.) and infrastructure (VMs, Containers). The OOM addresses the current lack of consistent platform-wide method in managing software components, their health, resiliency and other lifecycle management functions.  With OOM, service providers will have a single dashboard/UI to deploy & un-deploy the entire (or partial) ONAP platform, view the different instances being managed and the state of each component, monitor actions that have been taken as part of a control loop (e.g., scale in-out, self-heal), and trigger other control actions like capacity augments across data centers. 

The primary benefits of this approach are as follows:

• Flexible Platform Deployment - While current ONAP deployment automation enables the entire ONAP to be created, more flexibility is needed to support the dynamic nature of getting ONAP instantiated, tested and operational.  Specifically, we need the capability to repeatedly deploy, un-deploy, and make changes onto different environments (dev, system test, DevOps, production), for both platform as a whole or on an individual component basis.  To this end, we are introducing the ONAP Operations Manager with orchestration capabilities into the deployment, un-deployment and change management process associated with the platform. 

• State Management of ONAP platform components – Our initial health checking of Components and software modules are done manually and lack consistency.  We are proposing key modules/services in each ONAP Component to be able to self-register/discovered into the ONAP Operations Manager, which in turn performs regular health checks and determines the state of the Components/software.

• Platform Operations Orchestration / Control Loop Actions – Currently there is a lack of event-triggered corrective actions defined for platform components.  The ONAP Operations Manager will enable DevOps to view events and to manually trigger corrective actions.  The actions might be simple initially – stop, start or restart the platform component.  Over time, more advanced control loop automation, triggered by policy, will be built into the ONAP Operations Manager. 

Open

Proposed ONAP Operations Manager Functional Architecture:

Open

• UI/Dashboard – this provides DevOps users a view of the inventory, events and state of what is being managed by the ONAP Operations Manager, and the ability to manually trigger corrective actions on a component.  The users can also deploy ONAP instances, a component, or a change to a software module within a component.

• API handler – this supports NB API calls from external clients and from the UI/Dashboard

• Inventory & data store – tracks the inventory, events, health, and state of the ONAP instances and individual components

• ONAP Lifecycle Manager – this is a model-driven orchestration engine for deploying/un-deploying instances and components.  It will trigger downstream plugin actions such as instantiate VMs, create containers, stop/restart actions, etc. Target implementation should aim at TOSCA as the master information model for deploying/managing ONAP Platform components.

• SB Interface Layer – these are a collection of plugins to support actions and interactions needed by the ONAP Operations Manager to ONAP instances and other external cloud related resources – plugins may include Openstack, Docker, Kubernetes, Chef, Ansible, etc.

• Service & Configuration Registry – this function performs the registry and discovery of components/software to be managed as well as the subsequent health check on each registered component/software

• Hierarchical OOM architecture for scaling and specialization - OOM's architecture allows for a hierarchical implementation for scale as volume/load and scope of the underlying ONAP platform instance(s) increases. 

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

As OOM manages all of the ONAP components it has dependencies on all other projects. OOM's first goal is to manage all of the components from the 1.0 release and will incorporate newer components as they mature.  In order for a project to be managed by OOM deployment artifacts that must be created - specifically a kubernetes deployment specification(s) and project configuration/environment data - in formats provided by this project.

Architecture

See ONAP Operations Manager (5/10/17) and OOM User Guide page. 

See also detailed diagrams on the use of TOSCA Model Driven orchestration across container and non-container deployment options.

High level architecture diagram

OOM User Guide

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

API this release is delivering to other releases.

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

In case there are specific dependencies  (Centos 7 vs Ubuntu 16. Etc.) list them as well.

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.