The LSO Legato SDK is the complete set of deliverables developed by the MEF membership in order to
- Enable market adoption of LSO Legato APIs in the current release of the LSO API Framework.
- 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 'Ella' 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
MEF-LSO-Legato-SDK Ella Release
Download Link
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, Service Inventory and Service Notification 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 draft, in-progress versions of the API Developer Guides for each of the service types listed above.
High-level release notes
- Service Ordering and Service Inventory APIs are updated to match all Sonata API patterns and have API Developer Guide documents provided (MEF W99 and MEF W135).
- Carrier Ethernet and IP service schemas are revised and updated, together with their guide documents (MEF W101, MEF W102)
- Following documents have been published as MEF Standards:
- MEF 112 - Draft Release 1 MEF Services Model Information Model for IP and IP VPN
- MEF 128 - Draft Release 2 LSO API Security Profile
- New document:
- MEF W133 - Allegro, Interlude and Legato Fault Management and Performance Monitoring BR&UC
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
- Service Notification - This includes support for
- Hub - Create, Delete, Retrieve operations
- Service Specification - Create, Delete, StateChange event notifications
- Service Order/OrderItem - Create, StateChange event notifications
- Service events - Create, Delete, StateChange event notifications
- Not in scope
- Hub - Modify operations
- Retrieve Notification records history/log
- AttributeValueChange event notifications
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.
There is currently LSO Legato Service Provisioning Project open that aims to deliver:
- *LSO Legato Service Ordering Management API (MEF W99) - work in progress - ready for CfC#2
- *LSO Legato Service Inventory Management API - Developer Guide (MEF W135) - work in progress - ready for CfC#2
- LSO Legato Service Provisioning Specification - SD-WAN (MEF W100) - DRAFT version
- *LSO Legato Carrier Ethernet Service Schemas and Developer Guide (MEF W101) - work in progress - ready for CfC#2
- *LSO Legato Internet Protocol Service Schemas and Developer Guide (MEF W102) - work in progress - ready for CfC#2
- LSO Legato Service Provisioning Specification - L1 (MEF W103) - DRAFT version
(*) is used to mark item that changes their maturity comparing to previous release.
Contents
This SDK contains the following items:
COPYRIGHT
- Copyright 2020 MEF ForumLICENSE
- Contains a copy of the Apache 2.0 licenseREADME
- This fileserviceApi
- 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 formatsupportingStandards
- The rest of documents and standards.
generated
staticBinding
- No longer provided - please visit LSO Marketplace to use self-blending possibility.security
- A not normative version of the standard APIs including the security profiles as required by MEF 128. Provided for evaluation.
Issues, questions, and Feedback
Issues should be reported with the use of GitHub issues. Questions and feedback should be asked either at Legato SDK Community 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
BR&UC - Business Requirements & Use Cases
Underlined item indicates a release deliverable that is a delta from the previous SDK release.
Published standard | Draft standard | Work in progress |
---|
LSO Legato SDK Ella (Production)
Version: ella
Date: January 5th 2023
Release Ella Deliverables:
Deliverable | Maturity |
---|---|
MEF W112 - MEF Services Model Information Model for IP and IP VPN | Standard |
MEF W133 - Interlude SOAM, FM, PM | LB |
MEF W128 - LSO API Security Profile | Standard |
MEF W101 - Carrier Ethernet Schema/Guide for Service Provisioning | CfC #2 |
MEF W102 - IP-VPN Schema/Guide for Service Provisioning | CfC #2 |
MEF W99 - Service Provisioning API & Dev Guide | CfC #3 |
MEF W135 - Service Inventory API & Dev Guide | CfC #1 |
LSO Legato SDK Fergie (Planned: June 2023)
Release Fergie Deliverables:
Deliverable | Maturity |
---|---|
MEF W133 - Interlude SOAM, FM, PM | Standard |
MEF W136 - Allegro, Interlude and Legato SOAM and SFT BRUCs | Standard |
MEF W99 - Service Provisioning API & Dev Guide | LB |
MEF W135 - Service Inventory API & Dev Guide | LB |
MEF W100 - SD-WAN Schema/Guide for Service Provisioning | CfC #2 |
MEF W143 - PM Profiles, Jobs, Notifications and Collection API and Dev Guide | CfC #1 |
MEF W144 - Passive Real-time and Historical Statistics Configuration and Collection API and Dev Guide | CfC #1 |
MEF W145 - Threshold Crossing Alert Profile Management, Jobs API and Dev Guide | CfC #1 |
MEF W146 - Threshold Crossing Alerts (Alarms) API and Dev Guide | CfC #1 |
MEF W147 - Streaming Management API and Dev Guide | CfC #1 |
MEF W152 - Carrier Ethernet Payload Schema/Guide for SOAM | CfC #1 |
LSO Legato SDK Grace (Planned: December 2023)
Release Grace Deliverables:
Deliverable | Maturity |
---|---|
MEF W99 - Service Provisioning API & Dev Guide | Standard |
MEF W135 - Service Inventory API & Dev Guide | Standard |
MEF W100 - SD-WAN Schema/Guide for Service Provisioning | LB |
MEF W101 - Carrier Ethernet Schema/Guide for Service Provisioning | LB |
MEF W102 - IP-VPN Schema/Guide for Service Provisioning | LB |
MEF W143 - PM Profiles, Jobs, Notifications and Collection API and Dev Guide | CfC #2 |
MEF W144 - Passive Real-time and Historical Statistics Configuration and Collection API and Dev Guide | CfC #2 |
MEF W145 - Threshold Crossing Alert Profile Management, Jobs API and Dev Guide | CfC #2 |
MEF W146 - Threshold Crossing Alerts (Alarms) API and Dev Guide | CfC #2 |
MEF W147 - Streaming Management API and Dev Guide | CfC #2 |
MEF W152 - Carrier Ethernet Payload Schema/Guide for SOAM | CfC #2 |
MEF W158 - Allegro, Interlude, Legato Service Ordering BR/UC | CfC #1 |
MEF W159 - Allegro, Interlude, Legato Service Inventory BR/UC | CfC #1 |
MEF W148 - Fault Management API and Dev Guide | CfC #1 |
MEF W149 - Service Function Testing API and Dev Guide | CfC #1 |
MEF W153 - IP/IPVPN Schema/Guide for SOAM | CfC #1 |
MEF W154 - SD-WAN Schema/Guide for SOAM | CfC #1 |
LSO Legato SDK Haley (Planned: June 2024)
Release Haley Deliverables:
Deliverable | Maturity |
---|---|
MEF W100 - SD-WAN Schema/Guide for Service Provisioning | Standard |
MEF W101 - Carrier Ethernet Schema/Guide for Service Provisioning | Standard |
MEF W102 - IP-VPN Schema/Guide for Service Provisioning | Standard |
MEF W143 - PM Profiles, Jobs, Notifications and Collection API and Dev Guide | LB |
MEF W144 - Passive Real-time and Historical Statistics Configuration and Collection API and Dev Guide | LB |
MEF W145 - Threshold Crossing Alert Profile Management, Jobs API and Dev Guide | LB |
MEF W146 - Threshold Crossing Alerts (Alarms) API and Dev Guide | LB |
MEF W147 - Streaming Management API and Dev Guide | LB |
MEF W152 - Carrier Ethernet Payload Schema/Guide for SOAM | LB |
MEF W148 - Fault Management API and Dev Guide | CfC #2 |
MEF W149 - Service Function Testing API and Dev Guide | CfC #2 |
MEF W158 - Allegro, Interlude, Legato Service Ordering BR/UC | CfC #2 |
MEF W159 - Allegro, Interlude, Legato Service Inventory BR/UC | CfC #2 |
MEF W153 - IP/IPVPN Schema/Guide for SOAM | CfC #2 |
MEF W154 - SD-WAN Schema/Guide for SOAM | CfC #2 |
LSO Legato SDK Release Dolly
Version: dolly
Date: June 14th 2022
Release Dolly Deliverables:
Deliverable | Maturity |
---|---|
MEF W112 - MEF Services Model Information Model for IP and IP VPN | RfD #1 |
MEF W128 - LSO API Security Profile | RfD #2 |
LSO Legato SDK Release Celine
Version: celine
Date: January 14th 2022
Release Celine Deliverables:
Deliverable | Maturity |
---|---|
MEF W99 (Developer Guide document) | CfC#2 |
MEF W99 Generic API & Schema incl. following functions:
| CfC#2 |
MEF W100 SD-WAN Developer Guide | CfC#3 |
MEF W100 SD-WAN Schema | CfC#3 |
MEF W101 CE (EVC_OVC) Developer Guide | CfC#3 |
MEF W101 CE (EVC_OVC) Schema | CfC#3 |
MEF W103 L1 Developer Guide | CfC#3 |
MEF W103 L1 Schema | CfC#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:
Deliverable | Maturity |
---|---|
MEF W99 Generic API & Schema incl. following functions:
| CfC#2 |
MEF W100 SD-WAN Developer Guide | CfC#2 |
MEF W100 SD-WAN Schema | CfC#2 |
MEF W101 CE (EVC_OVC) Developer Guide | CfC#2 |
MEF W101 CE (EVC_OVC) Schema | CfC#2 |
MEF W103 L1 Developer Guide | CfC#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.
Function | BR&UC | IIS | Product specs | ||
---|---|---|---|---|---|
Doc | Spec | Document | Spec | ||
Service Catalog | MEF W73 | MEF W99 | MEF W101 CE (EVC_OVC) MEF W100 SD-WAN |
| |
Service Ordering | |||||
Service Inventory | |||||
Service Notification |
Release Aretha Deliverables:
Theme: Multi-technology service provisioning
Deliverable | Maturity |
---|---|
MEF W99 Generic API & Schema incl. following functions:
| CfC#2 partially resolved |
MEF W100 SD-WAN Schema | Working draft |
MEF W101 CE (EVC_OVC) Schema | Working draft |
MEF W103 L1 Schema | Working 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
Function | BR&UC | Developer Guide | Service specs | ||
---|---|---|---|---|---|
Doc | API | Document | Spec | ||
Service Catalog |
| ||||
Service Ordering | |||||
Service Inventory | |||||
Service Notification |
Release 4 Deliverables
Deliverable | Change |
---|---|
Generic API & Schema incl. following functions:
| 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
Function | BR&UC | Swagger | Product specs |
---|---|---|---|
Service Catalog | CE (EVC_OVC) SD-WAN | ||
Service Ordering | |||
Service Inventory | |||
Service Notification |
PUBLIC
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.
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!