Versions Compared

Old Version 15

changes.mady.by.user Michał Łączyński

Saved on

compared with

New Version 16

changes.mady.by.user Michał Łączyński

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

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



Panel
titleLatest Release

MEF-LSO-Legato-SDK

Dolly

Ella Release

Download the entire repository by clicking here

Overview

This repository contains the Dolly 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 StandardsNew documents:
    • MEF W112 112 - Draft Release 1 MEF Services Model Information Model for IP and IP VPN
    • MEF W128 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 Provisioning 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
  • 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)- 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)
  • JSON Schema definitions as YAML files (DRAFT, part of this SDK release)
    • Schema Guide as GFM file (DRAFT, part of this SDK release)- 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 Forum
  • LICENSE - Contains a copy of the Apache 2.0 license
  • README - This file
  • serviceApi - Definitions of the API APIs are found in this directory
    • catalog - 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.
    , provided as yaml files.
  • serviceSchema - Contains JSON schema (draft 7) files for
  • SD-WAN Services
  • Carrier Ethernet Services
  • L1 Connectivity Services.
    • IP/IP-VPN Servicesservice 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\staticBinding - contains automatically generated (with help of the open source Sonata Blending Tool), not normative static bindings of envelope APIs with Service payloads
    • 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


Maturity
Panel
titleLSO 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

Release Dolly

Ella  (Production)

Version: dollyella

Date:  June 14th 2022January 5th 2023

Release Dolly Ella Deliverables:

RfD #1
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 ProfileRfD #2

LSO Legato SDK Ella (Planned: November 2022)

Release Ella Deliverables:

Standard
MEF W101 - Carrier Ethernet Schema/Guide for Service ProvisioningCfC #2
MEF W102 - IP-VPN Schema/Guide for Service ProvisioningCfC #2
Deliverable
MEF W99 - Service Provisioning API & Dev GuideCfC #3
MEF W135 - Service Inventory API & Dev GuideCfC #1

LSO Legato SDK Fergie (Planned: May/June 2023)


Release Fergie Deliverables:

DeliverableMaturity
MEF W112 - MEF Services Model Information Model for IP and IP VPNStandard
MEF W133 - Interlude SOAM, FM, PM
LBMEF W136 - Interlude SFTRfD#1
Standard
MEF W101 - Carrier Ethernet Schema/Guide for Service Provisioning
CfC #2
LB
MEF W102 - IP-VPN Schema/Guide for Service Provisioning
CfC #2MEF W128 - LSO API Security ProfileStandard

LSO Legato SDK Fergie (Planned: May 2023)

Release Fergie Deliverables:

DeliverableMaturity
LB
MEF W99 - Service Provisioning API & Dev GuideCfC#4
MEF W135 - Service Inventory API & Dev GuideCfC#2
MEF
W133
W136 - Allegro, Interlude
SOAM, FM, PM
StandardMEF W136 - Interlude SFT
and Legato SOAM and SFT BRUCsRfD#1
MEF W82.1 - SD-WAN Information Model RevisionCfC #2
MEF W100 - SD-WAN Schema/Guide for Service ProvisioningCfC #2
MEF W101 - Carrier Ethernet Schema/Guide for Service ProvisioningLBMEF W102 - IP-VPN Schema/Guide for Service ProvisioningLB
MEF W143 - PM Profiles, Jobs, Notifications and Collection API and Dev GuideCfC #1
MEF W144 - Passive Real-time and Historical Statistics Configuration and Collection API and Dev GuideCfC #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 W147 - Streaming Management API and Dev GuideCfC #1

LSO Legato SDK Grace (Planned: November 2023)


Release Grace Deliverables:

DeliverableMaturity
MEF W99 - Service Provisioning API & Dev GuideLB
MEF W135 - Service Inventory API & Dev GuideLB
MEF W136 - Allegro, Interlude and Legato SOAM and SFT BRUCsLB
MEF W82.1 - SD-WAN Information Model RevisionLB
MEF W100 - SD-WAN Schema/Guide for Service ProvisioningLB
MEF W101 - Carrier Ethernet Schema/Guide for Service ProvisioningStandard
MEF W102 - IP-VPN Schema/Guide for Service ProvisioningStandard
MEF W143 - PM Profiles, Jobs, Notifications and Collection API and Dev GuideCfC #2
MEF W144 - Passive Real-time and Historical Statistics Configuration and Collection API and Dev GuideCfC #2
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 W147 - Streaming Management API and Dev GuideCfC #2



Panel
titleHistorical

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)







Panel
titleStatus

Status
colourGreen
titlePUBLIC


Panel
titleLSO Developer Community

LSO Legato SDK Community

LSO Developer Community Home Page


Panel
titleLSO Developer Community Manager

Michał Łączyński

Contact: community_manager@mef.net


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

Note

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.



Panel
titleCore Contributors

Karthik Sethuraman

Jack Pugaczewski

Min Yoon


Note

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!