Versions Compared

Old Version 25

changes.mady.by.user Stephen Terrill

Saved on

compared with

New Version Current

changes.mady.by.user Benjamin Cheung

Saved on

Key

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

...

WHEN EXECUTED: After Design Time (before Run Time). When SDC Service CSAR package has been composed and is ready for distribution by SDC from a user at the Deployment Studio.

PURPOSE: To distribute the SDC Service CSAR to the run-time components

INFORMATION PASSED: Service CSAR package.

ACTORS:

  • Service Designer
  • Operations Specialist
  • SDC (Deployment Studio)


2. Pre-Conditions

The preconditions are:

...

PlantUML Macro
titleSDC Service Distribution-1
@startuml
participant SDC
participant SO
participant DCAE
participant AAI
Participant SDNC
Participant APPC
Participant CLAMP
Participant POLICY
Participant MC

autonumber 

== Register to Service CSAR Distribution == 

SO-->SO: Register for Distribution

note right: performed by all receptiantsrecipients of the CSAR

== Service CSAR Distribution == 


group Distribute to SO
	hnote over SO : SO ListnerListener
	SDC -> SO : ServiceSDC CSAR Distribution Notification
	note left: Using DMaaP
	SO --> SOSDC : Store CSAR
	SO -> SDC: Distribution Response
end


note over SDC, AAI #FFAAAA
	The flow to DCAE is not correct. DCAE SCH does not get the CSAR itself;
	 SCH get the blueprint through the SDC distribution client 
	(the URL is notified by the SDC and the client library is used to retrieve it)
end noteRequest Artifact (Artifact Type)
	SDC ->SO: Respond with Artifact 
	SO --> SO : Store CSAR
	SO -> SDC: Distribution Status Update
end


group Distribute to DCAE
 	hnote over DCAE : Service Change Handler 
	
	SDC -> DCAE : SDC Distribution Notification
 	note left: Using DMaaP
	DCAE -> SDC : Request Artifact (Artifact Type)
	SDC -> DCAE: Respond with Artifact 
	DCAE --> DCAE : Store CSAR
	DCAE -> SDC: Distribution Status Update
end

group Distribute to DCAEAAI
 	hnote over DCAE AAI: Service Change Handler 


 AAI Listener
	SDC -> DCAEAAI : ServiceSDC CSARDistribution DistributionNotification
  	note left : Using DMaaP
 	DCAEAAI --> DCAESDC : Store CSARRequest Artifact (Artifact Type)
	DCAESDC -> SDCAAI : Distribution Response
end

group Distribute to AAI
	hnote over AAI: AAI Listner
	SDC -> AAI : Service CSAR Distribution  	
	note left: Using DMaaP
	AAI --Respond with Artifact 
	AAI --> AAI : Store CSAR
	AAI -> SDC: Distribution ResponseStatus Update
end

group Distribute to SDNC
 	hnote over SDNC: UEB ListnerListener
 	SDC -> SDNC : ServiceSDC CSARDistribution DistributionNotification
 	note left: Using DMaaP
 	SDNC --> SDNCSDC : Request Artifact (Artifact Type)
	SDC -> SDNC : Respond with Artifact 
	SDNC --> SDNC : Store CSAR
 	SDNC -> SDC: Distribution Status ResponseUpdate
end


group Distribute to APPC  	
	hnote over APPC: ListnerListener
  	SDC -> APPC : ServiceSDC CSARDistribution DistributionNotification
 	note left: Using DMaaP
  	APPC --> SDC APPC: Store CSAR
  Request Artifact (Artifact Type)
	SDC -> APPC : Respond with Artifact 
	APPC --> APPC : Store CSAR
	APPC -> SDC: Distribution ResponseStatus Update
end


group Distribute to CLAMP
	hnote over CLAMP: ListnerListener

   	SDC -> CLAMP : ServiceSDC CSARDistribution DistributionNotification
  	note left: Using DMaaP
   	CLAMP --> CLAMP: Store CSAR
   SDC : Request Artifact (Artifact Type)
	SDC -> CLAMP : Respond with Artifact 
	CLAMP --> CLAMP : Store CSAR
	CLAMP -> SDC: Distribution Status ResponseUpdate

end 

group Distribute to POLICY
	hnote over POLICY: ListnerListener

   	SDC -> POLICY : ServiceSDC CSARDistribution DistributionNotification
  	note left: Using DMaaP
 	SDC <- POLICY : Request Artifact (Artifact Type)
	SDC -> POLICY : Respond with Artifact 
	POLICY --> POLICY : Store CSAR
   	POLICY -> SDC: Distribution ResponseStatus Update

end

