Versions Compared

Key

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

...

Use Case Key Information

TopicDescriptionLink
Wiki PageDocumentationO-RAN A1 Policies in ONAP (Non-RealTime RIC)
Architecture Subcommittee
Presentations and JIRA Tickets for Architecture Subcommittee made  

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyONAPARC-580

5G Use Case RequirementJIRA Ticket for Guilin Use Case Requirements

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyREQ-352

CCSDK Requirement/EpicJIRA Ticket for Epic for A1 Adapter Evolution in Guilin

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCCSDK-2475

CCSDK Requirement/EpicJIRA Ticket for Epic for A1 Policy Management in Guilin

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCCSDK-2476

Business Driver

EXECUTIVE SUMMARY This requirement enhances the A1 adapter/interface capabilities provided in Rel 6 as part of  5G/ORAN & 3GPP Standards Harmonization requirement ( REQ-38).   O-RAN has defined A1 interface specification in the context of the management of 5G RAN elements to provide intent based policies for optimization of the RAN network performance. Planned enhancements for Rel 7 include additional support for managing A1 Policies, multiple A1 targets in the RAN, multi-version support for different A1 targets, and secure TLS communication.

BUSINESS IMPACT- Continuing the convergency between ONAP and ORAN initiated in Rel 6, A1 interface can be used by all service providers and avoid duplicate development effort.

.BUSINESS MARKETS -Enhanced A1 capabilities, once developed, will be useable by any service provider deploying and using ONAP.

FUNDING/FINANCIAL IMPACTS - A1 interface provides a flexible way for the operator to manage wide area RAN network optimization, reducing capex investment needs.

ORGANIZATION MGMT, SALES STRATEGIES - There is no additional organizational management or sales strategies for this use case outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider.

Development Status

PROJECTPTLUser Story / EpicRequirementA&AINO IMPACTAAFNO IMPACTAPPCNO IMPACTCLAMPTBCCC-SDK Extend existing A1 Adapter functionality in CCSDK

Integration StoryJIRA Ticket for User Story for Integration testing with OSC A1 simulator 

 

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyINT-1654

CSIT StoryAdd CSIT tests to show A1 Policy end-to-end flow - Guilin

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCCSDK-2700

CCSDK A1 Policy Management Service NBI / APIJIRA Ticket for CCSDK A1 Policy Management Service NBI/API - Guilin

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCCSDK-2489

See also: Open API (yaml)

Deployment (A1 Adapter)Story for deploying A1 adapter in Guilin (SDNC, CCSDK, OOM)

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCCSDK-

2475

2493

Deployment (A1 Policy Management)Story for A1 Policy Management in Guilin (OOM)

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCCSDK-

2476

2492

DCAENO IMPACTDMaaPNO IMPACTExternal APINO IMPACTMODELINGTBC

Multi-VIM / Cloud

NO IMPACTOOFTBCPOLICYNO IMPACTPORTALNO IMPACTSDN-C
  • Extend existing A1 Adapter functionality in SDNC / SDNR
  • Add additional support for A1 Policy Management
SDCNO IMPACTSONO IMPACTVIDNO IMPACTVNFRQTSNO IMPACTVNF-SDKNO IMPACTCDSNO IMPACT

Owners

John Keeney (Ericsson EST)

Michela Bevilacqua

Background

O-RAN A1 Interface:

  • The O-RAN architecture introduces a new management interface - “A1 interface” - between the network management system and the radio access network (RAN)
    • A1-AP (Application Protocol) specified by O-RAN Alliance WG2
  • A1 interface enables vendor-agnostic policy-based guidance (“A1 Policies”) to be sent to underlying RAN elements from the management system.
    • “A1-EI” will also support transmission of enrichment information from the management platform to the RAN elements (Still being defined – currently out of scope)
    • “A1-ML/AI” may also assist with ML Model management in the RAN (Still being defined – currently out of scope)
  • The A1 interface connects Non-RealTime-RIC logical function in OAM/SMO layer with the Near-RealTime-RIC logical function in the RAN.

A1 in O-RAN Architecture for Disaggregated RAN

A1 in O-RAN ArchitectureImage Removed

