The LSO Legato SDK is the complete set of deliverables developed by the MEF membership in order to

  1. Enable market adoption of LSO Legato APIs in the current release of the LSO API Framework.
  2. Support of development of additional features for the upcoming release of the LSO Legato SDK.

The latest release of LSO Legato SDK is in the LSO API Release 'Grace' and is available on GitHub (see Latest Release section for details).

Any MEF member can participate in the development of each new release of the LSO Legato SDK:

  • Contact the LSO Developer Community Manager (Michał Łączyński) either via GitHub or by email to let him know of your interest and to ask questions

Latest Release

MEF-LSO-Legato-SDK Grace Release

Download the entire repository by clicking here

Overview

This repository contains the release of the Legato SDK. The SDK includes APIs for Service Catalog, Service Order, and Service Inventory functions of the Service Orchestration Functionality (SOF) at the LSO Legato Interface Reference Point (IRP) as defined in the MEF LSO Reference Architecture.

Also included are Service schemas and Performance Monitoring definitions .

High-level release notes

  • Internet Protocol schemas are revised and updated, together with their guide documents (MEF W102)
  • Following documents have been published as MEF Standards:
    • MEF 99 - LSO Service Ordering Management API - Developer Guide
    • MEF 135 - LSO Legato Service Inventory Management API - Developer Guide
  • New document:
    • MEF 55.1.1 Amendment to MEF 55.1: Reference Architecture and Framework - Terminology
  • Updated documents:
    • MEF W128.1 - LSO API Security Profile
    • MEF W133.1 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC
    • MEF W143 - Performance Monitoring API and Developer Guide
    • MEF W147 - Streaming Management API and Developer Guide

Scope

It includes API definitions for the following functional areas:

  • Service Catalog - This includes support for
    • Service Specification - Retrieve operations only
    • Not in scope
      • Service Specifications - Create, Amend/Modify, Delete operations
      • Service Catalog, Service Category, Service Candidate, Job/Task
  • Service Ordering - This includes support for
    • Service Order/OrderItem - Create, Retrieve operations only
    • Not in scope
      • Service Order/OrderItem - Amend/Modify/Cancel, Delete operations
  • Service Inventory - This includes support for
    • Service - Retrieve operations only
    • Not in scope
      • Service - Create, Amend/Modify, Delete operations
  • Performance Monitoring
  • Streaming Management

In addition to the Service Provisioning APIs, the SDK includes the following MEF Service Specification schemas:

  • SD-WAN Services
  • Carrier Ethernet Services
  • L1 Connectivity Services
  • IP/IP-VPN Services

The MEF LSO Legato SDK is released under the Apache 2.0 license.

More information about the LSO Legato API reference point and it's roadmap can be found here:

https://wiki.mef.net/display/CESG/LSO+Legato

Maturity Level

The API files contained in this SDK are evolving and subject to change. They are based on documents that are either work in progress or draft standards that have not yet completed the review cycles and approvals necessary to achieve the status as a MEF standard. MEF is making these publicly available at this time to invite wider industry review.

The maturity per functionality presents as follows:

(*) is used to mark item that changes their maturity comparing to previous release.

APIs and Developer Guides:

  • Service Catalog API - early draft version, on hold
  • MEF 99 - LSO Service Ordering Management API - Developer Guide W99 - Published Standard
  • MEF 135 - LSO Legato Service Inventory Management API - Developer Guide - Published Standard

Service Schemas:

  • SD-WAN (MEF W100) - work in progress - CfC#2
  • Carrier Ethernet (MEF W101) - work in progress - CfC#2
  • *Internet Protocol (MEF W102) - work in progress - CfC#4
  • LSO Legato Service Provisioning Specification - L1 (MEF W103) - work in progress - CfC#3 - on hold

SOAM:

  • MEF 133 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC - Published Standard
  • *MEF W133.1 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC - early draft version, CfC#1
  • MEF 136 - Service Function Testing Business Requirements and Use Cases - Published Standard
  • *MEF W143 - Performance Monitoring API and Developer Guide - work in progress - CfC#2
  • *MEF W147 - Streaming Management API and Developer Guide - work in progress - CfC#2
  • Performance Monitoring reports and statistics definitions for Carrier Ethernet adn IP - early draft version, schemas only

Contents

This SDK contains the following items:

  • COPYRIGHT - Copyright 2023 MEF Forum
  • LICENSE - Contains a copy of the Apache 2.0 license
  • README - This file
  • serviceApi - Definitions of the APIs are found in this directory, provided as yaml files.
  • serviceSchema - Contains JSON schema (draft 7) files for service specifications.
  • documentation - documentation including API/Schema developer guides and openapi-tools generated API descriptions in markdown format
    • supportingStandards - The rest of documents and standards.
  • generated - No longer provided - please visit LSO Marketplace to use self-blending possibility.

Issues, questions, and Feedback

Issues should be reported with the use of GitHub issues. Questions and feedback should be asked either at Legato SDK Discussions or directly to community_manager@mef.net.

