Page tree
Skip to end of metadata
Go to start of metadata



This page is the OPEN-O Mercury Release Notes.
If you have any question please contact Linux Foundation.

OPEN-O Release Naming Convention

Release Overview

  • Release Name: Mercury
  • Release Version: 2.0.0
  • Release Date: April 27, 2017
  • Release Type: Generally Available
  • Former Release: OPEN-O Sun Release
  • Next Release: OPEN-O Mercury Release is the latest OPEN-O Release. OPEN-O has merged with Open Source ECOMP to become ONAP

Release Summary

OPEN-O is developing a solution to allow ''Any Service on Any Network". OPEN-O delivers to the community a micro services based architecture providing operators an incremental path to transform their networks (including OSS/BSS), through the adoption of SDN and NFV orchestration platform.

The Sun Release is built to support our Virtual CPE use case. This use case has two components:

  • Through a coordinated cloud and network approach, OPEN-O Enterprise Use Case provides automated end-to-end ''cloud + enterprise private network'' service to enterprise users. Enterprise users benefit from high-quality and cheap cloud service without deploying any complex infrastructure by themselves.
  • OPEN-O Residential Use Case allows operators to provide off the shelf residential vCPE services, such as parental control and firewall, within minutes. Open-O orchestrates the VNFs for vCPE to be deployed to the nearest TIC Edge to the requesting subscriber’s home.

The Mercury Release is built to support VoLTE (Voice Over LTE) where OPEN-O automatically triggers action, scales up and down to add and remove more virtual resource on data plane to cope with traffic.


OPEN-O Sun Release is built around 5 main projects providing the following functionalities:

  • GS-O project implements the Global Service Orchestrator. GS-O is responsible for providing end-to-end services.
  • SDN-O project implements the Software Defined Network Orchestrator. SDN-O provides connectivity services across SDN and legacy networks.
  • NFV-O projects implements the Network Function Virtualization Orchestrator. NFV-O provides an ETSI MANO-aligned NFV orchestrator.
  • Common Services project provides the common services for all the other OPEN-O components, including our Microservice bus, HA, Driver Manager, Log, Authentication and Protocol Stack.
  • Common Tosca project provides the TOSCA Parser and Execution Engine and Model Designer.


OPEN-O Mercury Release add the following functionalities:

  • VNF-SDK project delivers VNF packaging tool, VNF Marketplace and VNF Testing Framework to enable VNF suppliers to participate in the OPEN-O platform. It works with NFV-O to facilitate VNF Onboarding.
  • Modelling project documents API and Data Models used in OPEN-O.
  • GVNFM project provides a generic VNF manager as defined in ETSI NFV standard.
  • Client project provides an unified GUI and CLI for the OPEN-O functionalities provided over RESTful API. In addition, Client provides Java & JS SDK for OPEN-O services.
  • Multi VIM project offers support for multiple versions of OpenStack and VMWare VIMs.
  • SDN Hub Driver provides drivers for SDN Controllers.
  • SDN-O provides catalogue driven orchestration and management engine (SDN-O LCM), TOSCA based.
  • Holmes project provides an alarm correlation and analysis framework.
  • Policy project provides a policy framework for OPEN-O.

Supported Platform

OPEN-O Mercury Release has been tested on CentOS version 7 and is the only OS supported.

Required Software

Depending on the way you are installing OPEN-O (through the Tarball or Docker) the following software may be installed, configured and running prior to execute any OPEN-O Service.
Consult the Tarball or Docker installation instructions for further details.

Software Version


Integration and compatibility Matrix

This section is to document the third party software and their version OPEN-O is supporting.


OpenStackNewtonOpenStack on Ubuntu 14.04 and Red Hat 7.3.2


Third Party Dependencies: Controller view

NameDescriptionDependency Version
Huawei WAN ControllerThe Core Network Controller used for provisioning L3 VPN underlay in the WAN between two PEs.AC-VAN V3R1


Huawei Access ControllerThe Overlay SDN Controller used for provisioning VxLAN in Access/POP and provisioning IPsec in POP.AC-B V2R2C00


Huawei DC ControllerThe DC SDN Controller (Neutron) used for provisioning IPSec and VPC in DC.AC-DC V2R1C00


CT TE ControllerThe CT TE Controller specifically used for Monitor Unitilization & Optimize Underlay Service Path Use Case (stretch goal, minternal for Release 1)To fill out
Huawei DC DevicesHuawei Devices in the lab, most accessed via controllers, there will be temporary need to integrate directly with Huawei DC devicesFW (USG 63900)

TOR (CE5850, CE6850)

LB (F5)

ThinCPE (AR3260 V2R8)

PE (NE40E V8R8C10)

GW (CE6800+USG6390)