A1 Adapter in Frankfurt

  • Implemented as an SDNC/CCSDK extension to terminate & expose A1 interface
  • https://wiki.onap.org/display/DW/A1+Adapter+in+ONAP
  • Developed for Release Requirement (REQ-38): 5G / ORAN & 3GPP Standards Harmonization
  • Can be used by other ONAP functions to perform A1 Policy Operations over A1 Interface
  • Provides DMaaP northbound interface, and REST (A1) southbound interface

Enhancements for Guilin Release

  • Add additional support for standardized A1 protocol (O-RAN A1-AP v1.1)
    • Current (Frankfurt) supports only O-RAN-SC’s (draft) non-spec version of A1 Application Protocol
    • Will add support for upcoming A1 standard spec evolution
    • Will add support for multiple versions for different A1 connections
  • Managing A1 Policies
    • Operations:
      • Query A1 Policy Types in near-RT-RICs
      • Create/Query/Update/Delete A1 Policy Instances in near-RT-RICs
      • Query Status for A1 Policy Instances
    • Maintain transient cache of RAN’s A1 Policy information
      • Support RAN-wide view of A1 Policy information
      • Streamline A1 traffic
      • Enable (optional) re-synchronization after inconsistencies / near-RT-RIC restarts
  • Add support for multiple near-RT-RICs (with multi-version support)
  • Unified REST & DMaaP NBI
  • Add support for TLS/HTTPS REST for southbound A1 interfaces (and NBIs)
    • Leverage existing ONAP cert management approaches
  • Converge ONAP & O-RAN-SC A1 Adapter/Controller functions in ONAP SDNC/CCSDK
    • Proposed functionality is currently available as 2 functions in O-RAN-SC
    • Basic A1 Adapter is an ODL extension & Policy Management is a separate microservice

A1 Policies - Northbound Interface (REST & DMaaP) Proposed

Policy Types / Policy Instances / Policy Status Operations  (REST)

...

DMaaP

Inbound request (Topic can be configured)

{

  "type": "string",

  "correlationId": "string",

  "target": "string",

  "timestamp": "timestamp",

  "apiVersion": "string",

  "originatorId": "string",

  "requestId": "string",

  "operation": "string",

  "url": "string",

  "body": "string"

}

Example

To get all policy types for a specific Near‑RT RIC:

{

  "type":"request",

  "correlationId":“xyz123",

  "target":"policy-agent",

  "timestamp":"<timestamp>",

  "apiVersion":"1.0",

  "originatorId":“12345",

  "requestId":“6789",

  "operation":"GET",

  "url":"/policy_schemas?ric=ric_1"

}

