Versions Compared

Key

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

The user triggers a configuration, which will be forwarded to the O-RAN components. The flow is successfully passed when the corresponding VES message is available on DMaaP and can be processed by any other ONAP components.

Note: The VES notification syntax for a new ves-domain "cmNotify" is currently not available (state: 2019-11-21). 

Initial configuration read from C&PS

After service design the user stores the initial configuration of the xNF's within C&PS.

PlantUML Macro
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' 
' PlantUML for ONAP/O-RAN pnfRegistrationConfiguration from usedesign caseto 2019-12running
'
' Copyright 20192020 highstreet technologies GmbH
' Licensed under the Apache License, Version 2.0 (the "License"); 
' you may not use this file except in compliance with the License. 
' You may obtain a copy of the License at 
' 
' http://www.apache.org/licenses/LICENSE-2.0 
' 
' Unless required by applicable law or agreed to in writing, software 
' distributed under the License is distributed on an "AS IS" BASIS, 
' WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
' See the License for the specific language governing permissions and 
' limitations under the License. 
'

@startuml

' Diagram 
title 
  ONAP/O-RAN Configuration from design managementto running
end title

box “Network” #lightpink "User space" #lightblue
  actor "SMO µService or rApp" as user
end box

box "Configuration and \nPersistent Service" #gold
  database "Database" as caps
end box

box "SMO-O1-Controller \n(e.g. ONAP CCSDK/SDNC/SDN-R)" #gold
  participant "DB Listener" as dbl
  participant "OO1-xNF-RANAdapter Component\n(NTSim)e.g. DeviceManager)" as deviceManager
  participant "NetConf Client" as ntsimncc
end box

box “Network” #lightpink
  participant "xNF" as xnf
end box

autonumber 1 1 "<b>[00]"

user -> caps: Store initial configuration
dbl -> caps: read data
caps -> dbl: response
dbl -> deviceManager: forward
deviceManager -> deviceManager: convert to NetConf/YANG
deviceManager -> ncc: forward
ncc -> xnf: configure
xnf -> ncc: success
ncc -> deviceManager: success
deviceManager -> caps: tag as successfully configured

' End Diagram
' Format

right footer 

  Thanks to PlantUml! 
  License: Apache 2.0
  2020-09-20 | onap.org | o-ran-sc.org
end footer

skinparam backgroundColor #fefefe

skinparam backgroundColor #fefefe
'skinparam handwritten true
skinparam roundcorner 15

skinparam database  {
    BorderColor #444444
    BackgroundColor #ffffdd
    FontColor #444444
}

skinparam sequence {
  MessageAlign left
  ArrowColor #2277dd
  ArrowFontColor #444444
  ArrowThickness 2
  ActorBorderColor #444444
  LifeLineBorderColor #444444
  LifeLineBackgroundColor #eeeeee
  LifeLineBackgroundColor #eeeeee
 
  BoxBorderColor #444444
    
  GroupBorderColor #444444
  GroupBackgroundColor #eeeeee
  
  ParticipantBorderColor #444444
  ParticipantBackgroundColor #ffffdd
  ParticipantFontColor #444444
    
  ActorBackgroundColor #ffffdd
  'ActorFontColor DeepSkyBlue
  'ActorFontSize 17
  'ActorFontName Aapex
}

@enduml


CM with VES 


PlantUML Macro
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' 
' PlantUML for ONAP/O-RAN Configuration management (NetConf)
'
' Copyright 2020 highstreet technologies GmbH
' Licensed under the Apache License, Version 2.0 (the "License"); 
' you may not use this file except in compliance with the License. 
' You may obtain a copy of the License at 
' 
' http://www.apache.org/licenses/LICENSE-2.0 
' 
' Unless required by applicable law or agreed to in writing, software 
' distributed under the License is distributed on "Service Management and Orchestration (SMO) an "AS IS" BASIS, 
' WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
' See the License for the specific language governing permissions and 
' limitations under the License. 
'

@startuml

' Diagram 
title 
  ONAP/O-RAN Configuration management
end title
                          
box “Network” #lightpink
  participant "xNF" as xnf