NOTE: All artifacts included in this repository have line numbers. When referring to specific content in any of these artifacts, please quote the line numbers to which you are referring.

Reference Implementations

A reference implementation of the MEF Service Instantiation API may be available from the ONAP EXTAPI project.

https://wiki.onap.org/display/DW/External+API+Framework+Project

© MEF Forum 2023. All Rights Reserved.

LSO Legato SDK Releases

BR&UC - Business Requirements & Use Cases

Underlined item indicates a release deliverable that is a delta from the previous SDK release.

Published standardDraft standardWork in progress

LSO Legato SDK Grace (Production)

Version: grace

Date:  December 20th 2023

Release Grace Deliverables:

DeliverableMaturity
MEF W99 - Legato Service Provisioning API & Dev GuidePublished Standard
MEF W135 - Legato Service Inventory API & Dev GuidePublished Standard
MEF W102 - IP-VPN Schema/Guide for Service ProvisioningCfC #4
MEF W143 - Performance Monitoring and Passive StatisticsCfC #2
MEF W147 - Streaming Management API and Dev GuideCfC #2

LSO Legato SDK Haley (Planned: June 2024)

Release Haley Deliverables:

DeliverableMaturity
MEF W102 - IP-VPN Schema/Guide for Service ProvisioningLB
MEF W100 - SD-WAN Schema/Guide for Service ProvisioningCfC #3
MEF W101 - Carrier Ethernet Schema/Guide for Service ProvisioningCfC #3
MEF W133.1 - Fault Management and Performance Monitoring BR&UCRfD#1
MEF W136.1 - Service Function Testing BR&UCRfD#1
MEF W143 - Performance Monitoring and Passive StatisticsCfC #3
MEF W147 - Streaming Management API and Dev GuideCfC #3
MEF W158 - Allegro, Interlude, Legato Service Ordering BR/UCRfD#1
MEF W159 - Allegro, Interlude, Legato Service Inventory BR/UCRfD#1
MEF W145 - Threshold Crossing Alert Profile Management, Jobs API and Dev GuideCfC #1
MEF W146 - Threshold Crossing Alerts (Alarms) API and Dev GuideCfC #1
MEF W148 - Fault Management API and Dev GuideCfC #1
MEF W149 - Service Function Testing API and Dev GuideCfC #1
MEF W152 - Carrier Ethernet Payload Schema/Guide for SOAMCfC #1
MEF W153 - IP/IPVPN Schema/Guide for SOAMCfC #1
MEF W154 - SD-WAN Schema/Guide for SOAMCfC #1
MEF W161 - IaaS Schema/Guide for Service ProvisioningCfC #1

LSO Legato SDK Irene (Planned: December 2024)

Release Irene Deliverables:

DeliverableMaturity
MEF W100 - SD-WAN Schema/Guide for Service ProvisioningLB
MEF W101 - Carrier Ethernet Schema/Guide for Service ProvisioningLB
MEF W133.1 - Fault Management and Performance Monitoring BR&UCLB
MEF W136.1 - Service Function Testing BR&UCLB
MEF W143 - Performance Monitoring and Passive StatisticsLB
MEF W145 - Threshold Crossing Alert Profile Management, Jobs API and Dev GuideCfC #2
MEF W146 - Threshold Crossing Alerts (Alarms) API and Dev GuideCfC #2
MEF W148 - Fault Management API and Dev GuideCfC #2
MEF W149 - Service Function Testing API and Dev GuideCfC #2
MEF W154 - SD-WAN Schema/Guide for SOAMCfC #2
MEF W158 - Allegro, Interlude, Legato Service Ordering BR/UCCfC #2
MEF W159 - Allegro, Interlude, Legato Service Inventory BR/UCCfC #2
MEF W161 - IaaS Schema/Guide for Service ProvisioningCfC #2


Historical

LSO Legato SDK Fergie (Production)

Version: fergie

Date:  June 23rd 2023

Release Fergie Deliverables:

DeliverableMaturitycomment
MEF W133 - Fault Management and Performance Monitoring BR&UC
Standard
MEF W136 - Service Function Testing BR&UCStandard
MEF W99 - Service Provisioning API & Dev GuideLB
MEF W135 - Service Inventory API & Dev GuideLB
MEF W100 - SD-WAN Schema/Guide for Service ProvisioningCfC #2
MEF W143 - Performance Monitoring and Passive StatisticsCfC #1
MEF W147 - Streaming Management API and Dev GuideCfC #1
MEF W152 - Carrier Ethernet Payload Schema/Guide for SOAM
only yamls
MEF W153 - IP/IPVPN Schema/Guide for SOAM
only yamls

LSO Legato SDK Ella

Version: ella

Date:  January 5th 2023

Release Ella Deliverables:

DeliverableMaturity
MEF W112 - MEF Services Model Information Model for IP and IP VPNStandard
MEF W133 - Interlude SOAM, FM, PM
LB
MEF W128 - LSO API Security ProfileStandard
MEF W101 - Carrier Ethernet Schema/Guide for Service ProvisioningCfC #2
MEF W102 - IP-VPN Schema/Guide for Service ProvisioningCfC #2
MEF W99 - Service Provisioning API & Dev GuideCfC #3
MEF W135 - Service Inventory API & Dev GuideCfC #1