group Distribute to MultiCloud
	hnote over MC: ListnerListener
    	SDC -> MC : ServiceSDC CSARDistribution DistributionNotification
   	note left: Using DMaaP
 	MC -> SDC : Request Artifact (Artifact Type)
	SDC -> MC : Respond with Artifact 
	MC --> MC : Store CSAR
    	MC -> SDC: Distribution ResponseStatus Update
end 



== Un -Register to Service CSAR Distribution (optional, at any time) == 
SO-->SO: UnRegisterUn-Register for Distribution
note right: performed by all receptiantsrecipients of the CSAR that want to unregisterun-register


@enduml


The following text describes each of the steps in the above flow. More details and exceptions can be described in the detailed descriptions. Wiki page links can also be linked for a reader to explore more.

  1. REGISTER FOR DISTRIBUTION – REGISTER for distribution – SO, DCAE, A&AI, SDN-C, APP-C, VF-C register for distribution of the SDC Artifact distribution via the registration service of the SDCE-6 interface.  This is performed by all recipients of the CSAR. This allows the ONAP platform component to receive the message which will contain the package later on.

  2. SDC DISTRIBUTION NOTIFICATION (with SO) CSAR DISTRIBUTION to SO – SDC Distributes to service CSAR SO using the SDCE-6 interface. The SO listener retrieves the SDC CSAR package. SDC distributes the Service Distribution CSAR package which includes all of the artifacts, templates and resources related to the service created in design time. SDC publishes a topic onto DMaaP. Any RT component that has subscribed to that topic can get that package.

  3. STORE CSAR – SO stores the distributed package.

  4. REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
  5. RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.

  6. STORE CSAR PACKAGE – SO stores the distributed package.

  7. DISTRIBUTION STATUS UPDATE (with SO) - SO responds to the SDC Distribution SO RESPONDS - SO responds to the SDC Distribution exchange using SDCE-6.
  8. CSAR Distribution to DCAE SDC DISTRIBUTION NOTIFICATION (with DCAE) - SDC Distributes service CSAR to DCAE using the SDCE-6 interface,  the DCAE Service Change Handler retrieves the SDC CSAR package, SDC distributes the Service Distribution CSAR package which includes all of the artifacts, including templates and resources related to the service created at design time.
  9. REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
  10. RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
  11. STORE CSAR PACKAGE – DCAE stores the STORE CSAR – DCAE stores the distributed package.
  12. DCAE RESPONDS DISTRIBUTION STATUS UPDATE (with DCAE)- DCAE responds to the SDC Distribution exchange using SDCE-6.
  13. CSAR SDC DISTRIBUTION to NOTIFICATION (with A&AI) - SDC Distributes service CSAR to A&AI using the SDCE-6 interface,  the A&AI  listner listener retrieves the SDC CSAR package, SDC distributes the Service Distribution CSAR package which includes all of the artifacts, including templates and resources related to the service created at design time.
  14. REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
  15. RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
  16. STORE CSAR PACKAGE – STORE CSAR – A&AI stores the distributed package.
  17. DISTRIBUTION STATUS UPDATE (with A&AI RESPONDSAI)- A&AI responds to the SDC Distribution exchange using SDCE-6.
  18. CSAR DISTRIBUTION  to SDNSDC DISTRIBUTION NOTIFICATION (with SDN-C ) - SDC Distributes service CSAR to SDN-C using the SDCE-6 interface,  the SDN-C UEB  listner listener retrieves the SDC CSAR package, SDC distributes the Service Distribution CSAR package which includes all of the artifacts, including templates and resources related to the service created at design time.
  19. REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
  20. RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
  21. STORE CSAR PACKAGE – STORE CSAR – SDN-C stores the distributed package.
  22. DISTRIBUTION STATUS UPDATE (with SDN-C RESPONDSC) - SDN-C responds to the SDC Distribution exchange using SDCE-6.
  23. CSAR DISTRIBUTION  to APPSDC DISTRIBUTION NOTIFICATION (with APP-C ) - SDC Distributes service CSAR to APP-C using the SDCE-6 interface,  the APP-C listner listener retrieves the SDC CSAR package, SDC distributes the Service Distribution CSAR package which includes all of the artifacts, including templates and resources related to the service created at design time.
  24. REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
  25. RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
  26. STORE CSAR PACKAGE – STORE CSAR – APP-C stores the distributed package.
  27. DISTRIBUTION STATUS UPDATE (with APP-C RESPONDSC) - APP-C responds to the SDC Distribution exchange using SDCE-6.
  28. CSAR DISTRIBUTION  to CLAMPSDC DISTRIBUTION NOTIFICATION (with CLAMP) - SDC Distributes service CSAR to CLAMP using the SDCE-6 interface,  the CLAMP listner listener retrieves the SDC CSAR package, SDC distributes the Service Distribution CSAR package which includes all of the artifacts, including templates and resources related to the service created at design time.
  29. STORE CSAR – CLAMP stores the distributed package.
  30. REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
  31. RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
  32. STORE CSAR PACKAGE – CLAMP stores the distributed package.
  33. DISTRIBUTION STATUS UPDATE (with CLAMP) - CLAMP responds to the SDC Distribution CLAMP RESPONDS - CLAMP responds to the SDC Distribution exchange using SDCE-6.
  34. CSAR DISTRIBUTION  to POLICYSDC DISTRIBUTION NOTIFICATION (with POLICY) - SDC Distributes service CSAR to POLICY using the SDCE-6 interface,  the POLICY listner listener retrieves the SDC CSAR package, SDC distributes the Service Distribution CSAR package which includes all of the artifacts, including templates and resources related to the service created at design time.
  35. STORE CSAR – POLICY stores the distributed package.
  36. REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
  37. RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
  38. STORE CSAR PACKAGE – POLICY stores the distributed package.
  39. DISTRIBUTION STATUS UPDATE (with POLICY) -POLICY RESPONDS - POLICY responds to the SDC Distribution exchange using SDCE-6.
  40. CSAR DISTRIBUTION  to Multi-Cloud- SDC SDC DISTRIBUTION NOTIFICATION (with MULTICLOUD) - SDC Distributes service CSAR to Multi-Cloud using the SDCE-6 interface,  the Multi-Cloud listner retrieves the SDC CSAR package, SDC distributes the Service Distribution CSAR package which includes all of the artifacts, including templates and resources related to the service created at design time.
  41. REQUEST ARTIFACT - The ONAP platform component can request for the artifacts required by the component.
  42. RESPOND WITH ARTIFACT - The artifacts or SDC CSAR Package is retrieved from the DMaaP Bus. SDC responds with the package.
  43. STORE CSAR PACKAGE – MultiSTORE CSAR – Multi-Cloud stores the distributed package.
  44. Multi-Cloud RESPONDS -DISTRIBUTION STATUS UPDATE (with MULTICLOUD) - Multi-Cloud responds to the SDC Distribution exchange using SDCE-6.
  45. Unregister from CSAR distribution. UN-REGISTER FROM CSAR DISTRIBUTION - At any time, any module can unregister un-register from the reception of the CSAR using the Register for distribution service of SDCE-6 interface.