Outbound Response (Topic can be configured

{

  "requestId": "string",

  "correlationId": "string",

  "originatorId": "string",

  "type": "string",

  "message": "string",

  "type":  "string",

  "timestamp": "string",

  "status": "string"

}

Example

The response containing all policy types for a specific Near‑RT :

{

  "requestId":"6789",

  "correlationId":“xyz123",

  "originatorId":" 12345",

  "type":"response",

  "message":" <response – in this case an array

  of Policy type schemas> ",

  "timestamp":"<timestamp>",

  "status":"200 OK"

}

Propose to deprecate / phase out existing A1 Adapter DMaaP Interface

A1 Policies – Southbound (A1-P Application Protocol)

O-RAN Alliance (spec) v1.1.3 (Proposed)

/A1-P/v1/policies (GET)

/A1-P/v1/policies​/{policyId}  (GET,  PUT, DELETE)

/A1-P/v1/policies​/{policyId}​/status (GET)

O-RAN-SC A1 (non-spec) v2.1.0 (Existing)

​/a1-p​/healthcheck (GET)

​/a1-p​/policytypes (GET)

​/a1-p​/policytypes​/{policy_type_id} (GET, DELETE, PUT)

​/a1-p​/policytypes​/{policy_type_id}​/policies (GET)

​/a1-p​/policytypes​/{policy_type_id}​/policies​/{policy_instance_id} (GET, DELETE, PUT)

​/a1-p​/policytypes​/{policy_type_id}​/policies​/{policy_instance_id}​/status (GET)

Use Case Functional Definitions

Synchronize A1 Policy Information in RAN

Synchronize A1 Policy Information in RANImage Removed

A1 Policy Type / Instance Operations

Image Removed

A1 Policy Instance Status Operations

A1 Policy Instance Status OperationsImage Removed

Other Impacts

Affected ONAP Functions:

  • SDNC / CCSDK only

Integration of bordering ONAP components:

  • Guilin: None required – Studies only
    • Stretch Goal: “Hello world” demonstrations with other ONAP components
  • Honolulu: A&AI, RuntimeDB, DCAE, CLAMP, Policy. (TBC)
    • Will form part of cross-project 5G integration use cases envisioned for Honolulu (TBC)

Interfaces:

  • Northbound Interface – See earlier section
    • Add/Change SDNC NBI for A1 Policy Management (REST & DMaaP)
      • REST (New)
      • DMaaP (New – Deprecate Existing – goes beyond existing A1 interface message mediation)
  • Southbound Interfaces – See earlier section
    • OSC A1 v2.1 (Existing)
    • O-RAN A1 v1.1 (New)

Usage outside ONAP:

  • Used in O-RAN-SC NONRTRIC Project (Downstream)
  • Southbound Interface: O-RAN A1 Interface + Information Model is specified and maintained by O-RAN Alliance

Modelling Impacts:

  • TBC

Other:

  • Update Documentation with A1 interface aspects
  • Update Integration & Existing Test requirements

Testing

...

TestingStory for TEST Release Requirement (+ linked resources)

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyREQ-447

API DocumentationStories for Documentation (A1 Policy Management Service & A1 Adapter)

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCCSDK-2832

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCCSDK-2833



Business Driver

EXECUTIVE SUMMARY This requirement enhances the A1 adapter/interface capabilities provided in Rel 6 as part of  5G/ORAN & 3GPP Standards Harmonization requirement ( REQ-38).   O-RAN has defined A1 interface specification in the context of the management of 5G RAN elements to provide intent based policies for optimization of the RAN network performance. Planned enhancements for Rel 7 include additional support for managing A1 Policies, multiple A1 targets in the RAN, multi-version support for different A1 targets, and secure TLS communication.

BUSINESS IMPACT- Continuing the convergency between ONAP and ORAN initiated in Rel 6, A1 interface can be used by all service providers and avoid duplicate development effort.

.BUSINESS MARKETS -Enhanced A1 capabilities, once developed, will be useable by any service provider deploying and using ONAP.

FUNDING/FINANCIAL IMPACTS - A1 interface provides a flexible way for the operator to manage wide area RAN network optimization, reducing capex investment needs.

ORGANIZATION MGMT, SALES STRATEGIES - There is no additional organizational management or sales strategies for this use case outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider.

Development Status


PROJECTPTLUser Story / EpicRequirement
A&AINO IMPACT


AAFNO IMPACT
APPCNO IMPACT


CLAMPTBC
CC-SDK
  • Extend existing A1 Adapter functionality in CCSDK
  • Add additional support for A1 Policy Management

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCCSDK-2475

Jira Legacy
serverSystem Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCCSDK-2476

DCAENO IMPACT


DMaaPNO IMPACT
External APINO IMPACT
MODELINGTBC

Multi-VIM / Cloud

NO IMPACT
OOFTBC
POLICYNO IMPACT
PORTALNO IMPACT
SDN-C
  • Extend existing A1 Adapter functionality in SDNC / SDNR

SDCNO IMPACT
SONO IMPACT
VIDNO IMPACT
VNFRQTSNO IMPACT
VNF-SDKNO IMPACT
CDSNO IMPACT

Owners

John Keeney (Ericsson EST)

Michela Bevilacqua

Background

O-RAN A1 Interface:

  • The O-RAN architecture introduces a new management interface - “A1 interface” - between the network management system and the radio access network (RAN)
    • A1-AP (Application Protocol) specified by O-RAN Alliance WG2
  • A1 interface enables vendor-agnostic policy-based guidance (“A1 Policies”) to be sent to underlying RAN elements from the management system.
    • “A1-EI” will also support transmission of enrichment information from the management platform to the RAN elements (Still being defined – currently out of scope)
    • “A1-ML/AI” may also assist with ML Model management in the RAN (Still being defined – currently out of scope)
  • The A1 interface connects Non-RealTime-RIC logical function in OAM/SMO layer with the Near-RealTime-RIC logical function in the RAN.

A1 in O-RAN Architecture for Disaggregated RAN

A1 in O-RAN ArchitectureImage Added

A1 Adapter in Frankfurt

  • Implemented as an SDNC/CCSDK extension to terminate & expose A1 interface
  • https://lf-onap.atlassian.net/wiki/display/DW/A1+Adapter+in+ONAP
  • Developed for Release Requirement (REQ-38): 5G / ORAN & 3GPP Standards Harmonization
  • Can be used by other ONAP functions to perform A1 Policy Operations over A1 Interface
  • Provides DMaaP northbound interface, and REST (A1) southbound interface

Enhancements for Guilin Release

  • Add additional support for standardized A1 protocol (O-RAN A1-AP v1.1)
    • Current (Frankfurt) supports only O-RAN-SC’s (draft) non-spec version of A1 Application Protocol
    • Will add support for upcoming A1 standard spec evolution
    • Will add support for multiple versions for different A1 connections
  • Managing A1 Policies
    • Operations:
      • Query A1 Policy Types in near-RT-RICs
      • Create/Query/Update/Delete A1 Policy Instances in near-RT-RICs
      • Query Status for A1 Policy Instances
    • Maintain transient cache of RAN’s A1 Policy information
      • Support RAN-wide view of A1 Policy information
      • Streamline A1 traffic
      • Enable (optional) re-synchronization after inconsistencies / near-RT-RIC restarts
  • Add support for multiple near-RT-RICs (with multi-version support)
  • Unified REST & DMaaP NBI
  • Add support for TLS/HTTPS REST for southbound A1 interfaces (and NBIs)
    • Leverage existing ONAP cert management approaches
  • Converge ONAP & O-RAN-SC A1 Adapter/Controller functions in ONAP SDNC/CCSDK
    • Proposed functionality is currently available as 2 functions in O-RAN-SC
    • Basic A1 Adapter is an ODL extension & Policy Management is a separate microservice

A1 Policies - Northbound Interface (REST & DMaaP) Proposed

  • See
    Jira Legacy
    serverSystem Jira
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
    keyCCSDK-2489
      and Open API (yaml)

Policy Types / Policy Instances / Policy Status Operations  (REST)

/policies?ric=yy&service=zz&type=xx (GET)

/policy?id=ww (GET, PUT, DELETE)

/policy_types?ric=zz (GET)

/policy_schema?id=xx (GET)

/policy_schemas?ric=yy (GET)

/policy_status?id=ww (GET)

DMaaP

Inbound request (Topic can be configured)

{

  "type": "string",

  "correlationId": "string",

  "target": "string",

  "timestamp": "timestamp",

  "apiVersion": "string",

  "originatorId": "string",

  "requestId": "string",

  "operation": "string",

  "url": "string",

  "body": "string"

}

Example

To get all policy types for a specific Near‑RT RIC:

{

  "type":"request",

  "correlationId":“xyz123",

  "target":"policy-agent",

  "timestamp":"<timestamp>",

  "apiVersion":"1.0",

  "originatorId":“12345",

  "requestId":“6789",

  "operation":"GET",

  "url":"/policy_schemas?ric=ric_1"

}

Outbound Response (Topic can be configured

{

  "requestId": "string",

  "correlationId": "string",

  "originatorId": "string",

  "type": "string",

  "message": "string",

  "type":  "string",

  "timestamp": "string",

  "status": "string"

}

Example

The response containing all policy types for a specific Near‑RT :

{

  "requestId":"6789",

  "correlationId":“xyz123",

  "originatorId":" 12345",

  "type":"response",

  "message":" <response – in this case an array

  of Policy type schemas> ",

  "timestamp":"<timestamp>",

  "status":"200 OK"

}

Propose to deprecate / phase out existing A1 Adapter DMaaP Interface

A1 Policies – Southbound (A1-P Application Protocol)

O-RAN Alliance (spec) v1.1.3 (Proposed)

/A1-P/v1/policies (GET)

/A1-P/v1/policies​/{policyId}  (GET,  PUT, DELETE)

/A1-P/v1/policies​/{policyId}​/status (GET)

O-RAN-SC A1 (non-spec) v2.1.0 (Existing)

​/a1-p​/healthcheck (GET)

​/a1-p​/policytypes (GET)

​/a1-p​/policytypes​/{policy_type_id} (GET, DELETE, PUT)

​/a1-p​/policytypes​/{policy_type_id}​/policies (GET)

​/a1-p​/policytypes​/{policy_type_id}​/policies​/{policy_instance_id} (GET, DELETE, PUT)

​/a1-p​/policytypes​/{policy_type_id}​/policies​/{policy_instance_id}​/status (GET)

Use Case Functional Definitions

Synchronize A1 Policy Information in RAN

Synchronize A1 Policy Information in RANImage Added

A1 Policy Type / Instance Operations

Image Added

A1 Policy Instance Status Operations

A1 Policy Instance Status OperationsImage Added

Other Impacts

Affected ONAP Functions:

  • SDNC / CCSDK only

Integration of bordering ONAP components:

  • Guilin: None required – Studies only
    • Stretch Goal: “Hello world” demonstrations with other ONAP components
  • Honolulu: A&AI, Configuration & Persistency Service, DCAE, CLAMP, Policy. (TBC)
    • Will form part of cross-project 5G integration use cases envisioned for Honolulu (TBC)

Interfaces:

  • Northbound Interface – See earlier section
    • Add/Change SDNC NBI for A1 Policy Management (REST & DMaaP)
      • REST (New)
      • DMaaP (New – Deprecate Existing – goes beyond existing A1 interface message mediation)
  • Southbound Interfaces – See earlier section
    • OSC A1 v2.1 (Existing)
    • O-RAN A1 v1.1 (New)

Usage outside ONAP:

  • Used in O-RAN-SC NONRTRIC Project (Downstream)
  • Southbound Interface: O-RAN A1 Interface + Information Model is specified and maintained by O-RAN Alliance

Modelling Impacts:

  • TBC

Other:

  • Update Documentation with A1 interface aspects
  • Update Integration & Existing Test requirements

Testing

Test use-cases:

  • Synchronize A1 Policy Information in RAN
  • A1 Policy Type / Instance Operations
  • A1 Policy Instance Status Operations
  • See REQ-447 and linked resources for more information on TEST Release Requirements

Test variations:

  • A1 Adapter with/without A1 Policy Management Service
  • A1 versions:
    • O-RAN Alliance (spec) v1.1.3
    • O-RAN-SC A1 (non-spec) v2.1.0

OSC A1 Simulator: 

Integration Story:

  • Jira Legacy
    serverSystem Jira
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
    keyINT-1654

Current Status

End to End flow to be Tested

Test Cases and Status


1
There should be a test case for each item in the sequence diagram

NOT YET TESTED

2create additional requirements as needed for each discreet step
  • Synchronize A1 Policy Information in RAN

COMPLETE

2
  • A1 Policy Type / Instance Operations

COMPLETE

3
Test cases should cover entire Use Case

PARTIALLY COMPLETE

 Test Cases should include enough detail for testing team to implement the test FAILED
  • A1 Policy Instance Status Operations

COMPLETE


Use Case Functional Definitions

Use Case Title

A1 Adapter extensions

Actors (and System Components)

SDNC / CCSDK - A1 Adapter

Description

This requirement enhances the A1 adapter/interface capabilities provided in Rel 6 as part of  5G/ORAN & 3GPP Standards Harmonization requirement ( REQ-38).   O-RAN has defined A1 interface specification in the context of the management of 5G RAN elements to provide intent based policies for optimization of the RAN network performance. Planned enhancements for Rel 7 include additional support for managing A1 Policies, multiple A1 targets in the RAN, multi-version support for different A1 targets, and secure TLS communication.

Points of Contact

Preconditions

N/A

Triggers / Begins when

N/A

Steps / Flows (success)

Extend A1 adapter Support in CCSDK/SDNC

Add A1 Policy Management functionality

Post-conditions

Service can perform A1 Policy Management operations over O-RAN A1 interface using SDNC/CCSDK function NBIs (DMaaP & REST)

Alternate / Exception Paths

N/A

Related Use Cases

TBC

Assumptions

None

Tools / References / Artifacts

See information in the text above.

...