LSO Legato SDK Release Dolly

Version: dolly

Date:  June 14th 2022

Release Dolly Deliverables:

DeliverableMaturity
MEF W112 - MEF Services Model Information Model for IP and IP VPNRfD #1
MEF W128 - LSO API Security ProfileRfD #2

LSO Legato SDK Release Celine

Version: celine

Date:  January 14th 2022


Release Celine Deliverables:

DeliverableMaturity
MEF W99  (Developer Guide document)CfC#2

MEF W99 Generic API & Schema incl. following functions:

    • Service Catalog (to remove from the API?)
    • Service Ordering
    • Service Inventory
    • Service Notification
CfC#2
MEF W100 SD-WAN Developer GuideCfC#3
MEF W100 SD-WAN SchemaCfC#3
MEF W101 CE (EVC_OVC) Developer GuideCfC#3
MEF W101 CE (EVC_OVC) SchemaCfC#3
MEF W103 L1 Developer GuideCfC#3
MEF W103 L1 SchemaCfC#3

LSO Legato SDK Release Billie (June 2021)

Version: billie

Date:  June 2021

SDK Repository:https://github.com/MEF-GIT/MEF-LSO-Legato-SDK/releases/tag/billie


Release Billie Deliverables:

DeliverableMaturity

MEF W99 Generic API & Schema incl. following functions:

    • Service Catalog (to remove from the API?)
    • Service Ordering
    • Service Inventory
    • Service Notification
CfC#2
MEF W100 SD-WAN Developer GuideCfC#2
MEF W100 SD-WAN SchemaCfC#2
MEF W101 CE (EVC_OVC) Developer GuideCfC#2
MEF W101 CE (EVC_OVC) SchemaCfC#2
MEF W103 L1 Developer GuideCfC#2
MEF W103 L1 Schema

CfC#2

LSO Legato SDK Release Aretha

GitHub tag: aretha

Date:  22nd December 2021

SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Legato-SDK

Maturity Map:

Underlined item indicates a release deliverable that is a delta from the previous SDK release.


FunctionBR&UCIISProduct specs
DocSpecDocumentSpec
Service CatalogMEF W73



MEF W99



(tick)

MEF W101 CE (EVC_OVC)

MEF W100 SD-WAN

(tick) SD-WAN

(tick) CE (EVC_OVC)

(tick) L1

(question) IP

Service Ordering

(tick)

Service Inventory

(tick)

Service Notification

(tick)


Release Aretha Deliverables:

Theme: Multi-technology service provisioning

DeliverableMaturity

MEF W99 Generic API & Schema incl. following functions:

    • Service Catalog
    • Service Ordering
    • Service Inventory
    • Service Notification
CfC#2 partially resolved
MEF W100 SD-WAN SchemaWorking draft
MEF W101 CE (EVC_OVC) SchemaWorking draft
MEF W103 L1 SchemaWorking draft

LSO Legato SDK Release 4

Version: R4

Date:  31st July 2020

SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Legato-SDK/releases/download/rc4/MEF-LSO-Legato-SDK-rc4.zip


Maturity Map

FunctionBR&UCDeveloper GuideService specs
DocAPIDocumentSpec
Service Catalog



(tick)


(tick) SD-WAN

(tick) CE (EVC_OVC)

(tick) L1

Service Ordering

(tick)

Service Inventory

(tick)

Service Notification

(tick)

Release 4 Deliverables

DeliverableChange

Generic API & Schema incl. following functions:

    • Service Catalog
    • Service Ordering
    • Service Inventory
    • Service Notification
Update

Align envelope-payload approach to  Sonata Pattern

Update
SD-WAN - Service Schema only (part of MEF W100)Update
CE (EVC_OVC) - Service Schema only (part of MEF W101)Update
L1 - Service Schema only (part of MEF W103)New

LSO Legato SDK Release 3

Version: R3

Date: Aug 2019

SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Legato-SDK/releases/tag/r3

FunctionBR&UC

Swagger
specs

Product specs
Service Catalog

(tick)

CE (EVC_OVC)

SD-WAN

Service Ordering
(tick)
Service Inventory

(tick)

Service Notification

(tick)



Status

PUBLIC

LSO Developer Community Manager
LSO Legato SDK @ GitHub

Core (public):

https://github.com/MEF-GIT/MEF-LSO-Legato-SDK

Extensions (MEF Members only):

https://github.com/MEF-GIT/MEF-LSO-Legato-SDK-extended

If you are a MEF Member, update your wiki profile with your GitHub account name. Access to the LSO Legato SDK Extensions repository is periodically updated with provided GitHub accounts. Additionally contact the LSO Developer Community Manager to request the immediate access.

Core Contributors

Karthik Sethuraman

Jack Pugaczewski

Min Yoon


Are you a core contributor to this LSO SDK but not mentioned here? Please let the LSO Developer Community Manager know and we will add you!