3b (temp) Alternative flow representation

PlantUML Macro
titleSDC Service Distribution-1
@startuml
participant SDC
participant "SDC Artifact Consumer" as Consumer

autonumber 

== Register to Service CSAR Distribution == 

Consumer-->Consumer: Register for Distribution

note right: performed by all receptiants of the CSAR
note right: This includes SO, SDC, DCAE, AAI, SDNC, APPC, CLAMP, POLICY, MultiCloud

== Service CSAR Distribution == 



group Distribute to SDC artifact consumer
	hnote over Consumer: Consumer Listner
	SDC -> Consumer: SDC Distribution Notification
	note left: Using DMaaP
	note right: Can be any consumer (SO, SDC, DCAE, AAI, SDNC, APPC, CLAMP, POLICY, MultiCloud)
	Consumer -> SDC: Request Artifact(Artifact Type)
	SDC -> Consumer: Repond (with Artifact)
	Consumer -> Consumer: Store Artifact
	Consumer -> SDC: Distrubution Status Update
end

== Un Register to Service CSAR Distribution (optional, at any time) == 
Consumer --> Consumer : UnRegister for Distribution
note right: performed by all receptiants of the CSAR that want to unregister


@enduml

 

  1. REGISTER for distribution – SO, DCAE, A&AI, SDN-C, APP-C, VF-C register for distribution of the SDC Artifact distribution via the registration service of the SDCE-6 interface. 
    Note: This is only done once, not once per distribution request.

  2. CSAR Ready NOTIFICATION to Consumer– SDC informs the consumer that there is a new artifact to be distributed using the Distrbution notification interface of SDCE-6.

  3. CSAR RETRIEVAL request: The cosumer requests to retrieves the artifact using the Artifact retrieval interface of SDCE-6, indicating the required Artifact Type.

  4. CSAR DELIVERY: As a response to (3) SDC delivers the artifact to the consumer using SDCE-6 
  5. STORE CSAR:  The Consumer stores the distributed artifact.
  6. Consumer Status Update- The consumer informs SDC that the artifact has been consumed using the distribution status interface of SDCE-6.
  7. Unregister from CSAR distribution. At any time, any module can unregister from the reception of the CSAR using the Register for distribution service of SDCE-6 interface.
    Note: This is only done if the Consumer does not want to be informed of any more artifacts that are ready to distribute

3c (temp) Alternative flow

...

titleSDC Service Distribution-1

...


4. Post Condition

The post-conditions are:

...