ZTE SPTN ControllerThe SDN Super Controller used for provisioning L2VPN and L3VPN over MPLS-TP for SPTNSPTN_API
ZTE DC ControllerThe DC SDN Controller used for provisioning Vxlan in DCZTE ZENIC V1.0R2
ZTE SFC ControllerThe SFC Controller used for provisioning vCPE Service chain in DCZTE ZENIC for SFC
ZTE DC DevicesZTE Devices in the lab, most accessed via controllers, there will be temporary need to integrate directly with ZTE DC devicesTOR(5960H)
DCI SPTN(6500)
ZTE OLTThe OLT device used for Residence to Internet scenarioC320
ZTE pCPEThe pCPE device used for Residence to Internet scenarioF623
ZTE vCPEThe vCPE used for Residence to Internet scenario including vNAT, vFWZXVCPE V1.00.10
ZTE vBRAS CPThe vBRAS CP used for pCPE authentication, accouting, authorizationZXVBNG V1.00.10
ZTE VNFMZTE VNF Manager, used for VNF lifecycle managementZTE vManager V6.16.10

Third Party Dependencies: Services View

Use-caseServiceNetwork and Technology DescriptionContributing partner for DriverDriver nameControllerController NBI
EnterpriseOverlay VxLANBetween site edge ThinCPE and vCPEHuaweisdno-driver-huawei-overlayHuawei AC-Branch V2R2C00 Huawei and vCPE V200R007C00SPC900AC-B API
EnterpriseOvleray IPSecAt vCPE Egress towards PEHuaweisdno-driver-huawei-overlayHuawei AC-Branch V2R2C00AC-B API

vCPE Interface

EnterpriseOverlay IPSecAt DC GW/Firewall IngressHuaweisdno-driver-huawei-openstackHuawei AC-DC V2R1C00OS API
EnterpriseUnderlay MPLS-TP L2 VPNMetro accessZTEsdno-driver-zte-sptnZTE SPTN V1.20.00.B05SPTN API
EnterpriseUnderlay MPLS BGP L3 VPNWAN across PE'sHuaweisdno-driver-huawei-l3vpnHuawei AC-WAN V300R001C00AC-WAN API
EnterpriseDC GW instancevirtual router instance-VPCHuaweisdno-driver-huawei-openstackOpenstack with AC-DC V2R1C00OS API
EnterpriseDC SFCSFC of physical elements inside DC networkHuaweisdno-driver-huawei-servicechainFW: USG6390

GW: V200R005C21

TOR: CE5850 & CE6850

FW Interface

Enterprise GW Interface

Traffic OptimizationTraffic optimization to assist TE in Enterprise/ResidentialMetro WANChina Telecomsdno-driver-ct-teZTE ZENIC IPSDNController API
ResidentialUnderlay MPLS-TP L3 VPNMetro WANZTEsdno-driver-zte-sptnZTE SPTNSPTN API
ResidentialvFW instanceVirtual firewall for children's trafficZTEVNFM DriverZXVCPE V1.00.10VNFM Driver API Definition
ResidentialvNAT instanceVirtual NAT for children's trafficZTEVNFM DriverZXVCPE V1.00.10VNFM Driver API Definition
ResidentialvBRAS instanceThe vBRAS CP used for pCPE authentication, accounting and authorizationZTEVNFM DriverZXVBNG V1.00.10VNFM Driver API Definition
ResidentialvCPE SFCSFC of virtual elements inside TIC-EDGE networkZTESDNC DriverZTE ZENIC for SFCSDNC API Specification
ResidentialService Traffic ClassifyNSH encapsulationZTEZTE SDNC DriverM6000-3SSDNC API Specification


Download Binaries

Mercury Release deliverables are available in 2 format: Tarball and Docker. The are both accessible from the OPEN-O Releases download page.

Download Source Code

Source code is available to the public in Gerrit.
Clone each project from Gerrit by using the command:

git clone'project'

To find the complete list of OPEN-O projects, see

Example: git clone


Other Systems

Access to OPEN-O Continuous Integration System.



There are 2 main ways to install OPEN-O:

  1. From the Tarball: procedures to install OPEN-O from A to Z using the OPEN-O Tarball.
  2. Using Docker: procedures to install OPEN-O using Docker.


To understand the overall OPEN-O architecture, functional components and microservice refer to the OPEN-O Architecture and more particularly for OPEN-O Mercury Release Architecture.

GUI Documentation

To understand the OPEN-O GUI Operations refer to the OPEN-O GUI Operations.

CLI Documentation

Refer Open-O CLI wiki for developer guide and admin guide.

API Documentation

Each OPEN-O functional component has its set of API Documentation.


OPEN-O is an Apache Version 2 license type of Open Source project.

More info

Link toward OPEN-O Portal