D2.2 Definition of APIs and Interfaces for the SELFNET Framework
This deliverable represents the efforts made in SELFNET task 2.2 for a first definition of Interfaces and APIs in the scope of the project framework. The document sets up the guidelines that shall be followed henceforward in the specification of SELFNET APIs, describes the already identified interfaces at a high level, and makes a prospective description of the management/control flow for the various SON Use Cases throughout the various APIs and interfaces. Ref. Ares(2016)1584142 04/04/2016 SELFNET H2020 ICT 2014 2/671672 Deliverable D2.2 Page 2 of (158) (c) SELFNET consortium 2016 Disclaimer This document contains material, which is the copyright of certain SELFNET consortium parties, and may not be reproduced or copied without permission. All SELFNET consortium parties have agreed to full publication of this document. The commercial use of any information contained in this document may require a license from the proprietor of that information. Neither the SELFNET consortium as a whole, nor a certain part of the SELFNET consortium, warrant that the information contained in this document is capable of use, nor that use of the information is free from risk, accepting no liability for loss or damage suffered by any person using this information. The EC flag in this press release is owned by the European Commission and the 5G PPP logo is owned by the 5G PPP initiative. The use of the flag and the 5G PPP logo reflects that SELFNET receives funding from the European Commission, integrated in its 5G PPP initiative. Apart from this, the European Commission or the 5G PPP initiative have no responsibility for the content. The research leading to these results has received funding from the European Union Horizon 2020 Programme under grant agreement number H2020 ICT 20142/671672. Impressum [Full project title] Framework for Self Organized Network Management in Virtualized and Software Defined Networks [Short project title] SELFNET [Number and title of work package] WP2 SELFNET Network Management Framework [Number and title of task] T2.2 System APIs and Interfaces [Document title] Definition of APIs and Interfaces for the SELFNET Framework [Editor: Name, company] Rui Cale, Pedro Neves, PTIN [Work package leader: Name, company] Pedro Neves, PTIN Copyright notice 2016 Participants in SELFNET project Deliverable D2.2 SELFNET H2020 ICT 2014 2/671672 (c) SELFNET consortium 2016 Page 3 of (158) Executive summary The SELFNET architecture is partitioned in five layers in order to logically separate the different areas of concern. These layers are (i) the Infrastructure Layer, (ii) the Data Network Layer, (iii) the Control Layer, (iv) the SON Autonomic layer, and (v) the NFV Orchestration Management Layer. Finally a SON Access Layer has been defined that aggregates the functionality necessary to interface to the user/admin as well as any external systems. Each of these layers is further refined and sublayers are identified. The Infrastructure Layer is composed of the Physical sublayer and the Virtualization sublayer. The Control Layer is composed of the SDN Controllers sublayer and the SON Control Plane sublayer. The NFV Orchestration Management Layer is composed of the Virtualized Infrastructure manager sublayer and the VNF Management sublayer. The SON Autonomic Layer is composed of the Monitor Analyzer sublayer, the Autonomic Management sublayer, the VNF Onboarding sublayer and the Orchestration sublayer. The Orchestration sublayer is partly partitioned in the NFV Orchestration Management layer. This document identifies and specifies the interactions among the different sublayers, resulting in a refined system roadmap for the future design and development of the SELFNET framework. This document does not specify the detailed components of each sublayer, which is subject to future work. The specifications here in, were developed through an iterative process between the definitions of workflows among the different sublayers and the functional decomposition of the main building blocks that are documented in the SELFNET deliverable D2.1 [22] The iterative process with a project wide scope ensures that the architecture finds project wide consensus at the overall as well as the detailed level. As a result, a high level description of SELFNET architecture and interfaces was produced. Special attention was given to the way interfaces and APIs are specified throughout the project, in order to guarantee that a coherent approach is taken when the various project work items take on the task of fully detailing, implementing and integrating these interfaces and APIs so that the envisaged workflows are properly accommodated for the realization of the Use Cases. Two fundamental aspects of the SELFNET approach set the framework in which all the technical work took place. The first aspect was the pervasive as a service character of all the building blocks of the platform whereas the second one was the self autonomic multi tenant aware business logic. Regarding the first aspect certain patterns coming either from standards bodies, such as the work of the ETSI Industry Specification Group (ISG) on NFV Management and Orchestration (MANO) or the well established open source platforms like OpenStack were encapsulated in the platform definitions so that the rest of the work is well aligned with the current state of the art. For the second aspect special attention was given for inclusion of tenant information in all relevant workflows but also abstraction and uniformity was a parameter considered in interface definitions so that proprietary approaches are avoided. This report presents a number of guidelines for interface definition focusing on open API approaches based on RESTFul APIs whenever possible. Tools such as Swagger (OpenAPI) are identified to ease documentation and low level interface definition. A common high level template is introduced for project defined and for standard interfaces focusing on real needs in terms of operations and information flow. SELFNET H2020 ICT 2014 2/671672 Deliverable D2.2 Page 4 of (158) (c) SELFNET consortium 2016 Finally, a "pre validation" of the interfaces is performed by identifying and describing a set of operational workflows across the various interfaces for all Use Cases that drive the project. These workflows are applied to the specified interfaces and operations. The first set of workflows is related to "Management Operations" in which workflows, such as "APP Onboarding" "APP Update or Withdrawal" and "SON Rules Deployment" related to the management of the SELFNET framework were described. The second set of workflows is related to the runtime autonomic control loop, that is, workflows directly related to the SON use cases "Self Healing" "Self Protection" and "Self Optimization" Deliverable D2.2 SELFNET H2020 ICT 2014 2/671672 (c) SELFNET consortium 2016 Page 5 of (158) List of authors Company Author PT Inovacao e Sistemas SA Rui Cale PT Inovacao e Sistemas SA Pedro Neves PT Inovacao e Sistemas SA Mario Rui Costa PT Inovacao e Sistemas SA Bruno Parreira PT Inovacao e Sistemas SA Carlos Parada University of the West of Scotland Jose M. Alcaraz Calero University of the West of Scotland Qi Wang University of the West of Scotland Enrique Chirivella Perez University of the West of Scotland James Nightingale Nextworks Giacomo Bernini Nextworks Gino Carrozzo Universidad Complutense de Madrid Luis Javier Garcia Villalba Universidad Complutense de Madrid Lorena Isabel Barona Lopez Universidad Complutense de Madrid Angel Leonardo Valdivieso Caraguay Universidad Complutense de Madrid Marco Antonio Sotelo Monge Universidad Complutense de Madrid Jorge Maestre Vidal Creative Systems Engineering (C.S.E. Monoprosopi EPE Konstantinos Kotsopoulos Proef Ricardo Maia Proef Jose Santos Proef Rui Alheiro Proef Luis Andrade Universidad de Murcia Diego Sevilla Ruiz Universidad de Murcia Felix J. Garcia Clemente Universidad de Murcia Gregorio Martinez Perez Deutsches Forschungszentrum Fuer Kuenstliche Intelligenz GMBH Wei Jiang Deutsches Forschungszentrum Fuer Kuenstliche Intelligenz GMBH Hans Schotten Innoroute GMBH Marian Ulbricht Alvarion Technologies Ltd. Jesus Alonso Ubiwhere Lda. Miguel Paixao SELFNET H2020 ICT 2014 2/671672 Deliverable D2.2 Page 6 of (158) (c) SELFNET consortium 2016 Ubiwhere Lda. Tiago Teixeira Ubiwhere Lda. Ricardo Preto Eurescom GmbH Anastasius Gavras Deliverable D2.2 SELFNET H2020 ICT 2014 2/671672 (c) SELFNET consortium 2016 Page 7 of (158) Table of