end box


box "SMO-O1-Controller \n(e.g. ONAP CCSDK/SDNC/SDN-R)" #gold
  participant "VESNetConf CollectorClient" as vesncc
  participant "DMaaPO1-xNF-Adapter \n(e.g. DeviceManager)" as dmaapdeviceManager
  database "Log or CSP" as log
  participant "VES Provider" as vesProvider
  participant "SDN-R" as sdnrVES Listener" as vesListener
  participant "RestConf Server" as rcs
end box

box "SMO O1-EventCollector \n(e.g. ONAP VES Collector)" #gold
  participant "VES Collector" as vesConsumer
end box

box "SMO MessageBus \n(e.g. ONAP DMaaP)" #gold
  participant "WebMessage UIRouter" as uidmaap
end box

box "User space" #lightblue
  actor "UserSMO µService, rApp \n or OLDUX in browser" as user
end box

autonumber 1 1 "<b>[00]"

user -> ui: Trigger configuration
ui -> sdnr: RestConf: Configuration request
sdnr -> ntsim: NetConf: edit-config
ntsim -> sdnr: NetConf: success
sdnr -> ui: RestConf: success


ntsim -> ves: REST: VES:cmNotify
ves== Start the engines ==

xnf <-> ncc: NETCONF\nestablish session\n<hello>
ncc -> deviceManager: Connected! (including yang-capabilities
deviceManager -> deviceManager: IF device supports\n'VES-subscription'
ncc <- deviceManager: NETCONF\n<VES-subscription>

xnf <- ncc: NETCONF\n<create-subscription>


== Trigger a valid configuration ==

user -> rcs: REST PUT or POST request for xNF
rcs -> ncc: ODL-MDSAL
ncc -> xnf: <edit-config>
xnf -> ncc: <rpc-reply>
ncc -> rcs: ODL-MDSAL
rcs -> user: HTTP RESPONSE

== Related notification flow ==


xnf -> vesConsumer:send VES messaged CM-Notify
vesConsumer -> dmaap: REST: Publish event \nunauthenticated.SECVES_CM_CONFIGNOTIFY_OUTPUT
sdnrdmaap -> vesListener: fetch VES event
vesListener -> deviceManager: forward event
deviceManager -> log: store event

' End Diagram
' Format
header
  <b><font color=#8888ff>License</font></b>
  <b><font color=#8888ff>Apache 2.0</font></b>
end header

right footer 
  Thanks to plantUml! 
  2020-06-17 | onap.org | o-ran-sc.org
end footer

skinparam backgroundColor #fefefe

skinparam backgroundColor #fefefe
'skinparam handwritten true
skinparam roundcorner 15

skinparam databaseBorderColor #444444
skinparam databaseBackgroundColor #fefefe
skinparam databaseFontColor #444444

skinparam sequence {
  MessageAlign left
  ArrowColor #2277dd
  ArrowFontColor #444444
  ArrowThickness 2
  ActorBorderColor #444444
  LifeLineBorderColor #444444
  LifeLineBackgroundColor #eeeeee
  LifeLineBackgroundColor #eeeeee
 
  BoxBorderColor #444444
    
  GroupBorderColor #444444
  GroupBackgroundColor #eeeeee
  
  ParticipantBorderColor #444444
  ParticipantBackgroundColor #ffffdd
  ParticipantFontColor #444444
    
  ActorBackgroundColor #ffffdd
  'ActorFontColor DeepSkyBlue
  'ActorFontSize 17
  'ActorFontName Aapex
}

@enduml


CM with NetConf notification

PlantUML Macro
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' 
' PlantUML for ONAP/O-RAN Configuration management (NetConf)
'
' Copyright 2020 highstreet technologies GmbH
' Licensed under the Apache License, Version 2.0 (the "License"); 
' you may not use this file except in compliance with the License. 
' You may obtain a copy of the License at 
' 
' http://www.apache.org/licenses/LICENSE-2.0 
' 
' Unless required by applicable law or agreed to in writing, software 
' distributed under the License is distributed on an "AS IS" BASIS, 
' WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
' See the License for the specific language governing permissions and 
' limitations under the License. 
'

@startuml

' Diagram 
title 
  ONAP/O-RAN Configuration management
end title
                          
box “Network” #lightpink
  participant "xNF" as xnf
end box


box "SMO-O1-Controller \n(e.g. ONAP CCSDK/SDNC/SDN-R)" #gold
  participant "NetConf Client" as ncc
  participant "O1-xNF-Adapter \n(e.g. DeviceManager)" as deviceManager
  database "Log or CSP" as log
  participant "VES Provider" as vesProvider
  participant "RestConf Server" as rcs
end box

box "SMO O1-EventCollector \n(e.g. ONAP VES Collector)" #gold
  participant "VES Collector" as vesConsumer
end box

box "SMO MessageBus \n(e.g. ONAP DMaaP)" #gold
  participant "Message Router" as dmaap
end box

box "User space" #lightblue
  actor "SMO µService, rApp \n or OLDUX in browser" as user
end box

autonumber 1 1 "<b>[00]"

== Start the engines ==

xnf <-> ncc: NETCONF\nestablish session\n<hello>
ncc -> deviceManager: Connected! (including yang-capabilities
deviceManager -> deviceManager: IF device supports\n'create-subscription'
ncc <- deviceManager: NETCONF\n<create-subscription>

xnf <- ncc: NETCONF\n<create-subscription>


== Trigger a valid configuration ==

user -> rcs: REST PUT or POST request for xNF
rcs -> ncc: ODL-MDSAL
ncc -> xnf: <edit-config>
xnf -> ncc: <rpc-reply>
ncc -> rcs: ODL-MDSAL
rcs -> user: HTTP RESPONSE

== Related notification flow ==

xnf -> ncc:CM-notification\nNetConf/YANG
ncc -> deviceManager: ODL-MDSAL
deviceManager -> vesProvider: ODL-MDSAL
deviceManager -> log: store event
vesProvider -> vesProvider: convertion/model-translation \n(xml->ves)
vesProvider -> vesConsumer: REST: send VES Message
vesConsumer -> dmaap: REST: Publish event \nunauthenticated.VES_NOTIFICATION_OUTPUTdmaap: REST: Get topic \nunauthenticated.SEC_CONFIG_OUTPUT
dmaap -> sdnr: REST: cmNotify
sdnr -> sdnr: Alarm processing "DeviceManager"
sdnr -> log: Create EventLog entry
sdnr -> ui: WebSocket: cmNotify
ui -> user: Inform about config changes

user -> ui: check event log
ui -> sdnr: RestConf: Get EventLog
sdnr -> log: REST: Forward Log Request
log -> sdnr: Rest: Log response
sdnr -> ui: Response with EventLogEntries
ui -> user: View EventLogs

' End Diagram
' Format
header
  <b><font color=#8888ff>License</font></b>
  <b><font color=#8888ff>Apache 2.0</font></b>
end header

right footer 
  Thanks to plantUml! 
  20192020-1106-2117 | onap.org | o-ran-sc.org
end footer

skinparam backgroundColor #fefefe

skinparam backgroundColor #fefefe
'skinparam handwritten true
skinparam roundcorner 15

skinparam databaseBorderColor #444444
skinparam databaseBackgroundColor #ffffee#fefefe
skinparam databaseFontColor #444444

skinparam sequence {
  MessageAlign left
  ArrowColor #2277dd
  ArrowFontColor #444444
  ArrowThickness 2
  ActorBorderColor #444444
  LifeLineBorderColor #444444
  LifeLineBackgroundColor #eeeeee
  LifeLineBackgroundColor #eeeeee
 
  BoxBorderColor #444444
    
  GroupBorderColor #444444
  GroupBackgroundColor #eeeeee
  
  ParticipantBorderColor #444444
  ParticipantBackgroundColor #ffffdd
  ParticipantFontColor #444444
    
  ActorBackgroundColor #ffffdd
  'ActorFontColor DeepSkyBlue
  'ActorFontSize 17
  'ActorFontName Aapex
}

@enduml