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

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

The latest release of LSO Allegro 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 Allegro 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-Allegro-SDK Grace Release

Download the entire repository by clicking here

Overview

This repository contains the release of the Allegro SDK. The SDK includes APIs for Service Catalog, Service Order, and Service Inventory functions of the Service Orchestration Functionality (SOF) at the LSO Allegro 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

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

  • Performance Monitoring
  • Streaming Management

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

More information about the LSO Allegro API reference point and its roadmap can be found here:

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

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 is presented as follows:

(*) is used to mark an item that changes its maturity compared to the previous release.

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 and 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 the documents and standards.
  • generated - No longer provided - please visit LSO Marketplace to use the 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 Allegro 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.

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 Allegro SDK Grace (Production)

Version: grace

Date: December 20th 2023

Release Grace Deliverables:

DeliverableMaturity
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 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 GuideLB
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



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 W102 - IP-VPN 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 W99.1 - Service Provisioning API & Dev GuideCfC #1
MEF W135.1 - Service Inventory API & Dev GuideCfC #1
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 W158 - Allegro, Interlude, Legato Service Ordering BR/UCRfD #1
MEF W159 - Allegro, Interlude, Legato Service Inventory BR/UCRfD #1




Historical

LSO Allegro SDK Fergie

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



Status

PUBLIC

LSO Developer Community
LSO Developer Community Manager
LSO Legato SDK @ GitHub

Core (public):

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

Extensions (MEF Members only):

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

If you are a MEF Member, update your wiki profile with your GitHub account name. Access to the LSO Allegro 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!