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 'Celine' 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 Celine Release
Download Link
Download the entire repository by clicking here
Overview
This repository contains the Celine 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.
This version updates the payload schemas for:
- IP/IP-VPN (based on MEF 112)
Also included are draft, in-progress versions of the API Developer Guides for each of the service types listed above.
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 Provisioning API (MEF W99)
- OAS3 API/Schema definitions as YAML files (DRAFT, part of this SDK release)
- API Developer Guide as GFM file (DRAFT, part of this SDK release)
- LSO Legato Service Provisioning Specification - SD-WAN (MEF W100)
- JSON Schema definitions as YAML files (DRAFT, part of this SDK release)
- Schema Guide as GFM file (DRAFT, part of this SDK release)
- LSO Legato Service Provisioning Specification - Carrier Ethernet (MEF W101)
- JSON Schema definitions as YAML files (DRAFT, part of this SDK release)
- Schema Guide as GFM file (DRAFT, part of this SDK release)
- LSO Legato Service Provisioning Specification - L1 (MEF W103)
- JSON Schema definitions as YAML files (DRAFT, part of this SDK release)
- Schema Guide as GFM file (DRAFT, part of this SDK 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 API are found in this directorycatalog
- Contains the API definitions for querying and retrieving Service-Specification instances from the service catalog system in the SOF.inventory
- Contains the API definitions for querying and retrieving Service instances from the service inventory system in the SOF.order
- Contains the API definitions for posting Service-Order request to the service order system in the SOF. Each Service-Order contains one or more Service-Order-Items, each of which specifies the Service instance (and its characteristics) to be added/updated/deleted.common
- Contains the API definitions for registering Notification-Listeners to be called-back when the specified condition occurs. Also common API resources and error definition can be found here.
serviceSchema
- Contains JSON schema (draft 7) files for- SD-WAN Services
- Carrier Ethernet Services
- L1 Connectivity Services.
- IP/IP-VPN Services
documentation
- documentation including API/Schema developer guides and openapi-tools generated API descriptions in markdown formatgenerated\staticBinding
- contains automatically generated (with help of the open source Sonata Blending Tool), not normative static bindings of envelope APIs with Service payloads.
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
LSO Legato SDK Release Celine
Version: celine
Date: January 14th 2022
Release Celine Deliverables:
Deliverable | Maturity |
---|---|
MEF W99 (Developer Guide document) | CfC#3 |
MEF W99 Generic API & Schema incl. following functions:
| CfC#3 |
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
Version: billie-final
Date: 16th June 2021
Release Billie Deliverables:
Deliverable | Maturity |
---|---|
MEF W99 Generic API & Schema incl. following functions:
| CfC#3 |
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 Aretha
GitHub tag: aretha
Date: 22nd December 2020
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 |
Source: LSO Legato Graphics
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!